SearchIndexClient class
인덱스, & 동의어를 관리(만들기, 업데이트, 나열/삭제)하는 작업을 수행하는 클래스입니다.
생성자
| Search |
SearchIndexClient의 instance 만듭니다. 사용 예제: |
속성
| api |
서비스와 통신할 때 사용할 API 버전입니다. |
| endpoint | 검색 서비스의 엔드포인트 |
| service |
서비스와 통신할 때 사용할 API 버전입니다. |
메서드
생성자 세부 정보
SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)
SearchIndexClient의 instance 만듭니다.
사용 예제:
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)
제공된 텍스트에서 분석기 또는 토큰화기를 수동으로 호출합니다.
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
검색 서비스에서 만들 동의어Map 정의입니다.
- 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)
서비스의 기존 SynonymMaps 목록을 검색합니다.
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[]>