SearchIndexerClient Classe

Un client pour interagir avec les indexeurs du service de recherche Azure.

Héritage

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexerClient

Constructeur

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

Paramètres

endpoint

str

Obligatoire

Point de terminaison d’URL d’un service Recherche Azure

credential

AzureKeyCredential ou TokenCredential

Obligatoire

Informations d’identification permettant d’autoriser les demandes de client de recherche

api_version

str

Version de l’API De recherche à utiliser pour les requêtes.

audience

str

définit l’audience à utiliser pour l’authentification avec Azure Active Directory (AAD). L’audience n’est pas prise en compte lors de l’utilisation d’une clé partagée. Si l’audience n’est pas fournie, l’audience du cloud public est supposée.

Méthodes

close	Fermez la SearchIndexerClient session.
create_data_source_connection	Crée une connexion de source de données.
create_indexer	Crée un searchIndexer.
create_or_update_data_source_connection	Crée une connexion de source de données ou met à jour une connexion de source de données si elle existe déjà. :p aram data_source_connection : définition de la connexion de source de données à créer ou à mettre à jour. :type data_source_connection : ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :mot clé match_condition : Condition de correspondance à utiliser sur l’etag :p aramtype match_condition : ~azure.core.MatchConditions :return : The created SearchIndexerDataSourceConnection :rtype : ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
create_or_update_indexer	Crée un indexeur ou met à jour un indexeur s’il existe déjà.
create_or_update_skillset	Créez un searchIndexerSkillset dans un service Search Azure ou mettez-en à jour un existant.
create_skillset	Créer un searchIndexerSkillset dans un service Search Azure
delete_data_source_connection	Supprime une connexion de source de données. Pour utiliser des conditions d’accès, le modèle SearchIndexerDataSourceConnection doit être fourni au lieu du nom. Il suffit de fournir le nom de la connexion de source de données à supprimer sans condition
delete_indexer	Supprime un indexeur. Pour utiliser des conditions d’accès, le modèle SearchIndexer doit être fourni au lieu du nom. Il suffit de fournir le nom de l’indexeur à supprimer sans condition.
delete_skillset	Supprimez un searchIndexerSkillset nommé dans un service Search Azure. Pour utiliser des conditions d’accès, le modèle SearchIndexerSkillset doit être fourni au lieu du nom. Il suffit de fournir le nom de l’ensemble de compétences pour supprimer inconditionnellement
get_data_source_connection	Récupère une définition de connexion de source de données.
get_data_source_connection_names	Répertorie tous les noms de connexion de source de données disponibles pour un service de recherche.
get_data_source_connections	Répertorie toutes les connexions de source de données disponibles pour un service de recherche.
get_indexer	Récupère une définition d’indexeur.
get_indexer_names	Répertorie tous les noms d’indexeur disponibles pour un service de recherche.
get_indexer_status	Obtenez le status de l’indexeur.
get_indexers	Répertorie tous les indexeurs disponibles pour un service de recherche.
get_skillset	Récupérer un searchIndexerSkillset nommé dans un service Search Azure
get_skillset_names	Répertoriez les noms SearchIndexerSkillset dans un service Search Azure.
get_skillsets	Répertoriez les SearchIndexerSkillsets dans un service Search Azure.
reset_indexer	Réinitialise l’état de suivi des modifications associé à un indexeur.
run_indexer	Exécutez un indexeur.

close

Fermez la SearchIndexerClient session.

close() -> None

create_data_source_connection

Crée une connexion de source de données.

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

Paramètres

data_source_connection

SearchIndexerDataSourceConnection

Obligatoire

Définition de la connexion de source de données à créer.

Retours

SearchIndexerDataSourceConnection créé

Type de retour

SearchIndexerDataSourceConnection

Exemples

Créer une source de données

   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

Crée un searchIndexer.

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

Paramètres

indexer

SearchIndexer

Obligatoire

La définition de l'indexeur pour créer.

Retours

SearchIndexer créé

Type de retour

SearchIndexer

create_or_update_data_source_connection

Crée une connexion de source de données ou met à jour une connexion de source de données si elle existe déjà. :p aram data_source_connection : définition de la connexion de source de données à créer ou à mettre à jour. :type data_source_connection : ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :mot clé match_condition : Condition de correspondance à utiliser sur l’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

Crée un indexeur ou met à jour un indexeur s’il existe déjà.

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

Paramètres

indexer

SearchIndexer

Obligatoire

La définition de l'indexeur pour créer ou mettre à jour.

match_condition

MatchConditions

Condition de correspondance à utiliser sur l’etag

Retours

SearchIndexer créé

Type de retour

SearchIndexer

create_or_update_skillset

Créez un searchIndexerSkillset dans un service Search Azure ou mettez-en à jour un existant.

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

Paramètres

skillset

SearchIndexerSkillset

Obligatoire

Objet SearchIndexerSkillset à créer ou à mettre à jour

match_condition

MatchConditions

Condition de correspondance à utiliser sur l’etag

Retours

SearchIndexerSkillset créé ou mis à jour

Type de retour

SearchIndexerSkillset

create_skillset

Créer un searchIndexerSkillset dans un service Search Azure

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

Paramètres

skillset

SearchIndexerSkillset

