SearchIndexClient Classe

Mostra como um analisador divide o texto em tokens.

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

Parâmetros

Retornos

AnalyzeResult

Tipo de retorno

Exceções

Exemplos

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

Feche a SearchIndexClient sessão.

close() -> None

Exceções

Cria um novo índice de pesquisa.

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

Parâmetros

Retornos

O índice criado

Tipo de retorno

Exceções

Exemplos

Criando um novo í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)

Cria um novo índice de pesquisa ou atualiza um índice se ele já existir.

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

Parâmetros

Retornos

O índice criado ou atualizado

Tipo de retorno

Exceções

Exemplos

Atualizar um í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)

Crie um novo Mapa de Sinônimos em um serviço Pesquisa do Azure ou atualize um existente.

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

Parâmetros

Retornos

O Mapa de Sinônimos criado ou atualizado

Tipo de retorno

Exceções

Criar um novo Mapa de Sinônimos em um serviço Pesquisa do Azure

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

Parâmetros

Retornos

O Mapa de Sinônimos criado

Tipo de retorno

Exceções

Exemplos

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

Exclui um índice de pesquisa e todos os documentos que ele contém. O modelo deve ser fornecido em vez do nome para usar as condições de acesso.

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

Parâmetros

Exceções

Exemplos

Excluir um índice.

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

Exclua um Mapa de Sinônimos nomeado em um serviço Pesquisa do Azure. Para usar as condições de acesso, o modelo SynonymMap deve ser fornecido em vez do nome. É suficiente fornecer o nome do mapa de sinônimos para excluir incondicionalmente.

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

Parâmetros

Retornos

Nenhum

Tipo de retorno

Exceções

Exemplos

Excluir um 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

Retornos

Objeto SearchIndex

Tipo de retorno

Exceções

Exemplos

Obter um índice.

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

Retorna estatísticas para o índice fornecido, incluindo uma contagem de documentos e o uso de armazenamento.

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

Parâmetros

Retornos

Estatísticas para o índice fornecido, incluindo uma contagem de documentos e o uso de armazenamento.

Tipo de retorno

Exceções

Retornar um cliente para executar operações na Pesquisa

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

Parâmetros

Retornos

Objeto SearchClient

Tipo de retorno

Exceções

Obter estatísticas de nível de serviço para um serviço de pesquisa.

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

Retornos

Resultado das estatísticas de serviço.

Tipo de retorno

Exceções

Recuperar um Mapa de Sinônimos nomeado em um serviço Pesquisa do Azure

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

Parâmetros

Retornos

O Mapa de Sinônimos recuperado

Tipo de retorno

Exceções

Exemplos

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

Liste os nomes do Mapa de Sinônimos em um serviço Pesquisa do Azure.

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

Retornos

Lista de mapas de sinônimos

Tipo de retorno

Exceções

Listar os Mapas de Sinônimos em um serviço Pesquisa do Azure.

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

Parâmetros

Retornos

Lista de mapas de sinônimos

Tipo de retorno

Exceções

Exemplos

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

Liste os nomes de índice em um serviço Pesquisa do Azure.

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

Retornos

Lista de nomes de índice

Tipo de retorno

Exceções

Liste os índices em um serviço Pesquisa do Azure.

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

Parâmetros

Retornos

Lista de índices

Tipo de retorno

Exceções