SearchIndexClient Clase

Un cliente para interactuar con el índice del servicio Azure Search.

Herencia

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Constructor

SearchIndexClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)

Parámetros

endpoint

str

Requerido

Punto de conexión de dirección URL de un servicio de Azure Search

credential

AzureKeyCredential o TokenCredential

Requerido

Una credencial para autorizar solicitudes de cliente de búsqueda

api_version

str

La versión de Search API que se va a usar para las solicitudes.

audience

str

establece la audiencia que se va a usar para la autenticación con Azure Active Directory (AAD). La audiencia no se considera cuando se usa una clave compartida. Si no se proporciona audiencia, se supone que la audiencia de la nube pública.

Métodos

analyze_text	Muestra cómo un analizador divide el texto en tokens.
close	Cierre la SearchIndexClient sesión.
create_index	Crea un nuevo índice de búsqueda.
create_or_update_index	Crea un nuevo índice de búsqueda o actualiza un índice si ya existe.
create_or_update_synonym_map	Cree un nuevo mapa de sinónimos en una instancia de Azure servicio Search o actualice uno existente.
create_synonym_map	Creación de un nuevo mapa de sinónimos en una instancia de Azure servicio Search
delete_index	Elimina un índice de búsqueda y todos los documentos que contiene. El modelo debe proporcionarse en lugar del nombre para usar las condiciones de acceso.
delete_synonym_map	Elimine un mapa de sinónimos con nombre en una servicio Search de Azure. Para usar condiciones de acceso, se debe proporcionar el modelo SynonymMap en lugar del nombre. Es suficiente para proporcionar el nombre del mapa de sinónimos para eliminar incondicionalmente.
get_index
get_index_statistics	Devuelve estadísticas para el índice determinado, incluido un recuento de documentos y un uso de almacenamiento.
get_search_client	Devolver un cliente para realizar operaciones en la búsqueda
get_service_statistics	Obtenga estadísticas de nivel de servicio para un servicio de búsqueda.
get_synonym_map	Recuperación de un mapa de sinónimos con nombre en una instancia de Azure servicio Search
get_synonym_map_names	Enumere los nombres de mapa de sinónimos en una servicio Search de Azure.
get_synonym_maps	Enumere las asignaciones de sinónimos en una servicio Search de Azure.
list_index_names	Enumere los nombres de índice en una servicio Search de Azure.
list_indexes	Enumere los índices de una servicio Search de Azure.

analyze_text

Muestra cómo un analizador divide el texto en tokens.

analyze_text(index_name: str, analyze_request: AnalyzeTextOptions, **kwargs: Any) -> AnalyzeResult

Parámetros

index_name

str

Requerido

Nombre del índice para el que se va a probar un analizador.

analyze_request

AnalyzeTextOptions

Requerido

Componentes de análisis o texto que se van a probar.

Devoluciones

AnalyzeResult

Tipo de valor devuelto

AnalyzeResult

Excepciones

HttpResponseError

Ejemplos

Análisis de texto

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents.indexes import SearchIndexClient
   from azure.search.documents.indexes.models import AnalyzeTextOptions

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))

   analyze_request = AnalyzeTextOptions(text="One's <two/>", analyzer_name="standard.lucene")

   result = client.analyze_text(index_name, analyze_request)
   print(result.as_dict())

close

Cierre la SearchIndexClient sesión.

close() -> None

Excepciones

HttpResponseError

create_index

Crea un nuevo índice de búsqueda.

create_index(index: SearchIndex, **kwargs: Any) -> SearchIndex

Parámetros

index

SearchIndex

Requerido

Objeto de índice.

Devoluciones

Índice creado

Tipo de valor devuelto

SearchIndex

Excepciones

HttpResponseError

Ejemplos

Creación de un nuevo índice.

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   fields = [
       SimpleField(name="hotelId", type=SearchFieldDataType.String, key=True),
       SimpleField(name="baseRate", type=SearchFieldDataType.Double),
       SearchableField(name="description", type=SearchFieldDataType.String, collection=True),
       ComplexField(
           name="address",
           fields=[
               SimpleField(name="streetAddress", type=SearchFieldDataType.String),
               SimpleField(name="city", type=SearchFieldDataType.String),
           ],
           collection=True,
       ),
   ]
   cors_options = CorsOptions(allowed_origins=["*"], max_age_in_seconds=60)
   scoring_profiles: List[ScoringProfile] = []
   index = SearchIndex(name=name, fields=fields, scoring_profiles=scoring_profiles, cors_options=cors_options)

   result = client.create_index(index)

