Compartilhar via


SearchIndexerClient Classe

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

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

Construtor

SearchIndexerClient(endpoint: str, credential: AzureKeyCredential | AsyncTokenCredential, **kwargs)

Parâmetros

endpoint
str
Obrigatório

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

credential
AzureKeyCredential ou AsyncTokenCredential
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

close

Feche a SearchIndexerClient sessão.

create_data_source_connection

Cria uma nova conexão de fonte de dados. :p aram data_source_connection: a definição da conexão de fonte de dados a ser criada. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :return: The created SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

create_indexer

Cria um novo SearchIndexer.

create_or_update_data_source_connection

Cria uma nova conexão de fonte de dados ou atualiza uma conexão de fonte de dados se ela já existir. :p aram data_source_connection: a definição da conexão de fonte de dados para criar ou atualizar. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :palavra-chave match_condition: a condição de correspondência a ser usada na 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 ele já existir.

create_or_update_skillset

Crie um novo SearchIndexerSkillset em um serviço Pesquisa do Azure ou atualize um existente.

create_skillset

Criar um novo SearchIndexerSkillset em um serviço Pesquisa do Azure

delete_data_source_connection

Exclui uma conexão de fonte de dados. Para usar as condições de acesso, o modelo SearchIndexerDataSourceConnection deve ser fornecido em vez do nome. É suficiente para fornecer o nome da conexão de fonte de dados para excluir incondicionalmente

delete_indexer

Exclui um indexador. Para usar as condições de acesso, o modelo SearchIndexer deve ser fornecido em vez do nome. É suficiente fornecer o nome do indexador para excluir incondicionalmente.

delete_skillset

Exclua um SearchIndexerSkillset nomeado em um serviço Pesquisa do Azure. Para usar condições de acesso, o modelo SearchIndexerSkillset deve ser fornecido em vez do nome. É o suficiente para fornecer o nome do conjunto de habilidades para excluir incondicionalmente

get_data_source_connection

Recupera uma definição de conexão de fonte de dados.

get_data_source_connection_names

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

get_data_source_connections

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

get_indexer

Recupera 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 status do indexador.

get_indexers

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

get_skillset

Recuperar um SearchIndexerSkillset nomeado em um serviço Pesquisa do Azure

get_skillset_names

Liste os nomes SearchIndexerSkillset em um serviço Pesquisa do Azure.

get_skillsets

Liste os SearchIndexerSkillsets em um serviço Pesquisa do Azure.

reset_indexer

Redefine o estado de controle de alterações associado a um indexador.

run_indexer

Execute um indexador.

close

Feche a SearchIndexerClient sessão.

async close() -> None

Retornos

Nenhum

Tipo de retorno

create_data_source_connection

Cria uma nova conexão de fonte de dados. :p aram data_source_connection: a definição da conexão de fonte de dados a ser criada. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :return: The created SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

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

Exemplos

Criar um SearchIndexerDataSourceConnection


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

create_indexer

Cria um novo SearchIndexer.

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

Parâmetros

indexer
SearchIndexer
Obrigatório

A definição do indexador a ser criado.

Retornos

O SearchIndexer criado

Tipo de retorno

create_or_update_data_source_connection

Cria uma nova conexão de fonte de dados ou atualiza uma conexão de fonte de dados se ela já existir. :p aram data_source_connection: a definição da conexão de fonte de dados para criar ou atualizar. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :palavra-chave match_condition: a condição de correspondência a ser usada na etag :p aramtype match_condition: ~azure.core.MatchConditions :return: The created SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

async 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 ele já existir.

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

Parâmetros

indexer
SearchIndexer
Obrigatório

A definição do indexador a ser criado ou atualizado.

Retornos

O SearchIndexer criado

Tipo de retorno

create_or_update_skillset

Crie um novo SearchIndexerSkillset em um serviço Pesquisa do Azure ou atualize um existente.

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

Parâmetros

skillset
SearchIndexerSkillset
Obrigatório

O objeto SearchIndexerSkillset para criar ou atualizar

match_condition
MatchConditions

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

Retornos

O SearchIndexerSkillset criado ou atualizado

Tipo de retorno

create_skillset

Criar um novo SearchIndexerSkillset em um serviço Pesquisa do Azure

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

Parâmetros

skillset
SearchIndexerSkillset
Obrigatório

O objeto SearchIndexerSkillset a ser criado

Retornos

O SearchIndexerSkillset criado

Tipo de retorno

delete_data_source_connection

