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)	建立新的 Skillset 或修改現有的技能集。
createSkillset(SearchIndexerSkillset, OperationOptions)	在搜尋服務中建立新的技能集。
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)	刪除現有的數據源。
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)	刪除現有的索引器。
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)	刪除現有的技能集。
getDataSourceConnection(string, OperationOptions)	擷取 DataSource 的相關信息
getIndexer(string, OperationOptions)	擷取索引器的相關信息。
getIndexerStatus(string, OperationOptions)	傳回索引子的目前狀態和執行記錄。
getSkillset(string, OperationOptions)	擷取技能集的相關信息。
listDataSourceConnections(OperationOptions)	擷取服務中現有數據源的清單。
listDataSourceConnectionsNames(OperationOptions)	擷取服務中現有數據源的名稱清單。
listIndexers(OperationOptions)	擷取服務中現有索引器的清單。
listIndexersNames(OperationOptions)	擷取服務中現有索引器的名稱清單。
listSkillsets(OperationOptions)	擷取服務中現有技能集的清單。
listSkillsetsNames(OperationOptions)	擷取服務中現有 Skillset 的名稱清單。
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)

建立新的 Skillset 或修改現有的技能集。

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)

擷取 DataSource 的相關信息

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)

擷取服務中現有 Skillset 的名稱清單。

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>