SearchIndexClient class
執行作業以管理 (建立、更新、列出/刪除) 索引的類別，& 同義字對應。
建構函式
| Search |
建立 SearchIndexClient 的實例。 使用方式範例： |
屬性
| api |
與服務通訊時要使用的 API 版本。 |
| endpoint | 搜尋服務的端點 |
| service |
與服務通訊時要使用的 API 版本。 |
方法
建構函式詳細資料
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
用來驗證對服務的要求。
- options
- SearchIndexClientOptions
用來設定搜尋索引用戶端。
屬性詳細資料
apiVersion
警告
此 API 現已淘汰。
use {@Link serviceVersion} instead
與服務通訊時要使用的 API 版本。
apiVersion: string屬性值
string
endpoint
搜尋服務的端點
endpoint: string屬性值
string
serviceVersion
與服務通訊時要使用的 API 版本。
serviceVersion: string屬性值
string
方法詳細資料
analyzeText(string, AnalyzeTextOptions)
在提供的文字上手動呼叫分析器或 Tokenizer。
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)
擷取對應至此 SearchIndexClient 的 SearchClient
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
清單索引作業的選項。
傳回
listIndexesNames(OperationOptions)
擷取服務中現有索引的名稱清單。
function listIndexesNames(options?: OperationOptions): IndexNameIterator參數
- options
- OperationOptions
清單索引作業的選項。
傳回
listSynonymMaps(OperationOptions)
擷取服務中現有 SynonymMap 的清單。
function listSynonymMaps(options?: OperationOptions): Promise<SynonymMap[]>參數
- options
- OperationOptions
清單 SynonymMaps 作業的選項。
傳回
Promise<SynonymMap[]>
listSynonymMapsNames(OperationOptions)
擷取服務中現有 SynonymMaps 的名稱清單。
function listSynonymMapsNames(options?: OperationOptions): Promise<string[]>參數
- options
- OperationOptions
清單 SynonymMaps 作業的選項。
傳回
Promise<string[]>