你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
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 或修改现有 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)
检索服务中现有 SynonymMap 的名称列表。
function listSynonymMapsNames(options?: OperationOptions): Promise<string[]>参数
- options
- OperationOptions
用于列出 SynonymMaps 操作的选项。
返回
Promise<string[]>