SearchIndexClient class

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

使用例:

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

const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

new SearchIndexClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexClientOptions)

パラメーター

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

apiVersion: string

プロパティ値

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

endpoint: string

プロパティ値

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

pipeline: Pipeline

プロパティ値

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

serviceVersion: string

プロパティ値

指定されたテキストに対してアナライザーまたはトークナイザーを手動で呼び出します。

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

パラメーター

戻り値

新しい検索エイリアスを作成します。

function createAlias(alias: SearchAlias, options?: OperationOptions): Promise<SearchAlias>

パラメーター

戻り値

新しいインデックスを作成します。

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

パラメーター

戻り値

新しい知識ベースを作り出します。

function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>

パラメーター

戻り値

新しいナレッジソースを作成します。

function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>

パラメーター

戻り値

新しい検索エイリアスを作成するか、エイリアスが既に存在する場合は更新します。

function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchAlias>

パラメーター

戻り値

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

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

パラメーター

戻り値

新しいナレッジベースを作成したり、すでに存在しているナレッジベースを更新します。

function createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise<KnowledgeBase>

パラメーター

戻り値

function createOrUpdateKnowledgeSource(sourceName: string, knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>

パラメーター

戻り値

新しい SynonymMap を作成するか、既存のものを変更します。

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

パラメーター

戻り値

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

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

パラメーター

戻り値

検索エイリアスとそれに関連付けられているインデックスへのマッピングを削除します。 この操作は永続的であり、回復オプションはありません。 マップされたインデックスは、この操作によって変更されません。

function deleteAlias(alias: SearchAlias, options?: DeleteAliasOptions): Promise<void>

パラメーター

戻り値

検索エイリアスとそれに関連付けられているインデックスへのマッピングを削除します。 この操作は永続的であり、回復オプションはありません。 マップされたインデックスは、この操作によって変更されません。

function deleteAlias(aliasName: string, options?: DeleteAliasOptions): Promise<void>

パラメーター

戻り値

既存のインデックスを削除します。

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

パラメーター

戻り値

既存のインデックスを削除します。

function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise<void>

パラメーター

戻り値

既存のナレッジ ベースを削除します。

function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>

パラメーター

戻り値

既存のナレッジ ベースを削除します。

function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>

パラメーター

戻り値

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

function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise<void>

パラメーター

戻り値

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

function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise<void>

パラメーター

戻り値

既存の SynonymMap を削除します。

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

パラメーター

戻り値

エイリアス定義を取得します。

function getAlias(aliasName: string, options?: OperationOptions): Promise<SearchAlias>

パラメーター

戻り値

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

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

パラメーター

戻り値

ドキュメントの数やインデックス ストレージのサイズなど、インデックスに関する統計情報を取得します。

function getIndexStatistics(indexName: string, options?: OperationOptions): Promise<SearchIndexStatistics>

パラメーター

戻り値

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

function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIterator

パラメーター

戻り値

ナレッジベースの定義を取得します。

function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>

パラメーター

戻り値

この SearchIndexClient に対応する KnowledgeRetrievalClient を取得します。

function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClient

パラメーター

戻り値

ナレッジソースの定義を取得します。

function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise<KnowledgeSource>

パラメーター

戻り値

知識ソースの現在の状態と同期履歴を返します。

function getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise<KnowledgeSourceStatus>

パラメーター

戻り値

この SearchIndexClient に対応する SearchClient を取得します。

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

パラメーター

戻り値

ドキュメントの数、インデックスなど、サービスに関する統計情報を取得します。

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

パラメーター

戻り値

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

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

パラメーター

戻り値

検索サービスで使用できるすべてのエイリアスを一覧表示します。

function listAliases(options?: OperationOptions): AliasIterator

パラメーター

戻り値

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

function listIndexes(options?: OperationOptions): IndexIterator

パラメーター

戻り値

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

function listIndexesNames(options?: OperationOptions): IndexNameIterator

パラメーター

戻り値

サービス内の既存のナレッジベースのリストを取得します。

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

パラメーター

戻り値

サービス内の既存の KnowledgeSource のリストを取得します。

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値