StreamEvents - Go SDK
StreamEvents - Go SDK
StreamEvents type definition
The Go SDK and docs are currently in beta. Report issues on GitHub.
Union of all possible event types emitted during response streaming
Supported Types
ErrorEvent
1 streamEvents := components.CreateStreamEventsError(components.ErrorEvent{/* values here */})
ApplyPatchCallOperationDiffDeltaEvent
1 streamEvents := components.CreateStreamEventsResponseApplyPatchCallOperationDiffDelta(components.ApplyPatchCallOperationDiffDeltaEvent{/* values here */})
ApplyPatchCallOperationDiffDoneEvent
1 streamEvents := components.CreateStreamEventsResponseApplyPatchCallOperationDiffDone(components.ApplyPatchCallOperationDiffDoneEvent{/* values here */})
StreamEventsResponseCompleted
1 streamEvents := components.CreateStreamEventsResponseCompleted(components.StreamEventsResponseCompleted{/* values here */})
ContentPartAddedEvent
1 streamEvents := components.CreateStreamEventsResponseContentPartAdded(components.ContentPartAddedEvent{/* values here */})
ContentPartDoneEvent
1 streamEvents := components.CreateStreamEventsResponseContentPartDone(components.ContentPartDoneEvent{/* values here */})
OpenResponsesCreatedEvent
1 streamEvents := components.CreateStreamEventsResponseCreated(components.OpenResponsesCreatedEvent{/* values here */})
CustomToolCallInputDeltaEvent
1 streamEvents := components.CreateStreamEventsResponseCustomToolCallInputDelta(components.CustomToolCallInputDeltaEvent{/* values here */})
CustomToolCallInputDoneEvent
1 streamEvents := components.CreateStreamEventsResponseCustomToolCallInputDone(components.CustomToolCallInputDoneEvent{/* values here */})
StreamEventsResponseFailed
1 streamEvents := components.CreateStreamEventsResponseFailed(components.StreamEventsResponseFailed{/* values here */})
FunctionCallArgsDeltaEvent
1 streamEvents := components.CreateStreamEventsResponseFunctionCallArgumentsDelta(components.FunctionCallArgsDeltaEvent{/* values here */})
FunctionCallArgsDoneEvent
1 streamEvents := components.CreateStreamEventsResponseFunctionCallArgumentsDone(components.FunctionCallArgsDoneEvent{/* values here */})
FusionCallAnalysisCompletedEvent
1 streamEvents := components.CreateStreamEventsResponseFusionCallAnalysisCompleted(components.FusionCallAnalysisCompletedEvent{/* values here */})
FusionCallAnalysisInProgressEvent
1 streamEvents := components.CreateStreamEventsResponseFusionCallAnalysisInProgress(components.FusionCallAnalysisInProgressEvent{/* values here */})
FusionCallCompletedEvent
1 streamEvents := components.CreateStreamEventsResponseFusionCallCompleted(components.FusionCallCompletedEvent{/* values here */})
FusionCallInProgressEvent
1 streamEvents := components.CreateStreamEventsResponseFusionCallInProgress(components.FusionCallInProgressEvent{/* values here */})
FusionCallPanelAddedEvent
1 streamEvents := components.CreateStreamEventsResponseFusionCallPanelAdded(components.FusionCallPanelAddedEvent{/* values here */})
FusionCallPanelCompletedEvent
1 streamEvents := components.CreateStreamEventsResponseFusionCallPanelCompleted(components.FusionCallPanelCompletedEvent{/* values here */})
FusionCallPanelDeltaEvent
1 streamEvents := components.CreateStreamEventsResponseFusionCallPanelDelta(components.FusionCallPanelDeltaEvent{/* values here */})
FusionCallPanelFailedEvent
1 streamEvents := components.CreateStreamEventsResponseFusionCallPanelFailed(components.FusionCallPanelFailedEvent{/* values here */})
FusionCallPanelReasoningDeltaEvent
1 streamEvents := components.CreateStreamEventsResponseFusionCallPanelReasoningDelta(components.FusionCallPanelReasoningDeltaEvent{/* values here */})
ImageGenCallCompletedEvent
1 streamEvents := components.CreateStreamEventsResponseImageGenerationCallCompleted(components.ImageGenCallCompletedEvent{/* values here */})
ImageGenCallGeneratingEvent
1 streamEvents := components.CreateStreamEventsResponseImageGenerationCallGenerating(components.ImageGenCallGeneratingEvent{/* values here */})
ImageGenCallInProgressEvent
1 streamEvents := components.CreateStreamEventsResponseImageGenerationCallInProgress(components.ImageGenCallInProgressEvent{/* values here */})
ImageGenCallPartialImageEvent
1 streamEvents := components.CreateStreamEventsResponseImageGenerationCallPartialImage(components.ImageGenCallPartialImageEvent{/* values here */})
OpenResponsesInProgressEvent
1 streamEvents := components.CreateStreamEventsResponseInProgress(components.OpenResponsesInProgressEvent{/* values here */})
StreamEventsResponseIncomplete
1 streamEvents := components.CreateStreamEventsResponseIncomplete(components.StreamEventsResponseIncomplete{/* values here */})
StreamEventsResponseOutputItemAdded
1 streamEvents := components.CreateStreamEventsResponseOutputItemAdded(components.StreamEventsResponseOutputItemAdded{/* values here */})
StreamEventsResponseOutputItemDone
1 streamEvents := components.CreateStreamEventsResponseOutputItemDone(components.StreamEventsResponseOutputItemDone{/* values here */})
AnnotationAddedEvent
1 streamEvents := components.CreateStreamEventsResponseOutputTextAnnotationAdded(components.AnnotationAddedEvent{/* values here */})
TextDeltaEvent
1 streamEvents := components.CreateStreamEventsResponseOutputTextDelta(components.TextDeltaEvent{/* values here */})
TextDoneEvent
1 streamEvents := components.CreateStreamEventsResponseOutputTextDone(components.TextDoneEvent{/* values here */})
ReasoningSummaryPartAddedEvent
1 streamEvents := components.CreateStreamEventsResponseReasoningSummaryPartAdded(components.ReasoningSummaryPartAddedEvent{/* values here */})
ReasoningSummaryPartDoneEvent
1 streamEvents := components.CreateStreamEventsResponseReasoningSummaryPartDone(components.ReasoningSummaryPartDoneEvent{/* values here */})
ReasoningSummaryTextDeltaEvent
1 streamEvents := components.CreateStreamEventsResponseReasoningSummaryTextDelta(components.ReasoningSummaryTextDeltaEvent{/* values here */})
ReasoningSummaryTextDoneEvent
1 streamEvents := components.CreateStreamEventsResponseReasoningSummaryTextDone(components.ReasoningSummaryTextDoneEvent{/* values here */})
ReasoningDeltaEvent
1 streamEvents := components.CreateStreamEventsResponseReasoningTextDelta(components.ReasoningDeltaEvent{/* values here */})
ReasoningDoneEvent
1 streamEvents := components.CreateStreamEventsResponseReasoningTextDone(components.ReasoningDoneEvent{/* values here */})
RefusalDeltaEvent
1 streamEvents := components.CreateStreamEventsResponseRefusalDelta(components.RefusalDeltaEvent{/* values here */})
RefusalDoneEvent
1 streamEvents := components.CreateStreamEventsResponseRefusalDone(components.RefusalDoneEvent{/* values here */})
WebSearchCallCompletedEvent
1 streamEvents := components.CreateStreamEventsResponseWebSearchCallCompleted(components.WebSearchCallCompletedEvent{/* values here */})
WebSearchCallInProgressEvent
1 streamEvents := components.CreateStreamEventsResponseWebSearchCallInProgress(components.WebSearchCallInProgressEvent{/* values here */})
WebSearchCallSearchingEvent
1 streamEvents := components.CreateStreamEventsResponseWebSearchCallSearching(components.WebSearchCallSearchingEvent{/* values here */})
Union Discrimination
Use the Type field to determine which variant is active, then access the corresponding field:
1 switch streamEvents.Type { 2 case components.StreamEventsTypeError: 3 // streamEvents.ErrorEvent is populated 4 case components.StreamEventsTypeResponseApplyPatchCallOperationDiffDelta: 5 // streamEvents.ApplyPatchCallOperationDiffDeltaEvent is populated 6 case components.StreamEventsTypeResponseApplyPatchCallOperationDiffDone: 7 // streamEvents.ApplyPatchCallOperationDiffDoneEvent is populated 8 case components.StreamEventsTypeResponseCompleted: 9 // streamEvents.StreamEventsResponseCompleted is populated 10 case components.StreamEventsTypeResponseContentPartAdded: 11 // streamEvents.ContentPartAddedEvent is populated 12 case components.StreamEventsTypeResponseContentPartDone: 13 // streamEvents.ContentPartDoneEvent is populated 14 case components.StreamEventsTypeResponseCreated: 15 // streamEvents.OpenResponsesCreatedEvent is populated 16 case components.StreamEventsTypeResponseCustomToolCallInputDelta: 17 // streamEvents.CustomToolCallInputDeltaEvent is populated 18 case components.StreamEventsTypeResponseCustomToolCallInputDone: 19 // streamEvents.CustomToolCallInputDoneEvent is populated 20 case components.StreamEventsTypeResponseFailed: 21 // streamEvents.StreamEventsResponseFailed is populated 22 case components.StreamEventsTypeResponseFunctionCallArgumentsDelta: 23 // streamEvents.FunctionCallArgsDeltaEvent is populated 24 case components.StreamEventsTypeResponseFunctionCallArgumentsDone: 25 // streamEvents.FunctionCallArgsDoneEvent is populated 26 case components.StreamEventsTypeResponseFusionCallAnalysisCompleted: 27 // streamEvents.FusionCallAnalysisCompletedEvent is populated 28 case components.StreamEventsTypeResponseFusionCallAnalysisInProgress: 29 // streamEvents.FusionCallAnalysisInProgressEvent is populated 30 case components.StreamEventsTypeResponseFusionCallCompleted: 31 // streamEvents.FusionCallCompletedEvent is populated 32 case components.StreamEventsTypeResponseFusionCallInProgress: 33 // streamEvents.FusionCallInProgressEvent is populated 34 case components.StreamEventsTypeResponseFusionCallPanelAdded: 35 // streamEvents.FusionCallPanelAddedEvent is populated 36 case components.StreamEventsTypeResponseFusionCallPanelCompleted: 37 // streamEvents.FusionCallPanelCompletedEvent is populated 38 case components.StreamEventsTypeResponseFusionCallPanelDelta: 39 // streamEvents.FusionCallPanelDeltaEvent is populated 40 case components.StreamEventsTypeResponseFusionCallPanelFailed: 41 // streamEvents.FusionCallPanelFailedEvent is populated 42 case components.StreamEventsTypeResponseFusionCallPanelReasoningDelta: 43 // streamEvents.FusionCallPanelReasoningDeltaEvent is populated 44 case components.StreamEventsTypeResponseImageGenerationCallCompleted: 45 // streamEvents.ImageGenCallCompletedEvent is populated 46 case components.StreamEventsTypeResponseImageGenerationCallGenerating: 47 // streamEvents.ImageGenCallGeneratingEvent is populated 48 case components.StreamEventsTypeResponseImageGenerationCallInProgress: 49 // streamEvents.ImageGenCallInProgressEvent is populated 50 case components.StreamEventsTypeResponseImageGenerationCallPartialImage: 51 // streamEvents.ImageGenCallPartialImageEvent is populated 52 case components.StreamEventsTypeResponseInProgress: 53 // streamEvents.OpenResponsesInProgressEvent is populated 54 case components.StreamEventsTypeResponseIncomplete: 55 // streamEvents.StreamEventsResponseIncomplete is populated 56 case components.StreamEventsTypeResponseOutputItemAdded: 57 // streamEvents.StreamEventsResponseOutputItemAdded is populated 58 case components.StreamEventsTypeResponseOutputItemDone: 59 // streamEvents.StreamEventsResponseOutputItemDone is populated 60 case components.StreamEventsTypeResponseOutputTextAnnotationAdded: 61 // streamEvents.AnnotationAddedEvent is populated 62 case components.StreamEventsTypeResponseOutputTextDelta: 63 // streamEvents.TextDeltaEvent is populated 64 case components.StreamEventsTypeResponseOutputTextDone: 65 // streamEvents.TextDoneEvent is populated 66 case components.StreamEventsTypeResponseReasoningSummaryPartAdded: 67 // streamEvents.ReasoningSummaryPartAddedEvent is populated 68 case components.StreamEventsTypeResponseReasoningSummaryPartDone: 69 // streamEvents.ReasoningSummaryPartDoneEvent is populated 70 case components.StreamEventsTypeResponseReasoningSummaryTextDelta: 71 // streamEvents.ReasoningSummaryTextDeltaEvent is populated 72 case components.StreamEventsTypeResponseReasoningSummaryTextDone: 73 // streamEvents.ReasoningSummaryTextDoneEvent is populated 74 case components.StreamEventsTypeResponseReasoningTextDelta: 75 // streamEvents.ReasoningDeltaEvent is populated 76 case components.StreamEventsTypeResponseReasoningTextDone: 77 // streamEvents.ReasoningDoneEvent is populated 78 case components.StreamEventsTypeResponseRefusalDelta: 79 // streamEvents.RefusalDeltaEvent is populated 80 case components.StreamEventsTypeResponseRefusalDone: 81 // streamEvents.RefusalDoneEvent is populated 82 case components.StreamEventsTypeResponseWebSearchCallCompleted: 83 // streamEvents.WebSearchCallCompletedEvent is populated 84 case components.StreamEventsTypeResponseWebSearchCallInProgress: 85 // streamEvents.WebSearchCallInProgressEvent is populated 86 case components.StreamEventsTypeResponseWebSearchCallSearching: 87 // streamEvents.WebSearchCallSearchingEvent is populated 88 default: 89 // Unknown type - use streamEvents.GetUnknownRaw() for raw JSON 90 }