SynonymMap Clase
Representa una definición de mapa de sinónimos.
Las variables solo se rellenan mediante el servidor y se omitirán al enviar una solicitud.
Todos los parámetros necesarios deben rellenarse para enviarlos a Azure.
- Herencia
-
azure.search.documents.indexes._generated._serialization.ModelSynonymMap
Constructor
SynonymMap(**kwargs)
Variables
Nombre | Description |
---|---|
name
|
Necesario. Nombre del mapa de sinónimos. |
format
|
Necesario. Formato del mapa de sinónimos. Actualmente solo se admite el formato "solr". Valor predeterminado: "solr". |
synonyms
|
Necesario. Una serie de reglas de sinónimos en el formato de asignación de sinónimos especificado. Las reglas deben estar separadas por líneas nuevas. |
encryption_key
|
Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se usa para proporcionar un nivel adicional de cifrado en reposo para los datos cuando desee asegurarse de que nadie, ni siquiera Microsoft, puede descifrar los datos en Azure Cognitive Search. Una vez que haya cifrado los datos, siempre permanecerá cifrado. Azure Cognitive Search omitirá los intentos de establecer esta propiedad en null. Puede cambiar esta propiedad según sea necesario si desea rotar la clave de cifrado; Los datos no se verán afectados. El cifrado con claves administradas por el cliente no está disponible para los servicios de búsqueda gratuitos y solo está disponible para los servicios de pago creados el 1 de enero de 2019 o después. |
e_tag
|
ETag del mapa de sinónimos. |
Métodos
as_dict |
Devuelve un dict que se puede serializar mediante json.dump. El uso avanzado puede usar opcionalmente una devolución de llamada como parámetro: Key es el nombre de atributo que se usa en Python. Attr_desc es un dict de metadatos. Actualmente contiene 'type' con el tipo msrest y 'key' con la clave codificada restAPI. Value es el valor actual de este objeto. La cadena devuelta se usará para serializar la clave. Si el tipo de valor devuelto es una lista, se considera una diferencia de resultado jerárquica. Vea los tres ejemplos de este archivo:
Si desea serialización XML, puede pasar los kwargs is_xml=True. |
deserialize |
Analice una cadena mediante la sintaxis restAPI y devuelva un modelo. |
enable_additional_properties_sending | |
from_dict |
Analizar un dict mediante un extractor de claves dado devuelve un modelo. De forma predeterminada, considere la posibilidad de extractores de claves (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor y last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Devuelve el JSON que se enviaría al servidor desde este modelo. Se trata de un alias para as_dict(full_restapi_key_transformer, keep_readonly=False). Si desea serialización XML, puede pasar los kwargs is_xml=True. |
as_dict
Devuelve un dict que se puede serializar mediante json.dump.
El uso avanzado puede usar opcionalmente una devolución de llamada como parámetro:
Key es el nombre de atributo que se usa en Python. Attr_desc es un dict de metadatos. Actualmente contiene 'type' con el tipo msrest y 'key' con la clave codificada restAPI. Value es el valor actual de este objeto.
La cadena devuelta se usará para serializar la clave. Si el tipo de valor devuelto es una lista, se considera una diferencia de resultado jerárquica.
Vea los tres ejemplos de este archivo:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Si desea serialización XML, puede pasar los kwargs is_xml=True.
as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]
Parámetros
Nombre | Description |
---|---|
key_transformer
|
<xref:function>
Función de transformador de teclas. |
keep_readonly
|
valor predeterminado: True
|
Devoluciones
Tipo | Description |
---|---|
Un objeto compatible con JSON dict |
deserialize
Analice una cadena mediante la sintaxis restAPI y devuelva un modelo.
deserialize(data: Any, content_type: str | None = None) -> ModelType
Parámetros
Nombre | Description |
---|---|
data
Requerido
|
Una cadena de datos mediante la estructura restAPI. JSON de forma predeterminada. |
content_type
|
JSON de forma predeterminada, establezca application/xml si XML. valor predeterminado: None
|
Devoluciones
Tipo | Description |
---|---|
Instancia de este modelo |
Excepciones
Tipo | Description |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> None
from_dict
Analizar un dict mediante un extractor de claves dado devuelve un modelo.
De forma predeterminada, considere la posibilidad de extractores de claves (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor y last_rest_key_case_insensitive_extractor)
from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType
Parámetros
Nombre | Description |
---|---|
data
Requerido
|
Un dict mediante la estructura restAPI |
content_type
|
JSON de forma predeterminada, establezca application/xml si XML. valor predeterminado: None
|
key_extractors
|
valor predeterminado: None
|
Devoluciones
Tipo | Description |
---|---|
Instancia de este modelo |
Excepciones
Tipo | Description |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> bool
serialize
Devuelve el JSON que se enviaría al servidor desde este modelo.
Se trata de un alias para as_dict(full_restapi_key_transformer, keep_readonly=False).
Si desea serialización XML, puede pasar los kwargs is_xml=True.
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
Parámetros
Nombre | Description |
---|---|
keep_readonly
|
Si desea serializar los atributos de solo lectura valor predeterminado: False
|
Devoluciones
Tipo | Description |
---|---|
Un objeto compatible con JSON dict |
Atributos
format
format = 'solr'
Azure SDK for Python
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de