--- id: llama-index-llms-openai version: "0.7.10" license: MIT license_treatment: permissive maintenance: active --- # llama-index-llms-openai — llama-index llms openai integration License: permissive · Maintenance: active · Popularity: top 1,000 on PyPI ## Install pip install llama-index-llms-openai uv add llama-index-llms-openai poetry add llama-index-llms-openai ## Description # 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... [View on SkillFed](https://skillfed.io/packages/llama-index-llms-openai) · [View on PyPI](https://pypi.org/project/llama-index-llms-openai/)