mirror of
https://github.com/BerriAI/litellm.git
synced 2026-11-17 09:34:48 +00:00
fix(guardrails): send tool calls to the guardrail only once their arguments are complete
This commit is contained in:
parent
c6e386cefd
commit
fd3ad67c47
2 changed files with 61 additions and 7 deletions
|
|
@ -909,14 +909,19 @@ class OpenAIChatCompletionsHandler(BaseTranslation):
|
|||
)
|
||||
sink.record(merged_texts, merged_holdback)
|
||||
return
|
||||
tool_calls: Final = chain.from_iterable(choice.message.tool_calls or () for choice in assembled.choices)
|
||||
inputs["tool_calls"] = TypeAdapter(list[ChatCompletionToolCallChunk]).validate_python(
|
||||
tuple(
|
||||
MappingProxyType({"index": index, **converted})
|
||||
for index, tool_call in enumerate(tool_calls)
|
||||
if (converted := self._convert_tool_call_to_dict(tool_call)) is not None
|
||||
# Mid-round the assembled arguments are a truncated JSON fragment such as `{"ci`, which
|
||||
# main never handed to a guardrail: one that parses them either errors or judges
|
||||
# arguments that do not exist yet. Send tool calls only once the stream has finished and
|
||||
# the arguments are complete; the text of those rounds is still inspected above.
|
||||
if self._first_choice_has_finished(responses_so_far):
|
||||
tool_calls: Final = chain.from_iterable(choice.message.tool_calls or () for choice in assembled.choices)
|
||||
inputs["tool_calls"] = TypeAdapter(list[ChatCompletionToolCallChunk]).validate_python(
|
||||
tuple(
|
||||
MappingProxyType({"index": index, **converted})
|
||||
for index, tool_call in enumerate(tool_calls)
|
||||
if (converted := self._convert_tool_call_to_dict(tool_call)) is not None
|
||||
)
|
||||
)
|
||||
)
|
||||
if responses_so_far and getattr(responses_so_far[0], "model", None):
|
||||
inputs["model"] = responses_so_far[0].model
|
||||
guardrailed_inputs: Final = await guardrail_to_apply.apply_guardrail(
|
||||
|
|
|
|||
|
|
@ -1586,6 +1586,55 @@ class TestOpenAIChatCompletionsHandlerStreamingOutput:
|
|||
)
|
||||
assert sink.holdback_per_choice == {0: len("alpha"), 1: len("bravo-long")}
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_diff_mode_withholds_tool_calls_until_their_arguments_are_complete(self) -> None:
|
||||
"""Mid-round the assembled arguments are a truncated JSON fragment, so they are not sent.
|
||||
|
||||
Sending them would hand the guardrail something like `{"ci`, which main never did.
|
||||
"""
|
||||
from litellm.llms.base_llm.guardrail_translation.base_translation import StreamTransformSink
|
||||
from litellm.types.utils import Delta, ModelResponseStream, StreamingChoices
|
||||
|
||||
class RecordingGuardrail(CustomGuardrail):
|
||||
seen: list[object] = []
|
||||
|
||||
async def apply_guardrail(
|
||||
self, inputs: GenericGuardrailAPIInputs, request_data: dict[str, object],
|
||||
input_type: Literal["request", "response"], logging_obj: object = None,
|
||||
) -> GenericGuardrailAPIInputs:
|
||||
type(self).seen.append(inputs.get("tool_calls"))
|
||||
return inputs
|
||||
|
||||
def chunk(text: str, arguments: str, finish_reason: str | None) -> ModelResponseStream:
|
||||
# The text keeps the guardrail in play for the partial round; without any text the
|
||||
# transform path has nothing to inspect and never calls it at all.
|
||||
return ModelResponseStream(choices=[StreamingChoices(
|
||||
index=0, delta=Delta(content=text, tool_calls=[{
|
||||
"index": 0, "id": "call_0", "type": "function",
|
||||
"function": {"name": "weather", "arguments": arguments},
|
||||
}]), finish_reason=finish_reason,
|
||||
)])
|
||||
|
||||
RecordingGuardrail.seen = []
|
||||
handler: Final = OpenAIChatCompletionsHandler()
|
||||
guardrail: Final = RecordingGuardrail(guardrail_name="recording")
|
||||
partial: Final = [chunk("looking", '{"ci', None)]
|
||||
await handler.process_output_streaming_response(
|
||||
responses_so_far=partial, guardrail_to_apply=guardrail,
|
||||
litellm_logging_obj=None, stream_transform_sink=StreamTransformSink(),
|
||||
)
|
||||
assert RecordingGuardrail.seen == [None]
|
||||
|
||||
RecordingGuardrail.seen = []
|
||||
complete: Final = [chunk("looking", '{"ci', None), chunk(" it up", 'ty": "Paris"}', "tool_calls")]
|
||||
await handler.process_output_streaming_response(
|
||||
responses_so_far=complete, guardrail_to_apply=guardrail,
|
||||
litellm_logging_obj=None, stream_transform_sink=StreamTransformSink(),
|
||||
)
|
||||
sent: Final = RecordingGuardrail.seen[-1]
|
||||
assert sent is not None
|
||||
assert [call["function"]["arguments"] for call in sent] == ['{"city": "Paris"}']
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_deliver_ended_stream_tool_rewrites_keep_choice_indices(self) -> None:
|
||||
handler: Final = OpenAIChatCompletionsHandler()
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue