SearchIndexerClient class

インデクサー、データソース、& スキルセットを管理 (作成、更新、リスト/削除) するための操作を実行するクラス。

コンストラクター

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

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

使用例:

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

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

プロパティ

apiVersion

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

endpoint

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

serviceVersion

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

メソッド

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

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

createIndexer(SearchIndexer, OperationOptions)

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

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

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

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

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

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

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

createSkillset(SearchIndexerSkillset, OperationOptions)

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

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

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

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

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

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

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

getDataSourceConnection(string, OperationOptions)

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

getIndexer(string, OperationOptions)

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

getIndexerStatus(string, OperationOptions)

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

getSkillset(string, OperationOptions)

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

listDataSourceConnections(OperationOptions)

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

listDataSourceConnectionsNames(OperationOptions)

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

listIndexers(OperationOptions)

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

listIndexersNames(OperationOptions)

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

listSkillsets(OperationOptions)

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

listSkillsetsNames(OperationOptions)

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

resetIndexer(string, OperationOptions)

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

runIndexer(string, OperationOptions)

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

コンストラクターの詳細

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

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

使用例:

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)

パラメーター

endpoint

string

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

credential

KeyCredential | TokenCredential

サービスへの要求を認証するために使用されます。

options
SearchIndexerClientOptions

検索クライアントを構成するために使用します。

プロパティの詳細

apiVersion

警告

この API は非推奨になりました。

use {@Link serviceVersion} instead

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

apiVersion: string

プロパティ値

string

endpoint

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

endpoint: string

プロパティ値

string

serviceVersion

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

serviceVersion: string

プロパティ値

string

メソッドの詳細

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

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

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

パラメーター

dataSourceConnection
SearchIndexerDataSourceConnection

検索サービスで作成する dataSource 定義。

options
OperationOptions

追加の省略可能な引数。

戻り値

createIndexer(SearchIndexer, OperationOptions)

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

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

パラメーター

indexer
SearchIndexer

検索サービスで作成するインデクサー定義。

options
OperationOptions

追加の省略可能な引数。

戻り値

Promise<SearchIndexer>

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

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

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

パラメーター

dataSourceConnection
SearchIndexerDataSourceConnection

作成または更新するデータソースを説明する情報。

options
CreateorUpdateDataSourceConnectionOptions

追加の省略可能な引数。

戻り値

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

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

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

パラメーター

indexer
SearchIndexer

作成または更新するインデクサーを説明する情報。

options
CreateorUpdateIndexerOptions

追加の省略可能な引数。

戻り値

Promise<SearchIndexer>

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

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

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

パラメーター

skillset
SearchIndexerSkillset

作成するインデックスを記述する情報。

options
CreateOrUpdateSkillsetOptions

追加の省略可能な引数。

戻り値

createSkillset(SearchIndexerSkillset, OperationOptions)

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

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

パラメーター

skillset
SearchIndexerSkillset

検索サービスで作成する 1 つ以上のスキルを含むスキルセット。

options
OperationOptions

追加の省略可能な引数。

戻り値

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

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

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

パラメーター

dataSourceConnection

string | SearchIndexerDataSourceConnection

options
DeleteDataSourceConnectionOptions

追加の省略可能な引数。

戻り値

Promise<void>

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

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

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

パラメーター

indexer

string | SearchIndexer

削除するインデクサーのインデクサー/名前。

options
DeleteIndexerOptions

追加の省略可能な引数。

戻り値

Promise<void>

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

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

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

パラメーター

skillset

string | SearchIndexerSkillset

削除するスキルセットのスキルセット/名前。

options
DeleteSkillsetOptions

追加の省略可能な引数。

戻り値

Promise<void>

getDataSourceConnection(string, OperationOptions)

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

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

パラメーター

dataSourceConnectionName

string

options
OperationOptions

追加の省略可能な引数

戻り値

getIndexer(string, OperationOptions)

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

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

パラメーター

indexerName

string

インデクサーの名前。

options
OperationOptions

追加の省略可能な引数。

戻り値

Promise<SearchIndexer>

getIndexerStatus(string, OperationOptions)

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

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

パラメーター

indexerName

string

インデクサーの名前。

options
OperationOptions

追加の省略可能な引数。

戻り値

getSkillset(string, OperationOptions)

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

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

パラメーター

skillsetName

string

options
OperationOptions

追加の省略可能な引数。

戻り値

listDataSourceConnections(OperationOptions)

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

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

パラメーター

options
OperationOptions

リスト インデクサー操作のオプション。

戻り値

listDataSourceConnectionsNames(OperationOptions)

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

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

パラメーター

options
OperationOptions

リスト インデクサー操作のオプション。

戻り値

Promise<string[]>

listIndexers(OperationOptions)

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

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

パラメーター

options
OperationOptions

リスト インデクサー操作のオプション。

戻り値

Promise<SearchIndexer[]>

listIndexersNames(OperationOptions)

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

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

パラメーター

options
OperationOptions

リスト インデクサー操作のオプション。

戻り値

Promise<string[]>

listSkillsets(OperationOptions)

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

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

パラメーター

options
OperationOptions

スキルセット操作の一覧に対するオプション。

戻り値

listSkillsetsNames(OperationOptions)

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

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

パラメーター

options
OperationOptions

スキルセット操作の一覧に対するオプション。

戻り値

Promise<string[]>

resetIndexer(string, OperationOptions)

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

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

パラメーター

indexerName

string

リセットするインデクサーの名前。

options
OperationOptions

その他の省略可能な引数。

戻り値

Promise<void>

runIndexer(string, OperationOptions)

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

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

パラメーター

indexerName

string

実行するインデクサーの名前。

options
OperationOptions

その他の省略可能な引数。

戻り値

Promise<void>