InsightsListOptionalParams interface

Package:

@azure/ai-projects

Optional parameters.

Extends

OperationOptions

Properties

agentName	Filter by the agent name.
clientRequestId	An opaque, globally-unique, client-generated string identifier for the request.
evalId	Filter by the evaluation ID.
includeCoordinates	Whether to include coordinates for visualization in the response. Defaults to false.
runId	Filter by the evaluation run ID.
typeParam	Filter by the type of analysis.

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

agentName

Filter by the agent name.

agentName?: string

Property Value

string

clientRequestId

An opaque, globally-unique, client-generated string identifier for the request.

clientRequestId?: string

Property Value

string

evalId

Filter by the evaluation ID.

evalId?: string

Property Value

string

includeCoordinates

Whether to include coordinates for visualization in the response. Defaults to false.

includeCoordinates?: boolean

Property Value

boolean

runId

Filter by the evaluation run ID.

runId?: string

Property Value

string

typeParam

Filter by the type of analysis.

typeParam?: InsightType

Property Value

InsightType

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