create_or_update_index

Crea un nuevo índice de búsqueda o actualiza un índice si ya existe.

create_or_update_index(index: SearchIndex, allow_index_downtime: bool | None = None, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndex

Parámetros

index

SearchIndex

Requerido

Objeto de índice.

allow_index_downtime

bool

Requerido

Permite agregar nuevos analizadores, tokenizadores, filtros de token o filtros char a un índice al desconectar el índice durante al menos unos segundos. Esto provoca temporalmente un error en la indexación y las solicitudes de consulta. El rendimiento y la disponibilidad de escritura del índice pueden ser desiguales durante varios minutos después de que se actualice el índice, o durante más tiempo en el caso de índices muy grandes.

match_condition

MatchConditions

Condición de coincidencia que se va a usar en el etag

Devoluciones

Índice creado o actualizado

Tipo de valor devuelto

SearchIndex

Excepciones

ResourceNotFoundError

ResourceModifiedError

ResourceNotModifiedError

ResourceNotFoundError

ResourceExistsError

Ejemplos

Actualizar un índice.

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   fields = [
       SimpleField(name="hotelId", type=SearchFieldDataType.String, key=True),
       SimpleField(name="baseRate", type=SearchFieldDataType.Double),
       SearchableField(name="description", type=SearchFieldDataType.String, collection=True),
       SearchableField(name="hotelName", type=SearchFieldDataType.String),
       ComplexField(
           name="address",
           fields=[
               SimpleField(name="streetAddress", type=SearchFieldDataType.String),
               SimpleField(name="city", type=SearchFieldDataType.String),
               SimpleField(name="state", type=SearchFieldDataType.String),
           ],
           collection=True,
       ),
   ]
   cors_options = CorsOptions(allowed_origins=["*"], max_age_in_seconds=60)
   scoring_profile = ScoringProfile(name="MyProfile")
   scoring_profiles = []
   scoring_profiles.append(scoring_profile)
   index = SearchIndex(name=name, fields=fields, scoring_profiles=scoring_profiles, cors_options=cors_options)

   result = client.create_or_update_index(index=index)

create_or_update_synonym_map

Cree un nuevo mapa de sinónimos en una instancia de Azure servicio Search o actualice uno existente.

create_or_update_synonym_map(synonym_map: SynonymMap, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SynonymMap

Parámetros

synonym_map

SynonymMap

Requerido

El objeto Synonym Map

match_condition

MatchConditions

Condición de coincidencia que se va a usar en el etag

Devoluciones

Mapa de sinónimos creado o actualizado

Tipo de valor devuelto

SynonymMap

Excepciones

HttpResponseError

create_synonym_map

Creación de un nuevo mapa de sinónimos en una instancia de Azure servicio Search

create_synonym_map(synonym_map: SynonymMap, **kwargs: Any) -> SynonymMap

Parámetros

synonym_map

SynonymMap

Requerido

El objeto Synonym Map

Devoluciones

Mapa de sinónimos creado

Tipo de valor devuelto

SynonymMap

Excepciones

HttpResponseError

Ejemplos

Crear un mapa de sinónimos

   synonyms = [
       "USA, United States, United States of America",
       "Washington, Wash. => WA",
   ]
   synonym_map = SynonymMap(name="test-syn-map", synonyms=synonyms)
   result = client.create_synonym_map(synonym_map)
   print("Create new Synonym Map 'test-syn-map succeeded")

delete_index

Elimina un índice de búsqueda y todos los documentos que contiene. El modelo debe proporcionarse en lugar del nombre para usar las condiciones de acceso.

delete_index(index: str | SearchIndex, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parámetros

index

str o SearchIndex

Requerido

Nombre de índice o objeto que se va a eliminar.

match_condition

MatchConditions

Condición de coincidencia que se va a usar en el etag

Excepciones

HttpResponseError

Ejemplos

Elimina un índice.

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   client.delete_index(name)

delete_synonym_map

Elimine un mapa de sinónimos con nombre en una servicio Search de Azure. Para usar condiciones de acceso, se debe proporcionar el modelo SynonymMap en lugar del nombre. Es suficiente para proporcionar el nombre del mapa de sinónimos para eliminar incondicionalmente.

delete_synonym_map(synonym_map: str | SynonymMap, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parámetros

name

str o SynonymMap

Requerido

Nombre o objeto de asignación de sinónimos que se va a eliminar

match_condition

MatchConditions

Condición de coincidencia que se va a usar en el etag

Devoluciones

None

Tipo de valor devuelto

None

Excepciones

HttpResponseError

Ejemplos

Eliminar un mapa de sinónimos

   client.delete_synonym_map("test-syn-map")
   print("Synonym Map 'test-syn-map' deleted")

get_index

get_index(name: str, **kwargs: Any) -> SearchIndex

Parámetros

name

str

Requerido

Nombre del índice que se va a recuperar.

Devoluciones

SearchIndex (objeto)

Tipo de valor devuelto

SearchIndex

Excepciones

HttpResponseError

Ejemplos

Obtener un índice.

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   result = client.get_index(name)

get_index_statistics

Devuelve estadísticas para el índice determinado, incluido un recuento de documentos y un uso de almacenamiento.

get_index_statistics(index_name: str, **kwargs: Any) -> MutableMapping[str, Any]

Parámetros

index_name

str

Requerido

Nombre del índice que se va a recuperar.

Devoluciones

Estadísticas del índice determinado, incluido un recuento de documentos y un uso de almacenamiento.

Tipo de valor devuelto

Dict

Excepciones

HttpResponseError

get_search_client

Devolver un cliente para realizar operaciones en la búsqueda

get_search_client(index_name: str, **kwargs: Any) -> SearchClient

Parámetros

index_name

str

Requerido

Nombre del índice de búsqueda

Devoluciones

SearchClient (objeto)

Tipo de valor devuelto

SearchClient

Excepciones

HttpResponseError

get_service_statistics

Obtenga estadísticas de nivel de servicio para un servicio de búsqueda.

get_service_statistics(**kwargs: Any) -> MutableMapping[str, Any]

Devoluciones

Resultado de las estadísticas del servicio.

Tipo de valor devuelto

dict

Excepciones

HttpResponseError

get_synonym_map

Recuperación de un mapa de sinónimos con nombre en una instancia de Azure servicio Search

get_synonym_map(name: str, **kwargs: Any) -> SynonymMap

Parámetros

name

str

Requerido

Nombre del mapa de sinónimos que se va a obtener

Devoluciones

Mapa de sinónimos recuperado

Tipo de valor devuelto

SynonymMap

Excepciones

ResourceNotFoundError

Ejemplos

Obtener un mapa de sinónimos

   result = client.get_synonym_map("test-syn-map")
   print("Retrived Synonym Map 'test-syn-map' with synonyms")
   for syn in result.synonyms:
       print("    {}".format(syn))

get_synonym_map_names

Enumere los nombres de mapa de sinónimos en una servicio Search de Azure.

get_synonym_map_names(**kwargs: Any) -> List[str]

Devoluciones

Lista de mapas de sinónimos

Tipo de valor devuelto

list[str]

Excepciones

HttpResponseError

get_synonym_maps

Enumere las asignaciones de sinónimos en una servicio Search de Azure.

get_synonym_maps(*, select: List[str] | None = None, **kwargs) -> List[SynonymMap]

Parámetros

select

list[str]

Selecciona las propiedades de nivel superior de los conjuntos de aptitudes que se van a recuperar. Se especifica como una lista de nombres de propiedad JSON o "*" para todas las propiedades. El valor predeterminado es todas las propiedades.

Devoluciones

Lista de mapas de sinónimos

Tipo de valor devuelto

list[SynonymMap]

Excepciones

HttpResponseError

Ejemplos

Enumerar mapas de sinónimos

   result = client.get_synonym_maps()
   names = [x.name for x in result]
   print("Found {} Synonym Maps in the service: {}".format(len(result), ", ".join(names)))

list_index_names

Enumere los nombres de índice en una servicio Search de Azure.

list_index_names(**kwargs: Any) -> ItemPaged[str]

Devoluciones

Lista de nombres de índice

Tipo de valor devuelto

ItemPaged[str]

Excepciones

HttpResponseError

list_indexes

Enumere los índices de una servicio Search de Azure.

list_indexes(*, select: List[str] | None = None, **kwargs: Any) -> ItemPaged[SearchIndex]

Parámetros

select

list[str]

Selecciona las propiedades de nivel superior de los conjuntos de aptitudes que se van a recuperar. Se especifica como una lista de nombres de propiedad JSON o "*" para todas las propiedades. El valor predeterminado es todas las propiedades.

Devoluciones

Lista de índices

Tipo de valor devuelto

ItemPaged[SearchIndex]

Excepciones

HttpResponseError