Exclui uma conexão de fonte de dados. Para usar as condições de acesso, o modelo SearchIndexerDataSourceConnection deve ser fornecido em vez do nome. É suficiente para fornecer o nome da conexão de fonte de dados para excluir incondicionalmente

async 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
Obrigatório

A conexão de fonte de dados a ser excluída.

match_condition
MatchConditions

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

Retornos

Nenhum

Tipo de retorno

delete_indexer

Exclui um indexador. Para usar as condições de acesso, o modelo SearchIndexer deve ser fornecido em vez do nome. É suficiente fornecer o nome do indexador para excluir incondicionalmente.

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

Parâmetros

name
str ou SearchIndexer
Obrigatório

O nome ou o objeto do indexador a ser excluído.

match_condition
MatchConditions

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

Retornos

Nenhum

Tipo de retorno

delete_skillset

Exclua um SearchIndexerSkillset nomeado em um serviço Pesquisa do Azure. Para usar condições de acesso, o modelo SearchIndexerSkillset deve ser fornecido em vez do nome. É o suficiente para fornecer o nome do conjunto de habilidades para excluir incondicionalmente

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

Parâmetros

skillset
str ou SearchIndexerSkillset
Obrigatório

O SearchIndexerSkillset a ser excluído

match_condition
MatchConditions

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

get_data_source_connection

Recupera uma definição de conexão de fonte de dados.

async get_data_source_connection(name: str, *, select: List[str] | None = None, **kwargs: Any) -> SearchIndexerDataSourceConnection

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.

name
str
Obrigatório

O nome da conexão de fonte de dados a ser recuperada.

Retornos

O SearchIndexerDataSourceConnection que é buscado.

Tipo de retorno

SearchIndexerDataSourceConnection<xref:Retrieve> <xref:a> SearchIndexerDataSourceConnection <xref:result> = <xref:await> <xref:client.get_data_source_connection>("<xref:async>-<xref:sample>-<xref:data>-<xref:source>-<xref:connection>") print("<xref:Retrived> <xref:Data> <xref:Source> <xref:Connection> '<xref:async>-<xref:sample>-<xref:data>-<xref:source>-<xref:connection>'") <xref:return> <xref:result>

get_data_source_connection_names

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

async get_data_source_connection_names(**kwargs) -> Sequence[str]

Retornos

Lista de todos os nomes de conexão da fonte de dados.

Tipo de retorno

get_data_source_connections

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

async get_data_source_connections(**kwargs: Any) -> Sequence[SearchIndexerDataSourceConnection]

Retornos

Lista de todas as conexões de fonte de dados.

Tipo de retorno

Exemplos

Listar todas as SearchIndexerDataSourceConnections


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

get_indexer

Recupera uma definição de indexador.

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

Parâmetros

name
str
Obrigatório

O nome do indexador a ser recuperado.

Retornos

O SearchIndexer que é buscado.

Tipo de retorno

get_indexer_names

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

async get_indexer_names(**kwargs) -> Sequence[str]

Retornos

Lista de todos os nomes SearchIndexer.

Tipo de retorno

get_indexer_status

Obtenha o status do indexador.

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

Parâmetros

name
str
Obrigatório

O nome do indexador para buscar o status.

Retornos

SearchIndexerStatus

Tipo de retorno

get_indexers

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

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

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 todos os SearchIndexers.

Tipo de retorno

get_skillset

Recuperar um SearchIndexerSkillset nomeado em um serviço Pesquisa do Azure

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

Parâmetros

name
str
Obrigatório

O nome do SearchIndexerSkillset a ser obtido

Retornos

O SearchIndexerSkillset recuperado

Tipo de retorno

Exceções

get_skillset_names

Liste os nomes SearchIndexerSkillset em um serviço Pesquisa do Azure.

async get_skillset_names(**kwargs) -> List[str]

Retornos

Lista de nomes SearchIndexerSkillset

Tipo de retorno

Exceções

get_skillsets

Liste os SearchIndexerSkillsets em um serviço Pesquisa do Azure.

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

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 SearchIndexerSkillsets

Tipo de retorno

Exceções

reset_indexer

Redefine o estado de controle de alterações associado a um indexador.

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

Parâmetros

name
str
Obrigatório

O nome do indexador a ser redefinido.

Retornos

Nenhum

Tipo de retorno

run_indexer

Execute um indexador.

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

Parâmetros

name
str
Obrigatório

O nome do indexador a ser executado.

Retornos

Nenhum

Tipo de retorno