Obligatoire

Objet SearchIndexerSkillset à créer

Retours

SearchIndexerSkillset créé

Type de retour

SearchIndexerSkillset

delete_data_source_connection

Supprime une connexion de source de données. Pour utiliser des conditions d’accès, le modèle SearchIndexerDataSourceConnection doit être fourni au lieu du nom. Il suffit de fournir le nom de la connexion de source de données à supprimer sans condition

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

Paramètres

data_source_connection

str ou SearchIndexerDataSourceConnection

Obligatoire

Connexion de source de données à supprimer.

match_condition

MatchConditions

Condition de correspondance à utiliser sur l’etag

Retours

None

Type de retour

None

Exemples

Supprimer un SearchIndexerDataSourceConnection

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

delete_indexer

Supprime un indexeur. Pour utiliser des conditions d’accès, le modèle SearchIndexer doit être fourni au lieu du nom. Il suffit de fournir le nom de l’indexeur à supprimer sans condition.

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

Paramètres

indexer

str ou SearchIndexer

Obligatoire

Indexeur à supprimer.

match_condition

MatchConditions

Condition de correspondance à utiliser sur l’etag

Retours

None

Type de retour

None

delete_skillset

Supprimez un searchIndexerSkillset nommé dans un service Search Azure. Pour utiliser des conditions d’accès, le modèle SearchIndexerSkillset doit être fourni au lieu du nom. Il suffit de fournir le nom de l’ensemble de compétences pour supprimer inconditionnellement

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

Paramètres

skillset

str ou SearchIndexerSkillset

Obligatoire

SearchIndexerSkillset à supprimer

match_condition

MatchConditions

Condition de correspondance à utiliser sur l’etag

get_data_source_connection

Récupère une définition de connexion de source de données.

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

Paramètres

name

str

Obligatoire

Nom de la connexion de source de données à récupérer.

Retours

SearchIndexerDataSourceConnection qui est extrait.

Type de retour

SearchIndexerDataSourceConnection

Exemples

Récupérer 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

Répertorie tous les noms de connexion de source de données disponibles pour un service de recherche.

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

Retours

Liste de tous les noms de connexion de source de données.

Type de retour

list[str]

get_data_source_connections

Répertorie toutes les connexions de source de données disponibles pour un service de recherche.

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

Paramètres

select

list[str]

Sélectionne les propriétés de niveau supérieur des ensembles de compétences à récupérer. Spécifié sous la forme d’une liste de noms de propriétés JSON, ou « * » pour toutes les propriétés. La valeur par défaut est toutes les propriétés.

Retours

Liste de toutes les connexions à la source de données.

Type de retour

list[SearchIndexerDataSourceConnection]

Exemples

Répertorier tous les 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

Récupère une définition d’indexeur.

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

Paramètres

name

str

Obligatoire

Le nom de l'indexeur à récupérer.

Retours

SearchIndexer extrait.

Type de retour

SearchIndexer

get_indexer_names

Répertorie tous les noms d’indexeur disponibles pour un service de recherche.

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

Retours

Liste de tous les SearchIndexers.

Type de retour

list[str]

get_indexer_status

Obtenez le status de l’indexeur.

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

Paramètres

name

str

Obligatoire

Nom de l’indexeur pour extraire le status.

Retours

SearchIndexerStatus

Type de retour

SearchIndexerStatus

get_indexers

Répertorie tous les indexeurs disponibles pour un service de recherche.

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

Paramètres

select

list[str]

Sélectionne les propriétés de niveau supérieur des ensembles de compétences à récupérer. Spécifié sous la forme d’une liste de noms de propriétés JSON, ou « * » pour toutes les propriétés. La valeur par défaut est toutes les propriétés.

Retours

Liste de tous les SearchIndexers.

Type de retour

list[SearchIndexer]

get_skillset

Récupérer un searchIndexerSkillset nommé dans un service Search Azure

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

Paramètres

name

str

Obligatoire

Nom du SearchIndexerSkillset à obtenir

Retours

SearchIndexerSkillset récupéré

Type de retour

SearchIndexerSkillset

Exceptions

ResourceNotFoundError

get_skillset_names

Répertoriez les noms SearchIndexerSkillset dans un service Search Azure.

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

Retours

Liste des noms SearchIndexerSkillset

Type de retour

list[str]

Exceptions

HttpResponseError

get_skillsets

Répertoriez les SearchIndexerSkillsets dans un service Search Azure.

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

Paramètres

select

list[str]

Sélectionne les propriétés de niveau supérieur des ensembles de compétences à récupérer. Spécifié sous la forme d’une liste de noms de propriétés JSON, ou « * » pour toutes les propriétés. La valeur par défaut est toutes les propriétés.

Retours

Liste des searchIndexerSkillsets

Type de retour

list[SearchIndexerSkillset]

Exceptions

HttpResponseError

reset_indexer

Réinitialise l’état de suivi des modifications associé à un indexeur.

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

Paramètres

name

str

Obligatoire

Le nom de l'indexeur à réinitialiser.

Retours

None

Type de retour

None

run_indexer

Exécutez un indexeur.

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

Paramètres

name

str

Obligatoire

Le nom de l'indexeur à exécuter.

Retours

None

Type de retour

None