agent-framework-openai 1.0.0__tar.gz

agent_framework_openai-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

agent_framework_openai-1.0.0/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: agent-framework-openai
+Version: 1.0.0
+Summary: OpenAI integrations for Microsoft Agent Framework.
+Author-email: Microsoft <af-support@microsoft.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+License-File: LICENSE
+Requires-Dist: agent-framework-core>=1.0.0,<2
+Requires-Dist: openai>=1.99.0,<3
+Project-URL: homepage, https://aka.ms/agent-framework
+Project-URL: issues, https://github.com/microsoft/agent-framework/issues
+Project-URL: release_notes, https://github.com/microsoft/agent-framework/releases?q=tag%3Apython-1&expanded=true
+Project-URL: source, https://github.com/microsoft/agent-framework/tree/main/python
+
+# agent-framework-openai
+
+OpenAI integration for Microsoft Agent Framework.
+
+This package provides:
+
+- `OpenAIChatClient` for the OpenAI Responses API
+- `OpenAIChatCompletionClient` for the Chat Completions API
+- `OpenAIEmbeddingClient` for embeddings
+
+## Installation
+
+```bash
+pip install agent-framework-openai
+```
+
+## Which chat client should I use?
+
+Use `OpenAIChatClient` for new work unless you specifically need the Chat Completions API.
+
+- `OpenAIChatClient` uses the Responses API and is the preferred general-purpose chat client.
+- `OpenAIChatCompletionClient` uses the Chat Completions API and is mainly for compatibility with
+  existing Chat Completions-based integrations.
+
+The previous deprecated Responses alias has been removed. Use `OpenAIChatClient` directly.
+
+## Environment variables
+
+### OpenAI
+
+These variables are used when the client is configured for OpenAI:
+
+| Variable | Purpose |
+| --- | --- |
+| `OPENAI_API_KEY` | OpenAI API key |
+| `OPENAI_ORG_ID` | OpenAI organization ID |
+| `OPENAI_BASE_URL` | Custom OpenAI-compatible base URL |
+| `OPENAI_MODEL` | Generic fallback model |
+| `OPENAI_CHAT_MODEL` | Preferred model for `OpenAIChatClient` |
+| `OPENAI_CHAT_COMPLETION_MODEL` | Preferred model for `OpenAIChatCompletionClient` |
+| `OPENAI_EMBEDDING_MODEL` | Preferred model for `OpenAIEmbeddingClient` |
+
+Model lookup order:
+
+- `OpenAIChatClient`: `OPENAI_CHAT_MODEL` -> `OPENAI_MODEL`
+- `OpenAIChatCompletionClient`: `OPENAI_CHAT_COMPLETION_MODEL` -> `OPENAI_MODEL`
+- `OpenAIEmbeddingClient`: `OPENAI_EMBEDDING_MODEL` -> `OPENAI_MODEL`
+
+These model variables are only consulted when you do not pass `model=` directly. In other words,
+`OpenAIChatClient(model="...")` ignores `OPENAI_CHAT_MODEL`, and
+`OpenAIChatCompletionClient(model="...")` ignores `OPENAI_CHAT_COMPLETION_MODEL`.
+
+### Azure OpenAI
+
+These variables are used when the client is configured for Azure OpenAI:
+
+| Variable | Purpose |
+| --- | --- |
+| `AZURE_OPENAI_ENDPOINT` | Azure OpenAI resource endpoint |
+| `AZURE_OPENAI_BASE_URL` | Full Azure OpenAI base URL (`.../openai/v1`) |
+| `AZURE_OPENAI_API_KEY` | Azure OpenAI API key |
+| `AZURE_OPENAI_API_VERSION` | Azure OpenAI API version |
+| `AZURE_OPENAI_MODEL` | Generic fallback deployment |
+| `AZURE_OPENAI_CHAT_MODEL` | Preferred deployment for `OpenAIChatClient` |
+| `AZURE_OPENAI_CHAT_COMPLETION_MODEL` | Preferred deployment for `OpenAIChatCompletionClient` |
+| `AZURE_OPENAI_EMBEDDING_MODEL` | Preferred deployment for `OpenAIEmbeddingClient` |
+
+Deployment lookup order:
+
+- `OpenAIChatClient`: `AZURE_OPENAI_CHAT_MODEL` -> `AZURE_OPENAI_MODEL`
+- `OpenAIChatCompletionClient`: `AZURE_OPENAI_CHAT_COMPLETION_MODEL` -> `AZURE_OPENAI_MODEL`
+- `OpenAIEmbeddingClient`: `AZURE_OPENAI_EMBEDDING_MODEL` -> `AZURE_OPENAI_MODEL`
+
+For Azure routing, the same rule applies: the client-specific deployment variable is checked first,
+then the generic `AZURE_OPENAI_MODEL` fallback. Passing `model=` overrides both environment variables.
+
+When both OpenAI and Azure environment variables are present, the generic clients prefer OpenAI
+when `OPENAI_API_KEY` is configured. To use Azure explicitly, pass `azure_endpoint` or
+`credential`.
+
+## OpenAI example
+
+```python
+from agent_framework.openai import OpenAIChatClient
+
+client = OpenAIChatClient(model="gpt-4.1")
+```
+
+## Azure OpenAI example
+
+```python
+from azure.identity.aio import AzureCliCredential
+
+from agent_framework.openai import OpenAIChatClient
+
+client = OpenAIChatClient(
+    model="my-responses-deployment",
+    azure_endpoint="https://my-resource.openai.azure.com",
+    credential=AzureCliCredential(),
+)
+```
+
+## ChatClient vs ChatCompletionClient
+
+Use `OpenAIChatClient` when you want the Responses API as your default chat surface.
+
+Use `OpenAIChatCompletionClient` when you specifically need the Chat Completions API:
+
+```python
+from agent_framework.openai import OpenAIChatCompletionClient
+
+client = OpenAIChatCompletionClient(model="gpt-4o-mini")
+```
+

