Compartir a través de


SearchIndex Clase

Representa una definición de índice de búsqueda, que describe los campos y el comportamiento de búsqueda de un índice.

Todos los parámetros necesarios deben rellenarse para enviarlos a Azure.

Herencia
azure.search.documents.indexes._generated._serialization.Model
SearchIndex

Constructor

SearchIndex(**kwargs)

Variables

Nombre Description
name
str

Necesario. El nombre del índice.

fields

Necesario. Campos del índice.

scoring_profiles

Perfiles de puntuación para el índice.

default_scoring_profile
str

Nombre del perfil de puntuación que se va a usar si no se especifica ninguno en la consulta. Si esta propiedad no está establecida y no se especifica ningún perfil de puntuación en la consulta, se usará la puntuación predeterminada (tf-idf).

cors_options

Opciones para controlar el uso compartido de recursos entre orígenes (CORS) para el índice.

suggesters

Los proveedores de sugerencias para el índice.

analyzers

Analizadores del índice.

tokenizers

Tokenizadores para el índice.

token_filters

El token filtra el índice.

char_filters

Filtros de caracteres para el índice.

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.

similarity

Tipo de algoritmo de similitud que se va a usar al puntuar y clasificar los documentos que coinciden con una consulta de búsqueda. El algoritmo de similitud solo se puede definir en el momento de la creación del índice y no se puede modificar en índices existentes. Si es null, se usa el algoritmo ClassicSimilarity.

semantic_search

Define parámetros para un índice de búsqueda que influye en las funcionalidades semánticas.

vector_search

Define parámetros para un índice de búsqueda que influye en la puntuación en un espacio vectorial.

e_tag
str

ETag del índice.

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:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

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
str

Una cadena de datos mediante la estructura restAPI. JSON de forma predeterminada.

content_type
str

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
str

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