SearchIndexClient class

Paquet:

@azure/search-documents

Classe permettant d’effectuer des opérations pour gérer (créer, mettre à jour, lister/supprimer) des index, & des synonymmaps.

Constructeurs

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Crée un instance de SearchIndexClient. Exemple d’utilisation : const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

Propriétés

apiVersion	Version de l’API à utiliser lors de la communication avec le service.
endpoint	Point de terminaison du service de recherche
serviceVersion	Version de l’API à utiliser lors de la communication avec le service.

Méthodes

analyzeText(string, AnalyzeTextOptions)	Appelle un analyseur ou un générateur de jetons manuellement sur le texte fourni.
createIndex(SearchIndex, OperationOptions)	crée un index.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Crée un index ou modifie un index existant.
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Crée un SynonymMap ou modifie un objet existant.
createSynonymMap(SynonymMap, OperationOptions)	Crée un SynonymMap dans un service de recherche.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	Supprime un index existant.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Supprime un SynonymMap existant.
getIndex(string, OperationOptions)	Récupère des informations sur un index.
getIndexStatistics(string, OperationOptions)	Récupère les statistiques relatives à un index, telles que le nombre de documents et la taille du stockage d’index.
getSearchClient<TModel>(string, SearchClientOptions)	Récupère le SearchClient correspondant à ce SearchIndexClient
getServiceStatistics(OperationOptions)	Récupère des statistiques sur le service, telles que le nombre de documents, l’index, etc.
getSynonymMap(string, OperationOptions)	Récupère des informations sur un SynonymMap.
listIndexes(OperationOptions)	Récupère une liste d’index existants dans le service.
listIndexesNames(OperationOptions)	Récupère une liste de noms d’index existants dans le service.
listSynonymMaps(OperationOptions)	Récupère une liste de SynonymMaps existants dans le service.
listSynonymMapsNames(OperationOptions)	Récupère une liste de noms de SynonymMaps existants dans le service.

Détails du constructeur

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Crée un instance de SearchIndexClient.

Exemple d’utilisation :

const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents");

const client = new SearchIndexClient(
  "<endpoint>",
  new AzureKeyCredential("<Admin Key>");
);

new SearchIndexClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexClientOptions)

Paramètres

endpoint

string

Point de terminaison du service de recherche

credential

KeyCredential | TokenCredential

Utilisé pour authentifier les demandes adressées au service.

options

SearchIndexClientOptions

Permet de configurer le client d’index 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

analyzeText(string, AnalyzeTextOptions)

Appelle un analyseur ou un générateur de jetons manuellement sur le texte fourni.

function analyzeText(indexName: string, options: AnalyzeTextOptions): Promise<AnalyzeResult>

Paramètres

indexName

string

Nom de l’index qui contient le champ à analyser

options

AnalyzeTextOptions

Arguments supplémentaires

Retours

Promise<AnalyzeResult>

createIndex(SearchIndex, OperationOptions)

crée un index.

function createIndex(index: SearchIndex, options?: OperationOptions): Promise<SearchIndex>

Paramètres

index

SearchIndex

Informations décrivant l’index à créer.

options

OperationOptions

Arguments facultatifs supplémentaires.

Retours

Promise<SearchIndex>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

Crée un index ou modifie un index existant.

function createOrUpdateIndex(index: SearchIndex, options?: CreateOrUpdateIndexOptions): Promise<SearchIndex>

Paramètres

index

SearchIndex

Informations décrivant l’index à créer.

options

CreateOrUpdateIndexOptions

Arguments facultatifs supplémentaires.

Retours

Promise<SearchIndex>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Crée un SynonymMap ou modifie un objet existant.

function createOrUpdateSynonymMap(synonymMap: SynonymMap, options?: CreateOrUpdateSynonymMapOptions): Promise<SynonymMap>

Paramètres

synonymMap

SynonymMap

Informations décrivant le SynonymMap à créer.

options

CreateOrUpdateSynonymMapOptions

Arguments facultatifs supplémentaires.

Retours

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Crée un SynonymMap dans un service de recherche.

function createSynonymMap(synonymMap: SynonymMap, options?: OperationOptions): Promise<SynonymMap>

Paramètres

synonymMap

SynonymMap

Définition synonymMap à créer dans un service de recherche.

options

OperationOptions

Arguments facultatifs supplémentaires.

Retours

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Supprime un index existant.

function deleteIndex(index: string | SearchIndex, options?: DeleteIndexOptions): Promise<void>

Paramètres

index

string | SearchIndex

options

DeleteIndexOptions

Arguments facultatifs supplémentaires.

Retours

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Supprime un SynonymMap existant.

function deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>

Paramètres

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Arguments facultatifs supplémentaires.

Retours

Promise<void>

getIndex(string, OperationOptions)

Récupère des informations sur un index.

function getIndex(indexName: string, options?: OperationOptions): Promise<SearchIndex>

Paramètres

indexName

string

Nom de l’index.

options

OperationOptions

Arguments facultatifs supplémentaires.

Retours

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

Récupère les statistiques relatives à un index, telles que le nombre de documents et la taille du stockage d’index.

function getIndexStatistics(indexName: string, options?: OperationOptions): Promise<SearchIndexStatistics>

Paramètres

indexName

string

Nom de l’index.

options

OperationOptions

Arguments facultatifs supplémentaires.

Retours

Promise<SearchIndexStatistics>

getSearchClient<TModel>(string, SearchClientOptions)

Récupère le SearchClient correspondant à ce SearchIndexClient

function getSearchClient<TModel>(indexName: string, options?: SearchClientOptions): SearchClient<TModel>

Paramètres

indexName

string

Nom de l'index.

options

SearchClientOptions

SearchClient Options

Retours

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Récupère des statistiques sur le service, telles que le nombre de documents, l’index, etc.

function getServiceStatistics(options?: OperationOptions): Promise<SearchServiceStatistics>

Paramètres

options

OperationOptions

Arguments facultatifs supplémentaires.

Retours

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Récupère des informations sur un SynonymMap.

function getSynonymMap(synonymMapName: string, options?: OperationOptions): Promise<SynonymMap>

Paramètres

synonymMapName

string

Nom du SynonymMap.

options

OperationOptions

Arguments facultatifs supplémentaires.

Retours

Promise<SynonymMap>

listIndexes(OperationOptions)

Récupère une liste d’index existants dans le service.

function listIndexes(options?: OperationOptions): IndexIterator

Paramètres

options

OperationOptions

Options de l’opération d’index de liste.

Retours

IndexIterator

listIndexesNames(OperationOptions)

Récupère une liste de noms d’index existants dans le service.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Paramètres

options

OperationOptions

Options de l’opération d’index de liste.

Retours

IndexNameIterator

listSynonymMaps(OperationOptions)

Récupère une liste de SynonymMaps existants dans le service.

function listSynonymMaps(options?: OperationOptions): Promise<SynonymMap[]>

Paramètres

options

OperationOptions

Options de l’opération de liste SynonymMaps.

Retours

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

Récupère une liste de noms de SynonymMaps existants dans le service.

function listSynonymMapsNames(options?: OperationOptions): Promise<string[]>

Paramètres

options

OperationOptions

Options de l’opération de liste SynonymMaps.

Retours

Promise<string[]>