SearchClient class

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)

パラメーター

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

apiVersion: string

プロパティ値

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

endpoint: string

プロパティ値

インデックスの名前

indexName: string

プロパティ値

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

serviceVersion: string

プロパティ値

ユーザーからの部分的な 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>

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

特定のドキュメント セットに対して一連のインデックス変更 (アップロード、マージ、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>

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

例

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 と指定した 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>>

パラメーター

戻り値

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

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

パラメーター

戻り値