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 от пользователя возвращает список потенциальных строк завершения на основе указанного средства подбора.

Пример

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>

Параметры

Возвращаемое значение

Выполните набор изменений индекса (upload, merge, mergeOrUpload, delete) для заданного набора документов. Эта операция может быть частично выполнена, и не все операции с документами будут отражены в индексе. Если вы хотите рассматривать это как исключение, задайте для 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 и указанного средства подбора.

Пример

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>

Параметры

Возвращаемое значение