feat: support for custom toolchoice in LLMs

.changeset/real-phones-cheat.md

@@ -0,0 +1,5 @@
+---
+"livekit-plugins-anthropic": patch
+---
+
+support for custom tool use in anthropic

livekit-agents/livekit/agents/llm/fallback_adapter.py

@@ -4,7 +4,7 @@
 import dataclasses
 import time
 from dataclasses import dataclass
-from typing import AsyncIterable, Literal
+from typing import AsyncIterable, Literal, TypedDict, Union
 
 from livekit.agents._exceptions import APIConnectionError, APIError
 
@@ -31,6 +31,11 @@ class AvailabilityChangedEvent:
     available: bool
 
 
+class ToolChoice(TypedDict, total=False):
+    type: Literal["auto", "any", "tool", "none", "required"]
+    name: str
+
+
 class FallbackAdapter(
     LLM[Literal["llm_availability_changed"]],
 ):
@@ -66,6 +71,9 @@ def chat(
         temperature: float | None = None,
         n: int | None = 1,
         parallel_tool_calls: bool | None = None,
+        tool_choice: Union[
+            ToolChoice, None, Literal["auto", "any", "none", "required"]
+        ] = None,
     ) -> "LLMStream":
         return FallbackLLMStream(
             llm=self,

livekit-agents/livekit/agents/llm/llm.py

@@ -5,7 +5,16 @@
 from abc import ABC, abstractmethod
 from dataclasses import dataclass, field
 from types import TracebackType
-from typing import Any, AsyncIterable, AsyncIterator, Generic, Literal, TypeVar, Union
+from typing import (
+    Any,
+    AsyncIterable,
+    AsyncIterator,
+    Generic,
+    Literal,
+    TypedDict,
+    TypeVar,
+    Union,
+)
 
 from livekit import rtc
 from livekit.agents._exceptions import APIConnectionError, APIError
@@ -51,6 +60,11 @@ class ChatChunk:
     usage: CompletionUsage | None = None
 
 
+class ToolChoice(TypedDict, total=False):
+    type: Literal["auto", "any", "tool", "none", "required"]
+    name: str
+
+
 TEvent = TypeVar("TEvent")
 
 
@@ -78,6 +92,9 @@ def chat(
         temperature: float | None = None,
         n: int | None = None,
         parallel_tool_calls: bool | None = None,
+        tool_choice: Union[
+            ToolChoice, None, Literal["auto", "any", "none", "required"]
+        ] = None,
     ) -> "LLMStream": ...
 
     @property

livekit-plugins/livekit-plugins-anthropic/livekit/plugins/anthropic/llm.py

@@ -19,7 +19,17 @@
 import json
 import os
 from dataclasses import dataclass
-from typing import Any, Awaitable, List, Tuple, get_args, get_origin
+from typing import (
+    Any,
+    Awaitable,
+    List,
+    Literal,
+    Tuple,
+    TypedDict,
+    Union,
+    get_args,
+    get_origin,
+)
 
 import httpx
 from livekit import rtc
@@ -40,11 +50,18 @@
 )
 
 
+class ToolChoice(TypedDict, total=False):
+    type: Literal["auto", "any", "tool", "none", "required"]
+    name: str  # Optional: only used when type is "tool"
+
+
 @dataclass
 class LLMOptions:
     model: str | ChatModels
     user: str | None
     temperature: float | None
+    parallel_tool_calls: bool | None
+    tool_choice: Union[ToolChoice, None, Literal["auto", "any", "none", "required"]]
 
 
 class LLM(llm.LLM):
@@ -57,6 +74,10 @@ def __init__(
         user: str | None = None,
         client: anthropic.AsyncClient | None = None,
         temperature: float | None = None,
+        parallel_tool_calls: bool | None = None,
+        tool_choice: Union[
+            ToolChoice, None, Literal["auto", "any", "none", "required"]
+        ] = None,
     ) -> None:
         """
         Create a new instance of Anthropic LLM.
@@ -71,7 +92,13 @@ def __init__(
         if api_key is None:
             raise ValueError("Anthropic API key is required")
 
-        self._opts = LLMOptions(model=model, user=user, temperature=temperature)
+        self._opts = LLMOptions(
+            model=model,
+            user=user,
+            temperature=temperature,
+            parallel_tool_calls=parallel_tool_calls,
+            tool_choice=tool_choice,
+        )
         self._client = client or anthropic.AsyncClient(
             api_key=api_key,
             base_url=base_url,
@@ -95,9 +122,16 @@ def chat(
         temperature: float | None = None,
         n: int | None = 1,
         parallel_tool_calls: bool | None = None,
+        tool_choice: Union[
+            ToolChoice, None, Literal["auto", "any", "none", "required"]
+        ] = None,
     ) -> "LLMStream":
         if temperature is None:
             temperature = self._opts.temperature
+        if parallel_tool_calls is None:
+            parallel_tool_calls = self._opts.parallel_tool_calls
+        if tool_choice is None:
+            tool_choice = self._opts.tool_choice
 
         opts: dict[str, Any] = dict()
         if fnc_ctx and len(fnc_ctx.ai_functions) > 0:
@@ -106,9 +140,23 @@ def chat(
                 fncs_desc.append(_build_function_description(fnc))
 
             opts["tools"] = fncs_desc
-
-            if fnc_ctx and parallel_tool_calls is not None:
-                opts["parallel_tool_calls"] = parallel_tool_calls
+            anthropic_tool_choice: dict[str, Any] = {"type": "auto"}
+            if isinstance(tool_choice, dict):
+                if tool_choice["type"] == "tool":
+                    anthropic_tool_choice = {
+                        "type": "tool",
+                        "name": tool_choice["name"],
+                    }
+                elif tool_choice["type"] in ["any", "required"]:
+                    anthropic_tool_choice = {"type": "any"}
+            elif isinstance(tool_choice, str):
+                if tool_choice in ["any", "required"]:
+                    anthropic_tool_choice = {"type": "any"}
+                elif tool_choice == "none":
+                    anthropic_tool_choice = {"type": "auto"}
+            if parallel_tool_calls is not None and parallel_tool_calls is False:
+                anthropic_tool_choice["disable_parallel_tool_use"] = True
+            opts["tool_choice"] = anthropic_tool_choice
 
         latest_system_message = _latest_system_message(chat_ctx)
         anthropic_ctx = _build_anthropic_context(chat_ctx.messages, id(self))

livekit-plugins/livekit-plugins-openai/livekit/plugins/openai/beta/assistant_llm.py

@@ -18,7 +18,7 @@
 import json
 import uuid
 from dataclasses import dataclass
-from typing import Any, Callable, Dict, Literal, MutableSet
+from typing import Any, Callable, Dict, Literal, MutableSet, TypedDict, Union
 
 import httpx
 from livekit import rtc
@@ -53,6 +53,11 @@ class LLMOptions:
     model: str | ChatModels
 
 
+class ToolChoice(TypedDict, total=False):
+    type: Literal["auto", "any", "tool", "none", "required"]
+    name: str  # Optional: only used when type is "tool"
+
+
 @dataclass
 class AssistantOptions:
     """Options for creating (on-the-fly) or loading an assistant. Only one of create_options or load_options should be set."""
@@ -172,6 +177,9 @@ def chat(
         temperature: float | None = None,
         n: int | None = None,
         parallel_tool_calls: bool | None = None,
+        tool_choice: Union[
+            ToolChoice, None, Literal["auto", "any", "none", "required"]
+        ] = None,
     ):
         if n is not None:
             logger.warning("OpenAI Assistants does not support the 'n' parameter")