SearchIndexClient Clase

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

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

Parámetros

Devoluciones

AnalyzeResult

Tipo de valor devuelto

Excepciones

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())

Cierre la SearchIndexClient sesión.

close() -> None

Excepciones

Crea un nuevo índice de búsqueda.

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

Parámetros

Devoluciones

Índice creado

Tipo de valor devuelto

Excepciones

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)

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

Devoluciones

Índice creado o actualizado

Tipo de valor devuelto

Excepciones

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)

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

Devoluciones

Mapa de sinónimos creado o actualizado

Tipo de valor devuelto

Excepciones

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

Devoluciones

Mapa de sinónimos creado

Tipo de valor devuelto

Excepciones

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")

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

Excepciones

Ejemplos

Elimina un índice.

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

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

Devoluciones

None

Tipo de valor devuelto

Excepciones

Ejemplos

Eliminar un mapa de sinónimos

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

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

Parámetros

Devoluciones

SearchIndex (objeto)

Tipo de valor devuelto

Excepciones

Ejemplos

Obtener un índice.

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

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

Devoluciones

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

Tipo de valor devuelto

Excepciones

Devolver un cliente para realizar operaciones en la búsqueda

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

Parámetros

Devoluciones

SearchClient (objeto)

Tipo de valor devuelto

Excepciones

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

Excepciones

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

Devoluciones

Mapa de sinónimos recuperado

Tipo de valor devuelto

Excepciones

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))

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

Excepciones

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

Devoluciones

Lista de mapas de sinónimos

Tipo de valor devuelto

Excepciones

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)))

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

Excepciones

Enumere los índices de una servicio Search de Azure.

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

Parámetros

Devoluciones

Lista de índices

Tipo de valor devuelto

Excepciones