SearchIndexerClient Clase

Un cliente para interactuar con indexadores del servicio Azure Search.

Herencia

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexerClient

Constructor

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

Parámetros

endpoint

str

Requerido

Punto de conexión de dirección URL de un servicio de Azure Search

credential

AzureKeyCredential o TokenCredential

Requerido

Credencial para autorizar solicitudes de cliente de búsqueda

api_version

str

La versión de Search API que se va a usar para las solicitudes.

audience

str

establece la audiencia que se va a usar para la autenticación con Azure Active Directory (AAD). La audiencia no se tiene en cuenta cuando se usa una clave compartida. Si no se proporciona audiencia, se supone que el público de la nube pública.

Métodos

close	Cierre la SearchIndexerClient sesión.
create_data_source_connection	Crea una nueva conexión de origen de datos.
create_indexer	Crea un nuevo SearchIndexer.
create_or_update_data_source_connection	Crea una nueva conexión de origen de datos o actualiza una conexión de origen de datos si ya existe. :p aram data_source_connection: definición de la conexión del origen de datos para crear o actualizar. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: la condición de coincidencia que se va a usar en el match_condition etag :p aramtype: ~azure.core.MatchConditions :return: The created SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
create_or_update_indexer	Crea un indexador o actualiza un indexador si ya existe.
create_or_update_skillset	Cree una nueva clase SearchIndexerSkillset en una instancia de Azure servicio Search o actualice una existente.
create_skillset	Creación de un objeto SearchIndexerSkillset en una instancia de Azure servicio Search
delete_data_source_connection	Elimina una conexión de origen de datos. Para usar condiciones de acceso, se debe proporcionar el modelo SearchIndexerDataSourceConnection en lugar del nombre. Es suficiente proporcionar el nombre de la conexión del origen de datos para eliminar incondicionalmente.
delete_indexer	Elimina un indexador. Para usar condiciones de acceso, se debe proporcionar el modelo SearchIndexer en lugar del nombre. Es suficiente proporcionar el nombre del indexador para eliminar incondicionalmente.
delete_skillset	Elimine un elemento denominado SearchIndexerSkillset en una instancia de Azure servicio Search. Para usar condiciones de acceso, se debe proporcionar el modelo SearchIndexerSkillset en lugar del nombre. Es suficiente proporcionar el nombre del conjunto de aptitudes para eliminar incondicionalmente.
get_data_source_connection	Recupera una definición de conexión de origen de datos.
get_data_source_connection_names	Enumera todos los nombres de conexión de origen de datos disponibles para un servicio de búsqueda.
get_data_source_connections	Enumera todas las conexiones de origen de datos disponibles para un servicio de búsqueda.
get_indexer	Recupera una definición del indexador.
get_indexer_names	Enumera todos los nombres de indexador disponibles para un servicio de búsqueda.
get_indexer_status	Obtenga el estado del indexador.
get_indexers	Enumera todos los indexadores disponibles para un servicio de búsqueda.
get_skillset	Recuperación de un elemento denominado SearchIndexerSkillset en una instancia de Azure servicio Search
get_skillset_names	Enumere los nombres de SearchIndexerSkillset en una servicio Search de Azure.
get_skillsets	Enumere searchIndexerSkillsets en una servicio Search de Azure.
reset_indexer	Restablece el estado de seguimiento de cambios asociado a un indexador.
run_indexer	Ejecute un indexador.

close

Cierre la SearchIndexerClient sesión.

close() -> None

create_data_source_connection

Crea una nueva conexión de origen de datos.

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

Parámetros

data_source_connection

SearchIndexerDataSourceConnection

Requerido

Definición de la conexión del origen de datos que se va a crear.

Devoluciones

SearchIndexerDataSourceConnection creado

Tipo de valor devuelto

SearchIndexerDataSourceConnection

Ejemplos

Crear un origen de datos

   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

Crea un nuevo SearchIndexer.

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

Parámetros

indexer

SearchIndexer

Requerido

Definición del indizador que se va a crear.

Devoluciones

SearchIndexer creado

Tipo de valor devuelto

SearchIndexer

create_or_update_data_source_connection

Crea una nueva conexión de origen de datos o actualiza una conexión de origen de datos si ya existe. :p aram data_source_connection: definición de la conexión del origen de datos para crear o actualizar. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: la condición de coincidencia que se va a usar en el match_condition etag :p aramtype: ~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

Crea un indexador o actualiza un indexador si ya existe.

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

Parámetros

indexer

SearchIndexer

Requerido

Definición del indizador que se va a crear o actualizar.

match_condition

MatchConditions

Condición de coincidencia que se va a usar en el etag

Devoluciones

SearchIndexer creado

Tipo de valor devuelto

SearchIndexer

create_or_update_skillset

Cree una nueva clase SearchIndexerSkillset en una instancia de Azure servicio Search o actualice una existente.

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

Parámetros

skillset

SearchIndexerSkillset

Requerido

El objeto SearchIndexerSkillset que se va a crear o actualizar

match_condition

MatchConditions

Condición de coincidencia que se va a usar en el etag

Devoluciones

SearchIndexerSkillset creado o actualizado

Tipo de valor devuelto

SearchIndexerSkillset

create_skillset

Creación de un objeto SearchIndexerSkillset en una instancia de Azure servicio Search

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

Parámetros

skillset

SearchIndexerSkillset

Requerido

El objeto SearchIndexerSkillset que se va a crear

Devoluciones

SearchIndexerSkillset creado

