SearchIndexClient class

Пакет:

@azure/search-documents

Класс для управления (создание, обновление, удаление) индексов, & синонимов.

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

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Создает экземпляр SearchIndexClient. Пример использования: const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

Свойства

apiVersion	Версия API, используемая при взаимодействии со службой.
endpoint	Конечная точка службы поиска
serviceVersion	Версия API, используемая при взаимодействии со службой.

Методы

analyzeText(string, AnalyzeTextOptions)	Вызывает анализатор или маркеризатор вручную в предоставленном тексте.
createIndex(SearchIndex, OperationOptions)	Создает новый индекс.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Создает новый индекс или изменяет существующий.
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Создает новую карту синонимов или изменяет существующую.
createSynonymMap(SynonymMap, OperationOptions)	Создает новую синоним-карту в службе поиска.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	Удаляет существующий индекс.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Удаляет существующую карту синонимов.
getIndex(string, OperationOptions)	Извлекает сведения об индексе.
getIndexStatistics(string, OperationOptions)	Извлекает статистику по индексу, например количество документов и размер хранилища индексов.
getSearchClient<TModel>(string, SearchClientOptions)	Извлекает searchClient, соответствующий этому SearchIndexClient
getServiceStatistics(OperationOptions)	Извлекает статистику о службе, например количество документов, индексов и т. д.
getSynonymMap(string, OperationOptions)	Извлекает сведения об Синоним-карте.
listIndexes(OperationOptions)	Извлекает список существующих индексов в службе.
listIndexesNames(OperationOptions)	Извлекает список имен существующих индексов в службе.
listSynonymMaps(OperationOptions)	Извлекает список существующих синонимов в службе.
listSynonymMapsNames(OperationOptions)	Извлекает список имен существующих синонимов в службе.

Сведения о конструкторе

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

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

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

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

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

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

Параметры

endpoint

string

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

credential

KeyCredential | TokenCredential

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

options

SearchIndexClientOptions

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

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

apiVersion

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

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

use {@Link serviceVersion} instead

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

apiVersion: string

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

string

endpoint

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

endpoint: string

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

string

serviceVersion

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

serviceVersion: string

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

string

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

analyzeText(string, AnalyzeTextOptions)

Вызывает анализатор или маркеризатор вручную в предоставленном тексте.

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

Параметры

indexName

string

Имя индекса, содержащего поле для анализа

options

AnalyzeTextOptions

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

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

Promise<AnalyzeResult>

createIndex(SearchIndex, OperationOptions)

Создает новый индекс.

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

Параметры

index

SearchIndex

Сведения, описывающие созданный индекс.

options

OperationOptions

Дополнительные необязательные аргументы.

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

Promise<SearchIndex>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

Создает новый индекс или изменяет существующий.

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

Параметры

index

SearchIndex

Сведения, описывающие созданный индекс.

options

CreateOrUpdateIndexOptions

Дополнительные необязательные аргументы.

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

Promise<SearchIndex>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Создает новую карту синонимов или изменяет существующую.

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

Параметры

synonymMap

SynonymMap

Сведения, описывающие созданную карту Синонимов.

options

CreateOrUpdateSynonymMapOptions

Дополнительные необязательные аргументы.

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

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Создает новую синоним-карту в службе поиска.

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

Параметры

synonymMap

SynonymMap

Определение синонима, создаваемое в службе поиска.

options

OperationOptions

Дополнительные необязательные аргументы.

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

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Удаляет существующий индекс.

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

Параметры

index

string | SearchIndex

options

DeleteIndexOptions

Дополнительные необязательные аргументы.

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

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Удаляет существующую карту синонимов.

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

Параметры

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Дополнительные необязательные аргументы.

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

Promise<void>

getIndex(string, OperationOptions)

Извлекает сведения об индексе.

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

Параметры

indexName

string

Имя индекса.

options

OperationOptions

Дополнительные необязательные аргументы.

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

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

Извлекает статистику по индексу, например количество документов и размер хранилища индексов.

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

Параметры

indexName

string

Имя индекса.

options

OperationOptions

Дополнительные необязательные аргументы.

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

Promise<SearchIndexStatistics>

getSearchClient<TModel>(string, SearchClientOptions)

Извлекает searchClient, соответствующий этому SearchIndexClient

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

Параметры

indexName

string

Имя индекса

options

SearchClientOptions

Параметры SearchClient

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

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Извлекает статистику о службе, например количество документов, индексов и т. д.

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

Параметры

options

OperationOptions

Дополнительные необязательные аргументы.

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

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Извлекает сведения об Синоним-карте.

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

Параметры

synonymMapName

string

Имя Синоним-карты.

options

OperationOptions

Дополнительные необязательные аргументы.

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

Promise<SynonymMap>

listIndexes(OperationOptions)

Извлекает список существующих индексов в службе.

function listIndexes(options?: OperationOptions): IndexIterator

Параметры

options

OperationOptions

Параметры операции индекса списка.

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

IndexIterator

listIndexesNames(OperationOptions)

Извлекает список имен существующих индексов в службе.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Параметры

options

OperationOptions

Параметры операции индекса списка.

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

IndexNameIterator

listSynonymMaps(OperationOptions)

Извлекает список существующих синонимов в службе.

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

Параметры

options

OperationOptions

Параметры операции "Синонимы".

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

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

Извлекает список имен существующих синонимов в службе.

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

Параметры

options

OperationOptions

Параметры операции "Синонимы".

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

Promise<string[]>