SearchIndexClient class

Paquet:

@azure/search-documents

Classe pour effectuer des opérations pour gérer les index (créer, mettre à jour, liste/supprimer), & synonymes.

Constructeurs

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Crée une instance de SearchIndexClient. Exemple d’utilisation : import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents"; const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

Propriétés

apiVersion	Version de l’API à utiliser lors de la communication avec le service.
endpoint	Point de terminaison du service de recherche
pipeline	Référence au pipeline HTTP interne à utiliser avec les requêtes brutes
serviceVersion	Version de l’API à utiliser lors de la communication avec le service.

Méthodes

analyzeText(string, AnalyzeTextOptions)	Appelle un analyseur ou un tokenizer manuellement sur le texte fourni.
createAlias(SearchAlias, OperationOptions)	Crée un alias de recherche.
createIndex(SearchIndex, OperationOptions)	Crée un index.
createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)	Cela crée une nouvelle base de connaissances.
createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)	Crée une nouvelle source de connaissances.
createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)	Crée un alias de recherche ou met à jour un alias s’il existe déjà.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Crée un index ou modifie un index existant.
createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)	Crée une nouvelle base de connaissances ou met à jour une base de connaissances si elle existe déjà.
createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Crée un SynonymMap ou modifie un élément existant.
createSynonymMap(SynonymMap, OperationOptions)	Crée un SynonymMap dans un service de recherche.
deleteAlias(SearchAlias, DeleteAliasOptions)	Supprime un alias de recherche et son mappage associé à un index. Cette opération est permanente, sans option de récupération. L’index mappé n’est pas touché par cette opération.
deleteAlias(string, DeleteAliasOptions)	Supprime un alias de recherche et son mappage associé à un index. Cette opération est permanente, sans option de récupération. L’index mappé n’est pas touché par cette opération.
deleteIndex(SearchIndex, DeleteIndexOptions)	Supprime un index existant.
deleteIndex(string, DeleteIndexOptions)	Supprime un index existant.
deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)	Supprime une base de connaissances existante.
deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)	Supprime une base de connaissances existante.
deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)	Supprime une source existante.
deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)	Supprime une source existante.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Supprime un SynonymMap existant.
getAlias(string, OperationOptions)	Récupère une définition d’alias.
getIndex(string, OperationOptions)	Récupère des informations sur un index.
getIndexStatistics(string, OperationOptions)	Récupère des statistiques sur un index, telles que le nombre de documents et la taille du stockage d’index.
getIndexStatsSummary(GetIndexStatsSummaryOptions)	Récupère une liste d’index existants dans le service.
getKnowledgeBase(string, GetKnowledgeBaseOptions)	Récupère une définition de base de connaissances.
getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)	Récupère le KnowledgeRetrievalClient correspondant à ce SearchIndexClient
getKnowledgeSource(string, GetKnowledgeSourceOptions)	Récupère une définition de source de connaissances.
getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)	Retourne l’état actuel et l’historique de synchronisation d’une source de connaissances.
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, d’index, etc.
getSynonymMap(string, OperationOptions)	Récupère des informations sur un SynonymMap.
listAliases(OperationOptions)	Répertorie tous les alias disponibles pour un service de recherche.
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.
listKnowledgeBases(ListKnowledgeBasesOptions)	Récupère une liste des bases de connaissances existantes dans le service.
listKnowledgeSources(ListKnowledgeSourcesOptions)	Récupère la liste des KnowledgeSources existantes dans le service.
listSynonymMaps(OperationOptions)	Récupère une liste des 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 une instance de SearchIndexClient.

Exemple d’utilisation :

import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents";

const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

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 auprès du 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

pipeline

Référence au pipeline HTTP interne à utiliser avec les requêtes brutes

pipeline: Pipeline

Valeur de propriété

Pipeline

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 tokenizer 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>

createAlias(SearchAlias, OperationOptions)

Crée un alias de recherche.

function createAlias(alias: SearchAlias, options?: OperationOptions): Promise<SearchAlias>

Paramètres

alias

SearchAlias

La définition de l’alias à créer.

options

OperationOptions

Paramètres d’options.

Retours

Promise<SearchAlias>

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>

createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)

Cela crée une nouvelle base de connaissances.

function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>

Paramètres

knowledgeBase

KnowledgeBase

Définition de la base de connaissances à créer.

options

CreateKnowledgeBaseOptions

options.

Retours

Promise<KnowledgeBase>

createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)

Crée une nouvelle source de connaissances.

function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>

Paramètres

knowledgeSource

KnowledgeSource

La définition de la source de connaissance à créer.

options

CreateKnowledgeSourceOptions

Paramètres d’options.

Retours

Promise<KnowledgeSource>

createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)

Crée un alias de recherche ou met à jour un alias s’il existe déjà.

function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchAlias>

Paramètres

alias

SearchAlias

Définition de l’alias à créer ou à mettre à jour.

options

CreateOrUpdateAliasOptions

Paramètres d’options.

Retours

Promise<SearchAlias>

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>

createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)

Crée une nouvelle base de connaissances ou met à jour une base de connaissances si elle existe déjà.

function createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise<KnowledgeBase>

Paramètres

knowledgeBaseName

string

Nom de la base de connaissances à créer ou à mettre à jour.

knowledgeBase

KnowledgeBase

Définition de la base de connaissances à créer ou à mettre à jour.

options

CreateOrUpdateKnowledgeBaseOptions

options.

Retours

Promise<KnowledgeBase>

createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)

