SearchIndexerClient class
Classe permettant d’effectuer des opérations pour gérer (créer, mettre à jour, lister/supprimer) des indexeurs, des sources de données & des ensembles de compétences.
Constructeurs
Search |
Crée une instance de SearchIndexerClient. Exemple d’utilisation :
|
Propriétés
api |
Version de l’API à utiliser lors de la communication avec le service. |
endpoint | Point de terminaison du service de recherche |
service |
Version de l’API à utiliser lors de la communication avec le service. |
Méthodes
create |
Crée un dataSource dans un service de recherche. |
create |
Crée un indexeur dans un service de recherche. |
create |
Crée une source de données ou modifie une source de données existante. |
create |
Crée un indexeur ou modifie un indexeur existant. |
create |
Crée un ensemble de compétences ou en modifie un existant. |
create |
Crée un nouvel ensemble de compétences dans un service de recherche. |
delete |
Supprime une source de données existante. |
delete |
Supprime un indexeur existant. |
delete |
Supprime un ensemble de compétences existant. |
get |
Récupère des informations sur une source de données |
get |
Récupère des informations sur un indexeur. |
get |
Renvoie le statut actuel et l'historique d'exécution d'un indexeur. |
get |
Récupère des informations sur un ensemble de compétences. |
list |
Récupère une liste des sources de données existantes dans le service. |
list |
Récupère une liste de noms de sources de données existantes dans le service. |
list |
Récupère une liste d’indexeurs existants dans le service. |
list |
Récupère une liste de noms d’indexeurs existants dans le service. |
list |
Récupère une liste des ensembles de compétences existants dans le service. |
list |
Récupère une liste de noms d’ensembles de compétences existants dans le service. |
reset |
Réinitialise l’état de suivi des modifications associé à un indexeur. |
run |
Exécute un indexeur à la demande. |
Détails du constructeur
SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)
Crée une instance de SearchIndexerClient.
Exemple d’utilisation :
const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents");
const client = new SearchIndexerClient(
"<endpoint>",
new AzureKeyCredential("<Admin Key>");
);
new SearchIndexerClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexerClientOptions)
Paramètres
- endpoint
-
string
Point de terminaison du service de recherche
- credential
Utilisé pour authentifier les demandes adressées au service.
- options
- SearchIndexerClientOptions
Utilisé pour configurer le client de recherche.
Détails de la propriété
apiVersion
Avertissement
Cette API est à présent déconseillée.
use {@Link serviceVersion} instead
Version de l’API à utiliser lors de la communication avec le service.
apiVersion: string
Valeur de propriété
string
endpoint
Point de terminaison du service de recherche
endpoint: string
Valeur de propriété
string
serviceVersion
Version de l’API à utiliser lors de la communication avec le service.
serviceVersion: string
Valeur de propriété
string
Détails de la méthode
createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)
Crée un dataSource dans un service de recherche.
function createDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>
Paramètres
- dataSourceConnection
- SearchIndexerDataSourceConnection
Définition dataSource à créer dans un service de recherche.
- options
- OperationOptions
Arguments facultatifs supplémentaires.
Retours
Promise<SearchIndexerDataSourceConnection>
createIndexer(SearchIndexer, OperationOptions)
Crée un indexeur dans un service de recherche.
function createIndexer(indexer: SearchIndexer, options?: OperationOptions): Promise<SearchIndexer>
Paramètres
- indexer
- SearchIndexer
Définition de l’indexeur à créer dans un service de recherche.
- options
- OperationOptions
Arguments facultatifs supplémentaires.
Retours
Promise<SearchIndexer>
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)
Crée une source de données ou modifie une source de données existante.
function createOrUpdateDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: CreateorUpdateDataSourceConnectionOptions): Promise<SearchIndexerDataSourceConnection>
Paramètres
- dataSourceConnection
- SearchIndexerDataSourceConnection
Informations décrivant la source de données à créer/mettre à jour.
Arguments facultatifs supplémentaires.
Retours
Promise<SearchIndexerDataSourceConnection>
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)
Crée un indexeur ou modifie un indexeur existant.
function createOrUpdateIndexer(indexer: SearchIndexer, options?: CreateorUpdateIndexerOptions): Promise<SearchIndexer>
Paramètres
- indexer
- SearchIndexer
Informations décrivant l’indexeur à créer/mettre à jour.
- options
- CreateorUpdateIndexerOptions
Arguments facultatifs supplémentaires.
Retours
Promise<SearchIndexer>
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)
Crée un ensemble de compétences ou en modifie un existant.
function createOrUpdateSkillset(skillset: SearchIndexerSkillset, options?: CreateOrUpdateSkillsetOptions): Promise<SearchIndexerSkillset>
Paramètres
- skillset
- SearchIndexerSkillset
Informations décrivant l’index à créer.
- options
- CreateOrUpdateSkillsetOptions
Arguments facultatifs supplémentaires.
Retours
Promise<SearchIndexerSkillset>
createSkillset(SearchIndexerSkillset, OperationOptions)
Crée un nouvel ensemble de compétences dans un service de recherche.
function createSkillset(skillset: SearchIndexerSkillset, options?: OperationOptions): Promise<SearchIndexerSkillset>
Paramètres
- skillset
- SearchIndexerSkillset
Ensemble de compétences contenant une ou plusieurs compétences à créer dans un service de recherche.
- options
- OperationOptions
Arguments facultatifs supplémentaires.
Retours
Promise<SearchIndexerSkillset>
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)
Supprime une source de données existante.
function deleteDataSourceConnection(dataSourceConnection: string | SearchIndexerDataSourceConnection, options?: DeleteDataSourceConnectionOptions): Promise<void>
Paramètres
- dataSourceConnection
-
string | SearchIndexerDataSourceConnection
Arguments facultatifs supplémentaires.
Retours
Promise<void>
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)
Supprime un indexeur existant.
function deleteIndexer(indexer: string | SearchIndexer, options?: DeleteIndexerOptions): Promise<void>
Paramètres
- indexer
-
string | SearchIndexer
Indexeur/Nom de l’indexeur à supprimer.
- options
- DeleteIndexerOptions
Arguments facultatifs supplémentaires.
Retours
Promise<void>
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)
Supprime un ensemble de compétences existant.
function deleteSkillset(skillset: string | SearchIndexerSkillset, options?: DeleteSkillsetOptions): Promise<void>
Paramètres
- skillset
-
string | SearchIndexerSkillset
Ensemble de compétences/Nom de l’ensemble de compétences à supprimer.
- options
- DeleteSkillsetOptions
Arguments facultatifs supplémentaires.
Retours
Promise<void>
getDataSourceConnection(string, OperationOptions)
Récupère des informations sur une source de données
function getDataSourceConnection(dataSourceConnectionName: string, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>
Paramètres
- dataSourceConnectionName
-
string
- options
- OperationOptions
Arguments facultatifs supplémentaires
Retours
Promise<SearchIndexerDataSourceConnection>
getIndexer(string, OperationOptions)
Récupère des informations sur un indexeur.
function getIndexer(indexerName: string, options?: OperationOptions): Promise<SearchIndexer>
Paramètres
- indexerName
-
string
Nom de l’indexeur.
- options
- OperationOptions
Arguments facultatifs supplémentaires.
Retours
Promise<SearchIndexer>
getIndexerStatus(string, OperationOptions)
Renvoie le statut actuel et l'historique d'exécution d'un indexeur.
function getIndexerStatus(indexerName: string, options?: OperationOptions): Promise<SearchIndexerStatus>
Paramètres
- indexerName
-
string
Nom de l'indexeur.
- options
- OperationOptions
Arguments facultatifs supplémentaires.
Retours
Promise<SearchIndexerStatus>
getSkillset(string, OperationOptions)
Récupère des informations sur un ensemble de compétences.
function getSkillset(skillsetName: string, options?: OperationOptions): Promise<SearchIndexerSkillset>
Paramètres
- skillsetName
-
string
- options
- OperationOptions
Arguments facultatifs supplémentaires.
Retours
Promise<SearchIndexerSkillset>
listDataSourceConnections(OperationOptions)
Récupère une liste des sources de données existantes dans le service.
function listDataSourceConnections(options?: OperationOptions): Promise<SearchIndexerDataSourceConnection[]>
Paramètres
- options
- OperationOptions
Options de l’opération de liste des indexeurs.
Retours
Promise<SearchIndexerDataSourceConnection[]>
listDataSourceConnectionsNames(OperationOptions)
Récupère une liste de noms de sources de données existantes dans le service.
function listDataSourceConnectionsNames(options?: OperationOptions): Promise<string[]>
Paramètres
- options
- OperationOptions
Options de l’opération de liste des indexeurs.
Retours
Promise<string[]>
listIndexers(OperationOptions)
Récupère une liste d’indexeurs existants dans le service.
function listIndexers(options?: OperationOptions): Promise<SearchIndexer[]>
Paramètres
- options
- OperationOptions
Options de l’opération d’indexeurs de liste.
Retours
Promise<SearchIndexer[]>
listIndexersNames(OperationOptions)
Récupère une liste de noms d’indexeurs existants dans le service.
function listIndexersNames(options?: OperationOptions): Promise<string[]>
Paramètres
- options
- OperationOptions
Options de l’opération d’indexeurs de liste.
Retours
Promise<string[]>
listSkillsets(OperationOptions)
Récupère une liste des ensembles de compétences existants dans le service.
function listSkillsets(options?: OperationOptions): Promise<SearchIndexerSkillset[]>
Paramètres
- options
- OperationOptions
Options de l’opération d’ensembles de compétences de la liste.
Retours
Promise<SearchIndexerSkillset[]>
listSkillsetsNames(OperationOptions)
Récupère une liste de noms d’ensembles de compétences existants dans le service.
function listSkillsetsNames(options?: OperationOptions): Promise<string[]>
Paramètres
- options
- OperationOptions
Options de l’opération d’ensembles de compétences de la liste.
Retours
Promise<string[]>
resetIndexer(string, OperationOptions)
Réinitialise l’état de suivi des modifications associé à un indexeur.
function resetIndexer(indexerName: string, options?: OperationOptions): Promise<void>
Paramètres
- indexerName
-
string
Le nom de l'indexeur à réinitialiser.
- options
- OperationOptions
Arguments facultatifs supplémentaires.
Retours
Promise<void>
runIndexer(string, OperationOptions)
Exécute un indexeur à la demande.
function runIndexer(indexerName: string, options?: OperationOptions): Promise<void>
Paramètres
- indexerName
-
string
Le nom de l'indexeur à exécuter.
- options
- OperationOptions
Arguments facultatifs supplémentaires.
Retours
Promise<void>