invoke_endpoint_with_bidirectional_stream¶
Operation¶
async
¶
invoke_endpoint_with_bidirectional_stream(input: InvokeEndpointWithBidirectionalStreamInput, plugins: list[Plugin] | None = None) -> DuplexEventStream[RequestStreamEvent, ResponseStreamEvent, InvokeEndpointWithBidirectionalStreamOutput]
Invokes a model endpoint with bidirectional streaming capabilities. This operation establishes a persistent connection that allows you to send multiple requests and receive streaming responses from the model in real-time.
Bidirectional streaming is useful for interactive applications such as chatbots, real-time translation, or any scenario where you need to maintain a conversation-like interaction with the model. The connection remains open, allowing you to send additional input and receive responses without establishing a new connection for each request.
For an overview of Amazon SageMaker AI, see How It Works.
Amazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.
Calls to InvokeEndpointWithBidirectionalStream are authenticated by
using Amazon Web Services Signature Version 4. For information, see
Authenticating Requests (Amazon Web Services Signature Version
4)
in the Amazon S3 API Reference.
The bidirectional stream maintains the connection until either the client closes it or the model indicates completion. Each request and response in the stream is sent as an event with optional headers for data type and completion state.
Note
Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker AI determines the account ID from the authentication token that is supplied by the caller.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
InvokeEndpointWithBidirectionalStreamInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DuplexEventStream[RequestStreamEvent, ResponseStreamEvent, InvokeEndpointWithBidirectionalStreamOutput]
|
A |
Input¶
dataclass
¶
Dataclass for InvokeEndpointWithBidirectionalStreamInput structure.
Attributes¶
class-attribute
instance-attribute
¶
endpoint_name: str | None = None
The name of the endpoint to invoke.
class-attribute
instance-attribute
¶
model_invocation_path: str | None = None
Model invocation path.
class-attribute
instance-attribute
¶
model_query_string: str | None = None
Model query string.
class-attribute
instance-attribute
¶
target_variant: str | None = None
Target variant for the request.
Output¶
This operation returns a DuplexEventStream for bidirectional streaming.