function createOrUpdateKnowledgeSource(sourceName: string, knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>

Paramètres

sourceName

string

knowledgeSource

KnowledgeSource

options

CreateOrUpdateKnowledgeSourceOptions

Retours

Promise<KnowledgeSource>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Crée un SynonymMap ou modifie un élément 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 de synonymMap à créer dans un service de recherche.

options

OperationOptions

Arguments facultatifs supplémentaires.

Retours

Promise<SynonymMap>

deleteAlias(SearchAlias, DeleteAliasOptions)

Supprime un alias de recherche et son mappage associé à un index. Cette opération est permanente, sans option de récupération. L’index mappé n’est pas touché par cette opération.

function deleteAlias(alias: SearchAlias, options?: DeleteAliasOptions): Promise<void>

Paramètres

alias

SearchAlias

L’alias à supprimer.

options

DeleteAliasOptions

Arguments facultatifs supplémentaires.

Retours

Promise<void>

deleteAlias(string, DeleteAliasOptions)

Supprime un alias de recherche et son mappage associé à un index. Cette opération est permanente, sans option de récupération. L’index mappé n’est pas touché par cette opération.

function deleteAlias(aliasName: string, options?: DeleteAliasOptions): Promise<void>

Paramètres

aliasName

string

Nom de l’alias à supprimer.

options

DeleteAliasOptions

Arguments facultatifs supplémentaires.

Retours

Promise<void>

deleteIndex(SearchIndex, DeleteIndexOptions)

Supprime un index existant.

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

Paramètres

index

SearchIndex

L’index à supprimer.

options

DeleteIndexOptions

Arguments facultatifs supplémentaires.

Retours

Promise<void>

deleteIndex(string, DeleteIndexOptions)

Supprime un index existant.

function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise<void>

Paramètres

indexName

string

Nom de l’index à supprimer.

options

DeleteIndexOptions

Arguments facultatifs supplémentaires.

Retours

Promise<void>

deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)

Supprime une base de connaissances existante.

function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>

Paramètres

knowledgeBase

KnowledgeBase

La base de connaissances à supprimer.

options

DeleteKnowledgeBaseOptions

options.

Retours

Promise<void>

deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)

Supprime une base de connaissances existante.

function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>

Paramètres

knowledgeBaseName

string

Nom de la base de connaissances à supprimer.

options

DeleteKnowledgeBaseOptions

options.

Retours

Promise<void>

deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)

Supprime une source existante.

function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise<void>

Paramètres

source

KnowledgeSource

Source de connaissances à supprimer.

options

DeleteKnowledgeSourceOptions

options.

Retours

Promise<void>

deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)

Supprime une source existante.

function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise<void>

Paramètres

sourceName

string

Nom de la source de connaissances à supprimer.

options

DeleteKnowledgeSourceOptions

options.

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>

getAlias(string, OperationOptions)

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

function getAlias(aliasName: string, options?: OperationOptions): Promise<SearchAlias>

Paramètres

aliasName

string

Nom de l’alias à récupérer.

options

OperationOptions

Paramètres d’options.

Retours

Promise<SearchAlias>

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 des statistiques sur 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>

getIndexStatsSummary(GetIndexStatsSummaryOptions)

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

function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIterator

Paramètres

options

GetIndexStatsSummaryOptions

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

Retours

IndexStatisticsSummaryIterator

getKnowledgeBase(string, GetKnowledgeBaseOptions)

Récupère une définition de base de connaissances.

function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>

Paramètres

knowledgeBaseName

string

Nom de la base de connaissances à récupérer.

options

GetKnowledgeBaseOptions

options.

Retours

Promise<KnowledgeBase>

getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)

Récupère le KnowledgeRetrievalClient correspondant à ce SearchIndexClient

function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClient

Paramètres

knowledgeBaseName

string

Nom de la base de connaissances

options

KnowledgeRetrievalClientOptions

KnowledgeRetrievalOptions du client

Retours

KnowledgeRetrievalClient

getKnowledgeSource(string, GetKnowledgeSourceOptions)

Récupère une définition de source de connaissances.

function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise<KnowledgeSource>

Paramètres

sourceName

string

Nom de la source de connaissances à récupérer.

options

GetKnowledgeSourceOptions

Paramètres d’options.

Retours

Promise<KnowledgeSource>

getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)

Retourne l’état actuel et l’historique de synchronisation d’une source de connaissances.

function getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise<KnowledgeSourceStatus>

Paramètres

sourceName

string

Nom de la source de connaissances pour laquelle récupérer l’état.

options

GetKnowledgeSourceStatusOptions

Paramètres d’options.

Retours

Promise<KnowledgeSourceStatus>

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

Options de recherche client

Retours

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Récupère des statistiques sur le service, telles que le nombre de documents, d’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>

listAliases(OperationOptions)

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

function listAliases(options?: OperationOptions): AliasIterator

Paramètres

options

OperationOptions

Paramètres d’options.

Retours

AliasIterator

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

listKnowledgeBases(ListKnowledgeBasesOptions)

Récupère une liste des bases de connaissances existantes dans le service.

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

Paramètres

options

ListKnowledgeBasesOptions

Options pour la liste de la base de connaissances.

Retours

KnowledgeBaseIterator

listKnowledgeSources(ListKnowledgeSourcesOptions)

Récupère la liste des KnowledgeSources existantes dans le service.

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

Paramètres

options

ListKnowledgeSourcesOptions

Options de l’opération de liste des sources de connaissances.

Retours

KnowledgeSourceIterator

listSynonymMaps(OperationOptions)

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

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

Paramètres

options

OperationOptions

Options de l’opération SynonymMaps de liste.

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 SynonymMaps de liste.

Retours

Promise<string[]>