SearchIndexClient class

Пакет:

@azure/search-documents

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

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

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

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

Свойства

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

Методы

analyzeText(string, AnalyzeTextOptions)	Вызывает анализатор или маркеризатор вручную в предоставленном тексте.
createAlias(SearchAlias, OperationOptions)	Создает новый псевдоним поиска.
createIndex(SearchIndex, OperationOptions)	Создает новый индекс.
createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)	Создаёт новую базу знаний.
createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)	Создает новый источник знаний.
createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)	Создает новый псевдоним поиска или обновляет псевдоним, если он уже существует.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Создает новый индекс или изменяет существующий.
createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)	Создаёт новую базу знаний или обновляет её, если она уже существует.
createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Создает новую карту синонимов или изменяет существующую.
createSynonymMap(SynonymMap, OperationOptions)	Создает новую синоним-карту в службе поиска.
deleteAlias(SearchAlias, DeleteAliasOptions)	Удаляет псевдоним поиска и его связанное сопоставление с индексом. Эта операция является постоянной, без параметра восстановления. Сопоставленный индекс не связан с этой операцией.
deleteAlias(string, DeleteAliasOptions)	Удаляет псевдоним поиска и его связанное сопоставление с индексом. Эта операция является постоянной, без параметра восстановления. Сопоставленный индекс не связан с этой операцией.
deleteIndex(SearchIndex, DeleteIndexOptions)	Удаляет существующий индекс.
deleteIndex(string, DeleteIndexOptions)	Удаляет существующий индекс.
deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)	Удаляет существующую базу знаний.
deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)	Удаляет существующую базу знаний.
deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)	Удаляет существующий источник.
deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)	Удаляет существующий источник.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Удаляет существующую карту синонимов.
getAlias(string, OperationOptions)	Извлекает определение псевдонима.
getIndex(string, OperationOptions)	Извлекает сведения об индексе.
getIndexStatistics(string, OperationOptions)	Извлекает статистику по индексу, например количество документов и размер хранилища индексов.
getIndexStatsSummary(GetIndexStatsSummaryOptions)	Извлекает список существующих индексов в службе.
getKnowledgeBase(string, GetKnowledgeBaseOptions)	Получает определение базы знаний.
getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)	Извлекает KnowledgeRetrievalClient, соответствующий этому SearchIndexClient
getKnowledgeSource(string, GetKnowledgeSourceOptions)	Извлекает определение источника знаний.
getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)	Возвращает текущее состояние и историю синхронизации источника знаний.
getSearchClient<TModel>(string, SearchClientOptions)	Извлекает searchClient, соответствующий этому SearchIndexClient
getServiceStatistics(OperationOptions)	Извлекает статистику о службе, например количество документов, индексов и т. д.
getSynonymMap(string, OperationOptions)	Извлекает сведения об Синоним-карте.
listAliases(OperationOptions)	Выводит список всех псевдонимов, доступных для службы поиска.
listIndexes(OperationOptions)	Извлекает список существующих индексов в службе.
listIndexesNames(OperationOptions)	Извлекает список имен существующих индексов в службе.
listKnowledgeBases(ListKnowledgeBasesOptions)	Получает список существующих баз знаний в сервисе.
listKnowledgeSources(ListKnowledgeSourcesOptions)	Извлекает список существующих источников знаний в службе.
listSynonymMaps(OperationOptions)	Извлекает список существующих синонимов в службе.
listSynonymMapsNames(OperationOptions)	Извлекает список имен существующих синонимов в службе.

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

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

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

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

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

const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

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

pipeline

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

pipeline: Pipeline

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

Pipeline

serviceVersion

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

serviceVersion: string

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

string

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

analyzeText(string, AnalyzeTextOptions)

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

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

Параметры

indexName

string

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

options

AnalyzeTextOptions

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

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

Promise<AnalyzeResult>

createAlias(SearchAlias, OperationOptions)

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

function createAlias(alias: SearchAlias, options?: OperationOptions): Promise<SearchAlias>

Параметры

alias

SearchAlias

Определение создаваемого псевдонима.

options

OperationOptions

Параметры параметров.

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

Promise<SearchAlias>

createIndex(SearchIndex, OperationOptions)

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

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

Параметры

index

SearchIndex

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

options

OperationOptions

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

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

Promise<SearchIndex>

createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)

Создаёт новую базу знаний.

function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>

Параметры

knowledgeBase

KnowledgeBase

Определение базы знаний для создания.

options

CreateKnowledgeBaseOptions

параметры опций.

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

Promise<KnowledgeBase>

createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)

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

function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>

Параметры

knowledgeSource

KnowledgeSource

Определение источника знаний, который необходимо создать.

options

CreateKnowledgeSourceOptions

Параметры параметров.

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

Promise<KnowledgeSource>

createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)

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

function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchAlias>

Параметры

alias

SearchAlias

Определение псевдонима для создания или обновления.

options

CreateOrUpdateAliasOptions

Параметры параметров.

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

Promise<SearchAlias>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

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

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

Параметры

index

SearchIndex

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

options

CreateOrUpdateIndexOptions

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

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

Promise<SearchIndex>

createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)

Создаёт новую базу знаний или обновляет её, если она уже существует.

function createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise<KnowledgeBase>

Параметры

knowledgeBaseName

string

Название базы знаний для создания или обновления.

knowledgeBase

KnowledgeBase

