RetrieveOptions interface

Package:
@azure/search-documents

Options for a completed knowledge base retrieval request.

Extends
OperationOptions

Properties

querySourceAuthorization

Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents.
queryWorkIQSourceAuthorization

User assertion for a customer-owned Microsoft Entra application configured on a Work IQ knowledge source. The service uses this assertion for on-behalf-of authentication to Work IQ.

Inherited Properties

abortSignal

The signal which can be used to abort requests.
onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions

Options used when creating and sending HTTP requests for this operation.
tracingOptions

Options used when tracing is enabled.

Property Details

querySourceAuthorization

Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents.

querySourceAuthorization?: string

Property Value

string

queryWorkIQSourceAuthorization

User assertion for a customer-owned Microsoft Entra application configured on a Work IQ knowledge source. The service uses this assertion for on-behalf-of authentication to Work IQ.

queryWorkIQSourceAuthorization?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions