SearchIndexClient class
インデックス、& シノニムマップを管理 (作成、更新、リスト/削除) する操作を実行するクラス。
コンストラクター
| Search |
SearchIndexClient のインスタンスを作成します。 使用例: |
プロパティ
| api |
サービスと通信するときに使用する API バージョン。 |
| endpoint | 検索サービスのエンドポイント |
| service |
サービスと通信するときに使用する API バージョン。 |
メソッド
コンストラクターの詳細
SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)
SearchIndexClient のインスタンスを作成します。
使用例:
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)パラメーター
- endpoint
-
string
検索サービスのエンドポイント
- credential
サービスへの要求を認証するために使用されます。
- options
- SearchIndexClientOptions
検索インデックス クライアントを構成するために使用します。
プロパティの詳細
apiVersion
警告
この API は非推奨になりました。
use {@Link serviceVersion} instead
サービスと通信するときに使用する API バージョン。
apiVersion: stringプロパティ値
string
endpoint
検索サービスのエンドポイント
endpoint: stringプロパティ値
string
serviceVersion
サービスと通信するときに使用する API バージョン。
serviceVersion: stringプロパティ値
string
メソッドの詳細
analyzeText(string, AnalyzeTextOptions)
指定されたテキストに対してアナライザーまたはトークナイザーを手動で呼び出します。
function analyzeText(indexName: string, options: AnalyzeTextOptions): Promise<AnalyzeResult>パラメーター
- indexName
-
string
分析するフィールドを含むインデックスの名前
- options
- AnalyzeTextOptions
追加の引数
戻り値
Promise<AnalyzeResult>
createIndex(SearchIndex, OperationOptions)
新しいインデックスを作成します。
function createIndex(index: SearchIndex, options?: OperationOptions): Promise<SearchIndex>パラメーター
- index
- SearchIndex
作成するインデックスを記述する情報。
- options
- OperationOptions
追加の省略可能な引数。
戻り値
Promise<SearchIndex>
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)
新しいインデックスを作成するか、既存のインデックスを変更します。
function createOrUpdateIndex(index: SearchIndex, options?: CreateOrUpdateIndexOptions): Promise<SearchIndex>パラメーター
- index
- SearchIndex
作成するインデックスを記述する情報。
- options
- CreateOrUpdateIndexOptions
追加の省略可能な引数。
戻り値
Promise<SearchIndex>
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)
新しい SynonymMap を作成するか、既存のものを変更します。
function createOrUpdateSynonymMap(synonymMap: SynonymMap, options?: CreateOrUpdateSynonymMapOptions): Promise<SynonymMap>パラメーター
- synonymMap
- SynonymMap
作成する SynonymMap を説明する情報。
- options
- CreateOrUpdateSynonymMapOptions
追加の省略可能な引数。
戻り値
Promise<SynonymMap>
createSynonymMap(SynonymMap, OperationOptions)
検索サービスに新しい SynonymMap を作成します。
function createSynonymMap(synonymMap: SynonymMap, options?: OperationOptions): Promise<SynonymMap>パラメーター
- synonymMap
- SynonymMap
検索サービスで作成する synonymMap 定義。
- options
- OperationOptions
追加の省略可能な引数。
戻り値
Promise<SynonymMap>
deleteIndex(string | SearchIndex, DeleteIndexOptions)
既存のインデックスを削除します。
function deleteIndex(index: string | SearchIndex, options?: DeleteIndexOptions): Promise<void>パラメーター
- index
-
string | SearchIndex
- options
- DeleteIndexOptions
追加の省略可能な引数。
戻り値
Promise<void>
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)
既存の SynonymMap を削除します。
function deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>パラメーター
- synonymMap
-
string | SynonymMap
- options
- DeleteSynonymMapOptions
追加の省略可能な引数。
戻り値
Promise<void>
getIndex(string, OperationOptions)
インデックスに関する情報を取得します。
function getIndex(indexName: string, options?: OperationOptions): Promise<SearchIndex>パラメーター
- indexName
-
string
インデックスの名前です。
- options
- OperationOptions
追加の省略可能な引数。
戻り値
Promise<SearchIndex>
getIndexStatistics(string, OperationOptions)
ドキュメントの数やインデックス ストレージのサイズなど、インデックスに関する統計を取得します。
function getIndexStatistics(indexName: string, options?: OperationOptions): Promise<SearchIndexStatistics>パラメーター
- indexName
-
string
インデックスの名前です。
- options
- OperationOptions
追加の省略可能な引数。
戻り値
Promise<SearchIndexStatistics>
getSearchClient<TModel>(string, SearchClientOptions)
この SearchIndexClient に対応する SearchClient を取得します
function getSearchClient<TModel>(indexName: string, options?: SearchClientOptions): SearchClient<TModel>パラメーター
- indexName
-
string
インデックス名。
- options
- SearchClientOptions
SearchClient オプション
戻り値
SearchClient<TModel>
getServiceStatistics(OperationOptions)
ドキュメント、インデックスなどのサービスに関する統計情報を取得します。
function getServiceStatistics(options?: OperationOptions): Promise<SearchServiceStatistics>パラメーター
- options
- OperationOptions
追加の省略可能な引数。
戻り値
Promise<SearchServiceStatistics>
getSynonymMap(string, OperationOptions)
SynonymMap に関する情報を取得します。
function getSynonymMap(synonymMapName: string, options?: OperationOptions): Promise<SynonymMap>パラメーター
- synonymMapName
-
string
SynonymMap の名前。
- options
- OperationOptions
追加の省略可能な引数。
戻り値
Promise<SynonymMap>
listIndexes(OperationOptions)
サービス内の既存のインデックスの一覧を取得します。
function listIndexes(options?: OperationOptions): IndexIteratorパラメーター
- options
- OperationOptions
リスト インデックス操作のオプション。
戻り値
listIndexesNames(OperationOptions)
サービス内の既存のインデックスの名前の一覧を取得します。
function listIndexesNames(options?: OperationOptions): IndexNameIteratorパラメーター
- options
- OperationOptions
リスト インデックス操作のオプション。
戻り値
listSynonymMaps(OperationOptions)
サービス内の既存の SynonymMap の一覧を取得します。
function listSynonymMaps(options?: OperationOptions): Promise<SynonymMap[]>パラメーター
- options
- OperationOptions
SynonymMaps 操作の一覧のオプション。
戻り値
Promise<SynonymMap[]>
listSynonymMapsNames(OperationOptions)
サービス内の既存の SynonymMap の名前の一覧を取得します。
function listSynonymMapsNames(options?: OperationOptions): Promise<string[]>パラメーター
- options
- OperationOptions
SynonymMaps 操作の一覧のオプション。
戻り値
Promise<string[]>