Bedrock's Converse API only accepts "auto", "any", or "tool" as valid
toolChoice keys. The previous code mapped tool_choice="none" to
{"none": {}}, which causes a botocore.exceptions.ParamValidationError.
When tool_choice="none" (set by FunctionInvocationLayer after exhausting
max iterations), the fix now omits toolConfig entirely so the model
won't attempt tool calls.
Added tests for tool_choice="none", "auto", and "required" modes.
Fixes#4529
Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
* fix: handle thread.message.completed event in Assistants API streaming
Previously, `thread.message.completed` events fell through to the
catch-all `else` branch and yielded empty `ChatResponseUpdate` objects,
silently discarding fully-resolved annotation data (file citations,
file paths, and their character-offset regions).
This commit adds a dedicated handler for `thread.message.completed`
that:
- Walks the completed ThreadMessage.content array
- Extracts text blocks with their fully-resolved annotations
- Maps FileCitationAnnotation and FilePathAnnotation to the
framework's Annotation type with proper TextSpanRegion data
- Yields a ChatResponseUpdate containing the complete text and
annotations
Fixes#4322
* test: add tests for thread.message.completed annotation handling
Tests cover:
- File citation annotation extraction
- File path annotation extraction
- Multiple annotations on a single text block
- Text-only messages (no annotations)
- Non-text blocks are skipped
- Mixed content blocks (text + image)
- Conversation ID propagation
* fix: address Copilot review - add quote field and log unrecognized annotations
- Include `quote` from `annotation.file_citation.quote` in
`additional_properties` for FileCitationAnnotation, preserving the
exact cited text snippet from the source file
- Add `else` clause to log unrecognized annotation types at debug level,
consistent with the pattern in `_responses_client.py`
- Add `import logging` and module-level logger
* test: add coverage for quote field and unrecognized annotation logging
- test_message_completed_with_file_citation_quote: verifies quote is
included in additional_properties
- test_message_completed_with_file_citation_no_quote: verifies quote
is omitted when None
- test_message_completed_unrecognized_annotation_logged: verifies
unknown annotation types are logged at debug level and skipped
* fix: address reviewer nits — logger name convention + annotation type string
Per @giles17's review:
- Use logging.getLogger('agent_framework.openai') to match module convention
- Simplify debug message to use annotation.type instead of type().__name__
* refactor: move message.completed tests into consolidated test file
Per @giles17's review: moved all tests from test_assistants_message_completed.py
into test_openai_assistants_client.py and deleted the standalone file.
* fix: resolve mypy no-redef and ruff RET504 lint errors
- Remove duplicate type annotation for 'ann' variable (no-redef)
- Return directly from fixture instead of unnecessary assignment (RET504)
* fix: rename annotation variable in completed block to fix mypy type conflict
The 'annotation' loop variable in thread.message.completed has type
FileCitationAnnotation | FilePathAnnotation, which conflicts with the
delta block's 'annotation' of type FileCitationDeltaAnnotation |
FilePathDeltaAnnotation. Renamed to 'completed_annotation' to avoid
mypy 'Incompatible types in assignment' error.
* fix: remove quote field from FileCitationAnnotation handling
---------
Co-authored-by: Giles Odigwe <79032838+giles17@users.noreply.github.com>
* fix(python): use AgentResponse.value instead of model_validate_json in HITL sample
Since the agent is configured with response_format=GuessOutput, the
AgentResponse already provides .value with the parsed Pydantic model.
Using .value is more idiomatic and avoids redundant JSON parsing.
Fixes#4396
* fix: add safety guard for AgentResponse.value being None
Address Copilot review feedback: .value is optional and may be None
if response_format isn't propagated through the streaming path.
Add an explicit None check with a clear error message.
