SearchIndexerClient class

Paket:

@azure/search-documents

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

Konstruktoren

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Erstellt eine instance von SearchIndexerClient. Beispielverwendung: const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexerClient( "<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

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)	Erstellt eine neue DataSource in einem Suchdienst.
createIndexer(SearchIndexer, OperationOptions)	Erstellt einen neuen Indexer in einem Suchdienst.
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)	Erstellt eine neue Datenquelle oder ändert eine vorhandene Datenquelle.
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)	Erstellt einen neuen Indexer oder ändert einen vorhandenen Indexer.
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)	Erstellt ein neues Skillset oder ändert ein vorhandenes Skillset.
createSkillset(SearchIndexerSkillset, OperationOptions)	Erstellt ein neues Skillset in einem Suchdienst.
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)	Löscht eine vorhandene Datenquelle.
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)	Löscht einen vorhandenen Indexer.
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)	Löscht ein vorhandenes Skillset.
getDataSourceConnection(string, OperationOptions)	Ruft Informationen zu einer Datenquelle ab.
getIndexer(string, OperationOptions)	Ruft Informationen zu einem Indexer ab.
getIndexerStatus(string, OperationOptions)	Gibt den aktuellen Status und Ausführungsverlauf eines Indexers zurück.
getSkillset(string, OperationOptions)	Ruft Informationen zu einem Skillset ab.
listDataSourceConnections(OperationOptions)	Ruft eine Liste der vorhandenen Datenquellen im Dienst ab.
listDataSourceConnectionsNames(OperationOptions)	Ruft eine Liste der Namen vorhandener Datenquellen im Dienst ab.
listIndexers(OperationOptions)	Ruft eine Liste der vorhandenen Indexer im Dienst ab.
listIndexersNames(OperationOptions)	Ruft eine Liste der Namen vorhandener Indexer im Dienst ab.
listSkillsets(OperationOptions)	Ruft eine Liste der vorhandenen Skillsets im Dienst ab.
listSkillsetsNames(OperationOptions)	Ruft eine Liste der Namen vorhandener Skillsets im Dienst ab.
resetIndexer(string, OperationOptions)	Setzt den Änderungsnachverfolgungsstatus zurück, der einem Indexer zugeordnet ist.
runIndexer(string, OperationOptions)	Führt einen Indexer bei Bedarf aus.

Details zum Konstruktor

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Erstellt eine instance von SearchIndexerClient.

Beispielverwendung:

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

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

new SearchIndexerClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexerClientOptions)

Parameter

endpoint

string

Der Endpunkt des Suchdiensts

credential

KeyCredential | TokenCredential

Wird verwendet, um Anforderungen an den Dienst zu authentifizieren.

options

SearchIndexerClientOptions

Wird zum Konfigurieren des Suchclients 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

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

Erstellt eine neue DataSource in einem Suchdienst.

function createDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parameter

dataSourceConnection

SearchIndexerDataSourceConnection

Die dataSource-Definition, die in einem Suchdienst erstellt werden soll.

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchIndexerDataSourceConnection>

createIndexer(SearchIndexer, OperationOptions)

Erstellt einen neuen Indexer in einem Suchdienst.

function createIndexer(indexer: SearchIndexer, options?: OperationOptions): Promise<SearchIndexer>

Parameter

indexer

SearchIndexer

Die Indexerdefinition, die in einem Suchdienst erstellt werden soll.

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchIndexer>

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

Erstellt eine neue Datenquelle oder ändert eine vorhandene Datenquelle.

function createOrUpdateDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: CreateorUpdateDataSourceConnectionOptions): Promise<SearchIndexerDataSourceConnection>

Parameter

dataSourceConnection

SearchIndexerDataSourceConnection

Die Informationen, die die zu erstellende/zu aktualisierende Datenquelle beschreiben.

options

CreateorUpdateDataSourceConnectionOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchIndexerDataSourceConnection>

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

Erstellt einen neuen Indexer oder ändert einen vorhandenen Indexer.

function createOrUpdateIndexer(indexer: SearchIndexer, options?: CreateorUpdateIndexerOptions): Promise<SearchIndexer>

Parameter

indexer

SearchIndexer

Die Informationen, die den zu erstellenden/aktualisierenden Indexer beschreiben.

options

CreateorUpdateIndexerOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchIndexer>

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

Erstellt ein neues Skillset oder ändert ein vorhandenes Skillset.

function createOrUpdateSkillset(skillset: SearchIndexerSkillset, options?: CreateOrUpdateSkillsetOptions): Promise<SearchIndexerSkillset>

Parameter

skillset

SearchIndexerSkillset

Die Informationen, die den zu erstellenden Index beschreiben.

options

CreateOrUpdateSkillsetOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchIndexerSkillset>

createSkillset(SearchIndexerSkillset, OperationOptions)

