llama-index-llms-openai 0.2.11__tar.gz → 0.2.13__tar.gz

llama_index_llms_openai-0.2.13/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.1
+Name: llama-index-llms-openai
+Version: 0.2.13
+Summary: llama-index llms openai integration
+License: MIT
+Author: llama-index
+Requires-Python: >=3.8.1,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: llama-index-core (>=0.11.7,<0.12.0)
+Requires-Dist: openai (>=1.40.0,<2.0.0)
+Description-Content-Type: text/markdown
+
+# LlamaIndex Llms Integration: Openai
+
+## Installation
+
+To install the required package, run:
+
+```bash
+%pip install llama-index-llms-openai
+```
+
+## Setup
+
+1. Set your OpenAI API key as an environment variable. You can replace `"sk-..."` with your actual API key:
+
+```python
+import os
+
+os.environ["OPENAI_API_KEY"] = "sk-..."
+```
+
+## Basic Usage
+
+### Generate Completions
+
+To generate a completion for a prompt, use the `complete` method:
+
+```python
+from llama_index.llms.openai import OpenAI
+
+resp = OpenAI().complete("Paul Graham is ")
+print(resp)
+```
+
+### Chat Responses
+
+To send a chat message and receive a response, create a list of `ChatMessage` instances and use the `chat` method:
+
+```python
+from llama_index.core.llms import ChatMessage
+
+messages = [
+    ChatMessage(
+        role="system", content="You are a pirate with a colorful personality."
+    ),
+    ChatMessage(role="user", content="What is your name?"),
+]
+resp = OpenAI().chat(messages)
+print(resp)
+```
+
+## Streaming Responses
+
+### Stream Complete
+
+To stream responses for a prompt, use the `stream_complete` method:
+
+```python
+from llama_index.llms.openai import OpenAI
+
+llm = OpenAI()
+resp = llm.stream_complete("Paul Graham is ")
+for r in resp:
+    print(r.delta, end="")
+```
+
+### Stream Chat
+
+To stream chat responses, use the `stream_chat` method:
+
+```python
+from llama_index.llms.openai import OpenAI
+from llama_index.core.llms import ChatMessage
+
+llm = OpenAI()
+messages = [
+    ChatMessage(
+        role="system", content="You are a pirate with a colorful personality."
+    ),
+    ChatMessage(role="user", content="What is your name?"),
+]
+resp = llm.stream_chat(messages)
+for r in resp:
+    print(r.delta, end="")
+```
+
+## Configure Model
+
+You can specify a particular model when creating the `OpenAI` instance:
+
+```python
+llm = OpenAI(model="gpt-3.5-turbo")
+resp = llm.complete("Paul Graham is ")
+print(resp)
+
+messages = [
+    ChatMessage(
+        role="system", content="You are a pirate with a colorful personality."
+    ),
+    ChatMessage(role="user", content="What is your name?"),
+]
+resp = llm.chat(messages)
+print(resp)
+```
+
+## Asynchronous Usage
+
+You can also use asynchronous methods for completion:
+
+```python
+from llama_index.llms.openai import OpenAI
+
+llm = OpenAI(model="gpt-3.5-turbo")
+resp = await llm.acomplete("Paul Graham is ")
+print(resp)
+```
+
+## Set API Key at a Per-Instance Level
+
+If desired, you can have separate LLM instances use different API keys:
+
+```python
+from llama_index.llms.openai import OpenAI
+
+llm = OpenAI(model="gpt-3.5-turbo", api_key="BAD_KEY")
+resp = OpenAI().complete("Paul Graham is ")
+print(resp)
+```
+
+### LLM Implementation example
+
+https://docs.llamaindex.ai/en/stable/examples/llm/openai/
+

llama_index_llms_openai-0.2.13/README.md