agent_framework_openai-1.0.0/README.md

@@ -0,0 +1,113 @@
+# agent-framework-openai
+
+OpenAI integration for Microsoft Agent Framework.
+
+This package provides:
+
+- `OpenAIChatClient` for the OpenAI Responses API
+- `OpenAIChatCompletionClient` for the Chat Completions API
+- `OpenAIEmbeddingClient` for embeddings
+
+## Installation
+
+```bash
+pip install agent-framework-openai
+```
+
+## Which chat client should I use?
+
+Use `OpenAIChatClient` for new work unless you specifically need the Chat Completions API.
+
+- `OpenAIChatClient` uses the Responses API and is the preferred general-purpose chat client.
+- `OpenAIChatCompletionClient` uses the Chat Completions API and is mainly for compatibility with
+  existing Chat Completions-based integrations.
+
+The previous deprecated Responses alias has been removed. Use `OpenAIChatClient` directly.
+
+## Environment variables
+
+### OpenAI
+
+These variables are used when the client is configured for OpenAI:
+
+| Variable | Purpose |
+| --- | --- |
+| `OPENAI_API_KEY` | OpenAI API key |
+| `OPENAI_ORG_ID` | OpenAI organization ID |
+| `OPENAI_BASE_URL` | Custom OpenAI-compatible base URL |
+| `OPENAI_MODEL` | Generic fallback model |
+| `OPENAI_CHAT_MODEL` | Preferred model for `OpenAIChatClient` |
+| `OPENAI_CHAT_COMPLETION_MODEL` | Preferred model for `OpenAIChatCompletionClient` |
+| `OPENAI_EMBEDDING_MODEL` | Preferred model for `OpenAIEmbeddingClient` |
+
+Model lookup order:
+
+- `OpenAIChatClient`: `OPENAI_CHAT_MODEL` -> `OPENAI_MODEL`
+- `OpenAIChatCompletionClient`: `OPENAI_CHAT_COMPLETION_MODEL` -> `OPENAI_MODEL`
+- `OpenAIEmbeddingClient`: `OPENAI_EMBEDDING_MODEL` -> `OPENAI_MODEL`
+
+These model variables are only consulted when you do not pass `model=` directly. In other words,
+`OpenAIChatClient(model="...")` ignores `OPENAI_CHAT_MODEL`, and
+`OpenAIChatCompletionClient(model="...")` ignores `OPENAI_CHAT_COMPLETION_MODEL`.
+
+### Azure OpenAI
+
+These variables are used when the client is configured for Azure OpenAI:
+
+| Variable | Purpose |
+| --- | --- |
+| `AZURE_OPENAI_ENDPOINT` | Azure OpenAI resource endpoint |
+| `AZURE_OPENAI_BASE_URL` | Full Azure OpenAI base URL (`.../openai/v1`) |
+| `AZURE_OPENAI_API_KEY` | Azure OpenAI API key |
+| `AZURE_OPENAI_API_VERSION` | Azure OpenAI API version |
+| `AZURE_OPENAI_MODEL` | Generic fallback deployment |
+| `AZURE_OPENAI_CHAT_MODEL` | Preferred deployment for `OpenAIChatClient` |
+| `AZURE_OPENAI_CHAT_COMPLETION_MODEL` | Preferred deployment for `OpenAIChatCompletionClient` |
+| `AZURE_OPENAI_EMBEDDING_MODEL` | Preferred deployment for `OpenAIEmbeddingClient` |
+
+Deployment lookup order:
+
+- `OpenAIChatClient`: `AZURE_OPENAI_CHAT_MODEL` -> `AZURE_OPENAI_MODEL`
+- `OpenAIChatCompletionClient`: `AZURE_OPENAI_CHAT_COMPLETION_MODEL` -> `AZURE_OPENAI_MODEL`
+- `OpenAIEmbeddingClient`: `AZURE_OPENAI_EMBEDDING_MODEL` -> `AZURE_OPENAI_MODEL`
+
+For Azure routing, the same rule applies: the client-specific deployment variable is checked first,
+then the generic `AZURE_OPENAI_MODEL` fallback. Passing `model=` overrides both environment variables.
+
+When both OpenAI and Azure environment variables are present, the generic clients prefer OpenAI
+when `OPENAI_API_KEY` is configured. To use Azure explicitly, pass `azure_endpoint` or
+`credential`.
+
+## OpenAI example
+
+```python
+from agent_framework.openai import OpenAIChatClient
+
+client = OpenAIChatClient(model="gpt-4.1")
+```
+
+## Azure OpenAI example
+
+```python
+from azure.identity.aio import AzureCliCredential
+
+from agent_framework.openai import OpenAIChatClient
+
+client = OpenAIChatClient(
+    model="my-responses-deployment",
+    azure_endpoint="https://my-resource.openai.azure.com",
+    credential=AzureCliCredential(),
+)
+```
+
+## ChatClient vs ChatCompletionClient
+
+Use `OpenAIChatClient` when you want the Responses API as your default chat surface.
+
+Use `OpenAIChatCompletionClient` when you specifically need the Chat Completions API:
+
+```python
+from agent_framework.openai import OpenAIChatCompletionClient
+
+client = OpenAIChatCompletionClient(model="gpt-4o-mini")
+```

