SearchIndexClient Classe

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

Herança

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Construtor

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

Parâmetros

endpoint

str

Necessário

O ponto final do URL de um serviço de pesquisa do Azure

credential

AzureKeyCredential ou TokenCredential

Necessário

Uma credencial para autorizar pedidos de cliente de pesquisa

api_version

str

A versão da API de Pesquisa a utilizar para pedidos.

audience

str

define a Audiência a utilizar para autenticação com o Azure Active Directory (AAD). A audiência não é considerada ao utilizar uma chave partilhada. Se a audiência não for fornecida, será assumida a audiência da cloud pública.

Métodos

analyze_text	Mostra como um analisador divide 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 já existir.
create_or_update_synonym_map	Crie um novo Mapa de Sinónimos num Serviço de pesquisa do Azure ou atualize um já existente.
create_synonym_map	Criar um novo Mapa de Sinónimos num Serviço de pesquisa do Azure
delete_index	Elimina um índice de pesquisa e todos os documentos que contém. O modelo tem de ser fornecido em vez do nome para utilizar as condições de acesso.
delete_synonym_map	Elimine um Mapa de Sinónimos com o nome num Serviço de pesquisa do Azure. Para utilizar as condições de acesso, o modelo SynonymMap tem de ser fornecido em vez do nome. Basta fornecer o nome do mapa de sinónimos para eliminar incondicionalmente.
get_index
get_index_statistics	Devolve estatísticas para o índice especificado, incluindo uma contagem de documentos e a utilização do armazenamento.
get_search_client	Devolver um cliente para realizar operações na Pesquisa
get_service_statistics	Obtenha estatísticas de nível de serviço para um serviço de pesquisa.
get_synonym_map	Obter um Mapa de Sinónimos com o nome num Serviço de pesquisa do Azure
get_synonym_map_names	Liste os nomes do Mapa de Sinónimos numa Serviço de pesquisa do Azure.
get_synonym_maps	Liste o Synonym Maps numa Serviço de pesquisa do Azure.
list_index_names	Liste os nomes dos índices numa Serviço de pesquisa do Azure.
list_indexes	Liste os índices numa Serviço de pesquisa do Azure.

analyze_text

Mostra como um analisador divide texto em tokens.

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

Parâmetros

index_name

str

Necessário

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

analyze_request

AnalyzeTextOptions

Necessário

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

Devoluções

AnalyzeResult

Tipo de retorno

AnalyzeResult

Exceções

HttpResponseError

Exemplos

Analisar 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

Necessário

O objeto de índice.

Devoluções

O índice criado

Tipo de retorno

SearchIndex

Exceções

HttpResponseError

Exemplos

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

Necessário

O objeto de índice.

allow_index_downtime

bool

Necessário

Permite que novos analisadores, tokens, filtros de tokens ou filtros de carateres sejam adicionados a um índice ao colocar o índice offline durante, pelo menos, alguns segundos. Isto faz com que os pedidos de indexação e consulta falhem temporariamente. A disponibilidade de desempenho e escrita do índice pode ser prejudicada durante vários minutos após a atualização do índice ou durante mais tempo para índices muito grandes.

match_condition

MatchConditions

A condição de correspondência a utilizar no etag

Devoluções

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 num Serviço de pesquisa do Azure ou atualize um já existente.

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

Parâmetros

synonym_map

SynonymMap

Necessário

O objeto Mapa de Sinónimos

match_condition

MatchConditions

A condição de correspondência a utilizar no etag

Devoluções

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 num Serviço de pesquisa do Azure

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

Parâmetros

synonym_map

SynonymMap

Necessário

O objeto Mapa de Sinónimos

Devoluções

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

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

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

Parâmetros

index

str ou SearchIndex

Necessário

O nome ou objeto de índice a eliminar.

match_condition

MatchConditions

A condição de correspondência a utilizar no etag

Exceções

HttpResponseError

Exemplos

Eliminar um índice.

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

delete_synonym_map

Elimine um Mapa de Sinónimos com o nome num Serviço de pesquisa do Azure. Para utilizar as condições de acesso, o modelo SynonymMap tem de ser fornecido em vez do nome. Basta fornecer o nome do 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 ou SynonymMap

Necessário

O nome ou objeto do mapa de sinónimos a eliminar

match_condition

MatchConditions

A condição de correspondência a utilizar no etag

Devoluções

Nenhuma

Tipo de retorno

None

Exceções

HttpResponseError

Exemplos

Eliminar 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

Necessário

O nome do índice a obter.

Devoluções

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

Devolve estatísticas para o índice especificado, incluindo uma contagem de documentos e a utilização do armazenamento.

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

Parâmetros

index_name

str

Necessário

O nome do índice a obter.

Devoluções

Estatísticas para o índice especificado, incluindo uma contagem de documentos e a utilização do armazenamento.

Tipo de retorno

Dict

Exceções

HttpResponseError

get_search_client

Devolver um cliente para realizar operações na Pesquisa

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

Parâmetros

index_name

str

Necessário

O nome do Índice de Pesquisa

Devoluções

Objeto SearchClient

Tipo de retorno

SearchClient

Exceções

HttpResponseError

get_service_statistics

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

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

Devoluções

Resultado das estatísticas do serviço.

Tipo de retorno

dict

Exceções

HttpResponseError

get_synonym_map

Obter um Mapa de Sinónimos com o nome num Serviço de pesquisa do Azure

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

Parâmetros

name

str

Necessário

O nome do Mapa de Sinónimos a obter

Devoluções

O Mapa de Sinónimos obtido

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 numa Serviço de pesquisa do Azure.

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

Devoluções

Lista de mapas de sinónimos

Tipo de retorno

list[str]

Exceções

HttpResponseError

get_synonym_maps

Liste o Synonym Maps numa Serviço de pesquisa do Azure.

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

Parâmetros

select

list[str]

Seleciona as propriedades de nível superior dos conjuntos de competências a obter. Especificado como uma lista de nomes de propriedades JSON ou "*" para todas as propriedades. A predefinição são todas as propriedades.

Devoluções

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 dos índices numa Serviço de pesquisa do Azure.

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

Devoluções

Lista de nomes de índice

Tipo de retorno

ItemPaged[str]

Exceções

HttpResponseError

list_indexes

Liste os índices numa Serviço de pesquisa do Azure.

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

Parâmetros

select

list[str]

Seleciona as propriedades de nível superior dos conjuntos de competências a obter. Especificado como uma lista de nomes de propriedades JSON ou "*" para todas as propriedades. A predefinição são todas as propriedades.

Devoluções

Lista de índices

Tipo de retorno

ItemPaged[SearchIndex]

Exceções

HttpResponseError