SearchIndexClient class

Erstellt eine instance von SearchIndexClient.

Beispielverwendung:

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)

Parameter

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

apiVersion: string

Eigenschaftswert

Der Endpunkt des Suchdiensts

endpoint: string

Eigenschaftswert

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

serviceVersion: string

Eigenschaftswert

Ruft ein Analysetool oder tokenizer manuell für bereitgestellten Text auf.

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

Parameter

Gibt zurück

Erstellt einen neuen Index.

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

Parameter

Gibt zurück

Erstellt einen neuen Index oder ändert einen vorhandenen Index.

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

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 vorhandenen Index.

function deleteIndex(index: string | SearchIndex, options?: DeleteIndexOptions): 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 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 den SearchClient ab, der diesem SearchIndexClient entspricht.

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

Parameter

Gibt zurück

Ruft Statistiken über den Dienst ab, z. B. 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

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