SearchIndexClient class

패키지:

@azure/search-documents

인덱스, & 동의어를 관리(만들기, 업데이트, 나열/삭제)하는 작업을 수행하는 클래스입니다.

생성자

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

SearchIndexClient의 인스턴스를 만듭니다. 사용 예: import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents"; const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

속성

apiVersion	서비스와 통신할 때 사용할 API 버전입니다.
endpoint	검색 서비스의 엔드포인트
pipeline	원시 요청에 사용할 내부 HTTP 파이프라인에 대한 참조
serviceVersion	서비스와 통신할 때 사용할 API 버전입니다.

메서드

analyzeText(string, AnalyzeTextOptions)	제공된 텍스트에서 분석기 또는 토케나이저를 수동으로 호출합니다.
createAlias(SearchAlias, OperationOptions)	새 검색 별칭을 만듭니다.
createIndex(SearchIndex, OperationOptions)	새 인덱스 만들기
createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)	새로운 지식 기반을 만듭니다.
createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)	새 지식 소스를 만듭니다.
createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)	새 검색 별칭을 만들거나 이미 있는 경우 별칭을 업데이트합니다.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	새 인덱스 만들기 또는 기존 인덱스 수정
createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)	새로운 지식 베이스를 만들거나 이미 존재하는 지식 베이스를 업데이트합니다.
createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	새 SynonymMap을 만들거나 기존 SynonymMap을 수정합니다.
createSynonymMap(SynonymMap, OperationOptions)	검색 서비스에서 새 SynonymMap을 만듭니다.
deleteAlias(SearchAlias, DeleteAliasOptions)	검색 별칭 및 인덱스에 대한 관련 매핑을 삭제합니다. 이 작업은 복구 옵션 없이 영구적입니다. 매핑된 인덱스는 이 작업의 영향을 받지 않습니다.
deleteAlias(string, DeleteAliasOptions)	검색 별칭 및 인덱스에 대한 관련 매핑을 삭제합니다. 이 작업은 복구 옵션 없이 영구적입니다. 매핑된 인덱스는 이 작업의 영향을 받지 않습니다.
deleteIndex(SearchIndex, DeleteIndexOptions)	기존 인덱스를 삭제합니다.
deleteIndex(string, DeleteIndexOptions)	기존 인덱스를 삭제합니다.
deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)	기존 기술 자료를 삭제합니다.
deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)	기존 기술 자료를 삭제합니다.
deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)	기존 원본을 삭제합니다.
deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)	기존 원본을 삭제합니다.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	기존 SynonymMap을 삭제합니다.
getAlias(string, OperationOptions)	별칭 정의를 검색합니다.
getIndex(string, OperationOptions)	인덱스에 대한 정보를 검색합니다.
getIndexStatistics(string, OperationOptions)	문서 수 및 인덱스 스토리지 크기와 같은 인덱스에 대한 통계를 검색합니다.
getIndexStatsSummary(GetIndexStatsSummaryOptions)	서비스의 기존 인덱스 목록을 검색합니다.
getKnowledgeBase(string, GetKnowledgeBaseOptions)	지식 기반 정의를 가져옵니다.
getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)	이 SearchIndexClient에 해당하는 KnowledgeRetrievalClient를 검색합니다.
getKnowledgeSource(string, GetKnowledgeSourceOptions)	지식 소스 정의를 검색합니다.
getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)	참조 자료의 현재 상태 및 동기화 기록을 반환합니다.
getSearchClient<TModel>(string, SearchClientOptions)	이 SearchIndexClient에 해당하는 SearchClient를 검색합니다.
getServiceStatistics(OperationOptions)	문서, 인덱스 등과 같은 서비스에 대한 통계를 검색합니다.
getSynonymMap(string, OperationOptions)	SynonymMap에 대한 정보를 검색합니다.
listAliases(OperationOptions)	검색 서비스에 사용할 수 있는 모든 별칭을 나열합니다.
listIndexes(OperationOptions)	서비스의 기존 인덱스 목록을 검색합니다.
listIndexesNames(OperationOptions)	서비스에서 기존 인덱스의 이름 목록을 검색합니다.
listKnowledgeBases(ListKnowledgeBasesOptions)	서비스 내 기존 지식베이스 목록을 검색합니다.
listKnowledgeSources(ListKnowledgeSourcesOptions)	서비스의 기존 KnowledgeSource 목록을 검색합니다.
listSynonymMaps(OperationOptions)	서비스의 기존 SynonymMaps 목록을 검색합니다.
listSynonymMapsNames(OperationOptions)	서비스에서 기존 SynonymMaps의 이름 목록을 검색합니다.

생성자 세부 정보

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

SearchIndexClient의 인스턴스를 만듭니다.

사용 예:

import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents";

const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

new SearchIndexClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexClientOptions)

매개 변수

endpoint

string

검색 서비스의 엔드포인트

credential

KeyCredential | TokenCredential

서비스에 대한 요청을 인증하는 데 사용됩니다.

options

SearchIndexClientOptions

