Поделиться через

SearchClient class

Пакет:
@azure/search-documents

Класс, используемый для выполнения операций с индексом поиска, включая запросы документов в индексе, а также добавление, обновление и удаление.

Конструкторы

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

Создает экземпляр SearchClient.

Пример использования:

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

const searchClient = new SearchClient(
  "<endpoint>",
  "<indexName>",
  new AzureKeyCredential("<apiKey>"),
);

При необходимости можно использовать тип модели для включения строгого ввода и указания типов:

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

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

const searchClient = new SearchClient<TModel>(
  "<endpoint>",
  "<indexName>",
  new AzureKeyCredential("<apiKey>"),
);

Свойства

apiVersion

Версия API, используемая при взаимодействии со службой.
endpoint

Конечная точка службы поиска
indexName

Имя индекса
pipeline

Ссылка на внутренний конвейер HTTP для использования с необработанными запросами
serviceVersion

Версия службы, используемая при взаимодействии со службой.

Методы

autocomplete(string, string, AutocompleteOptions<TModel>)

На основе частичного searchText от пользователя возвращает список потенциальных строк завершения на основе указанного средства предложения.

Пример

import { SearchClient, AzureKeyCredential, 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, delete) для заданного набора документов. Эта операция может частично завершиться, и не все операции с документами будут отражены в индексе. Если вы хотите рассматривать это как исключение, задайте для параметра throwOnAnyFailure значение true. Дополнительные сведения о том, как работает слияние, см. в статье https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeDocuments(TModel[], IndexDocumentsOptions)

Обновите набор документов в индексе.

Дополнительные сведения о том, как работает слияние, см. в https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Обновите набор документов в индексе или отправьте их, если они не существуют.

Дополнительные сведения о том, как работает слияние, см. в https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
search<TFields>(string, SearchOptions<TModel, TFields>)

Выполняет поиск по текущему индексу с указанными аргументами.

Пример

import { SearchClient, AzureKeyCredential, 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 и указанного средства предложения.

Пример

import { SearchClient, AzureKeyCredential, 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.

Пример использования:

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

const searchClient = new SearchClient(
  "<endpoint>",
  "<indexName>",
  new AzureKeyCredential("<apiKey>"),
);

При необходимости можно использовать тип модели для включения строгого ввода и указания типов:

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

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

const searchClient = new SearchClient<TModel>(
  "<endpoint>",
  "<indexName>",
  new AzureKeyCredential("<apiKey>"),
);

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

Параметры

endpoint

string

Конечная точка службы поиска

indexName

string

Имя индекса

credential

KeyCredential | TokenCredential

Используется для проверки подлинности запросов к службе.

options
SearchClientOptions

Используется для настройки клиента поиска.

Сведения о свойстве

apiVersion

Предупреждение

Теперь этот API является нерекомендуемым.

use {@Link serviceVersion} instead

Версия API, используемая при взаимодействии со службой.

apiVersion: string

Значение свойства

string

endpoint

Конечная точка службы поиска

endpoint: string

Значение свойства

string

indexName

Имя индекса

indexName: string

Значение свойства

string

pipeline

Ссылка на внутренний конвейер HTTP для использования с необработанными запросами

pipeline: Pipeline

Значение свойства

Pipeline

serviceVersion

Версия службы, используемая при взаимодействии со службой.

serviceVersion: string

Значение свойства

string

Сведения о методе

autocomplete(string, string, AutocompleteOptions<TModel>)

На основе частичного searchText от пользователя возвращает список потенциальных строк завершения на основе указанного средства предложения.

Пример

import { SearchClient, AzureKeyCredential, 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

Имя средства предложения, указанное в коллекции предлагаемых элементов, которые входят в определение индекса.

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, delete) для заданного набора документов. Эта операция может частично завершиться, и не все операции с документами будут отражены в индексе. Если вы хотите рассматривать это как исключение, задайте для параметра throwOnAnyFailure значение true. Дополнительные сведения о том, как работает слияние, см. в статье https://learn.microsoft.com/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://learn.microsoft.com/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://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Параметры

documents

TModel[]

Обновленные документы.

options
IndexDocumentsOptions

Дополнительные параметры.

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

Promise<IndexDocumentsResult>

Выполняет поиск по текущему индексу с указанными аргументами.

Пример

import { SearchClient, AzureKeyCredential, 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 и указанного средства предложения.

Пример

import { SearchClient, AzureKeyCredential, 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

Имя средства предложения, указанное в коллекции предлагаемых элементов, которые входят в определение индекса.

options

SuggestOptions<TModel, TFields>

Параметры для операции предложения

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

Promise<SuggestDocumentsResult<TModel, TFields>>

uploadDocuments(TModel[], IndexDocumentsOptions)

Отправьте массив документов в индекс.

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

Параметры

documents

TModel[]

Документы для отправки.

options
IndexDocumentsOptions

Дополнительные параметры.

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

Promise<IndexDocumentsResult>