SearchIndexerClient class

Пакет:

@azure/search-documents

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

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

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

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

Свойства

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

Методы

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)	Создает новый dataSource в службе поиска.
createIndexer(SearchIndexer, OperationOptions)	Создает новый индексатор в службе поиска.
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)	Создает новый источник данных или изменяет существующий.
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)	Создает новый индексатор или изменяет существующий.
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)	Создает новый набор навыков или изменяет существующий.
createSkillset(SearchIndexerSkillset, OperationOptions)	Создает новый набор навыков в службе поиска.
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)	Удаляет существующий источник данных.
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)	Удаляет существующий индексатор.
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)	Удаляет существующий набор навыков.
getDataSourceConnection(string, OperationOptions)	Извлекает сведения об источнике данных.
getIndexer(string, OperationOptions)	Извлекает сведения об индексаторе.
getIndexerStatus(string, OperationOptions)	Возвращает текущее состояние и журнал выполнений индексатора.
getSkillset(string, OperationOptions)	Извлекает сведения о наборе навыков.
listDataSourceConnections(OperationOptions)	Извлекает список существующих источников данных в службе.
listDataSourceConnectionsNames(OperationOptions)	Извлекает список имен существующих источников данных в службе.
listIndexers(OperationOptions)	Извлекает список существующих индексаторов в службе.
listIndexersNames(OperationOptions)	Извлекает список имен существующих индексаторов в службе.
listSkillsets(OperationOptions)	Извлекает список существующих наборов навыков в службе.
listSkillsetsNames(OperationOptions)	Извлекает список имен существующих наборов навыков в службе.
resetIndexer(string, OperationOptions)	Сбрасывает состояние отслеживания изменений, связанное с индексатором.
runIndexer(string, OperationOptions)	Запускает индексатор по запросу.

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

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

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

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

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

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

new SearchIndexerClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexerClientOptions)

Параметры

endpoint

string

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

credential

KeyCredential | TokenCredential

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

options

SearchIndexerClientOptions

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

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

apiVersion

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

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

use {@Link serviceVersion} instead

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

apiVersion: string

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

string

endpoint

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

endpoint: string

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

string

serviceVersion

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

serviceVersion: string

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

string

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

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

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

function createDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Параметры

dataSourceConnection

SearchIndexerDataSourceConnection

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

options

OperationOptions

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

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

Promise<SearchIndexerDataSourceConnection>

createIndexer(SearchIndexer, OperationOptions)

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

function createIndexer(indexer: SearchIndexer, options?: OperationOptions): Promise<SearchIndexer>

Параметры

indexer

SearchIndexer

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

options

OperationOptions

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

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

Promise<SearchIndexer>

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

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

function createOrUpdateDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: CreateorUpdateDataSourceConnectionOptions): Promise<SearchIndexerDataSourceConnection>

Параметры

dataSourceConnection

SearchIndexerDataSourceConnection

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

options

CreateorUpdateDataSourceConnectionOptions

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

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

Promise<SearchIndexerDataSourceConnection>

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

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

function createOrUpdateIndexer(indexer: SearchIndexer, options?: CreateorUpdateIndexerOptions): Promise<SearchIndexer>

Параметры

indexer

SearchIndexer

Сведения, описывающие индексатор, который необходимо создать или обновить.

options

CreateorUpdateIndexerOptions

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

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

Promise<SearchIndexer>

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

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

function createOrUpdateSkillset(skillset: SearchIndexerSkillset, options?: CreateOrUpdateSkillsetOptions): Promise<SearchIndexerSkillset>

Параметры

skillset

SearchIndexerSkillset

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

options

CreateOrUpdateSkillsetOptions

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

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

Promise<SearchIndexerSkillset>

createSkillset(SearchIndexerSkillset, OperationOptions)

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

function createSkillset(skillset: SearchIndexerSkillset, options?: OperationOptions): Promise<SearchIndexerSkillset>

Параметры

skillset

SearchIndexerSkillset

Набор навыков, содержащий один или несколько навыков для создания в службе поиска.

options

OperationOptions

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

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

Promise<SearchIndexerSkillset>

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

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

function deleteDataSourceConnection(dataSourceConnection: string | SearchIndexerDataSourceConnection, options?: DeleteDataSourceConnectionOptions): Promise<void>

Параметры

dataSourceConnection

string | SearchIndexerDataSourceConnection

options

DeleteDataSourceConnectionOptions

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

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

Promise<void>

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

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

function deleteIndexer(indexer: string | SearchIndexer, options?: DeleteIndexerOptions): Promise<void>

Параметры

indexer

string | SearchIndexer

Индексатор/имя удаляемого индексатора.

options

DeleteIndexerOptions

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

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

Promise<void>

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

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

function deleteSkillset(skillset: string | SearchIndexerSkillset, options?: DeleteSkillsetOptions): Promise<void>

Параметры

skillset

string | SearchIndexerSkillset

Набор навыков или имя набора навыков для удаления.

options

DeleteSkillsetOptions

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

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

Promise<void>

getDataSourceConnection(string, OperationOptions)

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

function getDataSourceConnection(dataSourceConnectionName: string, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Параметры

dataSourceConnectionName

string

options

OperationOptions

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

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

Promise<SearchIndexerDataSourceConnection>

getIndexer(string, OperationOptions)

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

function getIndexer(indexerName: string, options?: OperationOptions): Promise<SearchIndexer>

Параметры

indexerName

string

Имя индексатора.

options

OperationOptions

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

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

Promise<SearchIndexer>

getIndexerStatus(string, OperationOptions)

Возвращает текущее состояние и журнал выполнений индексатора.

function getIndexerStatus(indexerName: string, options?: OperationOptions): Promise<SearchIndexerStatus>

Параметры

indexerName

string

Имя индексатора.

options

OperationOptions

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

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

Promise<SearchIndexerStatus>

getSkillset(string, OperationOptions)

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

function getSkillset(skillsetName: string, options?: OperationOptions): Promise<SearchIndexerSkillset>

Параметры

skillsetName

string

options

OperationOptions

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

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

Promise<SearchIndexerSkillset>

listDataSourceConnections(OperationOptions)

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

function listDataSourceConnections(options?: OperationOptions): Promise<SearchIndexerDataSourceConnection[]>

Параметры

options

OperationOptions

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

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

Promise<SearchIndexerDataSourceConnection[]>

listDataSourceConnectionsNames(OperationOptions)

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

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

Параметры

options

OperationOptions

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

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

Promise<string[]>

listIndexers(OperationOptions)

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

function listIndexers(options?: OperationOptions): Promise<SearchIndexer[]>

Параметры

options

OperationOptions

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

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

Promise<SearchIndexer[]>

listIndexersNames(OperationOptions)

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

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

Параметры

options

OperationOptions

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

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

Promise<string[]>

listSkillsets(OperationOptions)

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

function listSkillsets(options?: OperationOptions): Promise<SearchIndexerSkillset[]>

Параметры

options

OperationOptions

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

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

Promise<SearchIndexerSkillset[]>

listSkillsetsNames(OperationOptions)

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

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

Параметры

options

OperationOptions

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

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

Promise<string[]>

resetIndexer(string, OperationOptions)

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

function resetIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Параметры

indexerName

string

Имя сбрасываемого индексатора.

options

OperationOptions

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

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

Promise<void>

runIndexer(string, OperationOptions)

Запускает индексатор по запросу.

function runIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Параметры

indexerName

string

Имя выполняющегося индексатора.

options

OperationOptions

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

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

Promise<void>