Tipo de valor devuelto

SearchIndexerSkillset

delete_data_source_connection

Elimina una conexión de origen de datos. Para usar condiciones de acceso, se debe proporcionar el modelo SearchIndexerDataSourceConnection en lugar del nombre. Es suficiente proporcionar el nombre de la conexión del origen de datos 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 o SearchIndexerDataSourceConnection

Requerido

La conexión del origen de datos que se va a eliminar.

match_condition

MatchConditions

Condición de coincidencia que se va a usar en el etag

Devoluciones

None

Tipo de valor devuelto

None

Ejemplos

Eliminar un searchIndexerDataSourceConnection

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

delete_indexer

Elimina un indexador. Para usar condiciones de acceso, se debe proporcionar el modelo SearchIndexer en lugar del nombre. Es suficiente proporcionar el nombre del indexador para eliminar incondicionalmente.

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

Parámetros

indexer

str o SearchIndexer

Requerido

Indexador que se va a eliminar.

match_condition

MatchConditions

Condición de coincidencia que se va a usar en el etag

Devoluciones

None

Tipo de valor devuelto

None

delete_skillset

Elimine un elemento denominado SearchIndexerSkillset en una instancia de Azure servicio Search. Para usar condiciones de acceso, se debe proporcionar el modelo SearchIndexerSkillset en lugar del nombre. Es suficiente proporcionar el nombre del conjunto de aptitudes para eliminar incondicionalmente.

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

Parámetros

skillset

str o SearchIndexerSkillset

Requerido

SearchIndexerSkillset que se va a eliminar

match_condition

MatchConditions

Condición de coincidencia que se va a usar en el etag

get_data_source_connection

Recupera una definición de conexión de origen de datos.

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

Parámetros

name

str

Requerido

Nombre de la conexión del origen de datos que se va a recuperar.

Devoluciones

SearchIndexerDataSourceConnection que se captura.

Tipo de valor devuelto

SearchIndexerDataSourceConnection

Ejemplos

Recuperar un 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

Enumera todos los nombres de conexión de origen de datos disponibles para un servicio de búsqueda.

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

Devoluciones

Lista de todos los nombres de conexión del origen de datos.

Tipo de valor devuelto

list[str]

get_data_source_connections

Enumera todas las conexiones de origen de datos disponibles para un servicio de búsqueda.

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

Parámetros

select

list[str]

Selecciona las propiedades de nivel superior de los conjuntos de aptitudes que se van a recuperar. Se especifica como una lista de nombres de propiedad JSON o "*" para todas las propiedades. El valor predeterminado es todas las propiedades.

Devoluciones

Lista de todas las conexiones del origen de datos.

Tipo de valor devuelto

list[SearchIndexerDataSourceConnection]

Ejemplos

Enumerar todas las 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

Recupera una definición del indexador.

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

Parámetros

name

str

Requerido

Nombre del indizador que se va a recuperar.

Devoluciones

SearchIndexer que se captura.

Tipo de valor devuelto

SearchIndexer

get_indexer_names

Enumera todos los nombres de indexador disponibles para un servicio de búsqueda.

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

Devoluciones

Lista de todos los searchIndexers.

Tipo de valor devuelto

list[str]

get_indexer_status

Obtenga el estado del indexador.

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

Parámetros

name

str

Requerido

Nombre del indexador que se va a capturar el estado.

Devoluciones

SearchIndexerStatus

Tipo de valor devuelto

SearchIndexerStatus

get_indexers

Enumera todos los indexadores disponibles para un servicio de búsqueda.

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

Parámetros

select

list[str]

Selecciona las propiedades de nivel superior de los conjuntos de aptitudes que se van a recuperar. Se especifica como una lista de nombres de propiedad JSON o "*" para todas las propiedades. El valor predeterminado es todas las propiedades.

Devoluciones

Lista de todos los searchIndexers.

Tipo de valor devuelto

list[SearchIndexer]

get_skillset

Recuperación de un elemento denominado SearchIndexerSkillset en una instancia de Azure servicio Search

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

Parámetros

name

str

Requerido

Nombre del searchIndexerSkillset que se va a obtener.

Devoluciones

SearchIndexerSkillset recuperado

Tipo de valor devuelto

SearchIndexerSkillset

Excepciones

ResourceNotFoundError

get_skillset_names

Enumere los nombres de SearchIndexerSkillset en una servicio Search de Azure.

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

Devoluciones

Lista de nombres searchIndexerSkillset

Tipo de valor devuelto

list[str]

Excepciones

HttpResponseError

get_skillsets

Enumere searchIndexerSkillsets en una servicio Search de Azure.

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

Parámetros

select

list[str]

Selecciona las propiedades de nivel superior de los conjuntos de aptitudes que se van a recuperar. Se especifica como una lista de nombres de propiedad JSON o "*" para todas las propiedades. El valor predeterminado es todas las propiedades.

Devoluciones

Lista de SearchIndexerSkillsets

Tipo de valor devuelto

list[SearchIndexerSkillset]

Excepciones

HttpResponseError

reset_indexer

Restablece el estado de seguimiento de cambios asociado a un indexador.

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

Parámetros

name

str

Requerido

Nombre del indizador que se va a restablecer.

Devoluciones

None

Tipo de valor devuelto

None

run_indexer

Ejecute un indexador.

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

Parámetros

name

str

Requerido

Nombre del indizador que se va a ejecutar.

Devoluciones

None

Tipo de valor devuelto

None