Search Index 클라이언트를 구성하는 데 사용됩니다.

속성 세부 정보

apiVersion

경고

이 API는 이제 사용되지 않습니다.

use {@Link serviceVersion} instead

서비스와 통신할 때 사용할 API 버전입니다.

apiVersion: string

속성 값

string

endpoint

검색 서비스의 엔드포인트

endpoint: string

속성 값

string

pipeline

원시 요청에 사용할 내부 HTTP 파이프라인에 대한 참조

pipeline: Pipeline

속성 값

Pipeline

serviceVersion

서비스와 통신할 때 사용할 API 버전입니다.

serviceVersion: string

속성 값

string

메서드 세부 정보

analyzeText(string, AnalyzeTextOptions)

제공된 텍스트에서 분석기 또는 토케나이저를 수동으로 호출합니다.

function analyzeText(indexName: string, options: AnalyzeTextOptions): Promise<AnalyzeResult>

매개 변수

indexName

string

분석할 필드가 포함된 인덱스의 이름입니다.

options

AnalyzeTextOptions

추가 인수

반환

Promise<AnalyzeResult>

createAlias(SearchAlias, OperationOptions)

새 검색 별칭을 만듭니다.

function createAlias(alias: SearchAlias, options?: OperationOptions): Promise<SearchAlias>

매개 변수

alias

SearchAlias

만들 별칭의 정의입니다.

options

OperationOptions

옵션 매개 변수입니다.

반환

Promise<SearchAlias>

createIndex(SearchIndex, OperationOptions)

새 인덱스 만들기

function createIndex(index: SearchIndex, options?: OperationOptions): Promise<SearchIndex>

매개 변수

index

SearchIndex

만들 인덱스 설명 정보입니다.

options

OperationOptions

추가 선택적 인수입니다.

반환

Promise<SearchIndex>

createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)

새로운 지식 기반을 만듭니다.

function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>

매개 변수

knowledgeBase

KnowledgeBase

만들 지식베이스의 정의.

options

CreateKnowledgeBaseOptions

options 매개변수.

반환

Promise<KnowledgeBase>

createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)

새 지식 소스를 만듭니다.

function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>

매개 변수

knowledgeSource

KnowledgeSource

만들 지식 소스의 정의입니다.

options

CreateKnowledgeSourceOptions

옵션 매개 변수입니다.

반환

Promise<KnowledgeSource>

createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)

새 검색 별칭을 만들거나 이미 있는 경우 별칭을 업데이트합니다.

function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchAlias>

매개 변수

alias

SearchAlias

만들거나 업데이트할 별칭의 정의입니다.

options

CreateOrUpdateAliasOptions

옵션 매개 변수입니다.

반환

Promise<SearchAlias>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

새 인덱스 만들기 또는 기존 인덱스 수정

function createOrUpdateIndex(index: SearchIndex, options?: CreateOrUpdateIndexOptions): Promise<SearchIndex>

매개 변수

index

SearchIndex

만들 인덱스 설명 정보입니다.

options

CreateOrUpdateIndexOptions

추가 선택적 인수입니다.

반환

Promise<SearchIndex>

createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)

새로운 지식 베이스를 만들거나 이미 존재하는 지식 베이스를 업데이트합니다.

function createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise<KnowledgeBase>

매개 변수

knowledgeBaseName

string

생성하거나 업데이트할 지식 베이스 이름.

knowledgeBase

KnowledgeBase

생성 또는 업데이트할 지식 베이스의 정의.

options

CreateOrUpdateKnowledgeBaseOptions

options 매개변수.

반환

Promise<KnowledgeBase>

createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)

function createOrUpdateKnowledgeSource(sourceName: string, knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>

매개 변수

sourceName

string

knowledgeSource

KnowledgeSource

options

CreateOrUpdateKnowledgeSourceOptions

반환

Promise<KnowledgeSource>

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>

deleteAlias(SearchAlias, DeleteAliasOptions)

검색 별칭 및 인덱스에 대한 관련 매핑을 삭제합니다. 이 작업은 복구 옵션 없이 영구적입니다. 매핑된 인덱스는 이 작업의 영향을 받지 않습니다.

function deleteAlias(alias: SearchAlias, options?: DeleteAliasOptions): Promise<void>

매개 변수

alias

SearchAlias

삭제할 별칭입니다.

options

DeleteAliasOptions

추가 선택적 인수입니다.

반환

Promise<void>

deleteAlias(string, DeleteAliasOptions)

검색 별칭 및 인덱스에 대한 관련 매핑을 삭제합니다. 이 작업은 복구 옵션 없이 영구적입니다. 매핑된 인덱스는 이 작업의 영향을 받지 않습니다.

function deleteAlias(aliasName: string, options?: DeleteAliasOptions): Promise<void>

매개 변수

aliasName

string

삭제할 별칭의 이름입니다.

options

DeleteAliasOptions

추가 선택적 인수입니다.

반환

Promise<void>

deleteIndex(SearchIndex, DeleteIndexOptions)

기존 인덱스를 삭제합니다.

function deleteIndex(index: SearchIndex, options?: DeleteIndexOptions): Promise<void>

매개 변수

index

SearchIndex

삭제할 인덱스입니다.

options

DeleteIndexOptions

추가 선택적 인수입니다.

반환

Promise<void>

deleteIndex(string, DeleteIndexOptions)

기존 인덱스를 삭제합니다.

function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise<void>

매개 변수

indexName

string

삭제할 인덱스의 이름입니다.

options

DeleteIndexOptions

추가 선택적 인수입니다.

반환

Promise<void>

deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)

