다음을 통해 공유

SearchClient class

  • 참조
패키지:
@azure/search-documents

인덱스의 문서 쿼리, 추가, 업데이트 및 제거를 포함하여 검색 인덱스에 대한 작업을 수행하는 데 사용되는 클래스입니다.

생성자

SearchClient<TModel>(string, string, KeyCredential | TokenCredential, SearchClientOptions)

SearchClient의 instance 만듭니다.

사용 예제:

const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");

const client = new SearchClient(
  "<endpoint>",
  "<indexName>",
  new AzureKeyCredential("<Admin Key>")
);

필요에 따라 모델의 형식을 사용하여 강력한 입력 및 형식 힌트를 사용하도록 설정할 수 있습니다.

type TModel = {
  keyName: string;
  field1?: string | null;
  field2?: { anotherField?: string | null } | null;
};

const client = new SearchClient<TModel>(
  ...
);

속성

apiVersion

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

검색 서비스의 엔드포인트
indexName

인덱스의 이름
serviceVersion

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

메서드

autocomplete(string, string, AutocompleteOptions<TModel>)

사용자의 부분 searchText에 따라 지정된 제안기를 기반으로 잠재적 완성 문자열 목록을 반환합니다.

예제

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const autocompleteResult = await client.autocomplete(
  "searchText",
  "suggesterName",
  { searchFields }
);
deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

문서 집합을 삭제합니다.
deleteDocuments(TModel[], IndexDocumentsOptions)

문서 집합을 삭제합니다.
getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)

키별로 인덱스에서 특정 문서를 검색합니다.
getDocumentsCount(OperationOptions)

인덱스의 문서 수를 검색합니다.
indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

지정된 문서 집합에 대한 인덱스 수정 집합(업로드, 병합, mergeOrUpload, 삭제)을 수행합니다. 이 작업은 부분적으로 성공할 수 있으며 일부 문서 작업이 인덱스에 반영되지는 않습니다. 이 옵션을 예외로 처리하려면 옵션을 true로 설정합니다 throwOnAnyFailure . 병합 작동 방식에 대한 자세한 내용은 다음을 참조하세요. https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeDocuments(TModel[], IndexDocumentsOptions)

인덱스의 문서 집합을 업데이트합니다. 병합 작동 방식에 대한 자세한 내용은 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

인덱스의 문서 집합을 업데이트하거나 없는 경우 업로드합니다. 병합 작동 방식에 대한 자세한 내용은 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
search<TFields>(string, SearchOptions<TModel, TFields>)

지정된 인수가 지정된 경우 현재 인덱스에 대한 검색을 수행합니다.

예제

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const searchResult = await client.search("searchText", {
  select,
  searchFields,
});
suggest<TFields>(string, string, SuggestOptions<TModel, TFields>)

searchText 및 지정된 제안기를 기반으로 제안의 짧은 목록을 반환합니다.

예제

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const suggestResult = await client.suggest("searchText", "suggesterName", {
  select,
  searchFields,
});
uploadDocuments(TModel[], IndexDocumentsOptions)

문서 배열을 인덱스로 업로드합니다.

생성자 세부 정보

SearchClient<TModel>(string, string, KeyCredential | TokenCredential, SearchClientOptions)

SearchClient의 instance 만듭니다.

사용 예제:

const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");

const client = new SearchClient(
  "<endpoint>",
  "<indexName>",
  new AzureKeyCredential("<Admin Key>")
);

필요에 따라 모델의 형식을 사용하여 강력한 입력 및 형식 힌트를 사용하도록 설정할 수 있습니다.

type TModel = {
  keyName: string;
  field1?: string | null;
  field2?: { anotherField?: string | null } | null;
};

const client = new SearchClient<TModel>(
  ...
);

new SearchClient(endpoint: string, indexName: string, credential: KeyCredential | TokenCredential, options?: SearchClientOptions)

매개 변수

endpoint

string

검색 서비스의 엔드포인트

indexName

string

인덱스의 이름

credential

KeyCredential | TokenCredential

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

options
SearchClientOptions

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

속성 세부 정보

apiVersion

경고

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

use {@Link serviceVersion} instead

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

apiVersion: string

속성 값

string

endpoint

검색 서비스의 엔드포인트

endpoint: string

속성 값

string

indexName

인덱스의 이름

indexName: string

속성 값

string

serviceVersion

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

serviceVersion: string

속성 값

string

메서드 세부 정보

autocomplete(string, string, AutocompleteOptions<TModel>)

사용자의 부분 searchText에 따라 지정된 제안기를 기반으로 잠재적 완성 문자열 목록을 반환합니다.

예제

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const autocompleteResult = await client.autocomplete(
  "searchText",
  "suggesterName",
  { searchFields }
);

function autocomplete(searchText: string, suggesterName: string, options?: AutocompleteOptions<TModel>): Promise<AutocompleteResult>

매개 변수

searchText

string

