Partilhar via


SearchIndexerClient Classe

Um cliente para interagir com os Indexadores do serviço de pesquisa do Azure.

Herança
azure.search.documents._headers_mixin.HeadersMixin
SearchIndexerClient

Construtor

SearchIndexerClient(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 o público não for fornecido, a audiência da cloud pública será assumida.

Métodos

close

Feche a SearchIndexerClient sessão.

create_data_source_connection

Cria uma nova ligação de origem de dados.

create_indexer

Cria um novo SearchIndexer.

create_or_update_data_source_connection

Cria uma nova ligação de origem de dados ou atualiza uma ligação de origem de dados se já existir. :p aram data_source_connection: a definição da ligação de origem de dados para criar ou atualizar. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: The match condition to use upon the etag :p aramtype match_condition ~ azure.core.MatchConditions :return: The created SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

create_or_update_indexer

Cria um novo indexador ou atualiza um indexador se já existir.

create_or_update_skillset

Crie um novo SearchIndexerSkillset num Serviço de pesquisa do Azure ou atualize um existente.

create_skillset

Criar um novo SearchIndexerSkillset num Serviço de pesquisa do Azure

delete_data_source_connection

Elimina uma ligação de origem de dados. Para utilizar as condições de acesso, o modelo SearchIndexerDataSourceConnection tem de ser fornecido em vez do nome. É suficiente para fornecer o nome da ligação da origem de dados para eliminar incondicionalmente

delete_indexer

Elimina um indexador. Para utilizar as condições de acesso, o modelo SearchIndexer tem de ser fornecido em vez do nome. Basta fornecer o nome do indexador para eliminar incondicionalmente.

delete_skillset

Elimine um searchIndexerSkillset nomeado num Serviço de pesquisa do Azure. Para utilizar as condições de acesso, o modelo SearchIndexerSkillset tem de ser fornecido em vez do nome. Basta fornecer o nome do conjunto de competências para eliminar incondicionalmente

get_data_source_connection

Obtém uma definição de ligação de origem de dados.

get_data_source_connection_names

Lista todos os nomes de ligação de origem de dados disponíveis para um serviço de pesquisa.

get_data_source_connections

Lista todas as ligações de origem de dados disponíveis para um serviço de pesquisa.

get_indexer

Obtém uma definição de indexador.

get_indexer_names

Lista todos os nomes de indexadores disponíveis para um serviço de pesquisa.

get_indexer_status

Obtenha o estado do indexador.

get_indexers

Lista todos os indexadores disponíveis para um serviço de pesquisa.

get_skillset

Obter um searchIndexerSkillset nomeado num Serviço de pesquisa do Azure

get_skillset_names

Liste os nomes searchIndexerSkillset num Serviço de pesquisa do Azure.

get_skillsets

Liste os conjuntos SearchIndexerSkillsets num Serviço de pesquisa do Azure.

reset_indexer

Repõe o estado de controlo de alterações associado a um indexador.

run_indexer

Execute um indexador.

close

Feche a SearchIndexerClient sessão.

close() -> None

create_data_source_connection

Cria uma nova ligação de origem de dados.

create_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, **kwargs: Any) -> SearchIndexerDataSourceConnection

Parâmetros

data_source_connection
SearchIndexerDataSourceConnection
Necessário

A definição da ligação de origem de dados a criar.

Devoluções

SearchIndexerDataSourceConnection criado

Tipo de retorno

Exemplos

Criar uma Origem de Dados


   container = SearchIndexerDataContainer(name="searchcontainer")
   data_source_connection = SearchIndexerDataSourceConnection(
       name="sample-data-source-connection", type="azureblob", connection_string=connection_string, container=container
   )
   result = client.create_data_source_connection(data_source_connection)
   print(result)
   print("Create new Data Source Connection - sample-data-source-connection")

create_indexer

Cria um novo SearchIndexer.

create_indexer(indexer: SearchIndexer, **kwargs: Any) -> SearchIndexer

Parâmetros

indexer
SearchIndexer
Necessário

A definição do indexador a criar.

Devoluções

O SearchIndexer criado

Tipo de retorno

create_or_update_data_source_connection

Cria uma nova ligação de origem de dados ou atualiza uma ligação de origem de dados se já existir. :p aram data_source_connection: a definição da ligação de origem de dados para criar ou atualizar. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: The match condition to use upon the etag :p aramtype match_condition ~ azure.core.MatchConditions :return: The created SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

create_or_update_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerDataSourceConnection

create_or_update_indexer

Cria um novo indexador ou atualiza um indexador se já existir.

