你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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>