Skip to content

Bedrock Agent Runtime  >  Unions  >  AgenticRetrieveStreamResponseOutput

AgenticRetrieveStreamResponseOutput

Union Type

AgenticRetrieveStreamResponseOutput module-attribute 

AgenticRetrieveStreamResponseOutput = Union[AgenticRetrieveStreamResponseOutputResult | AgenticRetrieveStreamResponseOutputTraceEvent | AgenticRetrieveStreamResponseOutputResponseEvent | AgenticRetrieveStreamResponseOutputInternalServerException | AgenticRetrieveStreamResponseOutputValidationException | AgenticRetrieveStreamResponseOutputResourceNotFoundException | AgenticRetrieveStreamResponseOutputServiceQuotaExceededException | AgenticRetrieveStreamResponseOutputThrottlingException | AgenticRetrieveStreamResponseOutputAccessDeniedException | AgenticRetrieveStreamResponseOutputConflictException | AgenticRetrieveStreamResponseOutputDependencyFailedException | AgenticRetrieveStreamResponseOutputBadGatewayException | AgenticRetrieveStreamResponseOutputUnknown]

The streaming output for agentic retrieval, containing results, traces, and errors.

Union Member Types

AgenticRetrieveStreamResponseOutputResult dataclass

A retrieval result event containing the retrieved items.

Attributes

value instance-attribute 
value: AgenticRetrieveResultEvent

AgenticRetrieveStreamResponseOutputTraceEvent dataclass

A trace event providing visibility into the retrieval process.

Attributes

value instance-attribute 
value: AgenticRetrieveTraceEvent

AgenticRetrieveStreamResponseOutputResponseEvent dataclass

A chunk of the generated answer. Emitted only when generateResponse is true.

Attributes

value instance-attribute 
value: AgenticRetrieveResponseEvent

AgenticRetrieveStreamResponseOutputInternalServerException dataclass

An internal server error occurred.

Attributes

value instance-attribute 
value: InternalServerException

AgenticRetrieveStreamResponseOutputValidationException dataclass

The request validation failed.

Attributes

value instance-attribute 
value: ValidationException

AgenticRetrieveStreamResponseOutputResourceNotFoundException dataclass

The specified resource was not found.

Attributes

value instance-attribute 
value: ResourceNotFoundException

AgenticRetrieveStreamResponseOutputServiceQuotaExceededException dataclass

The service quota has been exceeded.

Attributes

value instance-attribute 
value: ServiceQuotaExceededException

AgenticRetrieveStreamResponseOutputThrottlingException dataclass

The request was throttled.

Attributes

value instance-attribute 
value: ThrottlingException

AgenticRetrieveStreamResponseOutputAccessDeniedException dataclass

Access to the resource was denied.

Attributes

value instance-attribute 
value: AccessDeniedException

AgenticRetrieveStreamResponseOutputConflictException dataclass

A conflict occurred with the current state of the resource.

Attributes

value instance-attribute 
value: ConflictException

AgenticRetrieveStreamResponseOutputDependencyFailedException dataclass

A dependency failed during the operation.

Attributes

value instance-attribute 
value: DependencyFailedException

AgenticRetrieveStreamResponseOutputBadGatewayException dataclass

A bad gateway error occurred.

Attributes

value instance-attribute 
value: BadGatewayException

AgenticRetrieveStreamResponseOutputUnknown dataclass

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

Attributes

tag instance-attribute 
tag: str