SearchClient class

パッケージ:

@azure/search-documents

インデックス内のドキュメントのクエリ、追加、更新、削除など、検索インデックスに対する操作を実行するために使用されるクラス。

コンストラクター

SearchClient<TModel>(string, string, KeyCredential | TokenCredential, SearchClientOptions)

SearchClient のインスタンスを作成します。 使用例: const { SearchClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchClient( "<endpoint>", "<indexName>", new AzureKeyCredential("<Admin Key>") ); 必要に応じて、モデルの型を使用して、厳密な型指定と型ヒントを有効にすることができます。 type TModel = { keyName: string; field1?: string | null; field2?: { anotherField?: string | null } | null; }; const client = new SearchClient<TModel>( ... );

プロパティ

apiVersion	サービスと通信するときに使用する API バージョン。
endpoint	検索サービスのエンドポイント
indexName	インデックスの名前
serviceVersion	サービスと通信するときに使用するサービスバージョン。

メソッド

autocomplete(string, string, AutocompleteOptions<TModel>)	ユーザーからの部分的な searchText に基づいて、指定した suggester に基づいて候補候補文字列の一覧を返します。 例 import { AzureKeyCredential, SearchClient, SearchFieldArray, } from "@azure/search-documents"; type TModel = { key: string; azure?: { sdk: string | null } | null; }; const client = new SearchClient<TModel>( "endpoint.azure", "indexName", new AzureKeyCredential("key") ); const searchFields: SearchFieldArray<TModel> = ["azure/sdk"]; const autocompleteResult = await client.autocomplete( "searchText", "suggesterName", { searchFields } );
deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)	一連のドキュメントを削除します。
deleteDocuments(TModel[], IndexDocumentsOptions)	一連のドキュメントを削除します。
getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)	キーでインデックスから特定のドキュメントを取得します。
getDocumentsCount(OperationOptions)	インデックス内のドキュメントの数を取得します。
indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)	特定のドキュメント セットに対して一連のインデックス変更 (アップロード、マージ、mergeOrUpload、削除) を実行します。 この操作は部分的に成功する可能性があり、すべてのドキュメント操作がインデックスに反映されるわけではありません。 これを例外として扱う場合は、 オプションを throwOnAnyFailure true に設定します。 マージのしくみの詳細については、次を参照してください。 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeDocuments(TModel[], IndexDocumentsOptions)	インデックス内の一連のドキュメントを更新します。 マージのしくみの詳細については、次を参照してください。 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)	インデックス内の一連のドキュメントを更新するか、存在しない場合はアップロードします。 マージのしくみの詳細については、次を参照してください。 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
search<TFields>(string, SearchOptions<TModel, TFields>)	指定した引数を指定して、現在のインデックスに対して検索を実行します。 例 import { AzureKeyCredential, SearchClient, SearchFieldArray, } from "@azure/search-documents"; type TModel = { key: string; azure?: { sdk: string | null } | null; }; const client = new SearchClient<TModel>( "endpoint.azure", "indexName", new AzureKeyCredential("key") ); const select = ["azure/sdk"] as const; const searchFields: SearchFieldArray<TModel> = ["azure/sdk"]; const searchResult = await client.search("searchText", { select, searchFields, });
suggest<TFields>(string, string, SuggestOptions<TModel, TFields>)	searchText と指定した suggester に基づいて候補の短いリストを返します。 例 import { AzureKeyCredential, SearchClient, SearchFieldArray, } from "@azure/search-documents"; type TModel = { key: string; azure?: { sdk: string | null } | null; }; const client = new SearchClient<TModel>( "endpoint.azure", "indexName", new AzureKeyCredential("key") ); const select = ["azure/sdk"] as const; const searchFields: SearchFieldArray<TModel> = ["azure/sdk"]; const suggestResult = await client.suggest("searchText", "suggesterName", { select, searchFields, });
uploadDocuments(TModel[], IndexDocumentsOptions)	ドキュメントの配列をインデックスにアップロードします。

コンストラクターの詳細

SearchClient<TModel>(string, string, KeyCredential | TokenCredential, SearchClientOptions)

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

使用例:

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

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

必要に応じて、モデルの型を使用して、厳密な型指定と型ヒントを有効にすることができます。

type TModel = {
  keyName: string;
  field1?: string | null;
  field2?: { anotherField?: string | null } | null;
};

const client = new SearchClient<TModel>(
  ...
);

new SearchClient(endpoint: string, indexName: string, credential: KeyCredential | TokenCredential, options?: SearchClientOptions)

パラメーター

endpoint

string

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

indexName

string

インデックスの名前

credential

KeyCredential | TokenCredential

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

options

SearchClientOptions

Search クライアントを構成するために使用されます。

プロパティの詳細

apiVersion

警告

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

use {@Link serviceVersion} instead

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

apiVersion: string

プロパティ値

string

endpoint

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

endpoint: string

プロパティ値

string

indexName

インデックスの名前

indexName: string

プロパティ値

string

serviceVersion

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

serviceVersion: string

プロパティ値

string

メソッドの詳細

autocomplete(string, string, AutocompleteOptions<TModel>)

