diff --git a/docs-website/reference/integrations-api/amazon_bedrock.md b/docs-website/reference/integrations-api/amazon_bedrock.md index 51b1b21dce..0d36b2d855 100644 --- a/docs-website/reference/integrations-api/amazon_bedrock.md +++ b/docs-website/reference/integrations-api/amazon_bedrock.md @@ -819,6 +819,26 @@ Extracts the responses from the Amazon Bedrock streaming response. - list\[str\] – A list of string responses. +#### get_stream_responses_and_metadata + +```python +get_stream_responses_and_metadata( + stream: EventStream, streaming_callback: SyncStreamingCallbackT +) -> tuple[list[str], dict[str, Any]] +``` + +Extracts both the responses and normalized metadata from the Amazon Bedrock streaming response. + +**Parameters:** + +- **stream** (EventStream) – The streaming response from the Amazon Bedrock request. +- **streaming_callback** (SyncStreamingCallbackT) – The handler for the streaming response. + +**Returns:** + +- tuple\[list\[str\], dict\[str, Any\]\] – A tuple of `(responses, metadata)` where `responses` is a list of string + responses and `metadata` is a dictionary that may contain a normalized `usage` block. + ### AnthropicClaudeAdapter Bases: BedrockModelAdapter diff --git a/docs-website/reference_versioned_docs/version-2.18/integrations-api/amazon_bedrock.md b/docs-website/reference_versioned_docs/version-2.18/integrations-api/amazon_bedrock.md index 51b1b21dce..0d36b2d855 100644 --- a/docs-website/reference_versioned_docs/version-2.18/integrations-api/amazon_bedrock.md +++ b/docs-website/reference_versioned_docs/version-2.18/integrations-api/amazon_bedrock.md @@ -819,6 +819,26 @@ Extracts the responses from the Amazon Bedrock streaming response. - list\[str\] – A list of string responses. +#### get_stream_responses_and_metadata + +```python +get_stream_responses_and_metadata( + stream: EventStream, streaming_callback: SyncStreamingCallbackT +) -> tuple[list[str], dict[str, Any]] +``` + +Extracts both the responses and normalized metadata from the Amazon Bedrock streaming response. + +**Parameters:** + +- **stream** (EventStream) – The streaming response from the Amazon Bedrock request. +- **streaming_callback** (SyncStreamingCallbackT) – The handler for the streaming response. + +**Returns:** + +- tuple\[list\[str\], dict\[str, Any\]\] – A tuple of `(responses, metadata)` where `responses` is a list of string + responses and `metadata` is a dictionary that may contain a normalized `usage` block. + ### AnthropicClaudeAdapter Bases: BedrockModelAdapter diff --git a/docs-website/reference_versioned_docs/version-2.19/integrations-api/amazon_bedrock.md b/docs-website/reference_versioned_docs/version-2.19/integrations-api/amazon_bedrock.md index 51b1b21dce..0d36b2d855 100644 --- a/docs-website/reference_versioned_docs/version-2.19/integrations-api/amazon_bedrock.md +++ b/docs-website/reference_versioned_docs/version-2.19/integrations-api/amazon_bedrock.md @@ -819,6 +819,26 @@ Extracts the responses from the Amazon Bedrock streaming response. - list\[str\] – A list of string responses. +#### get_stream_responses_and_metadata + +```python +get_stream_responses_and_metadata( + stream: EventStream, streaming_callback: SyncStreamingCallbackT +) -> tuple[list[str], dict[str, Any]] +``` + +Extracts both the responses and normalized metadata from the Amazon Bedrock streaming response. + +**Parameters:** + +- **stream** (EventStream) – The streaming response from the Amazon Bedrock request. +- **streaming_callback** (SyncStreamingCallbackT) – The handler for the streaming response. + +**Returns:** + +- tuple\[list\[str\], dict\[str, Any\]\] – A tuple of `(responses, metadata)` where `responses` is a list of string + responses and `metadata` is a dictionary that may contain a normalized `usage` block. + ### AnthropicClaudeAdapter Bases: BedrockModelAdapter diff --git a/docs-website/reference_versioned_docs/version-2.20/integrations-api/amazon_bedrock.md b/docs-website/reference_versioned_docs/version-2.20/integrations-api/amazon_bedrock.md index 51b1b21dce..0d36b2d855 100644 --- a/docs-website/reference_versioned_docs/version-2.20/integrations-api/amazon_bedrock.md +++ b/docs-website/reference_versioned_docs/version-2.20/integrations-api/amazon_bedrock.md @@ -819,6 +819,26 @@ Extracts the responses from the Amazon Bedrock streaming response. - list\[str\] – A list of string responses. +#### get_stream_responses_and_metadata + +```python +get_stream_responses_and_metadata( + stream: EventStream, streaming_callback: SyncStreamingCallbackT +) -> tuple[list[str], dict[str, Any]] +``` + +Extracts both the responses and normalized metadata from the Amazon Bedrock streaming response. + +**Parameters:** + +- **stream** (EventStream) – The streaming response from the Amazon Bedrock request. +- **streaming_callback** (SyncStreamingCallbackT) – The handler for the streaming response. + +**Returns:** + +- tuple\[list\[str\], dict\[str, Any\]\] – A tuple of `(responses, metadata)` where `responses` is a list of string + responses and `metadata` is a dictionary that may contain a normalized `usage` block. + ### AnthropicClaudeAdapter Bases: BedrockModelAdapter diff --git a/docs-website/reference_versioned_docs/version-2.21/integrations-api/amazon_bedrock.md b/docs-website/reference_versioned_docs/version-2.21/integrations-api/amazon_bedrock.md index 51b1b21dce..0d36b2d855 100644 --- a/docs-website/reference_versioned_docs/version-2.21/integrations-api/amazon_bedrock.md +++ b/docs-website/reference_versioned_docs/version-2.21/integrations-api/amazon_bedrock.md @@ -819,6 +819,26 @@ Extracts the responses from the Amazon Bedrock streaming response. - list\[str\] – A list of string responses. +#### get_stream_responses_and_metadata + +```python +get_stream_responses_and_metadata( + stream: EventStream, streaming_callback: SyncStreamingCallbackT +) -> tuple[list[str], dict[str, Any]] +``` + +Extracts both the responses and normalized metadata from the Amazon Bedrock streaming response. + +**Parameters:** + +- **stream** (EventStream) – The streaming response from the Amazon Bedrock request. +- **streaming_callback** (SyncStreamingCallbackT) – The handler for the streaming response. + +**Returns:** + +- tuple\[list\[str\], dict\[str, Any\]\] – A tuple of `(responses, metadata)` where `responses` is a list of string + responses and `metadata` is a dictionary that may contain a normalized `usage` block. + ### AnthropicClaudeAdapter Bases: BedrockModelAdapter diff --git a/docs-website/reference_versioned_docs/version-2.22/integrations-api/amazon_bedrock.md b/docs-website/reference_versioned_docs/version-2.22/integrations-api/amazon_bedrock.md index 51b1b21dce..0d36b2d855 100644 --- a/docs-website/reference_versioned_docs/version-2.22/integrations-api/amazon_bedrock.md +++ b/docs-website/reference_versioned_docs/version-2.22/integrations-api/amazon_bedrock.md @@ -819,6 +819,26 @@ Extracts the responses from the Amazon Bedrock streaming response. - list\[str\] – A list of string responses. +#### get_stream_responses_and_metadata + +```python +get_stream_responses_and_metadata( + stream: EventStream, streaming_callback: SyncStreamingCallbackT +) -> tuple[list[str], dict[str, Any]] +``` + +Extracts both the responses and normalized metadata from the Amazon Bedrock streaming response. + +**Parameters:** + +- **stream** (EventStream) – The streaming response from the Amazon Bedrock request. +- **streaming_callback** (SyncStreamingCallbackT) – The handler for the streaming response. + +**Returns:** + +- tuple\[list\[str\], dict\[str, Any\]\] – A tuple of `(responses, metadata)` where `responses` is a list of string + responses and `metadata` is a dictionary that may contain a normalized `usage` block. + ### AnthropicClaudeAdapter Bases: BedrockModelAdapter diff --git a/docs-website/reference_versioned_docs/version-2.23/integrations-api/amazon_bedrock.md b/docs-website/reference_versioned_docs/version-2.23/integrations-api/amazon_bedrock.md index 51b1b21dce..0d36b2d855 100644 --- a/docs-website/reference_versioned_docs/version-2.23/integrations-api/amazon_bedrock.md +++ b/docs-website/reference_versioned_docs/version-2.23/integrations-api/amazon_bedrock.md @@ -819,6 +819,26 @@ Extracts the responses from the Amazon Bedrock streaming response. - list\[str\] – A list of string responses. +#### get_stream_responses_and_metadata + +```python +get_stream_responses_and_metadata( + stream: EventStream, streaming_callback: SyncStreamingCallbackT +) -> tuple[list[str], dict[str, Any]] +``` + +Extracts both the responses and normalized metadata from the Amazon Bedrock streaming response. + +**Parameters:** + +- **stream** (EventStream) – The streaming response from the Amazon Bedrock request. +- **streaming_callback** (SyncStreamingCallbackT) – The handler for the streaming response. + +**Returns:** + +- tuple\[list\[str\], dict\[str, Any\]\] – A tuple of `(responses, metadata)` where `responses` is a list of string + responses and `metadata` is a dictionary that may contain a normalized `usage` block. + ### AnthropicClaudeAdapter Bases: BedrockModelAdapter diff --git a/docs-website/reference_versioned_docs/version-2.24/integrations-api/amazon_bedrock.md b/docs-website/reference_versioned_docs/version-2.24/integrations-api/amazon_bedrock.md index 51b1b21dce..0d36b2d855 100644 --- a/docs-website/reference_versioned_docs/version-2.24/integrations-api/amazon_bedrock.md +++ b/docs-website/reference_versioned_docs/version-2.24/integrations-api/amazon_bedrock.md @@ -819,6 +819,26 @@ Extracts the responses from the Amazon Bedrock streaming response. - list\[str\] – A list of string responses. +#### get_stream_responses_and_metadata + +```python +get_stream_responses_and_metadata( + stream: EventStream, streaming_callback: SyncStreamingCallbackT +) -> tuple[list[str], dict[str, Any]] +``` + +Extracts both the responses and normalized metadata from the Amazon Bedrock streaming response. + +**Parameters:** + +- **stream** (EventStream) – The streaming response from the Amazon Bedrock request. +- **streaming_callback** (SyncStreamingCallbackT) – The handler for the streaming response. + +**Returns:** + +- tuple\[list\[str\], dict\[str, Any\]\] – A tuple of `(responses, metadata)` where `responses` is a list of string + responses and `metadata` is a dictionary that may contain a normalized `usage` block. + ### AnthropicClaudeAdapter Bases: BedrockModelAdapter diff --git a/docs-website/reference_versioned_docs/version-2.25/integrations-api/amazon_bedrock.md b/docs-website/reference_versioned_docs/version-2.25/integrations-api/amazon_bedrock.md index 51b1b21dce..0d36b2d855 100644 --- a/docs-website/reference_versioned_docs/version-2.25/integrations-api/amazon_bedrock.md +++ b/docs-website/reference_versioned_docs/version-2.25/integrations-api/amazon_bedrock.md @@ -819,6 +819,26 @@ Extracts the responses from the Amazon Bedrock streaming response. - list\[str\] – A list of string responses. +#### get_stream_responses_and_metadata + +```python +get_stream_responses_and_metadata( + stream: EventStream, streaming_callback: SyncStreamingCallbackT +) -> tuple[list[str], dict[str, Any]] +``` + +Extracts both the responses and normalized metadata from the Amazon Bedrock streaming response. + +**Parameters:** + +- **stream** (EventStream) – The streaming response from the Amazon Bedrock request. +- **streaming_callback** (SyncStreamingCallbackT) – The handler for the streaming response. + +**Returns:** + +- tuple\[list\[str\], dict\[str, Any\]\] – A tuple of `(responses, metadata)` where `responses` is a list of string + responses and `metadata` is a dictionary that may contain a normalized `usage` block. + ### AnthropicClaudeAdapter Bases: BedrockModelAdapter diff --git a/docs-website/reference_versioned_docs/version-2.26/integrations-api/amazon_bedrock.md b/docs-website/reference_versioned_docs/version-2.26/integrations-api/amazon_bedrock.md index 51b1b21dce..0d36b2d855 100644 --- a/docs-website/reference_versioned_docs/version-2.26/integrations-api/amazon_bedrock.md +++ b/docs-website/reference_versioned_docs/version-2.26/integrations-api/amazon_bedrock.md @@ -819,6 +819,26 @@ Extracts the responses from the Amazon Bedrock streaming response. - list\[str\] – A list of string responses. +#### get_stream_responses_and_metadata + +```python +get_stream_responses_and_metadata( + stream: EventStream, streaming_callback: SyncStreamingCallbackT +) -> tuple[list[str], dict[str, Any]] +``` + +Extracts both the responses and normalized metadata from the Amazon Bedrock streaming response. + +**Parameters:** + +- **stream** (EventStream) – The streaming response from the Amazon Bedrock request. +- **streaming_callback** (SyncStreamingCallbackT) – The handler for the streaming response. + +**Returns:** + +- tuple\[list\[str\], dict\[str, Any\]\] – A tuple of `(responses, metadata)` where `responses` is a list of string + responses and `metadata` is a dictionary that may contain a normalized `usage` block. + ### AnthropicClaudeAdapter Bases: BedrockModelAdapter diff --git a/docs-website/reference_versioned_docs/version-2.27/integrations-api/amazon_bedrock.md b/docs-website/reference_versioned_docs/version-2.27/integrations-api/amazon_bedrock.md index 51b1b21dce..0d36b2d855 100644 --- a/docs-website/reference_versioned_docs/version-2.27/integrations-api/amazon_bedrock.md +++ b/docs-website/reference_versioned_docs/version-2.27/integrations-api/amazon_bedrock.md @@ -819,6 +819,26 @@ Extracts the responses from the Amazon Bedrock streaming response. - list\[str\] – A list of string responses. +#### get_stream_responses_and_metadata + +```python +get_stream_responses_and_metadata( + stream: EventStream, streaming_callback: SyncStreamingCallbackT +) -> tuple[list[str], dict[str, Any]] +``` + +Extracts both the responses and normalized metadata from the Amazon Bedrock streaming response. + +**Parameters:** + +- **stream** (EventStream) – The streaming response from the Amazon Bedrock request. +- **streaming_callback** (SyncStreamingCallbackT) – The handler for the streaming response. + +**Returns:** + +- tuple\[list\[str\], dict\[str, Any\]\] – A tuple of `(responses, metadata)` where `responses` is a list of string + responses and `metadata` is a dictionary that may contain a normalized `usage` block. + ### AnthropicClaudeAdapter Bases: BedrockModelAdapter diff --git a/docs-website/reference_versioned_docs/version-2.28/integrations-api/amazon_bedrock.md b/docs-website/reference_versioned_docs/version-2.28/integrations-api/amazon_bedrock.md index 51b1b21dce..0d36b2d855 100644 --- a/docs-website/reference_versioned_docs/version-2.28/integrations-api/amazon_bedrock.md +++ b/docs-website/reference_versioned_docs/version-2.28/integrations-api/amazon_bedrock.md @@ -819,6 +819,26 @@ Extracts the responses from the Amazon Bedrock streaming response. - list\[str\] – A list of string responses. +#### get_stream_responses_and_metadata + +```python +get_stream_responses_and_metadata( + stream: EventStream, streaming_callback: SyncStreamingCallbackT +) -> tuple[list[str], dict[str, Any]] +``` + +Extracts both the responses and normalized metadata from the Amazon Bedrock streaming response. + +**Parameters:** + +- **stream** (EventStream) – The streaming response from the Amazon Bedrock request. +- **streaming_callback** (SyncStreamingCallbackT) – The handler for the streaming response. + +**Returns:** + +- tuple\[list\[str\], dict\[str, Any\]\] – A tuple of `(responses, metadata)` where `responses` is a list of string + responses and `metadata` is a dictionary that may contain a normalized `usage` block. + ### AnthropicClaudeAdapter Bases: BedrockModelAdapter diff --git a/docs-website/reference_versioned_docs/version-2.29-unstable/integrations-api/amazon_bedrock.md b/docs-website/reference_versioned_docs/version-2.29-unstable/integrations-api/amazon_bedrock.md index 51b1b21dce..0d36b2d855 100644 --- a/docs-website/reference_versioned_docs/version-2.29-unstable/integrations-api/amazon_bedrock.md +++ b/docs-website/reference_versioned_docs/version-2.29-unstable/integrations-api/amazon_bedrock.md @@ -819,6 +819,26 @@ Extracts the responses from the Amazon Bedrock streaming response. - list\[str\] – A list of string responses. +#### get_stream_responses_and_metadata + +```python +get_stream_responses_and_metadata( + stream: EventStream, streaming_callback: SyncStreamingCallbackT +) -> tuple[list[str], dict[str, Any]] +``` + +Extracts both the responses and normalized metadata from the Amazon Bedrock streaming response. + +**Parameters:** + +- **stream** (EventStream) – The streaming response from the Amazon Bedrock request. +- **streaming_callback** (SyncStreamingCallbackT) – The handler for the streaming response. + +**Returns:** + +- tuple\[list\[str\], dict\[str, Any\]\] – A tuple of `(responses, metadata)` where `responses` is a list of string + responses and `metadata` is a dictionary that may contain a normalized `usage` block. + ### AnthropicClaudeAdapter Bases: BedrockModelAdapter