SearchIndexClient class

Erstellt eine Instanz von SearchIndexClient.

Beispielverwendung:

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

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

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

Parameter

Die API-Version, die bei der Kommunikation mit dem Dienst verwendet werden soll.

apiVersion: string

Eigenschaftswert

Der Endpunkt des Suchdiensts

endpoint: string

Eigenschaftswert

Ein Verweis auf die interne HTTP-Pipeline für die Verwendung mit unformatierten Anforderungen

pipeline: Pipeline

Eigenschaftswert

Die API-Version, die bei der Kommunikation mit dem Dienst verwendet werden soll.

serviceVersion: string

Eigenschaftswert

Ruft einen Analyzer oder Tokenizer manuell auf bereitgestellten Text auf.

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

Parameter

Gibt zurück

Erstellt einen neuen Suchalias.

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

Parameter

Gibt zurück

Erstellt einen neuen Index.

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

Parameter

Gibt zurück

Schafft eine neue Wissensbasis.

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

Parameter

Gibt zurück

Erstellt eine neue Wissensquelle.

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

Parameter

Gibt zurück

Erstellt einen neuen Suchalias oder aktualisiert einen Alias, wenn er bereits vorhanden ist.

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

Parameter

Gibt zurück

Erstellt einen neuen Index oder ändert eine vorhandene.

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

Parameter

Gibt zurück

Erstellt eine neue Wissensdatenbank oder aktualisiert eine, falls sie bereits existiert.

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

Parameter

Gibt zurück

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

Parameter

Gibt zurück

Erstellt eine neue SynonymMap oder ändert eine vorhandene.

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

Parameter

Gibt zurück

Erstellt eine neue SynonymMap in einem Suchdienst.

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

Parameter

Gibt zurück

Löscht einen Suchalias und die zugehörige Zuordnung zu einem Index. Dieser Vorgang ist dauerhaft, ohne Wiederherstellungsoption. Der zugeordnete Index bleibt von diesem Vorgang unberührt.

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

Parameter

Gibt zurück

Löscht einen Suchalias und die zugehörige Zuordnung zu einem Index. Dieser Vorgang ist dauerhaft, ohne Wiederherstellungsoption. Der zugeordnete Index bleibt von diesem Vorgang unberührt.

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

Parameter

Gibt zurück

Löscht einen vorhandenen Index.

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

Parameter

Gibt zurück

Löscht einen vorhandenen Index.

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

Parameter

Gibt zurück

Löscht eine vorhandene Wissensdatenbank.

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

Parameter

Gibt zurück

Löscht eine vorhandene Wissensdatenbank.

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

Parameter

Gibt zurück

Löscht eine vorhandene Quelle.

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

Parameter

Gibt zurück

Löscht eine vorhandene Quelle.

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

Parameter

Gibt zurück

Löscht eine vorhandene SynonymMap.

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

Parameter

Gibt zurück

Ruft eine Aliasdefinition ab.

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

Parameter

Gibt zurück

Ruft Informationen zu einem Index ab.

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

Parameter

Gibt zurück

Ruft Statistiken zu einem Index ab, z. B. die Anzahl von Dokumenten und die Größe des Indexspeichers.

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

Parameter

Gibt zurück

Ruft eine Liste der vorhandenen Indizes im Dienst ab.

function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIterator

Parameter

Gibt zurück

Ruft eine Definition einer Wissensdatenbank ab.

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

Parameter

Gibt zurück

Ruft den KnowledgeRetrievalClient ab, der diesem SearchIndexClient entspricht

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

Parameter

Gibt zurück

Ruft eine Wissensquellendefinition ab.

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

Parameter

Gibt zurück

Gibt den aktuellen Status und den Synchronisationsverlauf einer Wissensquelle zurück.

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

Parameter

Gibt zurück

Ruft den SearchClient ab, der diesem SearchIndexClient entspricht.

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

Parameter

Gibt zurück

Ruft Statistiken zum Dienst ab, z. B. die Anzahl von Dokumenten, Index usw.

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

Parameter

Gibt zurück

Ruft Informationen zu einer SynonymMap ab.

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

Parameter

Gibt zurück

Listet alle Aliase auf, die für einen Suchdienst verfügbar sind.

function listAliases(options?: OperationOptions): AliasIterator

Parameter

Gibt zurück

Ruft eine Liste der vorhandenen Indizes im Dienst ab.

function listIndexes(options?: OperationOptions): IndexIterator

Parameter

Gibt zurück

Ruft eine Liste der Namen vorhandener Indizes im Dienst ab.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parameter

Gibt zurück

Ruft eine Liste der bestehenden KnowledgeBases im Service ab.

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

Parameter

Gibt zurück

Ruft eine Liste der im Service vorhandenen KnowledgeSources ab.

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

Parameter

Gibt zurück

Ruft eine Liste vorhandener SynonymMaps im Dienst ab.

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

Parameter

Gibt zurück

Ruft eine Liste der Namen vorhandener SynonymMaps im Dienst ab.

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

Parameter

Gibt zurück