ResponseEventStream.EmitFailed Method

Definition

Namespace:: Azure.AI.AgentServer.Responses

Assembly:: Azure.AI.AgentServer.Responses.dll

Package:: Azure.AI.AgentServer.Responses v1.0.0-beta.4

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Name	Description
EmitFailed(ResponseErrorCode, String, ResponseUsage)	Produces a `response.failed` event. Sets `Status = Failed`, `CompletedAt`, `Error`, and `Usage` (if provided) before creating the event.
EmitFailed(String, ResponseUsage)	Produces a `response.failed` event with a ServerError code.

EmitFailed(ResponseErrorCode, String, ResponseUsage)

Source:: ResponseEventStream.cs

Produces a response.failed event. Sets Status = Failed, CompletedAt, Error, and Usage (if provided) before creating the event.

public virtual Azure.AI.AgentServer.Responses.Models.ResponseFailedEvent EmitFailed(Azure.AI.AgentServer.Responses.Models.ResponseErrorCode code, string message = "An internal server error occurred.", Azure.AI.AgentServer.Responses.Models.ResponseUsage? usage = default);

abstract member EmitFailed : Azure.AI.AgentServer.Responses.Models.ResponseErrorCode * string * Azure.AI.AgentServer.Responses.Models.ResponseUsage -> Azure.AI.AgentServer.Responses.Models.ResponseFailedEvent
override this.EmitFailed : Azure.AI.AgentServer.Responses.Models.ResponseErrorCode * string * Azure.AI.AgentServer.Responses.Models.ResponseUsage -> Azure.AI.AgentServer.Responses.Models.ResponseFailedEvent

Public Overridable Function EmitFailed (code As ResponseErrorCode, Optional message As String = "An internal server error occurred.", Optional usage As ResponseUsage = Nothing) As ResponseFailedEvent

Parameters

code: ResponseErrorCode

The error code. Defaults to ServerError.

message: String

The error message. Defaults to "An internal server error occurred.".

usage: ResponseUsage

Optional token usage data to include in the response.

Returns

ResponseFailedEvent

A ResponseFailedEvent with the finalized response.

Applies to

EmitFailed(String, ResponseUsage)

Source:: ResponseEventStream.cs

Produces a response.failed event with a ServerError code.

public virtual Azure.AI.AgentServer.Responses.Models.ResponseFailedEvent EmitFailed(string message = "An internal server error occurred.", Azure.AI.AgentServer.Responses.Models.ResponseUsage? usage = default);

abstract member EmitFailed : string * Azure.AI.AgentServer.Responses.Models.ResponseUsage -> Azure.AI.AgentServer.Responses.Models.ResponseFailedEvent
override this.EmitFailed : string * Azure.AI.AgentServer.Responses.Models.ResponseUsage -> Azure.AI.AgentServer.Responses.Models.ResponseFailedEvent

Public Overridable Function EmitFailed (Optional message As String = "An internal server error occurred.", Optional usage As ResponseUsage = Nothing) As ResponseFailedEvent