GetDocumentOptions interface

包:

@azure/search-documents

用于检索单个文档的选项。

扩展

OperationOptions

属性

selectedFields	要检索文档的字段名称列表;未检索的任何字段都将从返回的文档中缺失。
xMsEnableElevatedRead	启用提升读取的值，该读取可绕过查询作的文档级权限检查。
xMsQuerySourceAuthorization	标识正在执行查询的用户的令牌。 此令牌用于对文档实施安全限制。

继承属性

abortSignal	可用于中止请求的信号。
onResponse	在执行请求的操作时，每次从服务器接收响应时调用的函数。 可以多次调用。
requestOptions	为此操作创建和发送 HTTP 请求时使用的选项。
serializerOptions	用于替代序列化/取消序列化行为的选项。
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

用于替代序列化/取消序列化行为的选项。

serializerOptions?: SerializerOptions

属性值

SerializerOptions

继承自 OperationOptions.serializerOptions

tracingOptions

启用跟踪时使用的选项。

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

继承自 OperationOptions.tracingOptions