agent_framework_openai-1.0.0/agent_framework_openai/__init__.py

@@ -0,0 +1,45 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+"""OpenAI integration for Microsoft Agent Framework.
+
+This package provides OpenAI client implementations for the Agent Framework,
+including clients for the Responses API and Chat Completions API.
+"""
+
+import importlib.metadata
+
+from ._chat_client import (
+    OpenAIChatClient,
+    OpenAIChatOptions,
+    OpenAIContinuationToken,
+    RawOpenAIChatClient,
+)
+from ._chat_completion_client import (
+    OpenAIChatCompletionClient,
+    OpenAIChatCompletionOptions,
+    RawOpenAIChatCompletionClient,
+)
+from ._embedding_client import OpenAIEmbeddingClient, OpenAIEmbeddingOptions
+from ._exceptions import ContentFilterResultSeverity, OpenAIContentFilterException
+from ._shared import OpenAISettings
+
+try:
+    __version__ = importlib.metadata.version("agent-framework-openai")
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "0.0.0"  # Fallback for development mode
+
+__all__ = [
+    "ContentFilterResultSeverity",
+    "OpenAIChatClient",
+    "OpenAIChatCompletionClient",
+    "OpenAIChatCompletionOptions",
+    "OpenAIChatOptions",
+    "OpenAIContentFilterException",
+    "OpenAIContinuationToken",
+    "OpenAIEmbeddingClient",
+    "OpenAIEmbeddingOptions",
+    "OpenAISettings",
+    "RawOpenAIChatClient",
+    "RawOpenAIChatCompletionClient",
+    "__version__",
+]