llama-index-llms-openai 0.3.44__py3-none-any.whl → 0.4.1__py3-none-any.whl

llama_index/llms/openai/base.py

@@ -179,6 +179,7 @@ class OpenAI(FunctionCallingLLM):
     )
     max_tokens: Optional[int] = Field(
         description="The maximum number of tokens to generate.",
+        default=None,
         gt=0,
     )
     logprobs: Optional[bool] = Field(
@@ -215,9 +216,13 @@ class OpenAI(FunctionCallingLLM):
         ),
     )
 
-    api_key: str = Field(default=None, description="The OpenAI API key.")
-    api_base: str = Field(description="The base URL for OpenAI API.")
-    api_version: str = Field(description="The API version for OpenAI API.")
+    api_key: Optional[str] = Field(default=None, description="The OpenAI API key.")
+    api_base: Optional[str] = Field(
+        default=None, description="The base URL for OpenAI API."
+    )
+    api_version: Optional[str] = Field(
+        default=None, description="The API version for OpenAI API."
+    )
     strict: bool = Field(
         default=False,
         description="Whether to use strict mode for invoking tools/using schemas.",
@@ -904,12 +909,15 @@ class OpenAI(FunctionCallingLLM):
         chat_history: Optional[List[ChatMessage]] = None,
         verbose: bool = False,
         allow_parallel_tool_calls: bool = False,
-        tool_choice: Union[str, dict] = "auto",
+        tool_required: bool = False,
+        tool_choice: Optional[Union[str, dict]] = None,
         strict: Optional[bool] = None,
         **kwargs: Any,
     ) -> Dict[str, Any]:
         """Predict and call the tool."""
-        tool_specs = [tool.metadata.to_openai_tool(skip_length_check=True) for tool in tools]
+        tool_specs = [
+            tool.metadata.to_openai_tool(skip_length_check=True) for tool in tools
+        ]
 
         # if strict is passed in, use, else default to the class-level attribute, else default to True`
         if strict is not None:
@@ -934,7 +942,9 @@ class OpenAI(FunctionCallingLLM):
         return {
             "messages": messages,
             "tools": tool_specs or None,
-            "tool_choice": resolve_tool_choice(tool_choice) if tool_specs else None,
+            "tool_choice": resolve_tool_choice(tool_choice, tool_required)
+            if tool_specs
+            else None,
             **kwargs,
         }
 

llama_index/llms/openai/responses.py

@@ -570,7 +570,12 @@ class OpenAIResponses(FunctionCallingLLM):
         elif isinstance(event, ResponseImageGenCallPartialImageEvent):
             # Partial image
             if event.partial_image_b64:
-                blocks.append(ImageBlock(image=base64.b64decode(event.partial_image_b64), detail=f"id_{event.partial_image_index}"))
+                blocks.append(
+                    ImageBlock(
+                        image=base64.b64decode(event.partial_image_b64),
+                        detail=f"id_{event.partial_image_index}",
+                    )
+                )
         elif isinstance(event, ResponseFunctionCallArgumentsDeltaEvent):
             # Function call arguments are being streamed
             if current_tool_call is not None:
@@ -815,7 +820,8 @@ class OpenAIResponses(FunctionCallingLLM):
         user_msg: Optional[Union[str, ChatMessage]] = None,
         chat_history: Optional[List[ChatMessage]] = None,
         allow_parallel_tool_calls: bool = True,
-        tool_choice: Union[str, dict] = "auto",
+        tool_required: bool = False,
+        tool_choice: Optional[Union[str, dict]] = None,
         verbose: bool = False,
         strict: Optional[bool] = None,
         **kwargs: Any,
@@ -848,7 +854,9 @@ class OpenAIResponses(FunctionCallingLLM):
         return {
             "messages": messages,
             "tools": tool_specs or None,
-            "tool_choice": resolve_tool_choice(tool_choice) if tool_specs else None,
+            "tool_choice": resolve_tool_choice(tool_choice, tool_required)
+            if tool_specs
+            else None,
             "parallel_tool_calls": allow_parallel_tool_calls,
             **kwargs,
         }
@@ -860,9 +868,9 @@ class OpenAIResponses(FunctionCallingLLM):
         **kwargs: Any,
     ) -> List[ToolSelection]:
         """Predict and call the tool."""