@@ -0,0 +1,131 @@
+# LlamaIndex Llms Integration: Openai
+
+## Installation
+
+To install the required package, run:
+
+```bash
+%pip install llama-index-llms-openai
+```
+
+## Setup
+
+1. Set your OpenAI API key as an environment variable. You can replace `"sk-..."` with your actual API key:
+
+```python
+import os
+
+os.environ["OPENAI_API_KEY"] = "sk-..."
+```
+
+## Basic Usage
+
+### Generate Completions
+
+To generate a completion for a prompt, use the `complete` method:
+
+```python
+from llama_index.llms.openai import OpenAI
+
+resp = OpenAI().complete("Paul Graham is ")
+print(resp)
+```
+
+### Chat Responses
+
+To send a chat message and receive a response, create a list of `ChatMessage` instances and use the `chat` method:
+
+```python
+from llama_index.core.llms import ChatMessage
+
+messages = [
+    ChatMessage(
+        role="system", content="You are a pirate with a colorful personality."
+    ),
+    ChatMessage(role="user", content="What is your name?"),
+]
+resp = OpenAI().chat(messages)
+print(resp)
+```
+
+## Streaming Responses
+
+### Stream Complete
+
+To stream responses for a prompt, use the `stream_complete` method:
+
+```python
+from llama_index.llms.openai import OpenAI
+
+llm = OpenAI()
+resp = llm.stream_complete("Paul Graham is ")
+for r in resp:
+    print(r.delta, end="")
+```
+
+### Stream Chat
+
+To stream chat responses, use the `stream_chat` method:
+
+```python
+from llama_index.llms.openai import OpenAI
+from llama_index.core.llms import ChatMessage
+
+llm = OpenAI()
+messages = [
+    ChatMessage(
+        role="system", content="You are a pirate with a colorful personality."
+    ),
+    ChatMessage(role="user", content="What is your name?"),
+]
+resp = llm.stream_chat(messages)
+for r in resp:
+    print(r.delta, end="")
+```
+
+## Configure Model
+
+You can specify a particular model when creating the `OpenAI` instance:
+
+```python
+llm = OpenAI(model="gpt-3.5-turbo")
+resp = llm.complete("Paul Graham is ")
+print(resp)
+
+messages = [
+    ChatMessage(
+        role="system", content="You are a pirate with a colorful personality."
+    ),
+    ChatMessage(role="user", content="What is your name?"),
+]
+resp = llm.chat(messages)
+print(resp)
+```
+
+## Asynchronous Usage
+
+You can also use asynchronous methods for completion:
+
+```python
+from llama_index.llms.openai import OpenAI
+
+llm = OpenAI(model="gpt-3.5-turbo")
+resp = await llm.acomplete("Paul Graham is ")
+print(resp)
+```
+
+## Set API Key at a Per-Instance Level
+
+If desired, you can have separate LLM instances use different API keys:
+
+```python
+from llama_index.llms.openai import OpenAI
+
+llm = OpenAI(model="gpt-3.5-turbo", api_key="BAD_KEY")
+resp = OpenAI().complete("Paul Graham is ")
+print(resp)
+```
+
+### LLM Implementation example
+
+https://docs.llamaindex.ai/en/stable/examples/llm/openai/

{llama_index_llms_openai-0.2.11 → llama_index_llms_openai-0.2.13}/llama_index/llms/openai/base.py

@@ -488,7 +488,8 @@ class OpenAI(FunctionCallingLLM):
                 additional_kwargs = {}
                 if is_function:
                     tool_calls = update_tool_calls(tool_calls, delta.tool_calls)
-                    additional_kwargs["tool_calls"] = tool_calls
+                    if tool_calls:
+                        additional_kwargs["tool_calls"] = tool_calls
 
                 yield ChatResponse(
                     message=ChatMessage(
@@ -738,7 +739,8 @@ class OpenAI(FunctionCallingLLM):
                 additional_kwargs = {}
                 if is_function:
                     tool_calls = update_tool_calls(tool_calls, delta.tool_calls)
-                    additional_kwargs["tool_calls"] = tool_calls
+                    if tool_calls:
+                        additional_kwargs["tool_calls"] = tool_calls
 
                 yield ChatResponse(
                     message=ChatMessage(

{llama_index_llms_openai-0.2.11 → llama_index_llms_openai-0.2.13}/llama_index/llms/openai/utils.py

@@ -54,6 +54,8 @@ GPT4_MODELS: Dict[str, int] = {
     "gpt-4o": 128000,
     "gpt-4o-2024-05-13": 128000,
     "gpt-4o-2024-08-06": 128000,
+    # Intended for research and evaluation
+    "chatgpt-4o-latest": 128000,
     "gpt-4o-mini": 128000,
     "gpt-4o-mini-2024-07-18": 128000,
     # 0613 models (function calling):
@@ -285,7 +287,7 @@ def from_openai_message(openai_message: ChatCompletionMessage) -> ChatMessage:
     # function_call = None  # deprecated in OpenAI v 1.1.0
 
     additional_kwargs: Dict[str, Any] = {}
-    if openai_message.tool_calls is not None:
+    if openai_message.tool_calls:
         tool_calls: List[ChatCompletionMessageToolCall] = openai_message.tool_calls
         additional_kwargs.update(tool_calls=tool_calls)
 

{llama_index_llms_openai-0.2.11 → llama_index_llms_openai-0.2.13}/pyproject.toml

@@ -29,7 +29,7 @@ exclude = ["**/BUILD"]
 license = "MIT"
 name = "llama-index-llms-openai"
 readme = "README.md"
-version = "0.2.11"
+version = "0.2.13"
 
 [tool.poetry.dependencies]
 python = ">=3.8.1,<4.0"

llama_index_llms_openai-0.2.11/PKG-INFO

@@ -1,19 +0,0 @@
-Metadata-Version: 2.1
-Name: llama-index-llms-openai
-Version: 0.2.11
-Summary: llama-index llms openai integration
-License: MIT
-Author: llama-index
-Requires-Python: >=3.8.1,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: llama-index-core (>=0.11.7,<0.12.0)
-Requires-Dist: openai (>=1.40.0,<2.0.0)
-Description-Content-Type: text/markdown
-
-# LlamaIndex Llms Integration: Openai
-

llama_index_llms_openai-0.2.11/README.md

@@ -1 +0,0 @@
-# LlamaIndex Llms Integration: Openai