2026-07-18 18:18 @216.73.216.114
CrawledBy Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)
Help on package openai: NAME openai - # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. PACKAGE CONTENTS _base_client _client _compat _constants _event_handler _exceptions _extras (package) _files _legacy_response _models _module_client _provider _qs _resource _response _send_queue _streaming _types _utils (package) _version auth (package) helpers (package) lib (package) pagination providers (package) resources (package) types (package) version SUBMODULES _azure _bedrock CLASSES builtins.Exception(builtins.BaseException) OpenAIError APIError APIConnectionError APITimeoutError APIResponseValidationError APIStatusError AuthenticationError OAuthError BadRequestError ConflictError InternalServerError NotFoundError PermissionDeniedError RateLimitError UnprocessableEntityError ContentFilterFinishReasonError LengthFinishReasonError WebSocketConnectionClosedError WebSocketQueueFullError builtins.ValueError(builtins.Exception) InvalidWebhookSignatureError builtins.dict(builtins.object) ReconnectingOverrides RequestOptions builtins.object builtins.NoneType BaseTransport NotGiven Omit ReconnectingEvent Timeout httpx.AsyncClient(httpx._client.BaseClient) _DefaultAioHttpClient _DefaultAsyncHttpxClient httpx.Client(httpx._client.BaseClient) _DefaultHttpxClient openai._base_client.AsyncAPIClient(openai._base_client.BaseClient) AsyncOpenAI AsyncBedrockOpenAI openai._base_client.SyncAPIClient(openai._base_client.BaseClient) OpenAI BedrockOpenAI pydantic.main.BaseModel(builtins.object) BaseModel typing.Generic(builtins.object) AsyncStream Stream class APIConnectionError(APIError) | APIConnectionError(*, message: 'str' = 'Connection error.', request: 'httpx.Request') -> 'None' | | Method resolution order: | APIConnectionError | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, *, message: 'str' = 'Connection error.', request: 'httpx.Request') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {} | | ---------------------------------------------------------------------- | Data and other attributes inherited from APIError: | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class APIError(OpenAIError) | APIError(message: 'str', request: 'httpx.Request', *, body: 'object | None') -> 'None' | | Method resolution order: | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, message: 'str', request: 'httpx.Request', *, body: 'object | None') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'body': 'object | None', 'code': 'Optional[str]', '... | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class APIResponseValidationError(APIError) | APIResponseValidationError(response: 'httpx.Response', body: 'object | None', *, message: 'str | None' = None) -> 'None' | | Method resolution order: | APIResponseValidationError | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, response: 'httpx.Response', body: 'object | None', *, message: 'str | None' = None) -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'response': 'httpx.Response', 'status_code': 'int'} | | ---------------------------------------------------------------------- | Data and other attributes inherited from APIError: | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class APIStatusError(APIError) | APIStatusError(message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | | Raised when an API response has a status code of 4xx or 5xx. | | Method resolution order: | APIStatusError | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'request_id': 'str | None', 'response': 'httpx.Resp... | | ---------------------------------------------------------------------- | Data and other attributes inherited from APIError: | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class APITimeoutError(APIConnectionError) | APITimeoutError(request: 'httpx.Request') -> 'None' | | Method resolution order: | APITimeoutError | APIConnectionError | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, request: 'httpx.Request') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {} | | ---------------------------------------------------------------------- | Data and other attributes inherited from APIError: | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class AsyncBedrockOpenAI(AsyncOpenAI) | AsyncBedrockOpenAI(*, api_key: 'str | None' = None, bedrock_token_provider: 'AsyncBedrockTokenProvider | None' = None, aws_region: 'str | None' = None, aws_profile: 'str | None' = None, aws_access_key_id: 'str | None' = None, aws_secret_access_key: 'str | None' = None, aws_session_token: 'str | None' = None, aws_credentials_provider: 'AwsCredentialsProvider | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, base_url: 'str | httpx.URL | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, max_retries: 'int' = 2, default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, http_client: 'httpx.AsyncClient | None' = None, _strict_response_validation: 'bool' = False, _enforce_credentials: 'bool' = True, _provider: '_Provider | None' = None, _state: '_LegacyBedrockState | None' = None, _region_was_explicit: 'bool | None' = None) -> 'None' | | Async compatibility client for Amazon Bedrock's OpenAI-compatible endpoint. | | Method resolution order: | AsyncBedrockOpenAI | AsyncOpenAI | openai._base_client.AsyncAPIClient | openai._base_client.BaseClient | typing.Generic | builtins.object | | Methods defined here: | | __init__(self, *, api_key: 'str | None' = None, bedrock_token_provider: 'AsyncBedrockTokenProvider | None' = None, aws_region: 'str | None' = None, aws_profile: 'str | None' = None, aws_access_key_id: 'str | None' = None, aws_secret_access_key: 'str | None' = None, aws_session_token: 'str | None' = None, aws_credentials_provider: 'AwsCredentialsProvider | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, base_url: 'str | httpx.URL | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, max_retries: 'int' = 2, default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, http_client: 'httpx.AsyncClient | None' = None, _strict_response_validation: 'bool' = False, _enforce_credentials: 'bool' = True, _provider: '_Provider | None' = None, _state: '_LegacyBedrockState | None' = None, _region_was_explicit: 'bool | None' = None) -> 'None' | Construct a new async AsyncOpenAI client instance. | | This automatically infers the following arguments from their corresponding environment variables if they are not provided: | - `api_key` from `OPENAI_API_KEY` | - `admin_api_key` from `OPENAI_ADMIN_KEY` | - `organization` from `OPENAI_ORG_ID` | - `project` from `OPENAI_PROJECT_ID` | - `webhook_secret` from `OPENAI_WEBHOOK_SECRET` | | When `provider` is supplied, authentication and the base URL are configured by that provider instead. | | copy(self, *, api_key: 'str | AsyncBedrockTokenProvider | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, provider: '_Provider | None | NotGiven' = NOT_GIVEN, bedrock_token_provider: 'AsyncBedrockTokenProvider | None' = None, aws_region: 'str | None' = None, aws_profile: 'str | None' = None, aws_access_key_id: 'str | None' = None, aws_secret_access_key: 'str | None' = None, aws_session_token: 'str | None' = None, aws_credentials_provider: 'AwsCredentialsProvider | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, http_client: 'httpx.AsyncClient | None' = None, max_retries: 'int | NotGiven' = NOT_GIVEN, default_headers: 'Mapping[str, str] | None' = None, set_default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, set_default_query: 'Mapping[str, object] | None' = None, _enforce_credentials: 'bool | None' = None, _extra_kwargs: 'Mapping[str, Any]' = {}) -> 'Self' | Create a new client instance re-using the same options given to the current client with optional overriding. | | with_options = copy(self, *, api_key: 'str | AsyncBedrockTokenProvider | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, provider: '_Provider | None | NotGiven' = NOT_GIVEN, bedrock_token_provider: 'AsyncBedrockTokenProvider | None' = None, aws_region: 'str | None' = None, aws_profile: 'str | None' = None, aws_access_key_id: 'str | None' = None, aws_secret_access_key: 'str | None' = None, aws_session_token: 'str | None' = None, aws_credentials_provider: 'AwsCredentialsProvider | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, http_client: 'httpx.AsyncClient | None' = None, max_retries: 'int | NotGiven' = NOT_GIVEN, default_headers: 'Mapping[str, str] | None' = None, set_default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, set_default_query: 'Mapping[str, object] | None' = None, _enforce_credentials: 'bool | None' = None, _extra_kwargs: 'Mapping[str, Any]' = {}) -> 'Self' | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'_bedrock_provider': '_Provider', '_bedrock_runtime... | | __parameters__ = () | | ---------------------------------------------------------------------- | Methods inherited from AsyncOpenAI: | | admin = <functools.cached_property object> | audio = <functools.cached_property object> | batches = <functools.cached_property object> | Create large batches of API requests to run asynchronously. | | beta = <functools.cached_property object> | chat = <functools.cached_property object> | completions = <functools.cached_property object> | Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. | | containers = <functools.cached_property object> | conversations = <functools.cached_property object> | Manage conversations and conversation items. | | embeddings = <functools.cached_property object> | Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. | | evals = <functools.cached_property object> | Manage and run evals in the OpenAI platform. | | files = <functools.cached_property object> | Files are used to upload documents that can be used with features like Assistants and Fine-tuning. | | fine_tuning = <functools.cached_property object> | images = <functools.cached_property object> | Given a prompt and/or an input image, the model will generate a new image. | | models = <functools.cached_property object> | List and describe the various models available in the API. | | moderations = <functools.cached_property object> | Given text and/or image inputs, classifies if those inputs are potentially harmful. | | realtime = <functools.cached_property object> | responses = <functools.cached_property object> | skills = <functools.cached_property object> | uploads = <functools.cached_property object> | Use Uploads to upload large files in multiple parts. | | vector_stores = <functools.cached_property object> | videos = <functools.cached_property object> | webhooks = <functools.cached_property object> | with_raw_response = <functools.cached_property object> | with_streaming_response = <functools.cached_property object> | ---------------------------------------------------------------------- | Readonly properties inherited from AsyncOpenAI: | | auth_headers | | custom_auth | | default_headers | | qs | | ---------------------------------------------------------------------- | Methods inherited from openai._base_client.AsyncAPIClient: | | async __aenter__(self: '_T') -> '_T' | | async __aexit__(self, exc_type: 'type[BaseException] | None', exc: 'BaseException | None', exc_tb: 'TracebackType | None') -> 'None' | | async close(self) -> 'None' | Close the underlying HTTPX client. | | The client will *not* be usable after this. | | async delete(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'AsyncBinaryTypes | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | async get(self, path: 'str', *, cast_to: 'Type[ResponseT]', options: 'RequestOptions' = {}, stream: 'bool' = False, stream_cls: 'type[_AsyncStreamT] | None' = None) -> 'ResponseT | _AsyncStreamT' | | get_api_list(self, path: 'str', *, model: 'Type[_T]', page: 'Type[AsyncPageT]', body: 'Body | None' = None, options: 'RequestOptions' = {}, method: 'str' = 'get') -> 'AsyncPaginator[_T, AsyncPageT]' | | is_closed(self) -> 'bool' | | async patch(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'AsyncBinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | async post(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'AsyncBinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}, stream: 'bool' = False, stream_cls: 'type[_AsyncStreamT] | None' = None) -> 'ResponseT | _AsyncStreamT' | | async put(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'AsyncBinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | async request(self, cast_to: 'Type[ResponseT]', options: 'FinalRequestOptions', *, stream: 'bool' = False, stream_cls: 'type[_AsyncStreamT] | None' = None) -> 'ResponseT | _AsyncStreamT' | | ---------------------------------------------------------------------- | Data and other attributes inherited from openai._base_client.AsyncAPIClient: | | __orig_bases__ = (openai._base_client.BaseClient[httpx.AsyncClient, op... | | ---------------------------------------------------------------------- | Methods inherited from openai._base_client.BaseClient: | | platform_headers(self) -> 'Dict[str, str]' | | ---------------------------------------------------------------------- | Readonly properties inherited from openai._base_client.BaseClient: | | default_query | | user_agent | | ---------------------------------------------------------------------- | Data descriptors inherited from openai._base_client.BaseClient: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | base_url | | ---------------------------------------------------------------------- | Class methods inherited from typing.Generic: | | __class_getitem__(params) from builtins.type | | __init_subclass__(*args, **kwargs) from builtins.type | This method is called when a class is subclassed. | | The default implementation does nothing. It may be | overridden to extend subclasses. AsyncClient = class AsyncOpenAI(openai._base_client.AsyncAPIClient) | AsyncClient(*, api_key: 'str | Callable[[], Awaitable[str]] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, provider: '_Provider | None' = None, base_url: 'str | httpx.URL | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, max_retries: 'int' = 2, default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, http_client: 'httpx.AsyncClient | None' = None, _strict_response_validation: 'bool' = False, _enforce_credentials: 'bool' = True) -> 'None' | | Method resolution order: | AsyncOpenAI | openai._base_client.AsyncAPIClient | openai._base_client.BaseClient | typing.Generic | builtins.object | | Methods defined here: | | __init__(self, *, api_key: 'str | Callable[[], Awaitable[str]] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, provider: '_Provider | None' = None, base_url: 'str | httpx.URL | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, max_retries: 'int' = 2, default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, http_client: 'httpx.AsyncClient | None' = None, _strict_response_validation: 'bool' = False, _enforce_credentials: 'bool' = True) -> 'None' | Construct a new async AsyncOpenAI client instance. | | This automatically infers the following arguments from their corresponding environment variables if they are not provided: | - `api_key` from `OPENAI_API_KEY` | - `admin_api_key` from `OPENAI_ADMIN_KEY` | - `organization` from `OPENAI_ORG_ID` | - `project` from `OPENAI_PROJECT_ID` | - `webhook_secret` from `OPENAI_WEBHOOK_SECRET` | | When `provider` is supplied, authentication and the base URL are configured by that provider instead. | | admin = <functools.cached_property object> | audio = <functools.cached_property object> | batches = <functools.cached_property object> | Create large batches of API requests to run asynchronously. | | beta = <functools.cached_property object> | chat = <functools.cached_property object> | completions = <functools.cached_property object> | Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. | | containers = <functools.cached_property object> | conversations = <functools.cached_property object> | Manage conversations and conversation items. | | copy(self, *, api_key: 'str | Callable[[], Awaitable[str]] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, provider: '_Provider | None | NotGiven' = NOT_GIVEN, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, http_client: 'httpx.AsyncClient | None' = None, max_retries: 'int | NotGiven' = NOT_GIVEN, default_headers: 'Mapping[str, str] | None' = None, set_default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, set_default_query: 'Mapping[str, object] | None' = None, _enforce_credentials: 'bool | None' = None, _extra_kwargs: 'Mapping[str, Any]' = {}) -> 'Self' | Create a new client instance re-using the same options given to the current client with optional overriding. | | embeddings = <functools.cached_property object> | Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. | | evals = <functools.cached_property object> | Manage and run evals in the OpenAI platform. | | files = <functools.cached_property object> | Files are used to upload documents that can be used with features like Assistants and Fine-tuning. | | fine_tuning = <functools.cached_property object> | images = <functools.cached_property object> | Given a prompt and/or an input image, the model will generate a new image. | | models = <functools.cached_property object> | List and describe the various models available in the API. | | moderations = <functools.cached_property object> | Given text and/or image inputs, classifies if those inputs are potentially harmful. | | realtime = <functools.cached_property object> | responses = <functools.cached_property object> | skills = <functools.cached_property object> | uploads = <functools.cached_property object> | Use Uploads to upload large files in multiple parts. | | vector_stores = <functools.cached_property object> | videos = <functools.cached_property object> | webhooks = <functools.cached_property object> | with_options = copy(self, *, api_key: 'str | Callable[[], Awaitable[str]] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, provider: '_Provider | None | NotGiven' = NOT_GIVEN, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, http_client: 'httpx.AsyncClient | None' = None, max_retries: 'int | NotGiven' = NOT_GIVEN, default_headers: 'Mapping[str, str] | None' = None, set_default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, set_default_query: 'Mapping[str, object] | None' = None, _enforce_credentials: 'bool | None' = None, _extra_kwargs: 'Mapping[str, Any]' = {}) -> 'Self' | | with_raw_response = <functools.cached_property object> | with_streaming_response = <functools.cached_property object> | ---------------------------------------------------------------------- | Readonly properties defined here: | | auth_headers | | custom_auth | | default_headers | | qs | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'_provider': '_Provider | None', '_provider_runtime... | | __parameters__ = () | | ---------------------------------------------------------------------- | Methods inherited from openai._base_client.AsyncAPIClient: | | async __aenter__(self: '_T') -> '_T' | | async __aexit__(self, exc_type: 'type[BaseException] | None', exc: 'BaseException | None', exc_tb: 'TracebackType | None') -> 'None' | | async close(self) -> 'None' | Close the underlying HTTPX client. | | The client will *not* be usable after this. | | async delete(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'AsyncBinaryTypes | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | async get(self, path: 'str', *, cast_to: 'Type[ResponseT]', options: 'RequestOptions' = {}, stream: 'bool' = False, stream_cls: 'type[_AsyncStreamT] | None' = None) -> 'ResponseT | _AsyncStreamT' | | get_api_list(self, path: 'str', *, model: 'Type[_T]', page: 'Type[AsyncPageT]', body: 'Body | None' = None, options: 'RequestOptions' = {}, method: 'str' = 'get') -> 'AsyncPaginator[_T, AsyncPageT]' | | is_closed(self) -> 'bool' | | async patch(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'AsyncBinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | async post(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'AsyncBinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}, stream: 'bool' = False, stream_cls: 'type[_AsyncStreamT] | None' = None) -> 'ResponseT | _AsyncStreamT' | | async put(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'AsyncBinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | async request(self, cast_to: 'Type[ResponseT]', options: 'FinalRequestOptions', *, stream: 'bool' = False, stream_cls: 'type[_AsyncStreamT] | None' = None) -> 'ResponseT | _AsyncStreamT' | | ---------------------------------------------------------------------- | Data and other attributes inherited from openai._base_client.AsyncAPIClient: | | __orig_bases__ = (openai._base_client.BaseClient[httpx.AsyncClient, op... | | ---------------------------------------------------------------------- | Methods inherited from openai._base_client.BaseClient: | | platform_headers(self) -> 'Dict[str, str]' | | ---------------------------------------------------------------------- | Readonly properties inherited from openai._base_client.BaseClient: | | default_query | | user_agent | | ---------------------------------------------------------------------- | Data descriptors inherited from openai._base_client.BaseClient: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | base_url | | ---------------------------------------------------------------------- | Class methods inherited from typing.Generic: | | __class_getitem__(params) from builtins.type | | __init_subclass__(*args, **kwargs) from builtins.type | This method is called when a class is subclassed. | | The default implementation does nothing. It may be | overridden to extend subclasses. class AsyncOpenAI(openai._base_client.AsyncAPIClient) | AsyncOpenAI(*, api_key: 'str | Callable[[], Awaitable[str]] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, provider: '_Provider | None' = None, base_url: 'str | httpx.URL | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, max_retries: 'int' = 2, default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, http_client: 'httpx.AsyncClient | None' = None, _strict_response_validation: 'bool' = False, _enforce_credentials: 'bool' = True) -> 'None' | | Method resolution order: | AsyncOpenAI | openai._base_client.AsyncAPIClient | openai._base_client.BaseClient | typing.Generic | builtins.object | | Methods defined here: | | __init__(self, *, api_key: 'str | Callable[[], Awaitable[str]] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, provider: '_Provider | None' = None, base_url: 'str | httpx.URL | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, max_retries: 'int' = 2, default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, http_client: 'httpx.AsyncClient | None' = None, _strict_response_validation: 'bool' = False, _enforce_credentials: 'bool' = True) -> 'None' | Construct a new async AsyncOpenAI client instance. | | This automatically infers the following arguments from their corresponding environment variables if they are not provided: | - `api_key` from `OPENAI_API_KEY` | - `admin_api_key` from `OPENAI_ADMIN_KEY` | - `organization` from `OPENAI_ORG_ID` | - `project` from `OPENAI_PROJECT_ID` | - `webhook_secret` from `OPENAI_WEBHOOK_SECRET` | | When `provider` is supplied, authentication and the base URL are configured by that provider instead. | | admin = <functools.cached_property object> | audio = <functools.cached_property object> | batches = <functools.cached_property object> | Create large batches of API requests to run asynchronously. | | beta = <functools.cached_property object> | chat = <functools.cached_property object> | completions = <functools.cached_property object> | Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. | | containers = <functools.cached_property object> | conversations = <functools.cached_property object> | Manage conversations and conversation items. | | copy(self, *, api_key: 'str | Callable[[], Awaitable[str]] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, provider: '_Provider | None | NotGiven' = NOT_GIVEN, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, http_client: 'httpx.AsyncClient | None' = None, max_retries: 'int | NotGiven' = NOT_GIVEN, default_headers: 'Mapping[str, str] | None' = None, set_default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, set_default_query: 'Mapping[str, object] | None' = None, _enforce_credentials: 'bool | None' = None, _extra_kwargs: 'Mapping[str, Any]' = {}) -> 'Self' | Create a new client instance re-using the same options given to the current client with optional overriding. | | embeddings = <functools.cached_property object> | Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. | | evals = <functools.cached_property object> | Manage and run evals in the OpenAI platform. | | files = <functools.cached_property object> | Files are used to upload documents that can be used with features like Assistants and Fine-tuning. | | fine_tuning = <functools.cached_property object> | images = <functools.cached_property object> | Given a prompt and/or an input image, the model will generate a new image. | | models = <functools.cached_property object> | List and describe the various models available in the API. | | moderations = <functools.cached_property object> | Given text and/or image inputs, classifies if those inputs are potentially harmful. | | realtime = <functools.cached_property object> | responses = <functools.cached_property object> | skills = <functools.cached_property object> | uploads = <functools.cached_property object> | Use Uploads to upload large files in multiple parts. | | vector_stores = <functools.cached_property object> | videos = <functools.cached_property object> | webhooks = <functools.cached_property object> | with_options = copy(self, *, api_key: 'str | Callable[[], Awaitable[str]] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, provider: '_Provider | None | NotGiven' = NOT_GIVEN, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, http_client: 'httpx.AsyncClient | None' = None, max_retries: 'int | NotGiven' = NOT_GIVEN, default_headers: 'Mapping[str, str] | None' = None, set_default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, set_default_query: 'Mapping[str, object] | None' = None, _enforce_credentials: 'bool | None' = None, _extra_kwargs: 'Mapping[str, Any]' = {}) -> 'Self' | | with_raw_response = <functools.cached_property object> | with_streaming_response = <functools.cached_property object> | ---------------------------------------------------------------------- | Readonly properties defined here: | | auth_headers | | custom_auth | | default_headers | | qs | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'_provider': '_Provider | None', '_provider_runtime... | | __parameters__ = () | | ---------------------------------------------------------------------- | Methods inherited from openai._base_client.AsyncAPIClient: | | async __aenter__(self: '_T') -> '_T' | | async __aexit__(self, exc_type: 'type[BaseException] | None', exc: 'BaseException | None', exc_tb: 'TracebackType | None') -> 'None' | | async close(self) -> 'None' | Close the underlying HTTPX client. | | The client will *not* be usable after this. | | async delete(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'AsyncBinaryTypes | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | async get(self, path: 'str', *, cast_to: 'Type[ResponseT]', options: 'RequestOptions' = {}, stream: 'bool' = False, stream_cls: 'type[_AsyncStreamT] | None' = None) -> 'ResponseT | _AsyncStreamT' | | get_api_list(self, path: 'str', *, model: 'Type[_T]', page: 'Type[AsyncPageT]', body: 'Body | None' = None, options: 'RequestOptions' = {}, method: 'str' = 'get') -> 'AsyncPaginator[_T, AsyncPageT]' | | is_closed(self) -> 'bool' | | async patch(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'AsyncBinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | async post(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'AsyncBinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}, stream: 'bool' = False, stream_cls: 'type[_AsyncStreamT] | None' = None) -> 'ResponseT | _AsyncStreamT' | | async put(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'AsyncBinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | async request(self, cast_to: 'Type[ResponseT]', options: 'FinalRequestOptions', *, stream: 'bool' = False, stream_cls: 'type[_AsyncStreamT] | None' = None) -> 'ResponseT | _AsyncStreamT' | | ---------------------------------------------------------------------- | Data and other attributes inherited from openai._base_client.AsyncAPIClient: | | __orig_bases__ = (openai._base_client.BaseClient[httpx.AsyncClient, op... | | ---------------------------------------------------------------------- | Methods inherited from openai._base_client.BaseClient: | | platform_headers(self) -> 'Dict[str, str]' | | ---------------------------------------------------------------------- | Readonly properties inherited from openai._base_client.BaseClient: | | default_query | | user_agent | | ---------------------------------------------------------------------- | Data descriptors inherited from openai._base_client.BaseClient: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | base_url | | ---------------------------------------------------------------------- | Class methods inherited from typing.Generic: | | __class_getitem__(params) from builtins.type | | __init_subclass__(*args, **kwargs) from builtins.type | This method is called when a class is subclassed. | | The default implementation does nothing. It may be | overridden to extend subclasses. class AsyncStream(typing.Generic) | AsyncStream(*, cast_to: 'type[_T]', response: 'httpx.Response', client: 'AsyncOpenAI', options: 'Optional[FinalRequestOptions]' = None) -> 'None' | | Provides the core interface to iterate over an asynchronous stream response. | | Method resolution order: | AsyncStream | typing.Generic | builtins.object | | Methods defined here: | | async __aenter__(self) -> 'Self' | | async __aexit__(self, exc_type: 'type[BaseException] | None', exc: 'BaseException | None', exc_tb: 'TracebackType | None') -> 'None' | | async __aiter__(self) -> 'AsyncIterator[_T]' | | async __anext__(self) -> '_T' | | __init__(self, *, cast_to: 'type[_T]', response: 'httpx.Response', client: 'AsyncOpenAI', options: 'Optional[FinalRequestOptions]' = None) -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | async __stream__(self) -> 'AsyncIterator[_T]' | | async close(self) -> 'None' | Close the response and release the connection. | | Automatically called if the response body is read to completion. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'_decoder': 'SSEDecoder | SSEBytesDecoder', '_optio... | | __orig_bases__ = (typing.Generic[~_T],) | | __parameters__ = (~_T,) | | ---------------------------------------------------------------------- | Class methods inherited from typing.Generic: | | __class_getitem__(params) from builtins.type | | __init_subclass__(*args, **kwargs) from builtins.type | This method is called when a class is subclassed. | | The default implementation does nothing. It may be | overridden to extend subclasses. class AuthenticationError(APIStatusError) | AuthenticationError(message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | | Method resolution order: | AuthenticationError | APIStatusError | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Data and other attributes defined here: | | __annotations__ = {'status_code': 'Literal[401]'} | | status_code = 401 | | ---------------------------------------------------------------------- | Methods inherited from APIStatusError: | | __init__(self, message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes inherited from APIError: | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class BadRequestError(APIStatusError) | BadRequestError(message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | | Method resolution order: | BadRequestError | APIStatusError | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Data and other attributes defined here: | | __annotations__ = {'status_code': 'Literal[400]'} | | status_code = 400 | | ---------------------------------------------------------------------- | Methods inherited from APIStatusError: | | __init__(self, message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes inherited from APIError: | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class BaseModel(pydantic.main.BaseModel) | BaseModel(**data: 'Any') -> 'None' | | Method resolution order: | BaseModel | pydantic.main.BaseModel | builtins.object | | Methods defined here: | | __str__(self) -> 'str' | Return str(self). | | to_dict(self, *, mode: "Literal['json', 'python']" = 'python', use_api_names: 'bool' = True, exclude_unset: 'bool' = True, exclude_defaults: 'bool' = False, exclude_none: 'bool' = False, warnings: 'bool' = True) -> 'dict[str, object]' | Recursively generate a dictionary representation of the model, optionally specifying which fields to include or exclude. | | By default, fields that were not set by the API will not be included, | and keys will match the API response, *not* the property names from the model. | | For example, if the API responds with `"fooBar": true` but we've defined a `foo_bar: bool` property, | the output will use the `"fooBar"` key (unless `use_api_names=False` is passed). | | Args: | mode: | If mode is 'json', the dictionary will only contain JSON serializable types. e.g. `datetime` will be turned into a string, `"2024-3-22T18:11:19.117000Z"`. | If mode is 'python', the dictionary may contain any Python objects. e.g. `datetime(2024, 3, 22)` | | use_api_names: Whether to use the key that the API responded with or the property name. Defaults to `True`. | exclude_unset: Whether to exclude fields that have not been explicitly set. | exclude_defaults: Whether to exclude fields that are set to their default value from the output. | exclude_none: Whether to exclude fields that have a value of `None` from the output. | warnings: Whether to log warnings when invalid fields are encountered. This is only supported in Pydantic v2. | | to_json(self, *, indent: 'int | None' = 2, use_api_names: 'bool' = True, exclude_unset: 'bool' = True, exclude_defaults: 'bool' = False, exclude_none: 'bool' = False, warnings: 'bool' = True) -> 'str' | Generates a JSON string representing this model as it would be received from or sent to the API (but with indentation). | | By default, fields that were not set by the API will not be included, | and keys will match the API response, *not* the property names from the model. | | For example, if the API responds with `"fooBar": true` but we've defined a `foo_bar: bool` property, | the output will use the `"fooBar"` key (unless `use_api_names=False` is passed). | | Args: | indent: Indentation to use in the JSON output. If `None` is passed, the output will be compact. Defaults to `2` | use_api_names: Whether to use the key that the API responded with or the property name. Defaults to `True`. | exclude_unset: Whether to exclude fields that have not been explicitly set. | exclude_defaults: Whether to exclude fields that have the default value. | exclude_none: Whether to exclude fields that have a value of `None`. | warnings: Whether to show any warnings that occurred during serialization. This is only supported in Pydantic v2. | | ---------------------------------------------------------------------- | Class methods defined here: | | construct(_fields_set: 'set[str] | None' = None, **values: 'object') -> 'ModelT' from pydantic._internal._model_construction.ModelMetaclass | # Override the 'construct' method in a way that supports recursive parsing without validation. | # Based on https://github.com/samuelcolvin/pydantic/issues/1168#issuecomment-817742836. | | model_construct = construct(_fields_set: 'set[str] | None' = None, **values: 'object') -> 'ModelT' from pydantic._internal._model_construction.ModelMetaclass | # Override the 'construct' method in a way that supports recursive parsing without validation. | # Based on https://github.com/samuelcolvin/pydantic/issues/1168#issuecomment-817742836. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __abstractmethods__ = frozenset() | | __annotations__ = {'model_config': 'ClassVar[ConfigDict]'} | | __class_vars__ = set() | | __private_attributes__ = {} | | __pydantic_complete__ = True | | __pydantic_computed_fields__ = {} | | __pydantic_core_schema__ = {'cls': <class 'openai.BaseModel'>, 'config... | | __pydantic_custom_init__ = False | | __pydantic_decorators__ = DecoratorInfos(validators={}, field_validato... | | __pydantic_extra_info__ = None | | __pydantic_fields__ = {} | | __pydantic_generic_metadata__ = {'args': (), 'origin': None, 'paramete... | | __pydantic_parent_namespace__ = None | | __pydantic_post_init__ = None | | __pydantic_serializer__ = SchemaSerializer(serializer=PolymorphismTram... | | __pydantic_setattr_handlers__ = {} | | __pydantic_validator__ = SchemaValidator(title="BaseModel", validator=... | | model_config = {'defer_build': True, 'extra': 'allow'} | | ---------------------------------------------------------------------- | Methods inherited from pydantic.main.BaseModel: | | __copy__(self) -> 'Self' | Returns a shallow copy of the model. | | __deepcopy__(self, memo: 'dict[int, Any] | None' = None) -> 'Self' | Returns a deep copy of the model. | | __delattr__(self, item: 'str') -> 'Any' | Implement delattr(self, name). | | __eq__(self, other: 'Any') -> 'bool' | Return self==value. | | __getattr__(self, item: 'str') -> 'Any' | | __getstate__(self) -> 'dict[Any, Any]' | | __init__(self, /, **data: 'Any') -> 'None' | Create a new model by parsing and validating input data from keyword arguments. | | Raises [`ValidationError`][pydantic_core.ValidationError] if the input data cannot be | validated to form a valid model. | | `self` is explicitly positional-only to allow `self` as a field name. | | __iter__(self) -> 'TupleGenerator' | So `dict(model)` works. | | __pretty__(self, fmt: 'Callable[[Any], Any]', **kwargs: 'Any') -> 'Generator[Any]' | Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects. | | __replace__(self, **changes: 'Any') -> 'Self' | # Because we make use of `@dataclass_transform()`, `__replace__` is already synthesized by | # type checkers, so we define the implementation in this `if not TYPE_CHECKING:` block: | | __repr__(self) -> 'str' | Return repr(self). | | __repr_args__(self) -> '_repr.ReprArgs' | | __repr_name__(self) -> 'str' | Name of the instance's class, used in __repr__. | | __repr_recursion__(self, object: 'Any') -> 'str' | Returns the string representation of a recursive object. | | __repr_str__(self, join_str: 'str') -> 'str' | | __rich_repr__(self) -> 'RichReprResult' | Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects. | | __setattr__(self, name: 'str', value: 'Any') -> 'None' | Implement setattr(self, name, value). | | __setstate__(self, state: 'dict[Any, Any]') -> 'None' | | copy(self, *, include: 'AbstractSetIntStr | MappingIntStrAny | None' = None, exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None, update: 'Dict[str, Any] | None' = None, deep: 'bool' = False) -> 'Self' | Returns a copy of the model. | | !!! warning "Deprecated" | This method is now deprecated; use `model_copy` instead. | | If you need `include` or `exclude`, use: | | ```python {test="skip" lint="skip"} | data = self.model_dump(include=include, exclude=exclude, round_trip=True) | data = {**data, **(update or {})} | copied = self.model_validate(data) | ``` | | Args: | include: Optional set or mapping specifying which fields to include in the copied model. | exclude: Optional set or mapping specifying which fields to exclude in the copied model. | update: Optional dictionary of field-value pairs to override field values in the copied model. | deep: If True, the values of fields that are Pydantic models will be deep-copied. | | Returns: | A copy of the model with included, excluded and updated fields as specified. | | dict(self, *, include: 'IncEx | None' = None, exclude: 'IncEx | None' = None, by_alias: 'bool' = False, exclude_unset: 'bool' = False, exclude_defaults: 'bool' = False, exclude_none: 'bool' = False) -> 'Dict[str, Any]' | | json(self, *, include: 'IncEx | None' = None, exclude: 'IncEx | None' = None, by_alias: 'bool' = False, exclude_unset: 'bool' = False, exclude_defaults: 'bool' = False, exclude_none: 'bool' = False, encoder: 'Callable[[Any], Any] | None' = PydanticUndefined, models_as_dict: 'bool' = PydanticUndefined, **dumps_kwargs: 'Any') -> 'str' | | model_copy(self, *, update: 'Mapping[str, Any] | None' = None, deep: 'bool' = False) -> 'Self' | !!! abstract "Usage Documentation" | [`model_copy`](../concepts/models.md#model-copy) | | Returns a copy of the model. | | !!! note | The underlying instance's [`__dict__`][object.__dict__] attribute is copied. This | might have unexpected side effects if you store anything in it, on top of the model | fields (e.g. the value of [cached properties][functools.cached_property]). | | Args: | update: Values to change/add in the new model. Note: the data is not validated | before creating the new model. You should trust this data. | deep: Set to `True` to make a deep copy of the model. | | Returns: | New model instance. | | model_dump(self, *, mode: "Literal['json', 'python'] | str" = 'python', include: 'IncEx | None' = None, exclude: 'IncEx | None' = None, context: 'Any | None' = None, by_alias: 'bool | None' = None, exclude_unset: 'bool' = False, exclude_defaults: 'bool' = False, exclude_none: 'bool' = False, exclude_computed_fields: 'bool' = False, round_trip: 'bool' = False, warnings: "bool | Literal['none', 'warn', 'error']" = True, fallback: 'Callable[[Any], Any] | None' = None, serialize_as_any: 'bool' = False, polymorphic_serialization: 'bool | None' = None) -> 'dict[str, Any]' | !!! abstract "Usage Documentation" | [`model_dump`](../concepts/serialization.md#python-mode) | | Generate a dictionary representation of the model, optionally specifying which fields to include or exclude. | | Args: | mode: The mode in which `to_python` should run. | If mode is 'json', the output will only contain JSON serializable types. | If mode is 'python', the output may contain non-JSON-serializable Python objects. | include: A set of fields to include in the output. | exclude: A set of fields to exclude from the output. | context: Additional context to pass to the serializer. | by_alias: Whether to use the field's alias in the dictionary key if defined. | exclude_unset: Whether to exclude fields that have not been explicitly set. | exclude_defaults: Whether to exclude fields that are set to their default value. | exclude_none: Whether to exclude fields that have a value of `None`. | exclude_computed_fields: Whether to exclude computed fields. | While this can be useful for round-tripping, it is usually recommended to use the dedicated | `round_trip` parameter instead. | round_trip: If True, dumped values should be valid as input for non-idempotent types such as Json[T]. | warnings: How to handle serialization errors. False/"none" ignores them, True/"warn" logs errors, | "error" raises a [`PydanticSerializationError`][pydantic_core.PydanticSerializationError]. | fallback: A function to call when an unknown value is encountered. If not provided, | a [`PydanticSerializationError`][pydantic_core.PydanticSerializationError] error is raised. | serialize_as_any: Whether to serialize fields with duck-typing serialization behavior. | polymorphic_serialization: Whether to use model and dataclass polymorphic serialization for this call. | | Returns: | A dictionary representation of the model. | | model_dump_json(self, *, indent: 'int | None' = None, ensure_ascii: 'bool' = False, include: 'IncEx | None' = None, exclude: 'IncEx | None' = None, context: 'Any | None' = None, by_alias: 'bool | None' = None, exclude_unset: 'bool' = False, exclude_defaults: 'bool' = False, exclude_none: 'bool' = False, exclude_computed_fields: 'bool' = False, round_trip: 'bool' = False, warnings: "bool | Literal['none', 'warn', 'error']" = True, fallback: 'Callable[[Any], Any] | None' = None, serialize_as_any: 'bool' = False, polymorphic_serialization: 'bool | None' = None) -> 'str' | !!! abstract "Usage Documentation" | [`model_dump_json`](../concepts/serialization.md#json-mode) | | Generates a JSON representation of the model using Pydantic's `to_json` method. | | Args: | indent: Indentation to use in the JSON output. If None is passed, the output will be compact. | ensure_ascii: If `True`, the output is guaranteed to have all incoming non-ASCII characters escaped. | If `False` (the default), these characters will be output as-is. | include: Field(s) to include in the JSON output. | exclude: Field(s) to exclude from the JSON output. | context: Additional context to pass to the serializer. | by_alias: Whether to serialize using field aliases. | exclude_unset: Whether to exclude fields that have not been explicitly set. | exclude_defaults: Whether to exclude fields that are set to their default value. | exclude_none: Whether to exclude fields that have a value of `None`. | exclude_computed_fields: Whether to exclude computed fields. | While this can be useful for round-tripping, it is usually recommended to use the dedicated | `round_trip` parameter instead. | round_trip: If True, dumped values should be valid as input for non-idempotent types such as Json[T]. | warnings: How to handle serialization errors. False/"none" ignores them, True/"warn" logs errors, | "error" raises a [`PydanticSerializationError`][pydantic_core.PydanticSerializationError]. | fallback: A function to call when an unknown value is encountered. If not provided, | a [`PydanticSerializationError`][pydantic_core.PydanticSerializationError] error is raised. | serialize_as_any: Whether to serialize fields with duck-typing serialization behavior. | polymorphic_serialization: Whether to use model and dataclass polymorphic serialization for this call. | | Returns: | A JSON string representation of the model. | | model_post_init(self, context: 'Any', /) -> 'None' | Override this method to perform additional initialization after `__init__` and `model_construct`. | This is useful if you want to do some validation that requires the entire model to be initialized. | | ---------------------------------------------------------------------- | Class methods inherited from pydantic.main.BaseModel: | | __class_getitem__(typevar_values: 'type[Any] | tuple[type[Any], ...]') -> 'type[BaseModel] | _forward_ref.PydanticRecursiveRef' from pydantic._internal._model_construction.ModelMetaclass | | __get_pydantic_core_schema__(source: 'type[BaseModel]', handler: 'GetCoreSchemaHandler', /) -> 'CoreSchema' from pydantic._internal._model_construction.ModelMetaclass | | __get_pydantic_json_schema__(core_schema: 'CoreSchema', handler: 'GetJsonSchemaHandler', /) -> 'JsonSchemaValue' from pydantic._internal._model_construction.ModelMetaclass | Hook into generating the model's JSON schema. | | Args: | core_schema: A `pydantic-core` CoreSchema. | You can ignore this argument and call the handler with a new CoreSchema, | wrap this CoreSchema (`{'type': 'nullable', 'schema': current_schema}`), | or just call the handler with the original schema. | handler: Call into Pydantic's internal JSON schema generation. | This will raise a `pydantic.errors.PydanticInvalidForJsonSchema` if JSON schema | generation fails. | Since this gets called by `BaseModel.model_json_schema` you can override the | `schema_generator` argument to that function to change JSON schema generation globally | for a type. | | Returns: | A JSON schema, as a Python object. | | __pydantic_init_subclass__(**kwargs: 'Any') -> 'None' from pydantic._internal._model_construction.ModelMetaclass | This is intended to behave just like `__init_subclass__`, but is called by `ModelMetaclass` | only after basic class initialization is complete. In particular, attributes like `model_fields` will | be present when this is called, but forward annotations are not guaranteed to be resolved yet, | meaning that creating an instance of the class may fail. | | This is necessary because `__init_subclass__` will always be called by `type.__new__`, | and it would require a prohibitively large refactor to the `ModelMetaclass` to ensure that | `type.__new__` was called in such a manner that the class would already be sufficiently initialized. | | This will receive the same `kwargs` that would be passed to the standard `__init_subclass__`, namely, | any kwargs passed to the class definition that aren't used internally by Pydantic. | | Args: | **kwargs: Any keyword arguments passed to the class definition that aren't used internally | by Pydantic. | | Note: | You may want to override [`__pydantic_on_complete__()`][pydantic.main.BaseModel.__pydantic_on_complete__] | instead, which is called once the class and its fields are fully initialized and ready for validation. | | __pydantic_on_complete__() -> 'None' from pydantic._internal._model_construction.ModelMetaclass | This is called once the class and its fields are fully initialized and ready to be used. | | This typically happens when the class is created (just before | [`__pydantic_init_subclass__()`][pydantic.main.BaseModel.__pydantic_init_subclass__] is called on the superclass), | except when forward annotations are used that could not immediately be resolved. | In that case, it will be called later, when the model is rebuilt automatically or explicitly using | [`model_rebuild()`][pydantic.main.BaseModel.model_rebuild]. | | from_orm(obj: 'Any') -> 'Self' from pydantic._internal._model_construction.ModelMetaclass | | model_json_schema(by_alias: 'bool' = True, ref_template: 'str' = '#/$defs/{model}', schema_generator: 'type[GenerateJsonSchema]' = <class 'pydantic.json_schema.GenerateJsonSchema'>, mode: 'JsonSchemaMode' = 'validation', *, union_format: "Literal['any_of', 'primitive_type_array']" = 'any_of') -> 'dict[str, Any]' from pydantic._internal._model_construction.ModelMetaclass | Generates a JSON schema for a model class. | | Args: | by_alias: Whether to use attribute aliases or not. | ref_template: The reference template. | union_format: The format to use when combining schemas from unions together. Can be one of: | | - `'any_of'`: Use the [`anyOf`](https://json-schema.org/understanding-json-schema/reference/combining#anyOf) | keyword to combine schemas (the default). | - `'primitive_type_array'`: Use the [`type`](https://json-schema.org/understanding-json-schema/reference/type) | keyword as an array of strings, containing each type of the combination. If any of the schemas is not a primitive | type (`string`, `boolean`, `null`, `integer` or `number`) or contains constraints/metadata, falls back to | `any_of`. | schema_generator: To override the logic used to generate the JSON schema, as a subclass of | `GenerateJsonSchema` with your desired modifications | mode: The mode in which to generate the schema. | | Returns: | The JSON schema for the given model class. | | model_parametrized_name(params: 'tuple[type[Any], ...]') -> 'str' from pydantic._internal._model_construction.ModelMetaclass | Compute the class name for parametrizations of generic classes. | | This method can be overridden to achieve a custom naming scheme for generic BaseModels. | | Args: | params: Tuple of types of the class. Given a generic class | `Model` with 2 type variables and a concrete model `Model[str, int]`, | the value `(str, int)` would be passed to `params`. | | Returns: | String representing the new class where `params` are passed to `cls` as type variables. | | Raises: | TypeError: Raised when trying to generate concrete names for non-generic models. | | model_rebuild(*, force: 'bool' = False, raise_errors: 'bool' = True, _parent_namespace_depth: 'int' = 2, _types_namespace: 'MappingNamespace | None' = None) -> 'bool | None' from pydantic._internal._model_construction.ModelMetaclass | Try to rebuild the pydantic-core schema for the model. | | This may be necessary when one of the annotations is a ForwardRef which could not be resolved during | the initial attempt to build the schema, and automatic rebuilding fails. | | Args: | force: Whether to force the rebuilding of the model schema, defaults to `False`. | raise_errors: Whether to raise errors, defaults to `True`. | _parent_namespace_depth: The depth level of the parent namespace, defaults to 2. | _types_namespace: The types namespace, defaults to `None`. | | Returns: | Returns `None` if the schema is already "complete" and rebuilding was not required. | If rebuilding _was_ required, returns `True` if rebuilding was successful, otherwise `False`. | | model_validate(obj: 'Any', *, strict: 'bool | None' = None, extra: 'ExtraValues | None' = None, from_attributes: 'bool | None' = None, context: 'Any | None' = None, by_alias: 'bool | None' = None, by_name: 'bool | None' = None) -> 'Self' from pydantic._internal._model_construction.ModelMetaclass | Validate a pydantic model instance. | | Args: | obj: The object to validate. | strict: Whether to enforce types strictly. | extra: Whether to ignore, allow, or forbid extra data during model validation. | See the [`extra` configuration value][pydantic.ConfigDict.extra] for details. | from_attributes: Whether to extract data from object attributes. | context: Additional context to pass to the validator. | by_alias: Whether to use the field's alias when validating against the provided input data. | by_name: Whether to use the field's name when validating against the provided input data. | | Raises: | ValidationError: If the object could not be validated. | | Returns: | The validated model instance. | | model_validate_json(json_data: 'str | bytes | bytearray', *, strict: 'bool | None' = None, extra: 'ExtraValues | None' = None, context: 'Any | None' = None, by_alias: 'bool | None' = None, by_name: 'bool | None' = None) -> 'Self' from pydantic._internal._model_construction.ModelMetaclass | !!! abstract "Usage Documentation" | [JSON Parsing](../concepts/json.md#json-parsing) | | Validate the given JSON data against the Pydantic model. | | Args: | json_data: The JSON data to validate. | strict: Whether to enforce types strictly. | extra: Whether to ignore, allow, or forbid extra data during model validation. | See the [`extra` configuration value][pydantic.ConfigDict.extra] for details. | context: Extra variables to pass to the validator. | by_alias: Whether to use the field's alias when validating against the provided input data. | by_name: Whether to use the field's name when validating against the provided input data. | | Returns: | The validated Pydantic model. | | Raises: | ValidationError: If `json_data` is not a JSON string or the object could not be validated. | | model_validate_strings(obj: 'Any', *, strict: 'bool | None' = None, extra: 'ExtraValues | None' = None, context: 'Any | None' = None, by_alias: 'bool | None' = None, by_name: 'bool | None' = None) -> 'Self' from pydantic._internal._model_construction.ModelMetaclass | Validate the given object with string data against the Pydantic model. | | Args: | obj: The object containing string data to validate. | strict: Whether to enforce types strictly. | extra: Whether to ignore, allow, or forbid extra data during model validation. | See the [`extra` configuration value][pydantic.ConfigDict.extra] for details. | context: Extra variables to pass to the validator. | by_alias: Whether to use the field's alias when validating against the provided input data. | by_name: Whether to use the field's name when validating against the provided input data. | | Returns: | The validated Pydantic model. | | parse_file(path: 'str | Path', *, content_type: 'str | None' = None, encoding: 'str' = 'utf8', proto: 'DeprecatedParseProtocol | None' = None, allow_pickle: 'bool' = False) -> 'Self' from pydantic._internal._model_construction.ModelMetaclass | | parse_obj(obj: 'Any') -> 'Self' from pydantic._internal._model_construction.ModelMetaclass | | parse_raw(b: 'str | bytes', *, content_type: 'str | None' = None, encoding: 'str' = 'utf8', proto: 'DeprecatedParseProtocol | None' = None, allow_pickle: 'bool' = False) -> 'Self' from pydantic._internal._model_construction.ModelMetaclass | | schema(by_alias: 'bool' = True, ref_template: 'str' = '#/$defs/{model}') -> 'Dict[str, Any]' from pydantic._internal._model_construction.ModelMetaclass | | schema_json(*, by_alias: 'bool' = True, ref_template: 'str' = '#/$defs/{model}', **dumps_kwargs: 'Any') -> 'str' from pydantic._internal._model_construction.ModelMetaclass | | update_forward_refs(**localns: 'Any') -> 'None' from pydantic._internal._model_construction.ModelMetaclass | | validate(value: 'Any') -> 'Self' from pydantic._internal._model_construction.ModelMetaclass | | ---------------------------------------------------------------------- | Readonly properties inherited from pydantic.main.BaseModel: | | __fields_set__ | | model_extra | Get extra fields set during validation. | | Returns: | A dictionary of extra fields, or `None` if `config.extra` is not set to `"allow"`. | | model_fields_set | Returns the set of fields that have been explicitly set on this model instance. | | Returns: | A set of strings representing the fields that have been set, | i.e. that were not filled from defaults. | | ---------------------------------------------------------------------- | Data descriptors inherited from pydantic.main.BaseModel: | | __dict__ | dictionary for instance variables (if defined) | | __pydantic_extra__ | | __pydantic_fields_set__ | | __pydantic_private__ | | ---------------------------------------------------------------------- | Data and other attributes inherited from pydantic.main.BaseModel: | | __hash__ = None | | __pydantic_root_model__ = False | | model_computed_fields = {} | | model_fields = {} class BedrockOpenAI(OpenAI) | BedrockOpenAI(*, api_key: 'str | None' = None, bedrock_token_provider: 'BedrockTokenProvider | None' = None, aws_region: 'str | None' = None, aws_profile: 'str | None' = None, aws_access_key_id: 'str | None' = None, aws_secret_access_key: 'str | None' = None, aws_session_token: 'str | None' = None, aws_credentials_provider: 'AwsCredentialsProvider | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, base_url: 'str | httpx.URL | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, max_retries: 'int' = 2, default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, http_client: 'httpx.Client | None' = None, _strict_response_validation: 'bool' = False, _enforce_credentials: 'bool' = True, _provider: '_Provider | None' = None, _state: '_LegacyBedrockState | None' = None, _region_was_explicit: 'bool | None' = None) -> 'None' | | Compatibility client for Amazon Bedrock's OpenAI-compatible endpoint. | | Method resolution order: | BedrockOpenAI | OpenAI | openai._base_client.SyncAPIClient | openai._base_client.BaseClient | typing.Generic | builtins.object | | Methods defined here: | | __init__(self, *, api_key: 'str | None' = None, bedrock_token_provider: 'BedrockTokenProvider | None' = None, aws_region: 'str | None' = None, aws_profile: 'str | None' = None, aws_access_key_id: 'str | None' = None, aws_secret_access_key: 'str | None' = None, aws_session_token: 'str | None' = None, aws_credentials_provider: 'AwsCredentialsProvider | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, base_url: 'str | httpx.URL | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, max_retries: 'int' = 2, default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, http_client: 'httpx.Client | None' = None, _strict_response_validation: 'bool' = False, _enforce_credentials: 'bool' = True, _provider: '_Provider | None' = None, _state: '_LegacyBedrockState | None' = None, _region_was_explicit: 'bool | None' = None) -> 'None' | Construct a new synchronous OpenAI client instance. | | This automatically infers the following arguments from their corresponding environment variables if they are not provided: | - `api_key` from `OPENAI_API_KEY` | - `admin_api_key` from `OPENAI_ADMIN_KEY` | - `organization` from `OPENAI_ORG_ID` | - `project` from `OPENAI_PROJECT_ID` | - `webhook_secret` from `OPENAI_WEBHOOK_SECRET` | | When `provider` is supplied, authentication and the base URL are configured by that provider instead. | | copy(self, *, api_key: 'str | BedrockTokenProvider | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, provider: '_Provider | None | NotGiven' = NOT_GIVEN, bedrock_token_provider: 'BedrockTokenProvider | None' = None, aws_region: 'str | None' = None, aws_profile: 'str | None' = None, aws_access_key_id: 'str | None' = None, aws_secret_access_key: 'str | None' = None, aws_session_token: 'str | None' = None, aws_credentials_provider: 'AwsCredentialsProvider | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, http_client: 'httpx.Client | None' = None, max_retries: 'int | NotGiven' = NOT_GIVEN, default_headers: 'Mapping[str, str] | None' = None, set_default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, set_default_query: 'Mapping[str, object] | None' = None, _enforce_credentials: 'bool | None' = None, _extra_kwargs: 'Mapping[str, Any]' = {}) -> 'Self' | Create a new client instance re-using the same options given to the current client with optional overriding. | | with_options = copy(self, *, api_key: 'str | BedrockTokenProvider | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, provider: '_Provider | None | NotGiven' = NOT_GIVEN, bedrock_token_provider: 'BedrockTokenProvider | None' = None, aws_region: 'str | None' = None, aws_profile: 'str | None' = None, aws_access_key_id: 'str | None' = None, aws_secret_access_key: 'str | None' = None, aws_session_token: 'str | None' = None, aws_credentials_provider: 'AwsCredentialsProvider | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, http_client: 'httpx.Client | None' = None, max_retries: 'int | NotGiven' = NOT_GIVEN, default_headers: 'Mapping[str, str] | None' = None, set_default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, set_default_query: 'Mapping[str, object] | None' = None, _enforce_credentials: 'bool | None' = None, _extra_kwargs: 'Mapping[str, Any]' = {}) -> 'Self' | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'_bedrock_provider': '_Provider', '_bedrock_runtime... | | __parameters__ = () | | ---------------------------------------------------------------------- | Methods inherited from OpenAI: | | admin = <functools.cached_property object> | audio = <functools.cached_property object> | batches = <functools.cached_property object> | Create large batches of API requests to run asynchronously. | | beta = <functools.cached_property object> | chat = <functools.cached_property object> | completions = <functools.cached_property object> | Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. | | containers = <functools.cached_property object> | conversations = <functools.cached_property object> | Manage conversations and conversation items. | | embeddings = <functools.cached_property object> | Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. | | evals = <functools.cached_property object> | Manage and run evals in the OpenAI platform. | | files = <functools.cached_property object> | Files are used to upload documents that can be used with features like Assistants and Fine-tuning. | | fine_tuning = <functools.cached_property object> | images = <functools.cached_property object> | Given a prompt and/or an input image, the model will generate a new image. | | models = <functools.cached_property object> | List and describe the various models available in the API. | | moderations = <functools.cached_property object> | Given text and/or image inputs, classifies if those inputs are potentially harmful. | | realtime = <functools.cached_property object> | responses = <functools.cached_property object> | skills = <functools.cached_property object> | uploads = <functools.cached_property object> | Use Uploads to upload large files in multiple parts. | | vector_stores = <functools.cached_property object> | videos = <functools.cached_property object> | webhooks = <functools.cached_property object> | with_raw_response = <functools.cached_property object> | with_streaming_response = <functools.cached_property object> | ---------------------------------------------------------------------- | Readonly properties inherited from OpenAI: | | auth_headers | | default_headers | | qs | | ---------------------------------------------------------------------- | Methods inherited from openai._base_client.SyncAPIClient: | | __enter__(self: '_T') -> '_T' | | __exit__(self, exc_type: 'type[BaseException] | None', exc: 'BaseException | None', exc_tb: 'TracebackType | None') -> 'None' | | close(self) -> 'None' | Close the underlying HTTPX client. | | The client will *not* be usable after this. | | delete(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'BinaryTypes | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | get(self, path: 'str', *, cast_to: 'Type[ResponseT]', options: 'RequestOptions' = {}, stream: 'bool' = False, stream_cls: 'type[_StreamT] | None' = None) -> 'ResponseT | _StreamT' | | get_api_list(self, path: 'str', *, model: 'Type[object]', page: 'Type[SyncPageT]', body: 'Body | None' = None, options: 'RequestOptions' = {}, method: 'str' = 'get') -> 'SyncPageT' | | is_closed(self) -> 'bool' | | patch(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'BinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | post(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'BinaryTypes | None' = None, options: 'RequestOptions' = {}, files: 'RequestFiles | None' = None, stream: 'bool' = False, stream_cls: 'type[_StreamT] | None' = None) -> 'ResponseT | _StreamT' | | put(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'BinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | request(self, cast_to: 'Type[ResponseT]', options: 'FinalRequestOptions', *, stream: 'bool' = False, stream_cls: 'type[_StreamT] | None' = None) -> 'ResponseT | _StreamT' | | ---------------------------------------------------------------------- | Data and other attributes inherited from openai._base_client.SyncAPIClient: | | __orig_bases__ = (openai._base_client.BaseClient[httpx.Client, openai.... | | ---------------------------------------------------------------------- | Methods inherited from openai._base_client.BaseClient: | | platform_headers(self) -> 'Dict[str, str]' | | ---------------------------------------------------------------------- | Readonly properties inherited from openai._base_client.BaseClient: | | custom_auth | | default_query | | user_agent | | ---------------------------------------------------------------------- | Data descriptors inherited from openai._base_client.BaseClient: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | base_url | | ---------------------------------------------------------------------- | Class methods inherited from typing.Generic: | | __class_getitem__(params) from builtins.type | | __init_subclass__(*args, **kwargs) from builtins.type | This method is called when a class is subclassed. | | The default implementation does nothing. It may be | overridden to extend subclasses. Client = class OpenAI(openai._base_client.SyncAPIClient) | Client(*, api_key: 'str | Callable[[], str] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, provider: '_Provider | None' = None, base_url: 'str | httpx.URL | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, max_retries: 'int' = 2, default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, http_client: 'httpx.Client | None' = None, _strict_response_validation: 'bool' = False, _enforce_credentials: 'bool' = True) -> 'None' | | Method resolution order: | OpenAI | openai._base_client.SyncAPIClient | openai._base_client.BaseClient | typing.Generic | builtins.object | | Methods defined here: | | __init__(self, *, api_key: 'str | Callable[[], str] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, provider: '_Provider | None' = None, base_url: 'str | httpx.URL | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, max_retries: 'int' = 2, default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, http_client: 'httpx.Client | None' = None, _strict_response_validation: 'bool' = False, _enforce_credentials: 'bool' = True) -> 'None' | Construct a new synchronous OpenAI client instance. | | This automatically infers the following arguments from their corresponding environment variables if they are not provided: | - `api_key` from `OPENAI_API_KEY` | - `admin_api_key` from `OPENAI_ADMIN_KEY` | - `organization` from `OPENAI_ORG_ID` | - `project` from `OPENAI_PROJECT_ID` | - `webhook_secret` from `OPENAI_WEBHOOK_SECRET` | | When `provider` is supplied, authentication and the base URL are configured by that provider instead. | | admin = <functools.cached_property object> | audio = <functools.cached_property object> | batches = <functools.cached_property object> | Create large batches of API requests to run asynchronously. | | beta = <functools.cached_property object> | chat = <functools.cached_property object> | completions = <functools.cached_property object> | Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. | | containers = <functools.cached_property object> | conversations = <functools.cached_property object> | Manage conversations and conversation items. | | copy(self, *, api_key: 'str | Callable[[], str] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, provider: '_Provider | None | NotGiven' = NOT_GIVEN, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, http_client: 'httpx.Client | None' = None, max_retries: 'int | NotGiven' = NOT_GIVEN, default_headers: 'Mapping[str, str] | None' = None, set_default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, set_default_query: 'Mapping[str, object] | None' = None, _enforce_credentials: 'bool | None' = None, _extra_kwargs: 'Mapping[str, Any]' = {}) -> 'Self' | Create a new client instance re-using the same options given to the current client with optional overriding. | | embeddings = <functools.cached_property object> | Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. | | evals = <functools.cached_property object> | Manage and run evals in the OpenAI platform. | | files = <functools.cached_property object> | Files are used to upload documents that can be used with features like Assistants and Fine-tuning. | | fine_tuning = <functools.cached_property object> | images = <functools.cached_property object> | Given a prompt and/or an input image, the model will generate a new image. | | models = <functools.cached_property object> | List and describe the various models available in the API. | | moderations = <functools.cached_property object> | Given text and/or image inputs, classifies if those inputs are potentially harmful. | | realtime = <functools.cached_property object> | responses = <functools.cached_property object> | skills = <functools.cached_property object> | uploads = <functools.cached_property object> | Use Uploads to upload large files in multiple parts. | | vector_stores = <functools.cached_property object> | videos = <functools.cached_property object> | webhooks = <functools.cached_property object> | with_options = copy(self, *, api_key: 'str | Callable[[], str] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, provider: '_Provider | None | NotGiven' = NOT_GIVEN, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, http_client: 'httpx.Client | None' = None, max_retries: 'int | NotGiven' = NOT_GIVEN, default_headers: 'Mapping[str, str] | None' = None, set_default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, set_default_query: 'Mapping[str, object] | None' = None, _enforce_credentials: 'bool | None' = None, _extra_kwargs: 'Mapping[str, Any]' = {}) -> 'Self' | | with_raw_response = <functools.cached_property object> | with_streaming_response = <functools.cached_property object> | ---------------------------------------------------------------------- | Readonly properties defined here: | | auth_headers | | default_headers | | qs | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'_provider': '_Provider | None', '_provider_runtime... | | __parameters__ = () | | ---------------------------------------------------------------------- | Methods inherited from openai._base_client.SyncAPIClient: | | __enter__(self: '_T') -> '_T' | | __exit__(self, exc_type: 'type[BaseException] | None', exc: 'BaseException | None', exc_tb: 'TracebackType | None') -> 'None' | | close(self) -> 'None' | Close the underlying HTTPX client. | | The client will *not* be usable after this. | | delete(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'BinaryTypes | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | get(self, path: 'str', *, cast_to: 'Type[ResponseT]', options: 'RequestOptions' = {}, stream: 'bool' = False, stream_cls: 'type[_StreamT] | None' = None) -> 'ResponseT | _StreamT' | | get_api_list(self, path: 'str', *, model: 'Type[object]', page: 'Type[SyncPageT]', body: 'Body | None' = None, options: 'RequestOptions' = {}, method: 'str' = 'get') -> 'SyncPageT' | | is_closed(self) -> 'bool' | | patch(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'BinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | post(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'BinaryTypes | None' = None, options: 'RequestOptions' = {}, files: 'RequestFiles | None' = None, stream: 'bool' = False, stream_cls: 'type[_StreamT] | None' = None) -> 'ResponseT | _StreamT' | | put(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'BinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | request(self, cast_to: 'Type[ResponseT]', options: 'FinalRequestOptions', *, stream: 'bool' = False, stream_cls: 'type[_StreamT] | None' = None) -> 'ResponseT | _StreamT' | | ---------------------------------------------------------------------- | Data and other attributes inherited from openai._base_client.SyncAPIClient: | | __orig_bases__ = (openai._base_client.BaseClient[httpx.Client, openai.... | | ---------------------------------------------------------------------- | Methods inherited from openai._base_client.BaseClient: | | platform_headers(self) -> 'Dict[str, str]' | | ---------------------------------------------------------------------- | Readonly properties inherited from openai._base_client.BaseClient: | | custom_auth | | default_query | | user_agent | | ---------------------------------------------------------------------- | Data descriptors inherited from openai._base_client.BaseClient: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | base_url | | ---------------------------------------------------------------------- | Class methods inherited from typing.Generic: | | __class_getitem__(params) from builtins.type | | __init_subclass__(*args, **kwargs) from builtins.type | This method is called when a class is subclassed. | | The default implementation does nothing. It may be | overridden to extend subclasses. class ConflictError(APIStatusError) | ConflictError(message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | | Method resolution order: | ConflictError | APIStatusError | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Data and other attributes defined here: | | __annotations__ = {'status_code': 'Literal[409]'} | | status_code = 409 | | ---------------------------------------------------------------------- | Methods inherited from APIStatusError: | | __init__(self, message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes inherited from APIError: | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class ContentFilterFinishReasonError(OpenAIError) | ContentFilterFinishReasonError() -> 'None' | | Method resolution order: | ContentFilterFinishReasonError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self) -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {} | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args DefaultAioHttpClient = class _DefaultAioHttpClient(httpx.AsyncClient) | DefaultAioHttpClient(**_kwargs: 'Any') -> 'None' | | Method resolution order: | _DefaultAioHttpClient | httpx.AsyncClient | httpx._client.BaseClient | builtins.object | | Methods defined here: | | __init__(self, **_kwargs: 'Any') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from httpx.AsyncClient: | | async __aenter__(self: 'U') -> 'U' | | async __aexit__(self, exc_type: 'type[BaseException] | None' = None, exc_value: 'BaseException | None' = None, traceback: 'TracebackType | None' = None) -> 'None' | | async aclose(self) -> 'None' | Close transport and proxies. | | async delete(self, url: 'URL | str', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `DELETE` request. | | **Parameters**: See `httpx.request`. | | async get(self, url: 'URL | str', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `GET` request. | | **Parameters**: See `httpx.request`. | | async head(self, url: 'URL | str', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `HEAD` request. | | **Parameters**: See `httpx.request`. | | async options(self, url: 'URL | str', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send an `OPTIONS` request. | | **Parameters**: See `httpx.request`. | | async patch(self, url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `PATCH` request. | | **Parameters**: See `httpx.request`. | | async post(self, url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `POST` request. | | **Parameters**: See `httpx.request`. | | async put(self, url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `PUT` request. | | **Parameters**: See `httpx.request`. | | async request(self, method: 'str', url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Build and send a request. | | Equivalent to: | | ```python | request = client.build_request(...) | response = await client.send(request, ...) | ``` | | See `AsyncClient.build_request()`, `AsyncClient.send()` | and [Merging of configuration][0] for how the various parameters | are merged with client-level configuration. | | [0]: /advanced/clients/#merging-of-configuration | | async send(self, request: 'Request', *, stream: 'bool' = False, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>) -> 'Response' | Send a request. | | The request is sent as-is, unmodified. | | Typically you'll want to build one with `AsyncClient.build_request()` | so that any client-level configuration is merged into the request, | but passing an explicit `httpx.Request()` is supported as well. | | See also: [Request instances][0] | | [0]: /advanced/clients/#request-instances | | stream(self, method: 'str', url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'typing.AsyncIterator[Response]' | Alternative to `httpx.request()` that streams the response body | instead of loading it into memory at once. | | **Parameters**: See `httpx.request`. | | See also: [Streaming Responses][0] | | [0]: /quickstart#streaming-responses | | ---------------------------------------------------------------------- | Methods inherited from httpx._client.BaseClient: | | build_request(self, method: 'str', url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Request' | Build and return a request instance. | | * The `params`, `headers` and `cookies` arguments | are merged with any values set on the client. | * The `url` argument is merged with any `base_url` set on the client. | | See also: [Request instances][0] | | [0]: /advanced/clients/#request-instances | | ---------------------------------------------------------------------- | Readonly properties inherited from httpx._client.BaseClient: | | is_closed | Check if the client being closed | | trust_env | | ---------------------------------------------------------------------- | Data descriptors inherited from httpx._client.BaseClient: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | auth | Authentication class used when none is passed at the request-level. | | See also [Authentication][0]. | | [0]: /quickstart/#authentication | | base_url | Base URL to use when sending requests with relative URLs. | | cookies | Cookie values to include when sending requests. | | event_hooks | | headers | HTTP headers to include when sending requests. | | params | Query parameters to include in the URL when sending requests. | | timeout DefaultAsyncHttpxClient = class _DefaultAsyncHttpxClient(httpx.AsyncClient) | DefaultAsyncHttpxClient(**kwargs: 'Any') -> 'None' | | Method resolution order: | _DefaultAsyncHttpxClient | httpx.AsyncClient | httpx._client.BaseClient | builtins.object | | Methods defined here: | | __init__(self, **kwargs: 'Any') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from httpx.AsyncClient: | | async __aenter__(self: 'U') -> 'U' | | async __aexit__(self, exc_type: 'type[BaseException] | None' = None, exc_value: 'BaseException | None' = None, traceback: 'TracebackType | None' = None) -> 'None' | | async aclose(self) -> 'None' | Close transport and proxies. | | async delete(self, url: 'URL | str', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `DELETE` request. | | **Parameters**: See `httpx.request`. | | async get(self, url: 'URL | str', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `GET` request. | | **Parameters**: See `httpx.request`. | | async head(self, url: 'URL | str', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `HEAD` request. | | **Parameters**: See `httpx.request`. | | async options(self, url: 'URL | str', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send an `OPTIONS` request. | | **Parameters**: See `httpx.request`. | | async patch(self, url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `PATCH` request. | | **Parameters**: See `httpx.request`. | | async post(self, url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `POST` request. | | **Parameters**: See `httpx.request`. | | async put(self, url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `PUT` request. | | **Parameters**: See `httpx.request`. | | async request(self, method: 'str', url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Build and send a request. | | Equivalent to: | | ```python | request = client.build_request(...) | response = await client.send(request, ...) | ``` | | See `AsyncClient.build_request()`, `AsyncClient.send()` | and [Merging of configuration][0] for how the various parameters | are merged with client-level configuration. | | [0]: /advanced/clients/#merging-of-configuration | | async send(self, request: 'Request', *, stream: 'bool' = False, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>) -> 'Response' | Send a request. | | The request is sent as-is, unmodified. | | Typically you'll want to build one with `AsyncClient.build_request()` | so that any client-level configuration is merged into the request, | but passing an explicit `httpx.Request()` is supported as well. | | See also: [Request instances][0] | | [0]: /advanced/clients/#request-instances | | stream(self, method: 'str', url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'typing.AsyncIterator[Response]' | Alternative to `httpx.request()` that streams the response body | instead of loading it into memory at once. | | **Parameters**: See `httpx.request`. | | See also: [Streaming Responses][0] | | [0]: /quickstart#streaming-responses | | ---------------------------------------------------------------------- | Methods inherited from httpx._client.BaseClient: | | build_request(self, method: 'str', url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Request' | Build and return a request instance. | | * The `params`, `headers` and `cookies` arguments | are merged with any values set on the client. | * The `url` argument is merged with any `base_url` set on the client. | | See also: [Request instances][0] | | [0]: /advanced/clients/#request-instances | | ---------------------------------------------------------------------- | Readonly properties inherited from httpx._client.BaseClient: | | is_closed | Check if the client being closed | | trust_env | | ---------------------------------------------------------------------- | Data descriptors inherited from httpx._client.BaseClient: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | auth | Authentication class used when none is passed at the request-level. | | See also [Authentication][0]. | | [0]: /quickstart/#authentication | | base_url | Base URL to use when sending requests with relative URLs. | | cookies | Cookie values to include when sending requests. | | event_hooks | | headers | HTTP headers to include when sending requests. | | params | Query parameters to include in the URL when sending requests. | | timeout DefaultHttpxClient = class _DefaultHttpxClient(httpx.Client) | DefaultHttpxClient(**kwargs: 'Any') -> 'None' | | Method resolution order: | _DefaultHttpxClient | httpx.Client | httpx._client.BaseClient | builtins.object | | Methods defined here: | | __init__(self, **kwargs: 'Any') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from httpx.Client: | | __enter__(self: 'T') -> 'T' | | __exit__(self, exc_type: 'type[BaseException] | None' = None, exc_value: 'BaseException | None' = None, traceback: 'TracebackType | None' = None) -> 'None' | | close(self) -> 'None' | Close transport and proxies. | | delete(self, url: 'URL | str', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `DELETE` request. | | **Parameters**: See `httpx.request`. | | get(self, url: 'URL | str', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `GET` request. | | **Parameters**: See `httpx.request`. | | head(self, url: 'URL | str', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `HEAD` request. | | **Parameters**: See `httpx.request`. | | options(self, url: 'URL | str', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send an `OPTIONS` request. | | **Parameters**: See `httpx.request`. | | patch(self, url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `PATCH` request. | | **Parameters**: See `httpx.request`. | | post(self, url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `POST` request. | | **Parameters**: See `httpx.request`. | | put(self, url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Send a `PUT` request. | | **Parameters**: See `httpx.request`. | | request(self, method: 'str', url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Response' | Build and send a request. | | Equivalent to: | | ```python | request = client.build_request(...) | response = client.send(request, ...) | ``` | | See `Client.build_request()`, `Client.send()` and | [Merging of configuration][0] for how the various parameters | are merged with client-level configuration. | | [0]: /advanced/clients/#merging-of-configuration | | send(self, request: 'Request', *, stream: 'bool' = False, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>) -> 'Response' | Send a request. | | The request is sent as-is, unmodified. | | Typically you'll want to build one with `Client.build_request()` | so that any client-level configuration is merged into the request, | but passing an explicit `httpx.Request()` is supported as well. | | See also: [Request instances][0] | | [0]: /advanced/clients/#request-instances | | stream(self, method: 'str', url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'typing.Iterator[Response]' | Alternative to `httpx.request()` that streams the response body | instead of loading it into memory at once. | | **Parameters**: See `httpx.request`. | | See also: [Streaming Responses][0] | | [0]: /quickstart#streaming-responses | | ---------------------------------------------------------------------- | Methods inherited from httpx._client.BaseClient: | | build_request(self, method: 'str', url: 'URL | str', *, content: 'RequestContent | None' = None, data: 'RequestData | None' = None, files: 'RequestFiles | None' = None, json: 'typing.Any | None' = None, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x7f4749e8cc10>, extensions: 'RequestExtensions | None' = None) -> 'Request' | Build and return a request instance. | | * The `params`, `headers` and `cookies` arguments | are merged with any values set on the client. | * The `url` argument is merged with any `base_url` set on the client. | | See also: [Request instances][0] | | [0]: /advanced/clients/#request-instances | | ---------------------------------------------------------------------- | Readonly properties inherited from httpx._client.BaseClient: | | is_closed | Check if the client being closed | | trust_env | | ---------------------------------------------------------------------- | Data descriptors inherited from httpx._client.BaseClient: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | auth | Authentication class used when none is passed at the request-level. | | See also [Authentication][0]. | | [0]: /quickstart/#authentication | | base_url | Base URL to use when sending requests with relative URLs. | | cookies | Cookie values to include when sending requests. | | event_hooks | | headers | HTTP headers to include when sending requests. | | params | Query parameters to include in the URL when sending requests. | | timeout class InternalServerError(APIStatusError) | InternalServerError(message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | | Method resolution order: | InternalServerError | APIStatusError | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Data and other attributes defined here: | | __annotations__ = {} | | ---------------------------------------------------------------------- | Methods inherited from APIStatusError: | | __init__(self, message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes inherited from APIError: | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class InvalidWebhookSignatureError(builtins.ValueError) | Raised when a webhook signature is invalid, meaning the computed signature does not match the expected signature. | | Method resolution order: | InvalidWebhookSignatureError | builtins.ValueError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.ValueError: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.ValueError: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class LengthFinishReasonError(OpenAIError) | LengthFinishReasonError(*, completion: 'ChatCompletion') -> 'None' | | Method resolution order: | LengthFinishReasonError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, *, completion: 'ChatCompletion') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'completion': 'ChatCompletion'} | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. class NotFoundError(APIStatusError) | NotFoundError(message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | | Method resolution order: | NotFoundError | APIStatusError | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Data and other attributes defined here: | | __annotations__ = {'status_code': 'Literal[404]'} | | status_code = 404 | | ---------------------------------------------------------------------- | Methods inherited from APIStatusError: | | __init__(self, message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes inherited from APIError: | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class NotGiven(builtins.object) | For parameters with a meaningful None value, we need to distinguish between | the user explicitly passing None, and the user not passing the parameter at | all. | | User code shouldn't need to use not_given directly. | | For example: | | ```py | def create(timeout: Timeout | None | NotGiven = not_given): ... | | | create(timeout=1) # 1s timeout | create(timeout=None) # No timeout | create() # Default timeout behavior | ``` | | Methods defined here: | | __bool__(self) -> 'Literal[False]' | | __repr__(self) -> 'str' | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class OAuthError(AuthenticationError) | OAuthError(*, response: 'httpx.Response', body: 'object | None') -> 'None' | | Method resolution order: | OAuthError | AuthenticationError | APIStatusError | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, *, response: 'httpx.Response', body: 'object | None') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'error': 'Optional[OAuthErrorCode]'} | | ---------------------------------------------------------------------- | Data and other attributes inherited from AuthenticationError: | | status_code = 401 | | ---------------------------------------------------------------------- | Data and other attributes inherited from APIError: | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class Omit(builtins.object) | To explicitly omit something from being sent in a request, use `omit`. | | ```py | # as the default `Content-Type` header is `application/json` that will be sent | client.post("/upload/files", files={"file": b"my raw file content"}) | | # you can't explicitly override the header as it has to be dynamically generated | # to look something like: 'multipart/form-data; boundary=0d8382fcf5f8c3be01ca2e11002d2983' | client.post(..., headers={"Content-Type": "multipart/form-data"}) | | # instead you can remove the default `application/json` header by passing omit | client.post(..., headers={"Content-Type": omit}) | ``` | | Methods defined here: | | __bool__(self) -> 'Literal[False]' | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class OpenAI(openai._base_client.SyncAPIClient) | OpenAI(*, api_key: 'str | Callable[[], str] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, provider: '_Provider | None' = None, base_url: 'str | httpx.URL | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, max_retries: 'int' = 2, default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, http_client: 'httpx.Client | None' = None, _strict_response_validation: 'bool' = False, _enforce_credentials: 'bool' = True) -> 'None' | | Method resolution order: | OpenAI | openai._base_client.SyncAPIClient | openai._base_client.BaseClient | typing.Generic | builtins.object | | Methods defined here: | | __init__(self, *, api_key: 'str | Callable[[], str] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, provider: '_Provider | None' = None, base_url: 'str | httpx.URL | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, max_retries: 'int' = 2, default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, http_client: 'httpx.Client | None' = None, _strict_response_validation: 'bool' = False, _enforce_credentials: 'bool' = True) -> 'None' | Construct a new synchronous OpenAI client instance. | | This automatically infers the following arguments from their corresponding environment variables if they are not provided: | - `api_key` from `OPENAI_API_KEY` | - `admin_api_key` from `OPENAI_ADMIN_KEY` | - `organization` from `OPENAI_ORG_ID` | - `project` from `OPENAI_PROJECT_ID` | - `webhook_secret` from `OPENAI_WEBHOOK_SECRET` | | When `provider` is supplied, authentication and the base URL are configured by that provider instead. | | admin = <functools.cached_property object> | audio = <functools.cached_property object> | batches = <functools.cached_property object> | Create large batches of API requests to run asynchronously. | | beta = <functools.cached_property object> | chat = <functools.cached_property object> | completions = <functools.cached_property object> | Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. | | containers = <functools.cached_property object> | conversations = <functools.cached_property object> | Manage conversations and conversation items. | | copy(self, *, api_key: 'str | Callable[[], str] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, provider: '_Provider | None | NotGiven' = NOT_GIVEN, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, http_client: 'httpx.Client | None' = None, max_retries: 'int | NotGiven' = NOT_GIVEN, default_headers: 'Mapping[str, str] | None' = None, set_default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, set_default_query: 'Mapping[str, object] | None' = None, _enforce_credentials: 'bool | None' = None, _extra_kwargs: 'Mapping[str, Any]' = {}) -> 'Self' | Create a new client instance re-using the same options given to the current client with optional overriding. | | embeddings = <functools.cached_property object> | Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. | | evals = <functools.cached_property object> | Manage and run evals in the OpenAI platform. | | files = <functools.cached_property object> | Files are used to upload documents that can be used with features like Assistants and Fine-tuning. | | fine_tuning = <functools.cached_property object> | images = <functools.cached_property object> | Given a prompt and/or an input image, the model will generate a new image. | | models = <functools.cached_property object> | List and describe the various models available in the API. | | moderations = <functools.cached_property object> | Given text and/or image inputs, classifies if those inputs are potentially harmful. | | realtime = <functools.cached_property object> | responses = <functools.cached_property object> | skills = <functools.cached_property object> | uploads = <functools.cached_property object> | Use Uploads to upload large files in multiple parts. | | vector_stores = <functools.cached_property object> | videos = <functools.cached_property object> | webhooks = <functools.cached_property object> | with_options = copy(self, *, api_key: 'str | Callable[[], str] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, provider: '_Provider | None | NotGiven' = NOT_GIVEN, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, websocket_base_url: 'str | httpx.URL | None' = None, base_url: 'str | httpx.URL | None' = None, timeout: 'float | Timeout | None | NotGiven' = NOT_GIVEN, http_client: 'httpx.Client | None' = None, max_retries: 'int | NotGiven' = NOT_GIVEN, default_headers: 'Mapping[str, str] | None' = None, set_default_headers: 'Mapping[str, str] | None' = None, default_query: 'Mapping[str, object] | None' = None, set_default_query: 'Mapping[str, object] | None' = None, _enforce_credentials: 'bool | None' = None, _extra_kwargs: 'Mapping[str, Any]' = {}) -> 'Self' | | with_raw_response = <functools.cached_property object> | with_streaming_response = <functools.cached_property object> | ---------------------------------------------------------------------- | Readonly properties defined here: | | auth_headers | | default_headers | | qs | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'_provider': '_Provider | None', '_provider_runtime... | | __parameters__ = () | | ---------------------------------------------------------------------- | Methods inherited from openai._base_client.SyncAPIClient: | | __enter__(self: '_T') -> '_T' | | __exit__(self, exc_type: 'type[BaseException] | None', exc: 'BaseException | None', exc_tb: 'TracebackType | None') -> 'None' | | close(self) -> 'None' | Close the underlying HTTPX client. | | The client will *not* be usable after this. | | delete(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'BinaryTypes | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | get(self, path: 'str', *, cast_to: 'Type[ResponseT]', options: 'RequestOptions' = {}, stream: 'bool' = False, stream_cls: 'type[_StreamT] | None' = None) -> 'ResponseT | _StreamT' | | get_api_list(self, path: 'str', *, model: 'Type[object]', page: 'Type[SyncPageT]', body: 'Body | None' = None, options: 'RequestOptions' = {}, method: 'str' = 'get') -> 'SyncPageT' | | is_closed(self) -> 'bool' | | patch(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'BinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | post(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'BinaryTypes | None' = None, options: 'RequestOptions' = {}, files: 'RequestFiles | None' = None, stream: 'bool' = False, stream_cls: 'type[_StreamT] | None' = None) -> 'ResponseT | _StreamT' | | put(self, path: 'str', *, cast_to: 'Type[ResponseT]', body: 'Body | None' = None, content: 'BinaryTypes | None' = None, files: 'RequestFiles | None' = None, options: 'RequestOptions' = {}) -> 'ResponseT' | | request(self, cast_to: 'Type[ResponseT]', options: 'FinalRequestOptions', *, stream: 'bool' = False, stream_cls: 'type[_StreamT] | None' = None) -> 'ResponseT | _StreamT' | | ---------------------------------------------------------------------- | Data and other attributes inherited from openai._base_client.SyncAPIClient: | | __orig_bases__ = (openai._base_client.BaseClient[httpx.Client, openai.... | | ---------------------------------------------------------------------- | Methods inherited from openai._base_client.BaseClient: | | platform_headers(self) -> 'Dict[str, str]' | | ---------------------------------------------------------------------- | Readonly properties inherited from openai._base_client.BaseClient: | | custom_auth | | default_query | | user_agent | | ---------------------------------------------------------------------- | Data descriptors inherited from openai._base_client.BaseClient: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | base_url | | ---------------------------------------------------------------------- | Class methods inherited from typing.Generic: | | __class_getitem__(params) from builtins.type | | __init_subclass__(*args, **kwargs) from builtins.type | This method is called when a class is subclassed. | | The default implementation does nothing. It may be | overridden to extend subclasses. class OpenAIError(builtins.Exception) | Method resolution order: | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {} | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class PermissionDeniedError(APIStatusError) | PermissionDeniedError(message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | | Method resolution order: | PermissionDeniedError | APIStatusError | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Data and other attributes defined here: | | __annotations__ = {'status_code': 'Literal[403]'} | | status_code = 403 | | ---------------------------------------------------------------------- | Methods inherited from APIStatusError: | | __init__(self, message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes inherited from APIError: | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class RateLimitError(APIStatusError) | RateLimitError(message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | | Method resolution order: | RateLimitError | APIStatusError | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Data and other attributes defined here: | | __annotations__ = {'status_code': 'Literal[429]'} | | status_code = 429 | | ---------------------------------------------------------------------- | Methods inherited from APIStatusError: | | __init__(self, message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes inherited from APIError: | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class ReconnectingEvent(builtins.object) | ReconnectingEvent(attempt: 'int', max_attempts: 'int', delay: 'float', close_code: 'int', extra_query: 'Query', extra_headers: 'Headers') -> None | | Information about a reconnection attempt, passed to the ``on_reconnecting`` handler. | | Methods defined here: | | __delattr__(self, name) | Implement delattr(self, name). | | __eq__(self, other) | Return self==value. | | __hash__(self) | Return hash(self). | | __init__(self, attempt: 'int', max_attempts: 'int', delay: 'float', close_code: 'int', extra_query: 'Query', extra_headers: 'Headers') -> None | Initialize self. See help(type(self)) for accurate signature. | | __repr__(self) | Return repr(self). | | __setattr__(self, name, value) | Implement setattr(self, name, value). | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'attempt': 'int', 'close_code': 'int', 'delay': 'fl... | | __dataclass_fields__ = {'attempt': Field(name='attempt',type='int',def... | | __dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,or... | | __match_args__ = ('attempt', 'max_attempts', 'delay', 'close_code', 'e... class ReconnectingOverrides(builtins.dict) | Optional overrides returned from the ``on_reconnecting`` handler | to customize the next reconnection attempt. | | Method resolution order: | ReconnectingOverrides | builtins.dict | builtins.object | | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'abort': ForwardRef('bool'), 'extra_headers': Forwa... | | __closed__ = None | | __extra_items__ = typing_extensions.NoExtraItems | | __mutable_keys__ = frozenset({'abort', 'extra_headers', 'extra_query'}... | | __optional_keys__ = frozenset({'abort', 'extra_headers', 'extra_query'... | | __orig_bases__ = (typing_extensions.TypedDict,) | | __readonly_keys__ = frozenset() | | __required_keys__ = frozenset() | | __total__ = False | | ---------------------------------------------------------------------- | Methods inherited from builtins.dict: | | __contains__(self, key, /) | True if the dictionary has the specified key, else False. | | __delitem__(self, key, /) | Delete self[key]. | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __getattribute__(self, name, /) | Return getattr(self, name). | | __getitem__(...) | x.__getitem__(y) <==> x[y] | | __gt__(self, value, /) | Return self>value. | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | __ior__(self, value, /) | Return self|=value. | | __iter__(self, /) | Implement iter(self). | | __le__(self, value, /) | Return self<=value. | | __len__(self, /) | Return len(self). | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __or__(self, value, /) | Return self|value. | | __repr__(self, /) | Return repr(self). | | __reversed__(self, /) | Return a reverse iterator over the dict keys. | | __ror__(self, value, /) | Return value|self. | | __setitem__(self, key, value, /) | Set self[key] to value. | | __sizeof__(...) | D.__sizeof__() -> size of D in memory, in bytes | | clear(...) | D.clear() -> None. Remove all items from D. | | copy(...) | D.copy() -> a shallow copy of D | | get(self, key, default=None, /) | Return the value for key if key is in the dictionary, else default. | | items(...) | D.items() -> a set-like object providing a view on D's items | | keys(...) | D.keys() -> a set-like object providing a view on D's keys | | pop(...) | D.pop(k[,d]) -> v, remove specified key and return the corresponding value. | | If the key is not found, return the default if given; otherwise, | raise a KeyError. | | popitem(self, /) | Remove and return a (key, value) pair as a 2-tuple. | | Pairs are returned in LIFO (last-in, first-out) order. | Raises KeyError if the dict is empty. | | setdefault(self, key, default=None, /) | Insert key with a value of default if key is not in the dictionary. | | Return the value for key if key is in the dictionary, else default. | | update(...) | D.update([E, ]**F) -> None. Update D from dict/iterable E and F. | If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] | If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v | In either case, this is followed by: for k in F: D[k] = F[k] | | values(...) | D.values() -> an object providing a view on D's values | | ---------------------------------------------------------------------- | Class methods inherited from builtins.dict: | | __class_getitem__(...) from typing_extensions._TypedDictMeta | See PEP 585 | | fromkeys(iterable, value=None, /) from typing_extensions._TypedDictMeta | Create a new dictionary with keys from iterable and values set to value. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.dict: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes inherited from builtins.dict: | | __hash__ = None class RequestOptions(builtins.dict) | Method resolution order: | RequestOptions | builtins.dict | builtins.object | | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'extra_json': ForwardRef('AnyMapping'), 'follow_red... | | __closed__ = None | | __extra_items__ = typing_extensions.NoExtraItems | | __mutable_keys__ = frozenset({'extra_json', 'follow_redirects', 'heade... | | __optional_keys__ = frozenset({'extra_json', 'follow_redirects', 'head... | | __orig_bases__ = (typing_extensions.TypedDict,) | | __readonly_keys__ = frozenset() | | __required_keys__ = frozenset() | | __total__ = False | | ---------------------------------------------------------------------- | Methods inherited from builtins.dict: | | __contains__(self, key, /) | True if the dictionary has the specified key, else False. | | __delitem__(self, key, /) | Delete self[key]. | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __getattribute__(self, name, /) | Return getattr(self, name). | | __getitem__(...) | x.__getitem__(y) <==> x[y] | | __gt__(self, value, /) | Return self>value. | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | __ior__(self, value, /) | Return self|=value. | | __iter__(self, /) | Implement iter(self). | | __le__(self, value, /) | Return self<=value. | | __len__(self, /) | Return len(self). | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __or__(self, value, /) | Return self|value. | | __repr__(self, /) | Return repr(self). | | __reversed__(self, /) | Return a reverse iterator over the dict keys. | | __ror__(self, value, /) | Return value|self. | | __setitem__(self, key, value, /) | Set self[key] to value. | | __sizeof__(...) | D.__sizeof__() -> size of D in memory, in bytes | | clear(...) | D.clear() -> None. Remove all items from D. | | copy(...) | D.copy() -> a shallow copy of D | | get(self, key, default=None, /) | Return the value for key if key is in the dictionary, else default. | | items(...) | D.items() -> a set-like object providing a view on D's items | | keys(...) | D.keys() -> a set-like object providing a view on D's keys | | pop(...) | D.pop(k[,d]) -> v, remove specified key and return the corresponding value. | | If the key is not found, return the default if given; otherwise, | raise a KeyError. | | popitem(self, /) | Remove and return a (key, value) pair as a 2-tuple. | | Pairs are returned in LIFO (last-in, first-out) order. | Raises KeyError if the dict is empty. | | setdefault(self, key, default=None, /) | Insert key with a value of default if key is not in the dictionary. | | Return the value for key if key is in the dictionary, else default. | | update(...) | D.update([E, ]**F) -> None. Update D from dict/iterable E and F. | If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] | If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v | In either case, this is followed by: for k in F: D[k] = F[k] | | values(...) | D.values() -> an object providing a view on D's values | | ---------------------------------------------------------------------- | Class methods inherited from builtins.dict: | | __class_getitem__(...) from typing_extensions._TypedDictMeta | See PEP 585 | | fromkeys(iterable, value=None, /) from typing_extensions._TypedDictMeta | Create a new dictionary with keys from iterable and values set to value. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.dict: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes inherited from builtins.dict: | | __hash__ = None class Stream(typing.Generic) | Stream(*, cast_to: 'type[_T]', response: 'httpx.Response', client: 'OpenAI', options: 'Optional[FinalRequestOptions]' = None) -> 'None' | | Provides the core interface to iterate over a synchronous stream response. | | Method resolution order: | Stream | typing.Generic | builtins.object | | Methods defined here: | | __enter__(self) -> 'Self' | | __exit__(self, exc_type: 'type[BaseException] | None', exc: 'BaseException | None', exc_tb: 'TracebackType | None') -> 'None' | | __init__(self, *, cast_to: 'type[_T]', response: 'httpx.Response', client: 'OpenAI', options: 'Optional[FinalRequestOptions]' = None) -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | __iter__(self) -> 'Iterator[_T]' | | __next__(self) -> '_T' | | __stream__(self) -> 'Iterator[_T]' | | close(self) -> 'None' | Close the response and release the connection. | | Automatically called if the response body is read to completion. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'_decoder': 'SSEBytesDecoder', '_options': 'Optiona... | | __orig_bases__ = (typing.Generic[~_T],) | | __parameters__ = (~_T,) | | ---------------------------------------------------------------------- | Class methods inherited from typing.Generic: | | __class_getitem__(params) from builtins.type | | __init_subclass__(*args, **kwargs) from builtins.type | This method is called when a class is subclassed. | | The default implementation does nothing. It may be | overridden to extend subclasses. class Timeout(builtins.object) | Timeout(timeout: 'TimeoutTypes | UnsetType' = <httpx._config.UnsetType object at 0x7f4749c0dd20>, *, connect: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x7f4749c0dd20>, read: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x7f4749c0dd20>, write: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x7f4749c0dd20>, pool: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x7f4749c0dd20>) -> 'None' | | Timeout configuration. | | **Usage**: | | Timeout(None) # No timeouts. | Timeout(5.0) # 5s timeout on all operations. | Timeout(None, connect=5.0) # 5s timeout on connect, no other timeouts. | Timeout(5.0, connect=10.0) # 10s timeout on connect. 5s timeout elsewhere. | Timeout(5.0, pool=None) # No timeout on acquiring connection from pool. | # 5s timeout elsewhere. | | Methods defined here: | | __eq__(self, other: 'typing.Any') -> 'bool' | Return self==value. | | __init__(self, timeout: 'TimeoutTypes | UnsetType' = <httpx._config.UnsetType object at 0x7f4749c0dd20>, *, connect: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x7f4749c0dd20>, read: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x7f4749c0dd20>, write: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x7f4749c0dd20>, pool: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x7f4749c0dd20>) -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | __repr__(self) -> 'str' | Return repr(self). | | as_dict(self) -> 'dict[str, float | None]' | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __hash__ = None Transport = class BaseTransport(builtins.object) | Methods defined here: | | __enter__(self: 'T') -> 'T' | | __exit__(self, exc_type: 'type[BaseException] | None' = None, exc_value: 'BaseException | None' = None, traceback: 'TracebackType | None' = None) -> 'None' | | close(self) -> 'None' | | handle_request(self, request: 'Request') -> 'Response' | Send a single HTTP request and return a response. | | Developers shouldn't typically ever need to call into this API directly, | since the Client class provides all the higher level user-facing API | niceties. | | In order to properly release any network resources, the response | stream should *either* be consumed immediately, with a call to | `response.stream.read()`, or else the `handle_request` call should | be followed with a try/finally block to ensuring the stream is | always closed. | | Example usage: | | with httpx.HTTPTransport() as transport: | req = httpx.Request( | method=b"GET", | url=(b"https", b"www.example.com", 443, b"/"), | headers=[(b"Host", b"www.example.com")], | ) | resp = transport.handle_request(req) | body = resp.stream.read() | print(resp.status_code, resp.headers, body) | | | Takes a `Request` instance as the only argument. | | Returns a `Response` instance. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class UnprocessableEntityError(APIStatusError) | UnprocessableEntityError(message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | | Method resolution order: | UnprocessableEntityError | APIStatusError | APIError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Data and other attributes defined here: | | __annotations__ = {'status_code': 'Literal[422]'} | | status_code = 422 | | ---------------------------------------------------------------------- | Methods inherited from APIStatusError: | | __init__(self, message: 'str', *, response: 'httpx.Response', body: 'object | None') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes inherited from APIError: | | code = None | | param = None | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class WebSocketConnectionClosedError(OpenAIError) | WebSocketConnectionClosedError(message: 'str', *, unsent_messages: 'list[str]') -> 'None' | | Raised when a WebSocket connection closes with unsent messages. | | Method resolution order: | WebSocketConnectionClosedError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, message: 'str', *, unsent_messages: 'list[str]') -> 'None' | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __annotations__ = {'unsent_messages': 'list[str]'} | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class WebSocketQueueFullError(OpenAIError) | Raised when the outgoing WebSocket message queue exceeds its byte-size limit. | | Method resolution order: | WebSocketQueueFullError | OpenAIError | builtins.Exception | builtins.BaseException | builtins.object | | Data and other attributes defined here: | | __annotations__ = {} | | ---------------------------------------------------------------------- | Data descriptors inherited from OpenAIError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args FUNCTIONS file_from_path(path: 'str') -> 'FileTypes' DATA DEFAULT_CONNECTION_LIMITS = Limits(max_connections=1000, max_keepalive... DEFAULT_MAX_RETRIES = 2 DEFAULT_TIMEOUT = Timeout(connect=5.0, read=600, write=600, pool=600) NOT_GIVEN = NOT_GIVEN ProxiesTypes = typing.Union[str, httpx.Proxy, typing.Dict[Forwa...ng.U... __all__ = ['types', '__version__', '__title__', 'NoneType', 'Transport... __annotations__ = {'_bedrock_api_key': 'str | None', '_client': 'OpenA... __title__ = 'openai' not_given = NOT_GIVEN omit = <openai.Omit object> VERSION 2.44.0 FILE /home/chedong/.local/lib/python3.10/site-packages/openai/__init__.py
Generated by phpman v4.9.27 · Markdown · JSON · MCP Author: Che Dong Under GNU General Public License
2026-07-18 18:18 @216.73.216.114
CrawledBy Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)