-        tool_calls: List[
-            ResponseFunctionToolCall
-        ] = response.message.additional_kwargs.get("tool_calls", [])
+        tool_calls: List[ResponseFunctionToolCall] = (
+            response.message.additional_kwargs.get("tool_calls", [])
+        )
 
         if len(tool_calls) < 1:
             if error_on_no_tool_call:

llama_index/llms/openai/utils.py

@@ -754,13 +754,19 @@ def validate_openai_api_key(api_key: Optional[str] = None) -> None:
         raise ValueError(MISSING_API_KEY_ERROR_MESSAGE)
 
 
-def resolve_tool_choice(tool_choice: Union[str, dict] = "auto") -> Union[str, dict]:
+def resolve_tool_choice(
+    tool_choice: Optional[Union[str, dict]], tool_required: bool = False
+) -> Union[str, dict]:
     """
     Resolve tool choice.
 
     If tool_choice is a function name string, return the appropriate dict.
     """
-    if isinstance(tool_choice, str) and tool_choice not in ["none", "auto", "required"]:
+    if tool_choice is None:
+        tool_choice = "required" if tool_required else "auto"
+    if isinstance(tool_choice, dict):
+        return tool_choice
+    if tool_choice not in ["none", "auto", "required"]:
         return {"type": "function", "function": {"name": tool_choice}}
 
     return tool_choice

{llama_index_llms_openai-0.3.44.dist-info → llama_index_llms_openai-0.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: llama-index-llms-openai
-Version: 0.3.44
+Version: 0.4.1
 Summary: llama-index llms openai integration
 Author: llama-index
 License-Expression: MIT

llama_index_llms_openai-0.4.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+llama_index/llms/openai/__init__.py,sha256=8nmgixeXifQ4eVSgtCic54WxXqrrpXQPL4rhACWCSFs,229
+llama_index/llms/openai/base.py,sha256=LTed9nxKpEnfha_FNDBrzNP3B1CTDFwaxGyAFUXXV5o,38856
+llama_index/llms/openai/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+llama_index/llms/openai/responses.py,sha256=Dmp7Tj-SzrzOcqGtWSBAFn-kwT44giXJSYxAXx233Ao,35944
+llama_index/llms/openai/utils.py,sha256=0xO-_6FPZRFCbW5JeqJDCMzLx3WN2_vVeAApWG74oA4,28071
+llama_index_llms_openai-0.4.1.dist-info/METADATA,sha256=qWTl2peBaSSumiXi90zIbdp3Ax04fbGjzK4u6fZEdmo,3039
+llama_index_llms_openai-0.4.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+llama_index_llms_openai-0.4.1.dist-info/licenses/LICENSE,sha256=JPQLUZD9rKvCTdu192Nk0V5PAwklIg6jANii3UmTyMs,1065
+llama_index_llms_openai-0.4.1.dist-info/RECORD,,

llama_index_llms_openai-0.3.44.dist-info/RECORD

@@ -1,9 +0,0 @@
-llama_index/llms/openai/__init__.py,sha256=8nmgixeXifQ4eVSgtCic54WxXqrrpXQPL4rhACWCSFs,229
-llama_index/llms/openai/base.py,sha256=2ojLUicnyDwVXO8-_kis93Yibrc8tQoUthSsY7tSyn8,38642
-llama_index/llms/openai/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-llama_index/llms/openai/responses.py,sha256=IVB2ZW8AZopUqKzaeJBsA36glKa9z6bh9lSBdT_KqGE,35749
-llama_index/llms/openai/utils.py,sha256=K8LQ6ykuU-TPzIJQLvZ869q5aGvXSM9HAJIX8GQfM_s,27913
-llama_index_llms_openai-0.3.44.dist-info/METADATA,sha256=pK9skvohtMh4L5JpWFDWht1gOSF3ikgnLJLsARZi1SI,3040
-llama_index_llms_openai-0.3.44.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-llama_index_llms_openai-0.3.44.dist-info/licenses/LICENSE,sha256=JPQLUZD9rKvCTdu192Nk0V5PAwklIg6jANii3UmTyMs,1065
-llama_index_llms_openai-0.3.44.dist-info/RECORD,,