자동 완성 결과를 기반으로 할 검색 텍스트입니다.

suggesterName

string

인덱스 정의의 일부인 제안기 컬렉션에 지정된 제안기의 이름입니다.

options

AutocompleteOptions<TModel>

자동 완성 작업에 대한 옵션입니다.

반환

Promise<AutocompleteResult>

deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

문서 집합을 삭제합니다.

function deleteDocuments(keyName: keyof TModel, keyValues: string[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

매개 변수

keyName

keyof TModel

인덱스의 기본 키 이름입니다.

keyValues

string[]

삭제할 문서의 기본 키 값입니다.

options
IndexDocumentsOptions

추가 옵션입니다.

반환

Promise<IndexDocumentsResult>

deleteDocuments(TModel[], IndexDocumentsOptions)

문서 집합을 삭제합니다.

function deleteDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

매개 변수

documents

TModel[]

삭제할 문서입니다.

options
IndexDocumentsOptions

추가 옵션입니다.

반환

Promise<IndexDocumentsResult>

getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)

키별로 인덱스에서 특정 문서를 검색합니다.

function getDocument<TFields>(key: string, options?: GetDocumentOptions<TModel, TFields>): Promise<NarrowedModel<TModel, TFields>>

매개 변수

key

string

문서의 기본 키 값

options

GetDocumentOptions<TModel, TFields>

추가 옵션

반환

Promise<NarrowedModel<TModel, TFields>>

getDocumentsCount(OperationOptions)

인덱스의 문서 수를 검색합니다.

function getDocumentsCount(options?: OperationOptions): Promise<number>

매개 변수

options
OperationOptions

개수 작업에 대한 옵션입니다.

반환

Promise<number>

indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

지정된 문서 집합에 대한 인덱스 수정 집합(업로드, 병합, mergeOrUpload, 삭제)을 수행합니다. 이 작업은 부분적으로 성공할 수 있으며 일부 문서 작업이 인덱스에 반영되지는 않습니다. 이 옵션을 예외로 처리하려면 옵션을 true로 설정합니다 throwOnAnyFailure . 병합 작동 방식에 대한 자세한 내용은 다음을 참조하세요. https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function indexDocuments(batch: IndexDocumentsBatch<TModel>, options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

매개 변수

batch

IndexDocumentsBatch<TModel>

인덱스에서 수행할 작업 배열입니다.

options
IndexDocumentsOptions

추가 옵션입니다.

반환

Promise<IndexDocumentsResult>

mergeDocuments(TModel[], IndexDocumentsOptions)

인덱스의 문서 집합을 업데이트합니다. 병합 작동 방식에 대한 자세한 내용은 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function mergeDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

매개 변수

documents

TModel[]

업데이트된 문서입니다.

options
IndexDocumentsOptions

추가 옵션입니다.

반환

Promise<IndexDocumentsResult>

mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

인덱스의 문서 집합을 업데이트하거나 없는 경우 업로드합니다. 병합 작동 방식에 대한 자세한 내용은 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function mergeOrUploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

매개 변수

documents

TModel[]

업데이트된 문서입니다.

options
IndexDocumentsOptions

추가 옵션입니다.

반환

Promise<IndexDocumentsResult>

지정된 인수가 지정된 경우 현재 인덱스에 대한 검색을 수행합니다.

예제

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const searchResult = await client.search("searchText", {
  select,
  searchFields,
});

function search<TFields>(searchText?: string, options?: SearchOptions<TModel, TFields>): Promise<SearchDocumentsResult<TModel, TFields>>

매개 변수

searchText

string

검색할 텍스트

options

SearchOptions<TModel, TFields>

검색 작업에 대한 옵션입니다.

반환

Promise<SearchDocumentsResult<TModel, TFields>>

suggest<TFields>(string, string, SuggestOptions<TModel, TFields>)

searchText 및 지정된 제안기를 기반으로 제안의 짧은 목록을 반환합니다.

예제

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const suggestResult = await client.suggest("searchText", "suggesterName", {
  select,
  searchFields,
});

function suggest<TFields>(searchText: string, suggesterName: string, options?: SuggestOptions<TModel, TFields>): Promise<SuggestDocumentsResult<TModel, TFields>>

매개 변수

searchText

string

문서를 제안하는 데 사용할 검색 텍스트입니다. 최소 1자가 되어야 하며 100자를 넘지 않아야 합니다.

suggesterName

string

인덱스 정의의 일부인 제안기 컬렉션에 지정된 제안기의 이름입니다.

options

SuggestOptions<TModel, TFields>

제안 작업에 대한 옵션

반환

Promise<SuggestDocumentsResult<TModel, TFields>>

uploadDocuments(TModel[], IndexDocumentsOptions)

문서 배열을 인덱스로 업로드합니다.

function uploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

매개 변수

documents

TModel[]

업로드할 문서입니다.

options
IndexDocumentsOptions

추가 옵션입니다.

반환

Promise<IndexDocumentsResult>