ユーザーからの部分的な searchText に基づいて、指定した suggester に基づいて候補候補文字列の一覧を返します。

例

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const autocompleteResult = await client.autocomplete(
  "searchText",
  "suggesterName",
  { searchFields }
);

function autocomplete(searchText: string, suggesterName: string, options?: AutocompleteOptions<TModel>): Promise<AutocompleteResult>

パラメーター

searchText

string

オートコンプリートの結果を基にする検索テキスト。

suggesterName

string

インデックス定義の一部である suggesters コレクションで指定された suggester の名前。

options

AutocompleteOptions<TModel>

オートコンプリート操作のオプション。

戻り値

Promise<AutocompleteResult>

deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

一連のドキュメントを削除します。

function deleteDocuments(keyName: keyof TModel, keyValues: string[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

パラメーター

keyName

keyof TModel

インデックス内の主キーの名前。

keyValues

string[]

削除するドキュメントの主キー値。

options

IndexDocumentsOptions

その他のオプション。

戻り値

Promise<IndexDocumentsResult>

deleteDocuments(TModel[], IndexDocumentsOptions)

一連のドキュメントを削除します。

function deleteDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

パラメーター

documents

TModel[]

削除するドキュメント。

options

IndexDocumentsOptions

その他のオプション。

戻り値

Promise<IndexDocumentsResult>

getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)

キーでインデックスから特定のドキュメントを取得します。

function getDocument<TFields>(key: string, options?: GetDocumentOptions<TModel, TFields>): Promise<NarrowedModel<TModel, TFields>>

パラメーター

key

string

ドキュメントの主キー値

options

GetDocumentOptions<TModel, TFields>

追加オプション

戻り値

Promise<NarrowedModel<TModel, TFields>>

getDocumentsCount(OperationOptions)

インデックス内のドキュメントの数を取得します。

function getDocumentsCount(options?: OperationOptions): Promise<number>

パラメーター

options

OperationOptions

カウント操作のオプション。

戻り値

Promise<number>

indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

特定のドキュメント セットに対して一連のインデックス変更 (アップロード、マージ、mergeOrUpload、削除) を実行します。 この操作は部分的に成功する可能性があり、すべてのドキュメント操作がインデックスに反映されるわけではありません。 これを例外として扱う場合は、 オプションを throwOnAnyFailure true に設定します。 マージのしくみの詳細については、次を参照してください。 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function indexDocuments(batch: IndexDocumentsBatch<TModel>, options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

パラメーター

batch

IndexDocumentsBatch<TModel>

インデックスに対して実行するアクションの配列。

options

IndexDocumentsOptions

その他のオプション。

戻り値

Promise<IndexDocumentsResult>

mergeDocuments(TModel[], IndexDocumentsOptions)

インデックス内の一連のドキュメントを更新します。 マージのしくみの詳細については、次を参照してください。 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function mergeDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

パラメーター

documents

TModel[]

更新されたドキュメント。

options

IndexDocumentsOptions

その他のオプション。

戻り値

Promise<IndexDocumentsResult>

mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

インデックス内の一連のドキュメントを更新するか、存在しない場合はアップロードします。 マージのしくみの詳細については、次を参照してください。 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function mergeOrUploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

パラメーター

documents

TModel[]

更新されたドキュメント。

options

IndexDocumentsOptions

その他のオプション。

戻り値

Promise<IndexDocumentsResult>

search<TFields>(string, SearchOptions<TModel, TFields>)

指定した引数を指定して、現在のインデックスに対して検索を実行します。

例

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const searchResult = await client.search("searchText", {
  select,
  searchFields,
});

function search<TFields>(searchText?: string, options?: SearchOptions<TModel, TFields>): Promise<SearchDocumentsResult<TModel, TFields>>

パラメーター

searchText

string

検索するテキスト

options

SearchOptions<TModel, TFields>

検索操作のオプション。

戻り値

Promise<SearchDocumentsResult<TModel, TFields>>

suggest<TFields>(string, string, SuggestOptions<TModel, TFields>)

searchText と指定した suggester に基づいて候補の短いリストを返します。

例

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const suggestResult = await client.suggest("searchText", "suggesterName", {
  select,
  searchFields,
});

function suggest<TFields>(searchText: string, suggesterName: string, options?: SuggestOptions<TModel, TFields>): Promise<SuggestDocumentsResult<TModel, TFields>>

パラメーター

searchText

string

ドキュメントの提案に使用する検索テキスト。 1 文字以上 100 文字以下で指定する必要があります。

suggesterName

string

インデックス定義の一部である suggesters コレクションで指定された suggester の名前。

options

SuggestOptions<TModel, TFields>

suggest 操作のオプション

戻り値

Promise<SuggestDocumentsResult<TModel, TFields>>

uploadDocuments(TModel[], IndexDocumentsOptions)

ドキュメントの配列をインデックスにアップロードします。

function uploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

パラメーター

documents

TModel[]

アップロードするドキュメント。

options

IndexDocumentsOptions

その他のオプション。

戻り値

Promise<IndexDocumentsResult>