SearchIndexClient class

Paket:

@azure/search-documents

Klasse zum Ausführen von Vorgängen zum Verwalten (Erstellen, Aktualisieren, Auflisten/Löschen) von Indizes & Synonymzuordnungen.

Konstruktoren

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Erstellt eine instance von SearchIndexClient. Beispielverwendung: const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

Eigenschaften

apiVersion	Die API-Version, die bei der Kommunikation mit dem Dienst verwendet werden soll.
endpoint	Der Endpunkt des Suchdiensts
serviceVersion	Die API-Version, die bei der Kommunikation mit dem Dienst verwendet werden soll.

Methoden

analyzeText(string, AnalyzeTextOptions)	Ruft ein Analysetool oder tokenizer manuell für bereitgestellten Text auf.
createIndex(SearchIndex, OperationOptions)	Erstellt einen neuen Index.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Erstellt einen neuen Index oder ändert einen vorhandenen Index.
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Erstellt eine neue SynonymMap oder ändert eine vorhandene.
createSynonymMap(SynonymMap, OperationOptions)	Erstellt eine neue SynonymMap in einem Suchdienst.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	Löscht einen vorhandenen Index.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Löscht eine vorhandene SynonymMap.
getIndex(string, OperationOptions)	Ruft Informationen zu einem Index ab.
getIndexStatistics(string, OperationOptions)	Ruft Statistiken zu einem Index ab, z. B. die Anzahl von Dokumenten und die Größe des Indexspeichers.
getSearchClient<TModel>(string, SearchClientOptions)	Ruft den SearchClient ab, der diesem SearchIndexClient entspricht.
getServiceStatistics(OperationOptions)	Ruft Statistiken über den Dienst ab, z. B. anzahl von Dokumenten, Index usw.
getSynonymMap(string, OperationOptions)	Ruft Informationen zu einer SynonymMap ab.
listIndexes(OperationOptions)	Ruft eine Liste der vorhandenen Indizes im Dienst ab.
listIndexesNames(OperationOptions)	Ruft eine Liste der Namen vorhandener Indizes im Dienst ab.
listSynonymMaps(OperationOptions)	Ruft eine Liste der vorhandenen SynonymMaps im Dienst ab.
listSynonymMapsNames(OperationOptions)	Ruft eine Liste der Namen vorhandener SynonymMaps im Dienst ab.

Details zum Konstruktor

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

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

endpoint

string

Der Endpunkt des Suchdiensts

credential

KeyCredential | TokenCredential

Wird verwendet, um Anforderungen an den Dienst zu authentifizieren.

options

SearchIndexClientOptions

Wird zum Konfigurieren des Suchindexclients verwendet.

Details zur Eigenschaft

apiVersion

Warnung

Diese API ist nun veraltet.

use {@Link serviceVersion} instead

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

apiVersion: string

Eigenschaftswert

string

endpoint

Der Endpunkt des Suchdiensts

endpoint: string

Eigenschaftswert

string

serviceVersion

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

serviceVersion: string

Eigenschaftswert

string

Details zur Methode

analyzeText(string, AnalyzeTextOptions)

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

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

Parameter

indexName

string

Der Name des Indexes, der das zu analysierende Feld enthält.

options

AnalyzeTextOptions

Zusätzliche Argumente

Gibt zurück

Promise<AnalyzeResult>

createIndex(SearchIndex, OperationOptions)

Erstellt einen neuen Index.

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

Parameter

index

SearchIndex

Die Informationen, die den zu erstellenden Index beschreiben.

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchIndex>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

Erstellt einen neuen Index oder ändert einen vorhandenen Index.

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

Parameter

index

SearchIndex

Die Informationen, die den zu erstellenden Index beschreiben.

options

CreateOrUpdateIndexOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchIndex>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Erstellt eine neue SynonymMap oder ändert eine vorhandene.

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

Parameter

synonymMap

SynonymMap

Die Informationen, die die zu erstellende SynonymMap beschreiben.

options

CreateOrUpdateSynonymMapOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Erstellt eine neue SynonymMap in einem Suchdienst.

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

Parameter

synonymMap

SynonymMap

Die definition synonymMap, die in einem Suchdienst erstellt werden soll.

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Löscht einen vorhandenen Index.

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

Parameter

index

string | SearchIndex

options

DeleteIndexOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Löscht eine vorhandene SynonymMap.

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

Parameter

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<void>

getIndex(string, OperationOptions)

Ruft Informationen zu einem Index ab.

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

Parameter

indexName

string

Der Name des Index.

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

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

indexName

string

Der Name des Index.

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchIndexStatistics>

getSearchClient<TModel>(string, SearchClientOptions)

Ruft den SearchClient ab, der diesem SearchIndexClient entspricht.

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

Parameter

indexName

string

Name des Indexes.

options

SearchClientOptions

SearchClient-Optionen

Gibt zurück

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Ruft Statistiken über den Dienst ab, z. B. anzahl von Dokumenten, Index usw.

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

Parameter

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Ruft Informationen zu einer SynonymMap ab.

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

Parameter

synonymMapName

string

Der Name der SynonymMap.

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SynonymMap>

listIndexes(OperationOptions)

Ruft eine Liste der vorhandenen Indizes im Dienst ab.

function listIndexes(options?: OperationOptions): IndexIterator

Parameter

options

OperationOptions

Optionen für den Listenindexvorgang.

Gibt zurück

IndexIterator

listIndexesNames(OperationOptions)

Ruft eine Liste der Namen vorhandener Indizes im Dienst ab.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parameter

options

OperationOptions

Optionen für den Listenindexvorgang.

Gibt zurück

IndexNameIterator

listSynonymMaps(OperationOptions)

Ruft eine Liste der vorhandenen SynonymMaps im Dienst ab.

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

Parameter

options

OperationOptions

Optionen für den Vorgang SynonymMaps auflisten.

Gibt zurück

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

Ruft eine Liste der Namen vorhandener SynonymMaps im Dienst ab.

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

Parameter

options

OperationOptions

Optionen für den Vorgang SynonymMaps auflisten.

Gibt zurück

Promise<string[]>