GetDocumentOptions interface

패키지:

@azure/search-documents

단일 문서를 검색하는 옵션입니다.

Extends

OperationOptions

속성

selectedFields	문서에 대해 검색할 필드 이름 목록입니다. 검색되지 않은 모든 필드는 반환된 문서에서 누락됩니다.
xMsEnableElevatedRead	쿼리 연산에 대한 문서 수준 권한 검사를 우회하는 상위 읽기를 가능하게 하는 값입니다.
xMsQuerySourceAuthorization	쿼리가 실행되는 사용자를 식별하는 토큰입니다. 이 토큰은 문서에 보안 제한을 적용하는 데 사용됩니다.

상속된 속성

abortSignal	요청을 중단하는 데 사용할 수 있는 신호입니다.
onResponse	요청된 작업을 수행하는 동안 서버에서 응답을 받을 때마다 호출되는 함수입니다. 여러 번 호출할 수 있습니다.
requestOptions	이 작업에 대한 HTTP 요청을 만들고 보낼 때 사용되는 옵션입니다.
serializerOptions	serialization/de-serialization 동작을 재정의하는 옵션입니다.
tracingOptions	추적을 사용할 때 사용되는 옵션입니다.

속성 세부 정보

selectedFields

문서에 대해 검색할 필드 이름 목록입니다. 검색되지 않은 모든 필드는 반환된 문서에서 누락됩니다.

selectedFields?: SelectArray<TFields>

속성 값

SelectArray<TFields>

xMsEnableElevatedRead

쿼리 연산에 대한 문서 수준 권한 검사를 우회하는 상위 읽기를 가능하게 하는 값입니다.

xMsEnableElevatedRead?: boolean

속성 값

boolean

xMsQuerySourceAuthorization

쿼리가 실행되는 사용자를 식별하는 토큰입니다. 이 토큰은 문서에 보안 제한을 적용하는 데 사용됩니다.

xMsQuerySourceAuthorization?: string

속성 값

string

상속된 속성 세부 정보

abortSignal

요청을 중단하는 데 사용할 수 있는 신호입니다.

abortSignal?: AbortSignalLike

속성 값

AbortSignalLike

OperationOptions.abortSignal에서 상속된

onResponse

요청된 작업을 수행하는 동안 서버에서 응답을 받을 때마다 호출되는 함수입니다. 여러 번 호출할 수 있습니다.

onResponse?: RawResponseCallback

속성 값

RawResponseCallback

OperationOptions.onResponse에서 상속된

requestOptions

이 작업에 대한 HTTP 요청을 만들고 보낼 때 사용되는 옵션입니다.

requestOptions?: OperationRequestOptions

속성 값

OperationRequestOptions

OperationOptions.requestOptions에서 상속된

serializerOptions

serialization/de-serialization 동작을 재정의하는 옵션입니다.

serializerOptions?: SerializerOptions

속성 값

SerializerOptions

OperationOptions.serializerOptions에서 상속된

tracingOptions

추적을 사용할 때 사용되는 옵션입니다.

tracingOptions?: OperationTracingOptions

속성 값

OperationTracingOptions

OperationOptions.tracingOptions에서 상속된