기존 기술 자료를 삭제합니다.

function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>

매개 변수

knowledgeBase

KnowledgeBase

삭제할 지식 베이스.

options

DeleteKnowledgeBaseOptions

options 매개변수.

반환

Promise<void>

deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)

기존 기술 자료를 삭제합니다.

function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>

매개 변수

knowledgeBaseName

string

삭제할 지식 베이스 이름.

options

DeleteKnowledgeBaseOptions

options 매개변수.

반환

Promise<void>

deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)

기존 원본을 삭제합니다.

function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise<void>

매개 변수

source

KnowledgeSource

삭제할 지식 소스입니다.

options

DeleteKnowledgeSourceOptions

options 매개변수.

반환

Promise<void>

deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)

기존 원본을 삭제합니다.

function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise<void>

매개 변수

sourceName

string

삭제할 지식 소스의 이름입니다.

options

DeleteKnowledgeSourceOptions

options 매개변수.

반환

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

기존 SynonymMap을 삭제합니다.

function deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>

매개 변수

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

추가 선택적 인수입니다.

반환

Promise<void>

getAlias(string, OperationOptions)

별칭 정의를 검색합니다.

function getAlias(aliasName: string, options?: OperationOptions): Promise<SearchAlias>

매개 변수

aliasName

string

검색할 별칭의 이름입니다.

options

OperationOptions

옵션 매개 변수입니다.

반환

Promise<SearchAlias>

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>

getIndexStatsSummary(GetIndexStatsSummaryOptions)

서비스의 기존 인덱스 목록을 검색합니다.

function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIterator

매개 변수

options

GetIndexStatsSummaryOptions

인덱스 목록 작업에 대한 옵션입니다.

반환

IndexStatisticsSummaryIterator

getKnowledgeBase(string, GetKnowledgeBaseOptions)

지식 기반 정의를 가져옵니다.

function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>

매개 변수

knowledgeBaseName

string

가져올 지식 베이스 이름.

options

GetKnowledgeBaseOptions

options 매개변수.

반환

Promise<KnowledgeBase>

getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)

이 SearchIndexClient에 해당하는 KnowledgeRetrievalClient를 검색합니다.

function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClient

매개 변수

knowledgeBaseName

string

지식 베이스의 이름

options

KnowledgeRetrievalClientOptions

KnowledgeRetrievalClient 옵션

반환

KnowledgeRetrievalClient

getKnowledgeSource(string, GetKnowledgeSourceOptions)

지식 소스 정의를 검색합니다.

function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise<KnowledgeSource>

매개 변수

sourceName

string

검색할 지식 소스의 이름입니다.

options

GetKnowledgeSourceOptions

옵션 매개 변수입니다.

반환

Promise<KnowledgeSource>

getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)

참조 자료의 현재 상태 및 동기화 기록을 반환합니다.

function getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise<KnowledgeSourceStatus>

매개 변수

sourceName

string

상태를 검색할 지식 소스의 이름입니다.

options

GetKnowledgeSourceStatusOptions

옵션 매개 변수입니다.

반환

Promise<KnowledgeSourceStatus>

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>

listAliases(OperationOptions)

검색 서비스에 사용할 수 있는 모든 별칭을 나열합니다.

function listAliases(options?: OperationOptions): AliasIterator

매개 변수

options

OperationOptions

옵션 매개 변수입니다.

반환

AliasIterator

listIndexes(OperationOptions)

서비스의 기존 인덱스 목록을 검색합니다.

function listIndexes(options?: OperationOptions): IndexIterator

매개 변수

options

OperationOptions

인덱스 목록 작업에 대한 옵션입니다.

반환

IndexIterator

listIndexesNames(OperationOptions)

서비스에서 기존 인덱스의 이름 목록을 검색합니다.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

매개 변수

options

OperationOptions

인덱스 목록 작업에 대한 옵션입니다.

반환

IndexNameIterator

listKnowledgeBases(ListKnowledgeBasesOptions)

서비스 내 기존 지식베이스 목록을 검색합니다.

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

매개 변수

options

ListKnowledgeBasesOptions

지식 베이스 운영에 대한 옵션.

반환

KnowledgeBaseIterator

listKnowledgeSources(ListKnowledgeSourcesOptions)

서비스의 기존 KnowledgeSource 목록을 검색합니다.

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

매개 변수

options

ListKnowledgeSourcesOptions

참조 자료 목록 작업에 대한 옵션입니다.

반환

KnowledgeSourceIterator

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[]>