Erstellt ein neues Skillset in einem Suchdienst.

function createSkillset(skillset: SearchIndexerSkillset, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parameter

skillset

SearchIndexerSkillset

Das Skillset, das eine oder mehrere Skills enthält, die in einem Suchdienst erstellt werden sollen.

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchIndexerSkillset>

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

Löscht eine vorhandene Datenquelle.

function deleteDataSourceConnection(dataSourceConnection: string | SearchIndexerDataSourceConnection, options?: DeleteDataSourceConnectionOptions): Promise<void>

Parameter

dataSourceConnection

string | SearchIndexerDataSourceConnection

options

DeleteDataSourceConnectionOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<void>

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

Löscht einen vorhandenen Indexer.

function deleteIndexer(indexer: string | SearchIndexer, options?: DeleteIndexerOptions): Promise<void>

Parameter

indexer

string | SearchIndexer

Indexer/Name des zu löschenden Indexers.

options

DeleteIndexerOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<void>

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

Löscht ein vorhandenes Skillset.

function deleteSkillset(skillset: string | SearchIndexerSkillset, options?: DeleteSkillsetOptions): Promise<void>

Parameter

skillset

string | SearchIndexerSkillset

Skillset/Name des zu löschenden Skillsets.

options

DeleteSkillsetOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<void>

getDataSourceConnection(string, OperationOptions)

Ruft Informationen zu einer Datenquelle ab.

function getDataSourceConnection(dataSourceConnectionName: string, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parameter

dataSourceConnectionName

string

options

OperationOptions

Zusätzliche optionale Argumente

Gibt zurück

Promise<SearchIndexerDataSourceConnection>

getIndexer(string, OperationOptions)

Ruft Informationen zu einem Indexer ab.

function getIndexer(indexerName: string, options?: OperationOptions): Promise<SearchIndexer>

Parameter

indexerName

string

Der Name des Indexers.

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchIndexer>

getIndexerStatus(string, OperationOptions)

Gibt den aktuellen Status und Ausführungsverlauf eines Indexers zurück.

function getIndexerStatus(indexerName: string, options?: OperationOptions): Promise<SearchIndexerStatus>

Parameter

indexerName

string

Der Name des Indexers.

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchIndexerStatus>

getSkillset(string, OperationOptions)

Ruft Informationen zu einem Skillset ab.

function getSkillset(skillsetName: string, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parameter

skillsetName

string

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<SearchIndexerSkillset>

listDataSourceConnections(OperationOptions)

Ruft eine Liste der vorhandenen Datenquellen im Dienst ab.

function listDataSourceConnections(options?: OperationOptions): Promise<SearchIndexerDataSourceConnection[]>

Parameter

options

OperationOptions

Optionen für den Listenindexervorgang.

Gibt zurück

Promise<SearchIndexerDataSourceConnection[]>

listDataSourceConnectionsNames(OperationOptions)

Ruft eine Liste der Namen vorhandener Datenquellen im Dienst ab.

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

Parameter

options

OperationOptions

Optionen für den Listenindexervorgang.

Gibt zurück

Promise<string[]>

listIndexers(OperationOptions)

Ruft eine Liste der vorhandenen Indexer im Dienst ab.

function listIndexers(options?: OperationOptions): Promise<SearchIndexer[]>

Parameter

options

OperationOptions

Optionen für den Listenindizierungsvorgang.

Gibt zurück

Promise<SearchIndexer[]>

listIndexersNames(OperationOptions)

Ruft eine Liste der Namen vorhandener Indexer im Dienst ab.

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

Parameter

options

OperationOptions

Optionen für den Listenindizierungsvorgang.

Gibt zurück

Promise<string[]>

listSkillsets(OperationOptions)

Ruft eine Liste der vorhandenen Skillsets im Dienst ab.

function listSkillsets(options?: OperationOptions): Promise<SearchIndexerSkillset[]>

Parameter

options

OperationOptions

Optionen zum List Skillsets-Vorgang.

Gibt zurück

Promise<SearchIndexerSkillset[]>

listSkillsetsNames(OperationOptions)

Ruft eine Liste der Namen vorhandener Skillsets im Dienst ab.

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

Parameter

options

OperationOptions

Optionen zum List Skillsets-Vorgang.

Gibt zurück

Promise<string[]>

resetIndexer(string, OperationOptions)

Setzt den Änderungsnachverfolgungsstatus zurück, der einem Indexer zugeordnet ist.

function resetIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parameter

indexerName

string

Der Name des zurückzusetzenden Indexers.

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<void>

runIndexer(string, OperationOptions)

Führt einen Indexer bei Bedarf aus.

function runIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parameter

indexerName

string

Der Name des auszuführenden Indexers.

options

OperationOptions

Zusätzliche optionale Argumente.

Gibt zurück

Promise<void>