create_or_update_indexer(indexer: SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexer

Parâmetros

indexer
SearchIndexer
Necessário

A definição do indexador para criar ou atualizar.

match_condition
MatchConditions

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

Devoluções

O SearchIndexer criado

Tipo de retorno

create_or_update_skillset

Crie um novo SearchIndexerSkillset num Serviço de pesquisa do Azure ou atualize um existente.

create_or_update_skillset(skillset: SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerSkillset

Parâmetros

skillset
SearchIndexerSkillset
Necessário

O objeto SearchIndexerSkillset para criar ou atualizar

match_condition
MatchConditions

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

Devoluções

SearchIndexerSkillset criado ou atualizado

Tipo de retorno

create_skillset

Criar um novo SearchIndexerSkillset num Serviço de pesquisa do Azure

create_skillset(skillset: SearchIndexerSkillset, **kwargs: Any) -> SearchIndexerSkillset

Parâmetros

skillset
SearchIndexerSkillset
Necessário

O objeto SearchIndexerSkillset a criar

Devoluções

SearchIndexerSkillset criado

Tipo de retorno

delete_data_source_connection

Elimina uma ligação de origem de dados. Para utilizar as condições de acesso, o modelo SearchIndexerDataSourceConnection tem de ser fornecido em vez do nome. É suficiente para fornecer o nome da ligação da origem de dados para eliminar incondicionalmente

delete_data_source_connection(data_source_connection: str | SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parâmetros

data_source_connection
str ou SearchIndexerDataSourceConnection
Necessário

A ligação da origem de dados a eliminar.

match_condition
MatchConditions

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

Devoluções

Nenhuma

Tipo de retorno

Exemplos

Eliminar um SearchIndexerDataSourceConnection


   client.delete_data_source_connection("sample-data-source-connection")
   print("Data Source Connection 'sample-data-source-connection' successfully deleted")

delete_indexer

Elimina um indexador. Para utilizar as condições de acesso, o modelo SearchIndexer tem de ser fornecido em vez do nome. Basta fornecer o nome do indexador para eliminar incondicionalmente.

delete_indexer(indexer: str | SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parâmetros

indexer
str ou SearchIndexer
Necessário

O indexador a eliminar.

match_condition
MatchConditions

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

Devoluções

Nenhuma

Tipo de retorno

delete_skillset

Elimine um searchIndexerSkillset nomeado num Serviço de pesquisa do Azure. Para utilizar as condições de acesso, o modelo SearchIndexerSkillset tem de ser fornecido em vez do nome. Basta fornecer o nome do conjunto de competências para eliminar incondicionalmente

delete_skillset(skillset: str | SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parâmetros

skillset
str ou SearchIndexerSkillset
Necessário

SearchIndexerSkillset a eliminar

match_condition
MatchConditions

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

get_data_source_connection

Obtém uma definição de ligação de origem de dados.

get_data_source_connection(name: str, **kwargs: Any) -> SearchIndexerDataSourceConnection

Parâmetros

name
str
Necessário

O nome da ligação da origem de dados a obter.

Devoluções

SearchIndexerDataSourceConnection que é obtido.

Tipo de retorno

Exemplos

Obter um SearchIndexerDataSourceConnection


   result = client.get_data_source_connection("sample-data-source-connection")
   print("Retrived Data Source Connection 'sample-data-source-connection'")

get_data_source_connection_names

Lista todos os nomes de ligação de origem de dados disponíveis para um serviço de pesquisa.

get_data_source_connection_names(**kwargs: Any) -> Sequence[str]

Devoluções

Lista de todos os nomes de ligação da origem de dados.

Tipo de retorno

get_data_source_connections

Lista todas as ligações de origem de dados disponíveis para um serviço de pesquisa.

get_data_source_connections(*, select: List[str] | None = None, **kwargs: Any) -> Sequence[SearchIndexerDataSourceConnection]

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 é todas as propriedades.

Devoluções

Lista de todas as ligações de origem de dados.

Tipo de retorno

Exemplos

Listar todas as SearchIndexerDataSourceConnections


   result = client.get_data_source_connections()
   names = [ds.name for ds in result]
   print("Found {} Data Source Connections in the service: {}".format(len(result), ", ".join(names)))

get_indexer

Obtém uma definição de indexador.

get_indexer(name: str, **kwargs: Any) -> SearchIndexer

Parâmetros

name
str
Necessário

O nome do indexador a obter.

Devoluções

O SearchIndexer que é obtido.

Tipo de retorno

get_indexer_names

Lista todos os nomes de indexadores disponíveis para um serviço de pesquisa.

get_indexer_names(**kwargs: Any) -> Sequence[str]

Devoluções

Lista de todos os SearchIndexers.

Tipo de retorno

get_indexer_status

Obtenha o estado do indexador.

get_indexer_status(name: str, **kwargs: Any) -> SearchIndexerStatus

Parâmetros

name
str
Necessário

O nome do indexador para obter o estado.

Devoluções

SearchIndexerStatus

Tipo de retorno

get_indexers

Lista todos os indexadores disponíveis para um serviço de pesquisa.

get_indexers(*, select: List[str] | None = None, **kwargs: Any) -> Sequence[SearchIndexer]

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 é todas as propriedades.

Devoluções

Lista de todos os SearchIndexers.

Tipo de retorno

get_skillset

Obter um searchIndexerSkillset nomeado num Serviço de pesquisa do Azure

get_skillset(name: str, **kwargs: Any) -> SearchIndexerSkillset

Parâmetros

name
str
Necessário

O nome do searchIndexerSkillset a obter

Devoluções

SearchIndexerSkillset obtido

Tipo de retorno

Exceções

get_skillset_names

Liste os nomes searchIndexerSkillset num Serviço de pesquisa do Azure.

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

Devoluções

Lista de nomes searchIndexerSkillset

Tipo de retorno

Exceções

get_skillsets

Liste os conjuntos SearchIndexerSkillsets num Serviço de pesquisa do Azure.

get_skillsets(*, select: List[str] | None = None, **kwargs: Any) -> List[SearchIndexerSkillset]

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 é todas as propriedades.

Devoluções

Lista de SearchIndexerSkillsets

Tipo de retorno

Exceções

reset_indexer

Repõe o estado de controlo de alterações associado a um indexador.

reset_indexer(name: str, **kwargs: Any) -> None

Parâmetros

name
str
Necessário

O nome do indexador a repor.

Devoluções

Nenhuma

Tipo de retorno

run_indexer

Execute um indexador.

run_indexer(name: str, **kwargs: Any) -> None

Parâmetros

name
str
Necessário

O nome do indexador a executar.

Devoluções

Nenhuma

Tipo de retorno