BetaAgentsCreateSessionOptionalParams interface
Optional parameters.
- Extends
Properties
| agent |
Optional caller-provided session ID. If specified, it must be unique within the agent endpoint. Auto-generated if omitted. |
| foundry |
A feature flag opt-in required when using preview operations or modifying persisted preview resources. |
Inherited Properties
| abort |
The signal which can be used to abort requests. |
| on |
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times. |
| request |
Options used when creating and sending HTTP requests for this operation. |
| tracing |
Options used when tracing is enabled. |
Property Details
agentSessionId
Optional caller-provided session ID. If specified, it must be unique within the agent endpoint. Auto-generated if omitted.
agentSessionId?: string
Property Value
string
foundryFeatures
A feature flag opt-in required when using preview operations or modifying persisted preview resources.
foundryFeatures?: "AgentEndpoints=V1Preview"
Property Value
"AgentEndpoints=V1Preview"
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
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
Inherited From OperationOptions.onResponse
requestOptions
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptions
Property Value
Inherited From OperationOptions.requestOptions
tracingOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptions
Property Value
Inherited From OperationOptions.tracingOptions