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)	Создает новый элемент SynonymMap или изменяет существующий.
createSynonymMap(SynonymMap, OperationOptions)	Создает объект SynonymMap в службе поиска.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	Удаляет существующий индекс.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Удаляет существующий Объект SynonymMap.
getIndex(string, OperationOptions)	Извлекает сведения об индексе.
getIndexStatistics(string, OperationOptions)	Извлекает статистику по индексу, например количество документов и размер хранилища индекса.
getSearchClient<TModel>(string, SearchClientOptions)	Извлекает объект SearchClient, соответствующий этому объекту SearchIndexClient.
getServiceStatistics(OperationOptions)	Извлекает статистику о службе, например количество документов, индекс и т. д.
getSynonymMap(string, OperationOptions)	Извлекает сведения о SynonymMap.
listIndexes(OperationOptions)	Извлекает список существующих индексов в службе.
listIndexesNames(OperationOptions)	Извлекает список имен существующих индексов в службе.
listSynonymMaps(OperationOptions)	Извлекает список существующих SynonymMap в службе.
listSynonymMapsNames(OperationOptions)	Извлекает список имен существующих SynonymMap в службе.

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

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)

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

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

Параметры

synonymMap

SynonymMap

Сведения, описывающие создаваемый Объект SynonymMap.

options

CreateOrUpdateSynonymMapOptions

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

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

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Создает объект SynonymMap в службе поиска.

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

Параметры

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)

Удаляет существующий Объект SynonymMap.

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)

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

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

Параметры

synonymMapName

string

Имя SynonymMap.

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)

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

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

Параметры

options

OperationOptions

Параметры для операции списка SynonymMaps.

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

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

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

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

Параметры

options

OperationOptions

Параметры для операции списка SynonymMaps.

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

Promise<string[]>