SearchIndexerClient class

SearchIndexerClient のインスタンスを作成します。

使用例:

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

const indexerClient = new SearchIndexerClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

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

パラメーター

サービスと通信するときに使用する API バージョン。

apiVersion: string

プロパティ値

検索サービスのエンドポイント

endpoint: string

プロパティ値

生の要求で使用する内部 HTTP パイプラインへの参照

pipeline: Pipeline

プロパティ値

サービスと通信するときに使用する API バージョン。

serviceVersion: string

プロパティ値

検索サービスに新しいデータソースを作成します。

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

パラメーター

戻り値

検索サービスに新しいインデクサーを作成します。

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

パラメーター

戻り値

新しいデータソースを作成するか、既存のデータソースを変更します。

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

パラメーター

戻り値

新しいインデクサーを作成するか、既存のインデクサーを変更します。

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

パラメーター

戻り値

新しいスキルセットを作成するか、既存のスキルセットを変更します。

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

パラメーター

戻り値

検索サービスに新しいスキルセットを作成します。

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

パラメーター

戻り値

既存のデータソースを削除します。

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

パラメーター

戻り値

既存のインデクサーを削除します。

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

パラメーター

戻り値

既存のスキルセットを削除します。

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

パラメーター

戻り値

DataSource に関する情報を取得します。

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

パラメーター

戻り値

インデクサーに関する情報を取得します。

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

パラメーター

戻り値

インデクサーの現在の状態と実行履歴を返します。

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

パラメーター

戻り値

スキルセットに関する情報を取得します。

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

パラメーター

戻り値

サービス内の既存のデータ ソースの一覧を取得します。

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

パラメーター

戻り値

サービス内の既存のデータ ソースの名前の一覧を取得します。

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

パラメーター

戻り値

サービス内の既存のインデクサーの一覧を取得します。

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

パラメーター

戻り値

サービス内の既存のインデクサーの名前の一覧を取得します。

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

パラメーター

戻り値

サービス内の既存のスキルセットの一覧を取得します。

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

パラメーター

戻り値

サービス内の既存のスキルセットの名前の一覧を取得します。

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

パラメーター

戻り値

インデクサーによって選択的に再取り込みされるように、データソース内の特定のドキュメントをリセットします。

function resetDocuments(indexerName: string, options?: ResetDocumentsOptions): Promise<void>

パラメーター

戻り値

インデクサーに関連付けられている変更追跡状態をリセットします。

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

パラメーター

戻り値

検索サービスの既存のスキルセットをリセットします。

function resetSkills(skillsetName: string, options?: ResetSkillsOptions): Promise<void>

パラメーター

戻り値

インデクサーをオンデマンドで実行します。

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

パラメーター

戻り値