SearchIndexClient Classe

Um cliente para interagir com o índice de serviço do Azure Search.

Herança

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Construtor

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

Parâmetros

endpoint

str

Obrigatório

O ponto de extremidade de URL de um serviço do Azure Search

credential

AzureKeyCredential ou TokenCredential

Obrigatório

Uma credencial para autorizar solicitações de cliente de pesquisa

api_version

str

A versão da API de Pesquisa a ser usada para solicitações.

audience

str

define o Público-alvo a ser usado para autenticação com o AAD (Azure Active Directory). O público-alvo não é considerado ao usar uma chave compartilhada. Se o público-alvo não for fornecido, o público-alvo da nuvem será assumido.

Métodos

analyze_text	Mostra como um analisador divide o texto em tokens.
close	Feche a SearchIndexClient sessão.
create_index	Cria um novo índice de pesquisa.
create_or_update_index	Cria um novo índice de pesquisa ou atualiza um índice se ele já existir.
create_or_update_synonym_map	Crie um novo Mapa de Sinônimos em um serviço Pesquisa do Azure ou atualize um existente.
create_synonym_map	Criar um novo Mapa de Sinônimos em um serviço Pesquisa do Azure
delete_index	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_synonym_map	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.
get_index
get_index_statistics	Retorna estatísticas para o índice fornecido, incluindo uma contagem de documentos e o uso de armazenamento.
get_search_client	Retornar um cliente para executar operações na Pesquisa
get_service_statistics	Obter estatísticas de nível de serviço para um serviço de pesquisa.
get_synonym_map	Recuperar um Mapa de Sinônimos nomeado em um serviço Pesquisa do Azure
get_synonym_map_names	Liste os nomes do Mapa de Sinônimos em um serviço Pesquisa do Azure.
get_synonym_maps	Listar os Mapas de Sinônimos em um serviço Pesquisa do Azure.
list_index_names	Liste os nomes de índice em um serviço Pesquisa do Azure.
list_indexes	Liste os índices em um serviço Pesquisa do Azure.

analyze_text

Mostra como um analisador divide o texto em tokens.

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

Parâmetros

index_name

str

Obrigatório

O nome do índice para o qual testar um analisador.

analyze_request

AnalyzeTextOptions

Obrigatório

O texto e o analisador ou os componentes de análise a serem testados.

Retornos

AnalyzeResult

Tipo de retorno

AnalyzeResult

Exceções

HttpResponseError

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

close

Feche a SearchIndexClient sessão.

close() -> None

Exceções

HttpResponseError

create_index

Cria um novo índice de pesquisa.

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

Parâmetros

index

SearchIndex

Obrigatório

O objeto index.

Retornos

O índice criado

Tipo de retorno

SearchIndex

Exceções

HttpResponseError

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)

create_or_update_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

index

SearchIndex

Obrigatório

O objeto index.

allow_index_downtime

bool

Obrigatório

Permite que novos analisadores, tokenizers, filtros de token ou filtros char sejam adicionados a um índice, tornando o índice offline por pelo menos alguns segundos. Isso faz com que as solicitações de indexação e consulta falhem temporariamente. O desempenho e a disponibilidade de gravação do índice podem ser prejudicados por vários minutos após o índice ser atualizado, ou por mais tempo em caso de índices muito grandes.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag

Retornos

O índice criado ou atualizado

Tipo de retorno

SearchIndex

Exceções

ResourceNotFoundError

ResourceModifiedError

ResourceNotModifiedError

ResourceNotFoundError

ResourceExistsError

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)

create_or_update_synonym_map

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

synonym_map

SynonymMap

Obrigatório

O objeto Mapa de Sinônimos

match_condition

MatchConditions

A condição de correspondência a ser usada na etag

Retornos

O Mapa de Sinônimos criado ou atualizado

Tipo de retorno

SynonymMap

Exceções

HttpResponseError

create_synonym_map

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

synonym_map

SynonymMap

Obrigatório

O objeto Mapa de Sinônimos

Retornos

O Mapa de Sinônimos criado

Tipo de retorno

SynonymMap

Exceções

HttpResponseError

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

delete_index

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

index

str ou SearchIndex

Obrigatório

O nome do índice ou objeto a ser excluído.

match_condition

MatchConditions

A condição de correspondência a ser usada na etag

Exceções

HttpResponseError

Exemplos

Excluir um índice.

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

delete_synonym_map

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

name

str ou SynonymMap

Obrigatório

O nome do mapa de sinônimos ou o objeto a ser excluído

match_condition

MatchConditions

A condição de correspondência a ser usada na etag

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

Exemplos

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

Obrigatório

O nome do índice a ser recuperado.

Retornos

Objeto SearchIndex

Tipo de retorno

SearchIndex

Exceções

HttpResponseError

Exemplos

Obter um índice.

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

get_index_statistics

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

index_name

str

Obrigatório

O nome do índice a ser recuperado.

Retornos

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

Tipo de retorno

Dict

Exceções

HttpResponseError

get_search_client

Retornar um cliente para executar operações na Pesquisa

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

Parâmetros

index_name

str

Obrigatório

O nome do índice de pesquisa

Retornos

Objeto SearchClient

Tipo de retorno

SearchClient

Exceções

HttpResponseError

get_service_statistics

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

dict

Exceções

HttpResponseError

get_synonym_map

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

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

Parâmetros

name

str

Obrigatório

O nome do Mapa de Sinônimos a ser obtido

Retornos

O Mapa de Sinônimos recuperado

Tipo de retorno

SynonymMap

Exceções

ResourceNotFoundError

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

get_synonym_map_names

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

list[str]

Exceções

HttpResponseError

get_synonym_maps

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

select

list[str]

Seleciona quais propriedades de nível superior dos conjuntos de habilidades recuperar. Especificado como uma lista de nomes de propriedade JSON ou '*' para todas as propriedades. O padrão é todas as propriedades.

Retornos

Lista de mapas de sinônimos

Tipo de retorno

list[SynonymMap]

Exceções

HttpResponseError

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

list_index_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

ItemPaged[str]

Exceções

HttpResponseError

list_indexes

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

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

Parâmetros

select

list[str]

Seleciona quais propriedades de nível superior dos conjuntos de habilidades recuperar. Especificado como uma lista de nomes de propriedade JSON ou '*' para todas as propriedades. O padrão é todas as propriedades.

Retornos

Lista de índices

Tipo de retorno

ItemPaged[SearchIndex]

Exceções

HttpResponseError