SearchIndexerClient class

패키지:

@azure/search-documents

인덱서, 데이터 원본 & 기술 세트를 관리(만들기, 업데이트, 나열/삭제)하는 작업을 수행하는 클래스입니다.

생성자

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

SearchIndexerClient의 instance 만듭니다. 사용 예제: 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)	새 기술 세트를 만들거나 기존 기술을 수정합니다.
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)	서비스에서 기존 기술 세트의 이름 목록을 검색합니다.
resetIndexer(string, OperationOptions)	인덱서와 연결된 변경 내용 추적 상태를 다시 설정합니다.
runIndexer(string, OperationOptions)	요청 시 인덱서 실행

생성자 세부 정보

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

SearchIndexerClient의 instance 만듭니다.

사용 예제:

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

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

속성 세부 정보

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)

새 기술 세트를 만들거나 기존 기술을 수정합니다.

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)

서비스에서 기존 기술 세트의 이름 목록을 검색합니다.

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>