определение базы знаний для создания или обновления.

options

CreateOrUpdateKnowledgeBaseOptions

параметры опций.

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

Promise<KnowledgeBase>

createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)

function createOrUpdateKnowledgeSource(sourceName: string, knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>

Параметры

sourceName

string

knowledgeSource

KnowledgeSource

options

CreateOrUpdateKnowledgeSourceOptions

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

Promise<KnowledgeSource>

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>

deleteAlias(SearchAlias, DeleteAliasOptions)

Удаляет псевдоним поиска и его связанное сопоставление с индексом. Эта операция является постоянной, без параметра восстановления. Сопоставленный индекс не связан с этой операцией.

function deleteAlias(alias: SearchAlias, options?: DeleteAliasOptions): Promise<void>

Параметры

alias

SearchAlias

Псевдоним для удаления.

options

DeleteAliasOptions

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

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

Promise<void>

deleteAlias(string, DeleteAliasOptions)

Удаляет псевдоним поиска и его связанное сопоставление с индексом. Эта операция является постоянной, без параметра восстановления. Сопоставленный индекс не связан с этой операцией.

function deleteAlias(aliasName: string, options?: DeleteAliasOptions): Promise<void>

Параметры

aliasName

string

Имя удаляемого псевдонима.

options

DeleteAliasOptions

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

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

Promise<void>

deleteIndex(SearchIndex, DeleteIndexOptions)

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

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

Параметры

index

SearchIndex

Индекс, который нужно удалить.

options

DeleteIndexOptions

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

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

Promise<void>

deleteIndex(string, DeleteIndexOptions)

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

function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise<void>

Параметры

indexName

string

Имя индекса, который нужно удалить.

options

DeleteIndexOptions

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

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

Promise<void>

deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)

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

function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>

Параметры

knowledgeBase

KnowledgeBase

База знаний для удаления.

options

DeleteKnowledgeBaseOptions

параметры опций.

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

Promise<void>

deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)

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

function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>

Параметры

knowledgeBaseName

string

Название базы знаний для удаления.

options

DeleteKnowledgeBaseOptions

параметры опций.

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

Promise<void>

deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)

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

function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise<void>

Параметры

source

KnowledgeSource

источник знаний для удаления.

options

DeleteKnowledgeSourceOptions

параметры опций.

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

Promise<void>

deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)

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

function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise<void>

Параметры

sourceName

string

Имя источника знаний, который необходимо удалить.

options

DeleteKnowledgeSourceOptions

параметры опций.

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

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

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

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

Параметры

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

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

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

Promise<void>

getAlias(string, OperationOptions)

Извлекает определение псевдонима.

function getAlias(aliasName: string, options?: OperationOptions): Promise<SearchAlias>

Параметры

aliasName

string

Имя извлекаемого псевдонима.

options

OperationOptions

Параметры параметров.

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

Promise<SearchAlias>

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>

getIndexStatsSummary(GetIndexStatsSummaryOptions)

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

function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIterator

Параметры

options

GetIndexStatsSummaryOptions

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

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

IndexStatisticsSummaryIterator

getKnowledgeBase(string, GetKnowledgeBaseOptions)

Получает определение базы знаний.

function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>

Параметры

knowledgeBaseName

string

Название базы знаний для извлечения.

options

GetKnowledgeBaseOptions

параметры опций.

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

Promise<KnowledgeBase>

getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)

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

function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClient

Параметры

knowledgeBaseName

string

Название базы знаний

options

KnowledgeRetrievalClientOptions

KnowledgeRetrievalОпции клиента

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

KnowledgeRetrievalClient

getKnowledgeSource(string, GetKnowledgeSourceOptions)

Извлекает определение источника знаний.

function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise<KnowledgeSource>

Параметры

sourceName

string

Имя источника знаний для извлечения.

options

GetKnowledgeSourceOptions

Параметры параметров.

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

Promise<KnowledgeSource>

getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)

Возвращает текущее состояние и историю синхронизации источника знаний.

function getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise<KnowledgeSourceStatus>

Параметры

sourceName

string

Имя источника знаний, для которого необходимо получить статус.

options

GetKnowledgeSourceStatusOptions

Параметры параметров.

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

Promise<KnowledgeSourceStatus>

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>

listAliases(OperationOptions)

Выводит список всех псевдонимов, доступных для службы поиска.

function listAliases(options?: OperationOptions): AliasIterator

Параметры

options

OperationOptions

Параметры параметров.

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

AliasIterator

listIndexes(OperationOptions)

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

function listIndexes(options?: OperationOptions): IndexIterator

Параметры

options

OperationOptions

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

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

IndexIterator

listIndexesNames(OperationOptions)

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

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Параметры

options

OperationOptions

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

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

IndexNameIterator

listKnowledgeBases(ListKnowledgeBasesOptions)

Получает список существующих баз знаний в сервисе.

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

Параметры

options

ListKnowledgeBasesOptions

Опции к работе списка баз знаний.

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

KnowledgeBaseIterator

listKnowledgeSources(ListKnowledgeSourcesOptions)

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

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

Параметры

options

ListKnowledgeSourcesOptions

Опции для работы со списком источников знаний.

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

KnowledgeSourceIterator

listSynonymMaps(OperationOptions)

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

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

Параметры

options

OperationOptions

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

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

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

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

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

Параметры

options

OperationOptions

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

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

Promise<string[]>