358 lines
9.8 KiB
Python
358 lines
9.8 KiB
Python
|
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
||
|
|
|
||
|
|
from __future__ import annotations
|
||
|
|
|
||
|
|
import os as _os
|
||
|
|
from typing_extensions import override
|
||
|
|
|
||
|
|
from . import types
|
||
|
|
from ._types import NOT_GIVEN, NoneType, NotGiven, Transport, ProxiesTypes
|
||
|
|
from ._utils import file_from_path
|
||
|
|
from ._client import Client, OpenAI, Stream, Timeout, Transport, AsyncClient, AsyncOpenAI, AsyncStream, RequestOptions
|
||
|
|
from ._models import BaseModel
|
||
|
|
from ._version import __title__, __version__
|
||
|
|
from ._response import APIResponse as APIResponse, AsyncAPIResponse as AsyncAPIResponse
|
||
|
|
from ._constants import DEFAULT_TIMEOUT, DEFAULT_MAX_RETRIES, DEFAULT_CONNECTION_LIMITS
|
||
|
|
from ._exceptions import (
|
||
|
|
APIError,
|
||
|
|
OpenAIError,
|
||
|
|
ConflictError,
|
||
|
|
NotFoundError,
|
||
|
|
APIStatusError,
|
||
|
|
RateLimitError,
|
||
|
|
APITimeoutError,
|
||
|
|
BadRequestError,
|
||
|
|
APIConnectionError,
|
||
|
|
AuthenticationError,
|
||
|
|
InternalServerError,
|
||
|
|
PermissionDeniedError,
|
||
|
|
UnprocessableEntityError,
|
||
|
|
APIResponseValidationError,
|
||
|
|
)
|
||
|
|
from ._base_client import DefaultHttpxClient, DefaultAsyncHttpxClient
|
||
|
|
from ._utils._logs import setup_logging as _setup_logging
|
||
|
|
|
||
|
|
__all__ = [
|
||
|
|
"types",
|
||
|
|
"__version__",
|
||
|
|
"__title__",
|
||
|
|
"NoneType",
|
||
|
|
"Transport",
|
||
|
|
"ProxiesTypes",
|
||
|
|
"NotGiven",
|
||
|
|
"NOT_GIVEN",
|
||
|
|
"OpenAIError",
|
||
|
|
"APIError",
|
||
|
|
"APIStatusError",
|
||
|
|
"APITimeoutError",
|
||
|
|
"APIConnectionError",
|
||
|
|
"APIResponseValidationError",
|
||
|
|
"BadRequestError",
|
||
|
|
"AuthenticationError",
|
||
|
|
"PermissionDeniedError",
|
||
|
|
"NotFoundError",
|
||
|
|
"ConflictError",
|
||
|
|
"UnprocessableEntityError",
|
||
|
|
"RateLimitError",
|
||
|
|
"InternalServerError",
|
||
|
|
"Timeout",
|
||
|
|
"RequestOptions",
|
||
|
|
"Client",
|
||
|
|
"AsyncClient",
|
||
|
|
"Stream",
|
||
|
|
"AsyncStream",
|
||
|
|
"OpenAI",
|
||
|
|
"AsyncOpenAI",
|
||
|
|
"file_from_path",
|
||
|
|
"BaseModel",
|
||
|
|
"DEFAULT_TIMEOUT",
|
||
|
|
"DEFAULT_MAX_RETRIES",
|
||
|
|
"DEFAULT_CONNECTION_LIMITS",
|
||
|
|
"DefaultHttpxClient",
|
||
|
|
"DefaultAsyncHttpxClient",
|
||
|
|
]
|
||
|
|
|
||
|
|
from .lib import azure as _azure
|
||
|
|
from .version import VERSION as VERSION
|
||
|
|
from .lib.azure import AzureOpenAI as AzureOpenAI, AsyncAzureOpenAI as AsyncAzureOpenAI
|
||
|
|
from .lib._old_api import *
|
||
|
|
from .lib.streaming import (
|
||
|
|
AssistantEventHandler as AssistantEventHandler,
|
||
|
|
AsyncAssistantEventHandler as AsyncAssistantEventHandler,
|
||
|
|
)
|
||
|
|
|
||
|
|
_setup_logging()
|
||
|
|
|
||
|
|
# Update the __module__ attribute for exported symbols so that
|
||
|
|
# error messages point to this module instead of the module
|
||
|
|
# it was originally defined in, e.g.
|
||
|
|
# openai._exceptions.NotFoundError -> openai.NotFoundError
|
||
|
|
__locals = locals()
|
||
|
|
for __name in __all__:
|
||
|
|
if not __name.startswith("__"):
|
||
|
|
try:
|
||
|
|
__locals[__name].__module__ = "openai"
|
||
|
|
except (TypeError, AttributeError):
|
||
|
|
# Some of our exported symbols are builtins which we can't set attributes for.
|
||
|
|
pass
|
||
|
|
|
||
|
|
# ------ Module level client ------
|
||
|
|
import typing as _t
|
||
|
|
import typing_extensions as _te
|
||
|
|
|
||
|
|
import httpx as _httpx
|
||
|
|
|
||
|
|
from ._base_client import DEFAULT_TIMEOUT, DEFAULT_MAX_RETRIES
|
||
|
|
|
||
|
|
api_key: str | None = None
|
||
|
|
|
||
|
|
organization: str | None = None
|
||
|
|
|
||
|
|
project: str | None = None
|
||
|
|
|
||
|
|
base_url: str | _httpx.URL | None = None
|
||
|
|
|
||
|
|
timeout: float | Timeout | None = DEFAULT_TIMEOUT
|
||
|
|
|
||
|
|
max_retries: int = DEFAULT_MAX_RETRIES
|
||
|
|
|
||
|
|
default_headers: _t.Mapping[str, str] | None = None
|
||
|
|
|
||
|
|
default_query: _t.Mapping[str, object] | None = None
|
||
|
|
|
||
|
|
http_client: _httpx.Client | None = None
|
||
|
|
|
||
|
|
_ApiType = _te.Literal["openai", "azure"]
|
||
|
|
|
||
|
|
api_type: _ApiType | None = _t.cast(_ApiType, _os.environ.get("OPENAI_API_TYPE"))
|
||
|
|
|
||
|
|
api_version: str | None = _os.environ.get("OPENAI_API_VERSION")
|
||
|
|
|
||
|
|
azure_endpoint: str | None = _os.environ.get("AZURE_OPENAI_ENDPOINT")
|
||
|
|
|
||
|
|
azure_ad_token: str | None = _os.environ.get("AZURE_OPENAI_AD_TOKEN")
|
||
|
|
|
||
|
|
azure_ad_token_provider: _azure.AzureADTokenProvider | None = None
|
||
|
|
|
||
|
|
|
||
|
|
class _ModuleClient(OpenAI):
|
||
|
|
# Note: we have to use type: ignores here as overriding class members
|
||
|
|
# with properties is technically unsafe but it is fine for our use case
|
||
|
|
|
||
|
|
@property # type: ignore
|
||
|
|
@override
|
||
|
|
def api_key(self) -> str | None:
|
||
|
|
return api_key
|
||
|
|
|
||
|
|
@api_key.setter # type: ignore
|
||
|
|
def api_key(self, value: str | None) -> None: # type: ignore
|
||
|
|
global api_key
|
||
|
|
|
||
|
|
api_key = value
|
||
|
|
|
||
|
|
@property # type: ignore
|
||
|
|
@override
|
||
|
|
def organization(self) -> str | None:
|
||
|
|
return organization
|
||
|
|
|
||
|
|
@organization.setter # type: ignore
|
||
|
|
def organization(self, value: str | None) -> None: # type: ignore
|
||
|
|
global organization
|
||
|
|
|
||
|
|
organization = value
|
||
|
|
|
||
|
|
@property # type: ignore
|
||
|
|
@override
|
||
|
|
def project(self) -> str | None:
|
||
|
|
return project
|
||
|
|
|
||
|
|
@project.setter # type: ignore
|
||
|
|
def project(self, value: str | None) -> None: # type: ignore
|
||
|
|
global project
|
||
|
|
|
||
|
|
project = value
|
||
|
|
|
||
|
|
@property
|
||
|
|
@override
|
||
|
|
def base_url(self) -> _httpx.URL:
|
||
|
|
if base_url is not None:
|
||
|
|
return _httpx.URL(base_url)
|
||
|
|
|
||
|
|
return super().base_url
|
||
|
|
|
||
|
|
@base_url.setter
|
||
|
|
def base_url(self, url: _httpx.URL | str) -> None:
|
||
|
|
super().base_url = url # type: ignore[misc]
|
||
|
|
|
||
|
|
@property # type: ignore
|
||
|
|
@override
|
||
|
|
def timeout(self) -> float | Timeout | None:
|
||
|
|
return timeout
|
||
|
|
|
||
|
|
@timeout.setter # type: ignore
|
||
|
|
def timeout(self, value: float | Timeout | None) -> None: # type: ignore
|
||
|
|
global timeout
|
||
|
|
|
||
|
|
timeout = value
|
||
|
|
|
||
|
|
@property # type: ignore
|
||
|
|
@override
|
||
|
|
def max_retries(self) -> int:
|
||
|
|
return max_retries
|
||
|
|
|
||
|
|
@max_retries.setter # type: ignore
|
||
|
|
def max_retries(self, value: int) -> None: # type: ignore
|
||
|
|
global max_retries
|
||
|
|
|
||
|
|
max_retries = value
|
||
|
|
|
||
|
|
@property # type: ignore
|
||
|
|
@override
|
||
|
|
def _custom_headers(self) -> _t.Mapping[str, str] | None:
|
||
|
|
return default_headers
|
||
|
|
|
||
|
|
@_custom_headers.setter # type: ignore
|
||
|
|
def _custom_headers(self, value: _t.Mapping[str, str] | None) -> None: # type: ignore
|
||
|
|
global default_headers
|
||
|
|
|
||
|
|
default_headers = value
|
||
|
|
|
||
|
|
@property # type: ignore
|
||
|
|
@override
|
||
|
|
def _custom_query(self) -> _t.Mapping[str, object] | None:
|
||
|
|
return default_query
|
||
|
|
|
||
|
|
@_custom_query.setter # type: ignore
|
||
|
|
def _custom_query(self, value: _t.Mapping[str, object] | None) -> None: # type: ignore
|
||
|
|
global default_query
|
||
|
|
|
||
|
|
default_query = value
|
||
|
|
|
||
|
|
@property # type: ignore
|
||
|
|
@override
|
||
|
|
def _client(self) -> _httpx.Client:
|
||
|
|
return http_client or super()._client
|
||
|
|
|
||
|
|
@_client.setter # type: ignore
|
||
|
|
def _client(self, value: _httpx.Client) -> None: # type: ignore
|
||
|
|
global http_client
|
||
|
|
|
||
|
|
http_client = value
|
||
|
|
|
||
|
|
|
||
|
|
class _AzureModuleClient(_ModuleClient, AzureOpenAI): # type: ignore
|
||
|
|
...
|
||
|
|
|
||
|
|
|
||
|
|
class _AmbiguousModuleClientUsageError(OpenAIError):
|
||
|
|
def __init__(self) -> None:
|
||
|
|
super().__init__(
|
||
|
|
"Ambiguous use of module client; please set `openai.api_type` or the `OPENAI_API_TYPE` environment variable to `openai` or `azure`"
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
def _has_openai_credentials() -> bool:
|
||
|
|
return _os.environ.get("OPENAI_API_KEY") is not None
|
||
|
|
|
||
|
|
|
||
|
|
def _has_azure_credentials() -> bool:
|
||
|
|
return azure_endpoint is not None or _os.environ.get("AZURE_OPENAI_API_KEY") is not None
|
||
|
|
|
||
|
|
|
||
|
|
def _has_azure_ad_credentials() -> bool:
|
||
|
|
return (
|
||
|
|
_os.environ.get("AZURE_OPENAI_AD_TOKEN") is not None
|
||
|
|
or azure_ad_token is not None
|
||
|
|
or azure_ad_token_provider is not None
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
_client: OpenAI | None = None
|
||
|
|
|
||
|
|
|
||
|
|
def _load_client() -> OpenAI: # type: ignore[reportUnusedFunction]
|
||
|
|
global _client
|
||
|
|
|
||
|
|
if _client is None:
|
||
|
|
global api_type, azure_endpoint, azure_ad_token, api_version
|
||
|
|
|
||
|
|
if azure_endpoint is None:
|
||
|
|
azure_endpoint = _os.environ.get("AZURE_OPENAI_ENDPOINT")
|
||
|
|
|
||
|
|
if azure_ad_token is None:
|
||
|
|
azure_ad_token = _os.environ.get("AZURE_OPENAI_AD_TOKEN")
|
||
|
|
|
||
|
|
if api_version is None:
|
||
|
|
api_version = _os.environ.get("OPENAI_API_VERSION")
|
||
|
|
|
||
|
|
if api_type is None:
|
||
|
|
has_openai = _has_openai_credentials()
|
||
|
|
has_azure = _has_azure_credentials()
|
||
|
|
has_azure_ad = _has_azure_ad_credentials()
|
||
|
|
|
||
|
|
if has_openai and (has_azure or has_azure_ad):
|
||
|
|
raise _AmbiguousModuleClientUsageError()
|
||
|
|
|
||
|
|
if (azure_ad_token is not None or azure_ad_token_provider is not None) and _os.environ.get(
|
||
|
|
"AZURE_OPENAI_API_KEY"
|
||
|
|
) is not None:
|
||
|
|
raise _AmbiguousModuleClientUsageError()
|
||
|
|
|
||
|
|
if has_azure or has_azure_ad:
|
||
|
|
api_type = "azure"
|
||
|
|
else:
|
||
|
|
api_type = "openai"
|
||
|
|
|
||
|
|
if api_type == "azure":
|
||
|
|
_client = _AzureModuleClient( # type: ignore
|
||
|
|
api_version=api_version,
|
||
|
|
azure_endpoint=azure_endpoint,
|
||
|
|
api_key=api_key,
|
||
|
|
azure_ad_token=azure_ad_token,
|
||
|
|
azure_ad_token_provider=azure_ad_token_provider,
|
||
|
|
organization=organization,
|
||
|
|
base_url=base_url,
|
||
|
|
timeout=timeout,
|
||
|
|
max_retries=max_retries,
|
||
|
|
default_headers=default_headers,
|
||
|
|
default_query=default_query,
|
||
|
|
http_client=http_client,
|
||
|
|
)
|
||
|
|
return _client
|
||
|
|
|
||
|
|
_client = _ModuleClient(
|
||
|
|
api_key=api_key,
|
||
|
|
organization=organization,
|
||
|
|
project=project,
|
||
|
|
base_url=base_url,
|
||
|
|
timeout=timeout,
|
||
|
|
max_retries=max_retries,
|
||
|
|
default_headers=default_headers,
|
||
|
|
default_query=default_query,
|
||
|
|
http_client=http_client,
|
||
|
|
)
|
||
|
|
return _client
|
||
|
|
|
||
|
|
return _client
|
||
|
|
|
||
|
|
|
||
|
|
def _reset_client() -> None: # type: ignore[reportUnusedFunction]
|
||
|
|
global _client
|
||
|
|
|
||
|
|
_client = None
|
||
|
|
|
||
|
|
|
||
|
|
from ._module_client import (
|
||
|
|
beta as beta,
|
||
|
|
chat as chat,
|
||
|
|
audio as audio,
|
||
|
|
files as files,
|
||
|
|
images as images,
|
||
|
|
models as models,
|
||
|
|
batches as batches,
|
||
|
|
embeddings as embeddings,
|
||
|
|
completions as completions,
|
||
|
|
fine_tuning as fine_tuning,
|
||
|
|
moderations as moderations,
|
||
|
|
)
|