openai API Reference
Full documentation for openai (2.52.0)
openai.APIConnectionError
Python Library Documentation: class APIConnectionError in module openai
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' from openai._exceptions.APIConnectionError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.APIError
Python Library Documentation: class APIError in module openai
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' from openai._exceptions.APIError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.APIResponse
Python Library Documentation: class APIResponse in module openai._response
class APIResponse(BaseAPIResponse)
| APIResponse(*, raw: 'httpx.Response', cast_to: 'type[R]', client: 'BaseClient[Any, Any]', stream: 'bool', stream_cls: 'type[Stream[Any]] | type[AsyncStream[Any]] | None', options: 'FinalRequestOptions', retries_taken: 'int' = 0) -> 'None'
|
| Method resolution order:
| APIResponse
| BaseAPIResponse
| typing.Generic
| builtins.object
|
| Methods defined here:
|
| close(self) -> 'None'
| Close the response and release the connection.
|
| Automatically called if the response body is read to completion.
|
| iter_bytes(self, chunk_size: 'int | None' = None) -> 'Iterator[bytes]'
| A byte-iterator over the decoded response content.
|
| This automatically handles gzip, deflate and brotli encoded responses.
|
| iter_lines(self) -> 'Iterator[str]'
| Like `iter_text()` but will only yield chunks for each line
|
| iter_text(self, chunk_size: 'int | None' = None) -> 'Iterator[str]'
| A str-iterator over the decoded response content
| that handles both gzip, deflate, etc but also detects the content's
| string encoding.
|
| json(self) -> 'object'
| Read and decode the JSON response content.
|
| parse(self, *, to: 'type[_T] | None' = None) -> 'R | _T'
| Returns the rich python representation of this response's data.
|
| For lower-level control, see `.read()`, `.json()`, `.iter_bytes()`.
|
| You can customise the type that the response is parsed into through
| the `to` argument, e.g.
|
| ```py
| from openai import BaseModel
|
|
| class MyModel(BaseModel):
| foo: str
|
|
| obj = response.parse(to=MyModel)
| print(obj.foo)
| ```
|
| We support parsing:
| - `BaseModel`
| - `dict`
| - `list`
| - `Union`
| - `str`
| - `int`
| - `float`
| - `httpx.Response`
|
| read(self) -> 'bytes'
| Read and return the binary response content.
|
| text(self) -> 'str'
| Read and decode the response content into a string.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| request_id
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._response.BaseAPIResponse[~R],)
|
| __parameters__ = (~R,)
|
| ----------------------------------------------------------------------
| Methods inherited from BaseAPIResponse:
|
| __init__(self, *, raw: 'httpx.Response', cast_to: 'type[R]', client: 'BaseClient[Any, Any]', stream: 'bool', stream_cls: 'type[Stream[Any]] | type[AsyncStream[Any]] | None', options: 'FinalRequestOptions', retries_taken: 'int' = 0) -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from BaseAPIResponse:
|
| elapsed
| The time taken for the complete request/response cycle to complete.
|
| headers
|
| http_request
| Returns the httpx Request instance associated with the current response.
|
| http_version
|
| is_closed
| Whether or not the response body has been closed.
|
| If this is False then there is response data that has not been read yet.
| You must either fully consume the response body or call `.close()`
| before discarding the response to prevent resource leaks.
|
| method
|
| status_code
|
| url
| Returns the URL for which the request was made.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseAPIResponse:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.APIResponseValidationError
Python Library Documentation: class APIResponseValidationError in module openai
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' from openai._exceptions.APIResponseValidationError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.APIStatusError
Python Library Documentation: class APIStatusError in module openai
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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.APITimeoutError
Python Library Documentation: class APITimeoutError in module openai
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' from openai._exceptions.APITimeoutError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.AssistantEventHandler
Python Library Documentation: class AssistantEventHandler in module openai.lib.streaming._assistants
class AssistantEventHandler(builtins.object)
| AssistantEventHandler() -> 'None'
|
| Methods defined here:
|
| __init__(self) -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| __iter__(self) -> 'Iterator[AssistantStreamEvent]'
|
| __next__(self) -> 'AssistantStreamEvent'
|
| __stream__(self) -> 'Iterator[AssistantStreamEvent]'
|
| __text_deltas__(self) -> 'Iterator[str]'
|
| close(self) -> 'None'
| Close the response and release the connection.
|
| Automatically called when the context manager exits.
|
| get_final_messages(self) -> 'list[Message]'
| Wait for the stream to finish and returns the messages emitted in this run
|
| get_final_run(self) -> 'Run'
| Wait for the stream to finish and returns the completed Run object
|
| get_final_run_steps(self) -> 'list[RunStep]'
| Wait for the stream to finish and returns the steps taken in this run
|
| on_end(self) -> 'None'
| Fires when the stream has finished.
|
| This happens if the stream is read to completion
| or if an exception occurs during iteration.
|
| on_event(self, event: 'AssistantStreamEvent') -> 'None'
| Callback that is fired for every Server-Sent-Event
|
| on_exception(self, exception: 'Exception') -> 'None'
| Fired whenever an exception happens during streaming
|
| on_image_file_done(self, image_file: 'ImageFile') -> 'None'
| Callback that is fired when an image file block is finished
|
| on_message_created(self, message: 'Message') -> 'None'
| Callback that is fired when a message is created
|
| on_message_delta(self, delta: 'MessageDelta', snapshot: 'Message') -> 'None'
| Callback that is fired whenever a message delta is returned from the API
|
| The first argument is just the delta as sent by the API and the second argument
| is the accumulated snapshot of the message. For example, a text content event may
| look like this:
|
| # delta
| MessageDeltaText(
| index=0,
| type='text',
| text=Text(
| value=' Jane'
| ),
| )
| # snapshot
| MessageContentText(
| index=0,
| type='text',
| text=Text(
| value='Certainly, Jane'
| ),
| )
|
| on_message_done(self, message: 'Message') -> 'None'
| Callback that is fired when a message is completed
|
| on_run_step_created(self, run_step: 'RunStep') -> 'None'
| Callback that is fired when a run step is created
|
| on_run_step_delta(self, delta: 'RunStepDelta', snapshot: 'RunStep') -> 'None'
| Callback that is fired whenever a run step delta is returned from the API
|
| The first argument is just the delta as sent by the API and the second argument
| is the accumulated snapshot of the run step. For example, a tool calls event may
| look like this:
|
| # delta
| tool_calls=[
| RunStepDeltaToolCallsCodeInterpreter(
| index=0,
| type='code_interpreter',
| id=None,
| code_interpreter=CodeInterpreter(input=' sympy', outputs=None)
| )
| ]
| # snapshot
| tool_calls=[
| CodeToolCall(
| id='call_wKayJlcYV12NiadiZuJXxcfx',
| code_interpreter=CodeInterpreter(input='from sympy', outputs=[]),
| type='code_interpreter',
| index=0
| )
| ],
|
| on_run_step_done(self, run_step: 'RunStep') -> 'None'
| Callback that is fired when a run step is completed
|
| on_text_created(self, text: 'Text') -> 'None'
| Callback that is fired when a text content block is created
|
| on_text_delta(self, delta: 'TextDelta', snapshot: 'Text') -> 'None'
| Callback that is fired whenever a text content delta is returned
| by the API.
|
| The first argument is just the delta as sent by the API and the second argument
| is the accumulated snapshot of the text. For example:
|
| on_text_delta(TextDelta(value="The"), Text(value="The")),
| on_text_delta(TextDelta(value=" solution"), Text(value="The solution")),
| on_text_delta(TextDelta(value=" to"), Text(value="The solution to")),
| on_text_delta(TextDelta(value=" the"), Text(value="The solution to the")),
| on_text_delta(TextDelta(value=" equation"), Text(value="The solution to the equation")),
|
| on_text_done(self, text: 'Text') -> 'None'
| Callback that is fired when a text content block is finished
|
| on_timeout(self) -> 'None'
| Fires if the request times out
|
| on_tool_call_created(self, tool_call: 'ToolCall') -> 'None'
| Callback that is fired when a tool call is created
|
| on_tool_call_delta(self, delta: 'ToolCallDelta', snapshot: 'ToolCall') -> 'None'
| Callback that is fired when a tool call delta is encountered
|
| on_tool_call_done(self, tool_call: 'ToolCall') -> 'None'
| Callback that is fired when a tool call delta is encountered
|
| until_done(self) -> 'None'
| Waits until the stream has been consumed
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| current_event
|
| current_message_snapshot
|
| current_run
|
| current_run_step_snapshot
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'text_deltas': 'Iterable[str]'}
openai.AsyncAPIResponse
Python Library Documentation: class AsyncAPIResponse in module openai._response
class AsyncAPIResponse(BaseAPIResponse)
| AsyncAPIResponse(*, raw: 'httpx.Response', cast_to: 'type[R]', client: 'BaseClient[Any, Any]', stream: 'bool', stream_cls: 'type[Stream[Any]] | type[AsyncStream[Any]] | None', options: 'FinalRequestOptions', retries_taken: 'int' = 0) -> 'None'
|
| Method resolution order:
| AsyncAPIResponse
| BaseAPIResponse
| typing.Generic
| builtins.object
|
| Methods defined here:
|
| async close(self) -> 'None'
| Close the response and release the connection.
|
| Automatically called if the response body is read to completion.
|
| async iter_bytes(self, chunk_size: 'int | None' = None) -> 'AsyncIterator[bytes]'
| A byte-iterator over the decoded response content.
|
| This automatically handles gzip, deflate and brotli encoded responses.
|
| async iter_lines(self) -> 'AsyncIterator[str]'
| Like `iter_text()` but will only yield chunks for each line
|
| async iter_text(self, chunk_size: 'int | None' = None) -> 'AsyncIterator[str]'
| A str-iterator over the decoded response content
| that handles both gzip, deflate, etc but also detects the content's
| string encoding.
|
| async json(self) -> 'object'
| Read and decode the JSON response content.
|
| async parse(self, *, to: 'type[_T] | None' = None) -> 'R | _T'
| Returns the rich python representation of this response's data.
|
| For lower-level control, see `.read()`, `.json()`, `.iter_bytes()`.
|
| You can customise the type that the response is parsed into through
| the `to` argument, e.g.
|
| ```py
| from openai import BaseModel
|
|
| class MyModel(BaseModel):
| foo: str
|
|
| obj = response.parse(to=MyModel)
| print(obj.foo)
| ```
|
| We support parsing:
| - `BaseModel`
| - `dict`
| - `list`
| - `Union`
| - `str`
| - `httpx.Response`
|
| async read(self) -> 'bytes'
| Read and return the binary response content.
|
| async text(self) -> 'str'
| Read and decode the response content into a string.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| request_id
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._response.BaseAPIResponse[~R],)
|
| __parameters__ = (~R,)
|
| ----------------------------------------------------------------------
| Methods inherited from BaseAPIResponse:
|
| __init__(self, *, raw: 'httpx.Response', cast_to: 'type[R]', client: 'BaseClient[Any, Any]', stream: 'bool', stream_cls: 'type[Stream[Any]] | type[AsyncStream[Any]] | None', options: 'FinalRequestOptions', retries_taken: 'int' = 0) -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from BaseAPIResponse:
|
| elapsed
| The time taken for the complete request/response cycle to complete.
|
| headers
|
| http_request
| Returns the httpx Request instance associated with the current response.
|
| http_version
|
| is_closed
| Whether or not the response body has been closed.
|
| If this is False then there is response data that has not been read yet.
| You must either fully consume the response body or call `.close()`
| before discarding the response to prevent resource leaks.
|
| method
|
| status_code
|
| url
| Returns the URL for which the request was made.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseAPIResponse:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.AsyncAssistantEventHandler
Python Library Documentation: class AsyncAssistantEventHandler in module openai.lib.streaming._assistants
class AsyncAssistantEventHandler(builtins.object)
| AsyncAssistantEventHandler() -> 'None'
|
| Methods defined here:
|
| async __aiter__(self) -> 'AsyncIterator[AssistantStreamEvent]'
|
| async __anext__(self) -> 'AssistantStreamEvent'
|
| __init__(self) -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| async __stream__(self) -> 'AsyncIterator[AssistantStreamEvent]'
|
| async __text_deltas__(self) -> 'AsyncIterator[str]'
|
| async close(self) -> 'None'
| Close the response and release the connection.
|
| Automatically called when the context manager exits.
|
| async get_final_messages(self) -> 'list[Message]'
| Wait for the stream to finish and returns the messages emitted in this run
|
| async get_final_run(self) -> 'Run'
| Wait for the stream to finish and returns the completed Run object
|
| async get_final_run_steps(self) -> 'list[RunStep]'
| Wait for the stream to finish and returns the steps taken in this run
|
| async on_end(self) -> 'None'
| Fires when the stream has finished.
|
| This happens if the stream is read to completion
| or if an exception occurs during iteration.
|
| async on_event(self, event: 'AssistantStreamEvent') -> 'None'
| Callback that is fired for every Server-Sent-Event
|
| async on_exception(self, exception: 'Exception') -> 'None'
| Fired whenever an exception happens during streaming
|
| async on_image_file_done(self, image_file: 'ImageFile') -> 'None'
| Callback that is fired when an image file block is finished
|
| async on_message_created(self, message: 'Message') -> 'None'
| Callback that is fired when a message is created
|
| async on_message_delta(self, delta: 'MessageDelta', snapshot: 'Message') -> 'None'
| Callback that is fired whenever a message delta is returned from the API
|
| The first argument is just the delta as sent by the API and the second argument
| is the accumulated snapshot of the message. For example, a text content event may
| look like this:
|
| # delta
| MessageDeltaText(
| index=0,
| type='text',
| text=Text(
| value=' Jane'
| ),
| )
| # snapshot
| MessageContentText(
| index=0,
| type='text',
| text=Text(
| value='Certainly, Jane'
| ),
| )
|
| async on_message_done(self, message: 'Message') -> 'None'
| Callback that is fired when a message is completed
|
| async on_run_step_created(self, run_step: 'RunStep') -> 'None'
| Callback that is fired when a run step is created
|
| async on_run_step_delta(self, delta: 'RunStepDelta', snapshot: 'RunStep') -> 'None'
| Callback that is fired whenever a run step delta is returned from the API
|
| The first argument is just the delta as sent by the API and the second argument
| is the accumulated snapshot of the run step. For example, a tool calls event may
| look like this:
|
| # delta
| tool_calls=[
| RunStepDeltaToolCallsCodeInterpreter(
| index=0,
| type='code_interpreter',
| id=None,
| code_interpreter=CodeInterpreter(input=' sympy', outputs=None)
| )
| ]
| # snapshot
| tool_calls=[
| CodeToolCall(
| id='call_wKayJlcYV12NiadiZuJXxcfx',
| code_interpreter=CodeInterpreter(input='from sympy', outputs=[]),
| type='code_interpreter',
| index=0
| )
| ],
|
| async on_run_step_done(self, run_step: 'RunStep') -> 'None'
| Callback that is fired when a run step is completed
|
| async on_text_created(self, text: 'Text') -> 'None'
| Callback that is fired when a text content block is created
|
| async on_text_delta(self, delta: 'TextDelta', snapshot: 'Text') -> 'None'
| Callback that is fired whenever a text content delta is returned
| by the API.
|
| The first argument is just the delta as sent by the API and the second argument
| is the accumulated snapshot of the text. For example:
|
| on_text_delta(TextDelta(value="The"), Text(value="The")),
| on_text_delta(TextDelta(value=" solution"), Text(value="The solution")),
| on_text_delta(TextDelta(value=" to"), Text(value="The solution to")),
| on_text_delta(TextDelta(value=" the"), Text(value="The solution to the")),
| on_text_delta(TextDelta(value=" equation"), Text(value="The solution to the equivalent")),
|
| async on_text_done(self, text: 'Text') -> 'None'
| Callback that is fired when a text content block is finished
|
| async on_timeout(self) -> 'None'
| Fires if the request times out
|
| async on_tool_call_created(self, tool_call: 'ToolCall') -> 'None'
| Callback that is fired when a tool call is created
|
| async on_tool_call_delta(self, delta: 'ToolCallDelta', snapshot: 'ToolCall') -> 'None'
| Callback that is fired when a tool call delta is encountered
|
| async on_tool_call_done(self, tool_call: 'ToolCall') -> 'None'
| Callback that is fired when a tool call delta is encountered
|
| async until_done(self) -> 'None'
| Waits until the stream has been consumed
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| current_event
|
| current_message_snapshot
|
| current_run
|
| current_run_step_snapshot
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'text_deltas': 'AsyncIterable[str]'}
openai.AsyncAzureOpenAI
Python Library Documentation: class AsyncAzureOpenAI in module openai.lib.azure
class AsyncAzureOpenAI(BaseAzureClient, openai.AsyncOpenAI)
| AsyncAzureOpenAI(*, azure_endpoint: 'str | None' = None, azure_deployment: 'str | None' = None, api_version: 'str | None' = None, api_key: 'str | Callable[[], Awaitable[str]] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, azure_ad_token: 'str | None' = None, azure_ad_token_provider: 'AsyncAzureADTokenProvider | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, base_url: 'str | 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:
| AsyncAzureOpenAI
| BaseAzureClient
| openai.AsyncOpenAI
| openai._base_client.AsyncAPIClient
| openai._base_client.BaseClient
| typing.Generic
| builtins.object
|
| Methods defined here:
|
| __init__(self, *, azure_endpoint: 'str | None' = None, azure_deployment: 'str | None' = None, api_version: 'str | None' = None, api_key: 'str | Callable[[], Awaitable[str]] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, azure_ad_token: 'str | None' = None, azure_ad_token_provider: 'AsyncAzureADTokenProvider | None' = None, organization: 'str | None' = None, project: 'str | None' = None, webhook_secret: 'str | None' = None, base_url: 'str | 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 asynchronous azure openai client instance.
|
| This automatically infers the following arguments from their corresponding environment variables if they are not provided:
| - `api_key` from `AZURE_OPENAI_API_KEY`
| - `organization` from `OPENAI_ORG_ID`
| - `project` from `OPENAI_PROJECT_ID`
| - `azure_ad_token` from `AZURE_OPENAI_AD_TOKEN`
| - `api_version` from `OPENAI_API_VERSION`
| - `azure_endpoint` from `AZURE_OPENAI_ENDPOINT`
|
| Args:
| azure_endpoint: Your Azure endpoint, including the resource, e.g. `https://example-resource.azure.openai.com/`
|
| azure_ad_token: Your Azure Active Directory token, https://www.microsoft.com/en-us/security/business/identity-access/microsoft-entra-id
|
| azure_ad_token_provider: A function that returns an Azure Active Directory token, will be invoked on every request.
|
| azure_deployment: A model deployment, if given with `azure_endpoint`, sets the base client URL to include `/deployments/{azure_deployment}`.
| Not supported with Assistants APIs.
|
| 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, api_version: 'str | None' = None, azure_ad_token: 'str | None' = None, azure_ad_token_provider: 'AsyncAzureADTokenProvider | 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 | 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, api_version: 'str | None' = None, azure_ad_token: 'str | None' = None, azure_ad_token_provider: 'AsyncAzureADTokenProvider | 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__ = {}
|
| __orig_bases__ = (openai.lib.azure.BaseAzureClient[httpx.AsyncClient, ...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai.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>
| content_provenance_checks = <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.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'
|
| ----------------------------------------------------------------------
| 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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.AsyncBedrockOpenAI
Python Library Documentation: class AsyncBedrockOpenAI in module openai
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' from openai.lib.bedrock.AsyncBedrockOpenAI
| 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' from openai.lib.bedrock.AsyncBedrockOpenAI
| 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>
| content_provenance_checks = <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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.AsyncClient
Python Library Documentation: class AsyncOpenAI in module openai
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' from openai._client.AsyncOpenAI
| 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>
| content_provenance_checks = <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' from openai._client.AsyncOpenAI
| 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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.AsyncOpenAI
Python Library Documentation: class AsyncOpenAI in module openai
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' from openai._client.AsyncOpenAI
| 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>
| content_provenance_checks = <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' from openai._client.AsyncOpenAI
| 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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.AsyncStream
Python Library Documentation: class AsyncStream in module openai
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' from openai._streaming.AsyncStream
|
| async __aexit__(self, exc_type: 'type[BaseException] | None', exc: 'BaseException | None', exc_tb: 'TracebackType | None') -> 'None' from openai._streaming.AsyncStream
|
| async __aiter__(self) -> 'AsyncIterator[_T]' from openai._streaming.AsyncStream
|
| async __anext__(self) -> '_T' from openai._streaming.AsyncStream
|
| __init__(self, *, cast_to: 'type[_T]', response: 'httpx.Response', client: 'AsyncOpenAI', options: 'Optional[FinalRequestOptions]' = None) -> 'None' from openai._streaming.AsyncStream
| Initialize self. See help(type(self)) for accurate signature.
|
| async __stream__(self) -> 'AsyncIterator[_T]' from openai._streaming.AsyncStream
|
| async close(self) -> 'None' from openai._streaming.AsyncStream
| 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
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| 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__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.Audio
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.AuthenticationError
Python Library Documentation: class AuthenticationError in module openai
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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.AzureOpenAI
Python Library Documentation: class AzureOpenAI in module openai.lib.azure
class AzureOpenAI(BaseAzureClient, openai.OpenAI)
| AzureOpenAI(*, api_version: 'str | None' = None, azure_endpoint: 'str | None' = None, azure_deployment: 'str | None' = None, api_key: 'str | Callable[[], str] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, azure_ad_token: 'str | None' = None, azure_ad_token_provider: 'AzureADTokenProvider | 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 | 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:
| AzureOpenAI
| BaseAzureClient
| openai.OpenAI
| openai._base_client.SyncAPIClient
| openai._base_client.BaseClient
| typing.Generic
| builtins.object
|
| Methods defined here:
|
| __init__(self, *, api_version: 'str | None' = None, azure_endpoint: 'str | None' = None, azure_deployment: 'str | None' = None, api_key: 'str | Callable[[], str] | None' = None, admin_api_key: 'str | None' = None, workload_identity: 'WorkloadIdentity | None' = None, azure_ad_token: 'str | None' = None, azure_ad_token_provider: 'AzureADTokenProvider | 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 | 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 azure openai client instance.
|
| This automatically infers the following arguments from their corresponding environment variables if they are not provided:
| - `api_key` from `AZURE_OPENAI_API_KEY`
| - `organization` from `OPENAI_ORG_ID`
| - `project` from `OPENAI_PROJECT_ID`
| - `azure_ad_token` from `AZURE_OPENAI_AD_TOKEN`
| - `api_version` from `OPENAI_API_VERSION`
| - `azure_endpoint` from `AZURE_OPENAI_ENDPOINT`
|
| Args:
| azure_endpoint: Your Azure endpoint, including the resource, e.g. `https://example-resource.azure.openai.com/`
|
| azure_ad_token: Your Azure Active Directory token, https://www.microsoft.com/en-us/security/business/identity-access/microsoft-entra-id
|
| azure_ad_token_provider: A function that returns an Azure Active Directory token, will be invoked on every request.
|
| azure_deployment: A model deployment, if given with `azure_endpoint`, sets the base client URL to include `/deployments/{azure_deployment}`.
| Not supported with Assistants APIs.
|
| 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, api_version: 'str | None' = None, azure_ad_token: 'str | None' = None, azure_ad_token_provider: 'AzureADTokenProvider | 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 | 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, api_version: 'str | None' = None, azure_ad_token: 'str | None' = None, azure_ad_token_provider: 'AzureADTokenProvider | 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__ = {}
|
| __orig_bases__ = (openai.lib.azure.BaseAzureClient[httpx.Client, opena...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai.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>
| content_provenance_checks = <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.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'
|
| ----------------------------------------------------------------------
| 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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.BadRequestError
Python Library Documentation: class BadRequestError in module openai
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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.BaseModel
Python Library Documentation: class BaseModel in module openai
class BaseModel(pydantic.main.BaseModel)
| BaseModel(**data: 'Any') -> 'None'
|
| Method resolution order:
| BaseModel
| pydantic.main.BaseModel
| builtins.object
|
| Methods defined here:
|
| __str__(self) -> 'str' from openai._models.BaseModel
| 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]' from openai._models.BaseModel
| 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' from openai._models.BaseModel
| 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 openai._models.BaseModel
| # 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 openai._models.BaseModel
| # 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
|
| ----------------------------------------------------------------------
| 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]'
| Helper for pickle.
|
| __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]' from pydantic._internal._repr.Representation
| 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' from pydantic._internal._repr.Representation
| Name of the instance's class, used in __repr__.
|
| __repr_recursion__(self, object: 'Any') -> 'str' from pydantic._internal._repr.Representation
| Returns the string representation of a recursive object.
|
| __repr_str__(self, join_str: 'str') -> 'str' from pydantic._internal._repr.Representation
|
| __rich_repr__(self) -> 'RichReprResult' from pydantic._internal._repr.Representation
| 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'
|
| __get_pydantic_core_schema__(source: 'type[BaseModel]', handler: 'GetCoreSchemaHandler', /) -> 'CoreSchema'
|
| __get_pydantic_json_schema__(core_schema: 'CoreSchema', handler: 'GetJsonSchemaHandler', /) -> 'JsonSchemaValue'
| 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'
| 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'
| 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'
|
| 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]'
| 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'
| 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'
| 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'
| 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'
| !!! 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'
| 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'
|
| parse_obj(obj: 'Any') -> 'Self'
|
| parse_raw(b: 'str | bytes', *, content_type: 'str | None' = None, encoding: 'str' = 'utf8', proto: 'DeprecatedParseProtocol | None' = None, allow_pickle: 'bool' = False) -> 'Self'
|
| schema(by_alias: 'bool' = True, ref_template: 'str' = '#/$defs/{model}') -> 'Dict[str, Any]'
|
| schema_json(*, by_alias: 'bool' = True, ref_template: 'str' = '#/$defs/{model}', **dumps_kwargs: 'Any') -> 'str'
|
| update_forward_refs(**localns: 'Any') -> 'None'
|
| validate(value: 'Any') -> 'Self'
|
| ----------------------------------------------------------------------
| 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
|
| __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 = {}
openai.BedrockOpenAI
Python Library Documentation: class BedrockOpenAI in module openai
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' from openai.lib.bedrock.BedrockOpenAI
| 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' from openai.lib.bedrock.BedrockOpenAI
| 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>
| content_provenance_checks = <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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.ChatCompletion
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.Client
Python Library Documentation: class OpenAI in module openai
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' from openai._client.OpenAI
| 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>
| content_provenance_checks = <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' from openai._client.OpenAI
| 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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.Completion
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.ConflictError
Python Library Documentation: class ConflictError in module openai
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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.ContentFilterFinishReasonError
Python Library Documentation: class ContentFilterFinishReasonError in module openai
class ContentFilterFinishReasonError(OpenAIError)
| ContentFilterFinishReasonError() -> 'None'
|
| Method resolution order:
| ContentFilterFinishReasonError
| OpenAIError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self) -> 'None' from openai._exceptions.ContentFilterFinishReasonError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.Customer
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.DEFAULT_CONNECTION_LIMITS
Python Library Documentation: Limits in module openai object class Limits(builtins.object) | Limits(*, max_connections: 'int | None' = None, max_keepalive_connections: 'int | None' = None, keepalive_expiry: 'float | None' = 5.0) -> 'None' | | Configuration for limits to various client behaviors. | | **Parameters:** | | * **max_connections** - The maximum number of concurrent connections that may be | established. | * **max_keepalive_connections** - Allow the connection pool to maintain | keep-alive connections below this point. Should be less than or equal | to `max_connections`. | * **keepalive_expiry** - Time limit on idle keep-alive connections in seconds. | | Methods defined here: | | __eq__(self, other: 'typing.Any') -> 'bool' from httpx._config.Limits | Return self==value. | | __init__(self, *, max_connections: 'int | None' = None, max_keepalive_connections: 'int | None' = None, keepalive_expiry: 'float | None' = 5.0) -> 'None' from httpx._config.Limits | Initialize self. See help(type(self)) for accurate signature. | | __repr__(self) -> 'str' from httpx._config.Limits | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __hash__ = None
openai.DEFAULT_MAX_RETRIES
Python Library Documentation: int object
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
openai.DEFAULT_TIMEOUT
Python Library Documentation: Timeout in module openai object class Timeout(builtins.object) | Timeout(timeout: 'TimeoutTypes | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, *, connect: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, read: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, write: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, pool: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>) -> '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' from httpx._config.Timeout | Return self==value. | | __init__(self, timeout: 'TimeoutTypes | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, *, connect: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, read: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, write: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, pool: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>) -> 'None' from httpx._config.Timeout | Initialize self. See help(type(self)) for accurate signature. | | __repr__(self) -> 'str' from httpx._config.Timeout | Return repr(self). | | as_dict(self) -> 'dict[str, float | None]' from httpx._config.Timeout | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __hash__ = None
openai.DefaultAioHttpClient
Python Library Documentation: class _DefaultAioHttpClient in module openai 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' from openai._base_client._DefaultAioHttpClient | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from httpx.AsyncClient: | | async __aenter__(self: 'U') -> 'U' from httpx._client.AsyncClient | | async __aexit__(self, exc_type: 'type[BaseException] | None' = None, exc_value: 'BaseException | None' = None, traceback: 'TracebackType | None' = None) -> 'None' from httpx._client.AsyncClient | | async aclose(self) -> 'None' from httpx._client.AsyncClient | Close transport and proxies. | | async delete(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send a `DELETE` request. | | **Parameters**: See `httpx.request`. | | async get(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send a `GET` request. | | **Parameters**: See `httpx.request`. | | async head(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send a `HEAD` request. | | **Parameters**: See `httpx.request`. | | async options(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send an `OPTIONS` request. | | **Parameters**: See `httpx.request`. | | async patch(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send a `PATCH` request. | | **Parameters**: See `httpx.request`. | | async post(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send a `POST` request. | | **Parameters**: See `httpx.request`. | | async put(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send a `PUT` request. | | **Parameters**: See `httpx.request`. | | async request(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | 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/#merging-of-configuration | | async send(self, request: 'Request', *, stream: 'bool' = False, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>) -> 'Response' from httpx._client.AsyncClient | 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/#request-instances | | stream(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'typing.AsyncIterator[Response]' from httpx._client.AsyncClient | 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: 'URLTypes', *, 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 0x0000024AD4224DD0>, 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/#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 | | __weakref__ | list of weak references to the object | | 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
openai.DefaultAsyncHttpx2Client
Python Library Documentation: function DefaultAsyncHttpx2Client in module openai
DefaultAsyncHttpx2Client(**kwargs: 'Any') -> 'httpx.AsyncClient'
Create an experimental async HTTPX2 client with the SDK's recommended defaults.
openai.DefaultAsyncHttpxClient
Python Library Documentation: class _DefaultAsyncHttpxClient in module openai 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' from openai._base_client._DefaultAsyncHttpxClient | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from httpx.AsyncClient: | | async __aenter__(self: 'U') -> 'U' from httpx._client.AsyncClient | | async __aexit__(self, exc_type: 'type[BaseException] | None' = None, exc_value: 'BaseException | None' = None, traceback: 'TracebackType | None' = None) -> 'None' from httpx._client.AsyncClient | | async aclose(self) -> 'None' from httpx._client.AsyncClient | Close transport and proxies. | | async delete(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send a `DELETE` request. | | **Parameters**: See `httpx.request`. | | async get(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send a `GET` request. | | **Parameters**: See `httpx.request`. | | async head(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send a `HEAD` request. | | **Parameters**: See `httpx.request`. | | async options(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send an `OPTIONS` request. | | **Parameters**: See `httpx.request`. | | async patch(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send a `PATCH` request. | | **Parameters**: See `httpx.request`. | | async post(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send a `POST` request. | | **Parameters**: See `httpx.request`. | | async put(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | Send a `PUT` request. | | **Parameters**: See `httpx.request`. | | async request(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient | 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/#merging-of-configuration | | async send(self, request: 'Request', *, stream: 'bool' = False, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>) -> 'Response' from httpx._client.AsyncClient | 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/#request-instances | | stream(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'typing.AsyncIterator[Response]' from httpx._client.AsyncClient | 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: 'URLTypes', *, 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 0x0000024AD4224DD0>, 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/#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 | | __weakref__ | list of weak references to the object | | 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
openai.DefaultHttpx2Client
Python Library Documentation: function DefaultHttpx2Client in module openai
DefaultHttpx2Client(**kwargs: 'Any') -> 'httpx.Client'
Create an experimental HTTPX2 client with the SDK's recommended defaults.
openai.DefaultHttpxClient
Python Library Documentation: class _DefaultHttpxClient in module openai 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' from openai._base_client._DefaultHttpxClient | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from httpx.Client: | | __enter__(self: 'T') -> 'T' from httpx._client.Client | | __exit__(self, exc_type: 'type[BaseException] | None' = None, exc_value: 'BaseException | None' = None, traceback: 'TracebackType | None' = None) -> 'None' from httpx._client.Client | | close(self) -> 'None' from httpx._client.Client | Close transport and proxies. | | delete(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send a `DELETE` request. | | **Parameters**: See `httpx.request`. | | get(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send a `GET` request. | | **Parameters**: See `httpx.request`. | | head(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send a `HEAD` request. | | **Parameters**: See `httpx.request`. | | options(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send an `OPTIONS` request. | | **Parameters**: See `httpx.request`. | | patch(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send a `PATCH` request. | | **Parameters**: See `httpx.request`. | | post(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send a `POST` request. | | **Parameters**: See `httpx.request`. | | put(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send a `PUT` request. | | **Parameters**: See `httpx.request`. | | request(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | 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/#merging-of-configuration | | send(self, request: 'Request', *, stream: 'bool' = False, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>) -> 'Response' from httpx._client.Client | 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/#request-instances | | stream(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'typing.Iterator[Response]' from httpx._client.Client | 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: 'URLTypes', *, 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 0x0000024AD4224DD0>, 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/#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 | | __weakref__ | list of weak references to the object | | 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
openai.Deployment
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.Edit
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.Embedding
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.Engine
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.ErrorObject
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.File
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.FineTune
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.FineTuningJob
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.HttpxBinaryResponseContent
Python Library Documentation: class HttpxBinaryResponseContent in module openai._legacy_response
class HttpxBinaryResponseContent(builtins.object)
| HttpxBinaryResponseContent(response: 'httpx.Response') -> 'None'
|
| Methods defined here:
|
| __init__(self, response: 'httpx.Response') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| async aclose(self) -> 'None'
|
| async aiter_bytes(self, chunk_size: 'int | None' = None) -> 'AsyncIterator[bytes]'
|
| async aiter_lines(self) -> 'AsyncIterator[str]'
|
| async aiter_raw(self, chunk_size: 'int | None' = None) -> 'AsyncIterator[bytes]'
|
| async aiter_text(self, chunk_size: 'int | None' = None) -> 'AsyncIterator[str]'
|
| async aread(self) -> 'bytes'
|
| async astream_to_file(self, file: 'str | os.PathLike[str]', *, chunk_size: 'int | None' = None) -> 'None'
|
| close(self) -> 'None'
|
| iter_bytes(self, chunk_size: 'int | None' = None) -> 'Iterator[bytes]'
|
| iter_lines(self) -> 'Iterator[str]'
|
| iter_raw(self, chunk_size: 'int | None' = None) -> 'Iterator[bytes]'
|
| iter_text(self, chunk_size: 'int | None' = None) -> 'Iterator[str]'
|
| json(self, **kwargs: 'Any') -> 'Any'
|
| read(self) -> 'bytes'
|
| stream_to_file(self, file: 'str | os.PathLike[str]', *, chunk_size: 'int | None' = None) -> 'None'
|
| write_to_file(self, file: 'str | os.PathLike[str]') -> 'None'
| Write the output to the given file.
|
| Accepts a filename or any path-like object, e.g. pathlib.Path
|
| Note: if you want to stream the data to the file instead of writing
| all at once then you should use `.with_streaming_response` when making
| the API request, e.g. `client.with_streaming_response.foo().stream_to_file('my_filename.txt')`
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| charset_encoding
|
| content
|
| encoding
|
| text
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'response': 'httpx.Response'}
openai.Image
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.InternalServerError
Python Library Documentation: class InternalServerError in module openai
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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.InvalidWebhookSignatureError
Python Library Documentation: class InvalidWebhookSignatureError in module openai 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 | | ---------------------------------------------------------------------- | 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) class method of builtins.ValueError | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | 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
openai.LengthFinishReasonError
Python Library Documentation: class LengthFinishReasonError in module openai
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' from openai._exceptions.LengthFinishReasonError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.Model
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.Moderation
Python Library Documentation: APIRemovedInV1Proxy in module openai.lib._old_api APIRemovedInV1Proxy
openai.NOT_GIVEN
Python Library Documentation: NotGiven in module openai object 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]' from openai._types.NotGiven | | __repr__(self) -> 'str' from openai._types.NotGiven | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
openai.NoneType
Python Library Documentation: class NoneType in module builtins class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
openai.NotFoundError
Python Library Documentation: class NotFoundError in module openai
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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.NotGiven
Python Library Documentation: class NotGiven in module openai 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]' from openai._types.NotGiven | | __repr__(self) -> 'str' from openai._types.NotGiven | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
openai.OAuthError
Python Library Documentation: class OAuthError in module openai
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' from openai._exceptions.OAuthError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.Omit
Python Library Documentation: class Omit in module openai
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]' from openai._types.Omit
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
openai.OpenAI
Python Library Documentation: class OpenAI in module openai
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' from openai._client.OpenAI
| 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>
| content_provenance_checks = <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' from openai._client.OpenAI
| 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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.OpenAIError
Python Library Documentation: class OpenAIError in module openai
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
|
| ----------------------------------------------------------------------
| 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) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.PermissionDeniedError
Python Library Documentation: class PermissionDeniedError in module openai
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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.ProxiesTypes
Python Library Documentation: _UnionGenericAlias in module openai
Union = typing.Union
Union type; Union[X, Y] means either X or Y.
On Python 3.10 and higher, the | operator
can also be used to denote unions;
X | Y means the same thing to the type checker as Union[X, Y].
To define a union, use e.g. Union[int, str]. Details:
- The arguments must be types and there must be at least one.
- None as an argument is a special case and is replaced by
type(None).
- Unions of unions are flattened, e.g.::
assert Union[Union[int, str], float] == Union[int, str, float]
- Unions of a single argument vanish, e.g.::
assert Union[int] == int # The constructor actually returns int
- Redundant arguments are skipped, e.g.::
assert Union[int, str, int] == Union[int, str]
- When comparing unions, the argument order is ignored, e.g.::
assert Union[int, str] == Union[str, int]
- You cannot subclass or instantiate a union.
- You can use Optional[X] as a shorthand for Union[X, None].
openai.RateLimitError
Python Library Documentation: class RateLimitError in module openai
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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.ReconnectingEvent
Python Library Documentation: class ReconnectingEvent in module openai
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) from openai.types.websocket_reconnection.ReconnectingEvent
| Implement delattr(self, name).
|
| __eq__(self, other) from openai.types.websocket_reconnection.ReconnectingEvent
| Return self==value.
|
| __hash__(self) from openai.types.websocket_reconnection.ReconnectingEvent
| Return hash(self).
|
| __init__(self, attempt: 'int', max_attempts: 'int', delay: 'float', close_code: 'int', extra_query: 'Query', extra_headers: 'Headers') -> None from openai.types.websocket_reconnection.ReconnectingEvent
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) from openai.types.websocket_reconnection.ReconnectingEvent
| Return repr(self).
|
| __setattr__(self, name, value) from openai.types.websocket_reconnection.ReconnectingEvent
| Implement setattr(self, name, value).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| 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...
openai.ReconnectingOverrides
Python Library Documentation: class ReconnectingOverrides in module openai
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
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'abort': ForwardRef('bool', module='openai.types.we...
|
| __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__(self, key, /)
| Return self[key].
|
| __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__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
openai.RequestOptions
Python Library Documentation: class RequestOptions in module openai
class RequestOptions(builtins.dict)
| Method resolution order:
| RequestOptions
| builtins.dict
| builtins.object
|
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'extra_json': ForwardRef('AnyMapping', module='open...
|
| __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__(self, key, /)
| Return self[key].
|
| __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__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
openai.Stream
Python Library Documentation: class Stream in module openai
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' from openai._streaming.Stream
|
| __exit__(self, exc_type: 'type[BaseException] | None', exc: 'BaseException | None', exc_tb: 'TracebackType | None') -> 'None' from openai._streaming.Stream
|
| __init__(self, *, cast_to: 'type[_T]', response: 'httpx.Response', client: 'OpenAI', options: 'Optional[FinalRequestOptions]' = None) -> 'None' from openai._streaming.Stream
| Initialize self. See help(type(self)) for accurate signature.
|
| __iter__(self) -> 'Iterator[_T]' from openai._streaming.Stream
|
| __next__(self) -> '_T' from openai._streaming.Stream
|
| __stream__(self) -> 'Iterator[_T]' from openai._streaming.Stream
|
| close(self) -> 'None' from openai._streaming.Stream
| 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
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| 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__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.Timeout
Python Library Documentation: class Timeout in module openai class Timeout(builtins.object) | Timeout(timeout: 'TimeoutTypes | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, *, connect: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, read: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, write: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, pool: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>) -> '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' from httpx._config.Timeout | Return self==value. | | __init__(self, timeout: 'TimeoutTypes | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, *, connect: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, read: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, write: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, pool: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>) -> 'None' from httpx._config.Timeout | Initialize self. See help(type(self)) for accurate signature. | | __repr__(self) -> 'str' from httpx._config.Timeout | Return repr(self). | | as_dict(self) -> 'dict[str, float | None]' from httpx._config.Timeout | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __hash__ = None
openai.Transport
Python Library Documentation: class BaseTransport in module openai class BaseTransport(builtins.object) | Methods defined here: | | __enter__(self: 'T') -> 'T' from httpx._transports.base.BaseTransport | | __exit__(self, exc_type: 'type[BaseException] | None' = None, exc_value: 'BaseException | None' = None, traceback: 'TracebackType | None' = None) -> 'None' from httpx._transports.base.BaseTransport | | close(self) -> 'None' from httpx._transports.base.BaseTransport | | handle_request(self, request: 'Request') -> 'Response' from httpx._transports.base.BaseTransport | 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 | | __weakref__ | list of weak references to the object
openai.UnprocessableEntityError
Python Library Documentation: class UnprocessableEntityError in module openai
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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.VERSION
Error rendering doc: No Python documentation found for '2.52.0'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
openai.WebSocketConnectionClosedError
Python Library Documentation: class WebSocketConnectionClosedError in module openai
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' from openai._exceptions.WebSocketConnectionClosedError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.WebSocketQueueFullError
Python Library Documentation: class WebSocketQueueFullError in module openai
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
|
| ----------------------------------------------------------------------
| 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) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
openai.admin
Python Library Documentation: AdminProxy in module openai._module_client object
class AdminProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| AdminProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Admin'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Admin')],...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.admin_api_key
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
openai.annotations
Python Library Documentation: _Feature in module __future__ object class _Feature(builtins.object) | _Feature(optionalRelease, mandatoryRelease, compiler_flag) | | Methods defined here: | | __init__(self, optionalRelease, mandatoryRelease, compiler_flag) | Initialize self. See help(type(self)) for accurate signature. | | __repr__(self) | Return repr(self). | | getMandatoryRelease(self) | Return release in which this feature will become mandatory. | | This is a 5-tuple, of the same form as sys.version_info, or, if | the feature was dropped, or the release date is undetermined, is None. | | getOptionalRelease(self) | Return first release in which this feature was recognized. | | This is a 5-tuple, of the same form as sys.version_info. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
openai.api_key
Python Library Documentation: built-in module builtins
NAME
builtins - Built-in functions, types, exceptions, and other objects.
DESCRIPTION
This module provides direct access to all 'built-in'
identifiers of Python; for example, builtins.len is
the full name for the built-in function len().
This module is not normally accessed explicitly by most
applications, but can be useful in modules that provide
objects with the same name as a built-in value, but in
which the built-in of that name is also needed.
CLASSES
object
BaseException
BaseExceptionGroup
ExceptionGroup(BaseExceptionGroup, Exception)
Exception
ArithmeticError
FloatingPointError
OverflowError
ZeroDivisionError
AssertionError
AttributeError
BufferError
EOFError
ImportError
ModuleNotFoundError
LookupError
IndexError
KeyError
MemoryError
NameError
UnboundLocalError
OSError
BlockingIOError
ChildProcessError
ConnectionError
BrokenPipeError
ConnectionAbortedError
ConnectionRefusedError
ConnectionResetError
FileExistsError
FileNotFoundError
InterruptedError
IsADirectoryError
NotADirectoryError
PermissionError
ProcessLookupError
TimeoutError
ReferenceError
RuntimeError
NotImplementedError
RecursionError
StopAsyncIteration
StopIteration
SyntaxError
IndentationError
TabError
SystemError
TypeError
ValueError
UnicodeError
UnicodeDecodeError
UnicodeEncodeError
UnicodeTranslateError
Warning
BytesWarning
DeprecationWarning
EncodingWarning
FutureWarning
ImportWarning
PendingDeprecationWarning
ResourceWarning
RuntimeWarning
SyntaxWarning
UnicodeWarning
UserWarning
GeneratorExit
KeyboardInterrupt
SystemExit
bytearray
bytes
classmethod
complex
dict
enumerate
filter
float
frozenset
int
bool
list
map
memoryview
property
range
reversed
set
slice
staticmethod
str
super
tuple
type
zip
class ArithmeticError(Exception)
| Base class for arithmetic errors.
|
| Method resolution order:
| ArithmeticError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| FloatingPointError
| OverflowError
| ZeroDivisionError
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class AssertionError(Exception)
| Assertion failed.
|
| Method resolution order:
| AssertionError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class AttributeError(Exception)
| Attribute not found.
|
| Method resolution order:
| AttributeError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __getstate__(...)
| Helper for pickle.
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| name
| attribute name
|
| obj
| object
|
| ----------------------------------------------------------------------
| Static methods inherited from Exception:
|
| __new__(*args, **kwargs) class method of Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class BaseException(object)
| Common base class for all exceptions
|
| Built-in subclasses:
| BaseExceptionGroup
| Exception
| GeneratorExit
| KeyboardInterrupt
| ... and 1 other subclasses
|
| Methods defined here:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class BaseExceptionGroup(BaseException)
| A combination of multiple unrelated exceptions.
|
| Method resolution order:
| BaseExceptionGroup
| BaseException
| object
|
| Built-in subclasses:
| ExceptionGroup
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __str__(self, /)
| Return str(self).
|
| derive(...)
|
| split(...)
|
| subgroup(...)
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| exceptions
| nested exceptions
|
| message
| exception message
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class BlockingIOError(OSError)
| I/O operation would block.
|
| Method resolution order:
| BlockingIOError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class BrokenPipeError(ConnectionError)
| Broken pipe.
|
| Method resolution order:
| BrokenPipeError
| ConnectionError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class BufferError(Exception)
| Buffer error.
|
| Method resolution order:
| BufferError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class BytesWarning(Warning)
| Base class for warnings about bytes and buffer related problems, mostly
| related to conversion from str or comparing to str.
|
| Method resolution order:
| BytesWarning
| Warning
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ChildProcessError(OSError)
| Child process error.
|
| Method resolution order:
| ChildProcessError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ConnectionAbortedError(ConnectionError)
| Connection aborted.
|
| Method resolution order:
| ConnectionAbortedError
| ConnectionError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ConnectionError(OSError)
| Connection error.
|
| Method resolution order:
| ConnectionError
| OSError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| BrokenPipeError
| ConnectionAbortedError
| ConnectionRefusedError
| ConnectionResetError
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ConnectionRefusedError(ConnectionError)
| Connection refused.
|
| Method resolution order:
| ConnectionRefusedError
| ConnectionError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ConnectionResetError(ConnectionError)
| Connection reset.
|
| Method resolution order:
| ConnectionResetError
| ConnectionError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class DeprecationWarning(Warning)
| Base class for warnings about deprecated features.
|
| Method resolution order:
| DeprecationWarning
| Warning
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class EOFError(Exception)
| Read beyond end of file.
|
| Method resolution order:
| EOFError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class EncodingWarning(Warning)
| Base class for warnings about encodings.
|
| Method resolution order:
| EncodingWarning
| Warning
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
EnvironmentError = class OSError(Exception)
| Base class for I/O related errors.
|
| Method resolution order:
| OSError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| BlockingIOError
| ChildProcessError
| ConnectionError
| FileExistsError
| ... and 7 other subclasses
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class Exception(BaseException)
| Common base class for all non-exit exceptions.
|
| Method resolution order:
| Exception
| BaseException
| object
|
| Built-in subclasses:
| ArithmeticError
| AssertionError
| AttributeError
| BufferError
| ... and 16 other subclasses
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ExceptionGroup(BaseExceptionGroup, Exception)
| Method resolution order:
| ExceptionGroup
| BaseExceptionGroup
| Exception
| BaseException
| object
|
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from BaseExceptionGroup:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __str__(self, /)
| Return str(self).
|
| derive(...)
|
| split(...)
|
| subgroup(...)
|
| ----------------------------------------------------------------------
| Class methods inherited from BaseExceptionGroup:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods inherited from BaseExceptionGroup:
|
| __new__(*args, **kwargs) class method of BaseExceptionGroup
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseExceptionGroup:
|
| exceptions
| nested exceptions
|
| message
| exception message
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class FileExistsError(OSError)
| File already exists.
|
| Method resolution order:
| FileExistsError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class FileNotFoundError(OSError)
| File not found.
|
| Method resolution order:
| FileNotFoundError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class FloatingPointError(ArithmeticError)
| Floating-point operation failed.
|
| Method resolution order:
| FloatingPointError
| ArithmeticError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class FutureWarning(Warning)
| Base class for warnings about constructs that will change semantically
| in the future.
|
| Method resolution order:
| FutureWarning
| Warning
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class GeneratorExit(BaseException)
| Request that a generator exit.
|
| Method resolution order:
| GeneratorExit
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
IOError = class OSError(Exception)
| Base class for I/O related errors.
|
| Method resolution order:
| OSError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| BlockingIOError
| ChildProcessError
| ConnectionError
| FileExistsError
| ... and 7 other subclasses
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ImportError(Exception)
| Import can't find module, or can't find name in module.
|
| Method resolution order:
| ImportError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| ModuleNotFoundError
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| msg
| exception message
|
| name
| module name
|
| name_from
| name imported from module
|
| path
| module path
|
| ----------------------------------------------------------------------
| Static methods inherited from Exception:
|
| __new__(*args, **kwargs) class method of Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ImportWarning(Warning)
| Base class for warnings about probable mistakes in module imports
|
| Method resolution order:
| ImportWarning
| Warning
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class IndentationError(SyntaxError)
| Improper indentation.
|
| Method resolution order:
| IndentationError
| SyntaxError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| TabError
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from SyntaxError:
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from SyntaxError:
|
| end_lineno
| exception end lineno
|
| end_offset
| exception end offset
|
| filename
| exception filename
|
| lineno
| exception lineno
|
| msg
| exception msg
|
| offset
| exception offset
|
| print_file_and_line
| exception print_file_and_line
|
| text
| exception text
|
| ----------------------------------------------------------------------
| Static methods inherited from Exception:
|
| __new__(*args, **kwargs) class method of Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class IndexError(LookupError)
| Sequence index out of range.
|
| Method resolution order:
| IndexError
| LookupError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class InterruptedError(OSError)
| Interrupted by signal.
|
| Method resolution order:
| InterruptedError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class IsADirectoryError(OSError)
| Operation doesn't work on directories.
|
| Method resolution order:
| IsADirectoryError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class KeyError(LookupError)
| Mapping key not found.
|
| Method resolution order:
| KeyError
| LookupError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from LookupError:
|
| __new__(*args, **kwargs) class method of LookupError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class KeyboardInterrupt(BaseException)
| Program interrupted by user.
|
| Method resolution order:
| KeyboardInterrupt
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class LookupError(Exception)
| Base class for lookup errors.
|
| Method resolution order:
| LookupError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| IndexError
| KeyError
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class MemoryError(Exception)
| Out of memory.
|
| Method resolution order:
| MemoryError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ModuleNotFoundError(ImportError)
| Module not found.
|
| Method resolution order:
| ModuleNotFoundError
| ImportError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from ImportError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ImportError:
|
| msg
| exception message
|
| name
| module name
|
| name_from
| name imported from module
|
| path
| module path
|
| ----------------------------------------------------------------------
| Static methods inherited from Exception:
|
| __new__(*args, **kwargs) class method of Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class NameError(Exception)
| Name not found globally.
|
| Method resolution order:
| NameError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| UnboundLocalError
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| name
| name
|
| ----------------------------------------------------------------------
| Static methods inherited from Exception:
|
| __new__(*args, **kwargs) class method of Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class NotADirectoryError(OSError)
| Operation only works on directories.
|
| Method resolution order:
| NotADirectoryError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class NotImplementedError(RuntimeError)
| Method or function hasn't been implemented yet.
|
| Method resolution order:
| NotImplementedError
| RuntimeError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class OSError(Exception)
| Base class for I/O related errors.
|
| Method resolution order:
| OSError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| BlockingIOError
| ChildProcessError
| ConnectionError
| FileExistsError
| ... and 7 other subclasses
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class OverflowError(ArithmeticError)
| Result too large to be represented.
|
| Method resolution order:
| OverflowError
| ArithmeticError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class PendingDeprecationWarning(Warning)
| Base class for warnings about features which will be deprecated
| in the future.
|
| Method resolution order:
| PendingDeprecationWarning
| Warning
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class PermissionError(OSError)
| Not enough permissions.
|
| Method resolution order:
| PermissionError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ProcessLookupError(OSError)
| Process not found.
|
| Method resolution order:
| ProcessLookupError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class RecursionError(RuntimeError)
| Recursion limit exceeded.
|
| Method resolution order:
| RecursionError
| RuntimeError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ReferenceError(Exception)
| Weak ref proxy used after referent went away.
|
| Method resolution order:
| ReferenceError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ResourceWarning(Warning)
| Base class for warnings about resource usage.
|
| Method resolution order:
| ResourceWarning
| Warning
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class RuntimeError(Exception)
| Unspecified run-time error.
|
| Method resolution order:
| RuntimeError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| NotImplementedError
| RecursionError
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class RuntimeWarning(Warning)
| Base class for warnings about dubious runtime behavior.
|
| Method resolution order:
| RuntimeWarning
| Warning
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class StopAsyncIteration(Exception)
| Signal the end from iterator.__anext__().
|
| Method resolution order:
| StopAsyncIteration
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class StopIteration(Exception)
| Signal the end from iterator.__next__().
|
| Method resolution order:
| StopIteration
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| value
| generator return value
|
| ----------------------------------------------------------------------
| Static methods inherited from Exception:
|
| __new__(*args, **kwargs) class method of Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class SyntaxError(Exception)
| Invalid syntax.
|
| Method resolution order:
| SyntaxError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| IndentationError
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| end_lineno
| exception end lineno
|
| end_offset
| exception end offset
|
| filename
| exception filename
|
| lineno
| exception lineno
|
| msg
| exception msg
|
| offset
| exception offset
|
| print_file_and_line
| exception print_file_and_line
|
| text
| exception text
|
| ----------------------------------------------------------------------
| Static methods inherited from Exception:
|
| __new__(*args, **kwargs) class method of Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class SyntaxWarning(Warning)
| Base class for warnings about dubious syntax.
|
| Method resolution order:
| SyntaxWarning
| Warning
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class SystemError(Exception)
| Internal error in the Python interpreter.
|
| Please report this to the Python maintainer, along with the traceback,
| the Python version, and the hardware/OS platform and version.
|
| Method resolution order:
| SystemError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class SystemExit(BaseException)
| Request to exit from the interpreter.
|
| Method resolution order:
| SystemExit
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| code
| exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Static methods inherited from BaseException:
|
| __new__(*args, **kwargs) class method of BaseException
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class TabError(IndentationError)
| Improper mixture of spaces and tabs.
|
| Method resolution order:
| TabError
| IndentationError
| SyntaxError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from SyntaxError:
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from SyntaxError:
|
| end_lineno
| exception end lineno
|
| end_offset
| exception end offset
|
| filename
| exception filename
|
| lineno
| exception lineno
|
| msg
| exception msg
|
| offset
| exception offset
|
| print_file_and_line
| exception print_file_and_line
|
| text
| exception text
|
| ----------------------------------------------------------------------
| Static methods inherited from Exception:
|
| __new__(*args, **kwargs) class method of Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class TimeoutError(OSError)
| Timeout expired.
|
| Method resolution order:
| TimeoutError
| OSError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from OSError:
|
| __new__(*args, **kwargs) class method of OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class TypeError(Exception)
| Inappropriate argument type.
|
| Method resolution order:
| TypeError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class UnboundLocalError(NameError)
| Local name referenced but not bound to a value.
|
| Method resolution order:
| UnboundLocalError
| NameError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from NameError:
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from NameError:
|
| name
| name
|
| ----------------------------------------------------------------------
| Static methods inherited from Exception:
|
| __new__(*args, **kwargs) class method of Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class UnicodeDecodeError(UnicodeError)
| Unicode decoding error.
|
| Method resolution order:
| UnicodeDecodeError
| UnicodeError
| ValueError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| encoding
| exception encoding
|
| end
| exception end
|
| object
| exception object
|
| reason
| exception reason
|
| start
| exception start
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class UnicodeEncodeError(UnicodeError)
| Unicode encoding error.
|
| Method resolution order:
| UnicodeEncodeError
| UnicodeError
| ValueError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| encoding
| exception encoding
|
| end
| exception end
|
| object
| exception object
|
| reason
| exception reason
|
| start
| exception start
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class UnicodeError(ValueError)
| Unicode related error.
|
| Method resolution order:
| UnicodeError
| ValueError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| UnicodeDecodeError
| UnicodeEncodeError
| UnicodeTranslateError
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class UnicodeTranslateError(UnicodeError)
| Unicode translation error.
|
| Method resolution order:
| UnicodeTranslateError
| UnicodeError
| ValueError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| encoding
| exception encoding
|
| end
| exception end
|
| object
| exception object
|
| reason
| exception reason
|
| start
| exception start
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class UnicodeWarning(Warning)
| Base class for warnings about Unicode related problems, mostly
| related to conversion problems.
|
| Method resolution order:
| UnicodeWarning
| Warning
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class UserWarning(Warning)
| Base class for warnings generated by user code.
|
| Method resolution order:
| UserWarning
| Warning
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ValueError(Exception)
| Inappropriate argument value (of correct type).
|
| Method resolution order:
| ValueError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| UnicodeError
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class Warning(Exception)
| Base class for warning categories.
|
| Method resolution order:
| Warning
| Exception
| BaseException
| object
|
| Built-in subclasses:
| BytesWarning
| DeprecationWarning
| EncodingWarning
| FutureWarning
| ... and 7 other subclasses
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
WindowsError = class OSError(Exception)
| Base class for I/O related errors.
|
| Method resolution order:
| OSError
| Exception
| BaseException
| object
|
| Built-in subclasses:
| BlockingIOError
| ChildProcessError
| ConnectionError
| FileExistsError
| ... and 7 other subclasses
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ZeroDivisionError(ArithmeticError)
| Second argument to a division or modulo operation was zero.
|
| Method resolution order:
| ZeroDivisionError
| ArithmeticError
| Exception
| BaseException
| object
|
| Methods defined here:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class bool(int)
| bool(x) -> bool
|
| Returns True when the argument x is true, False otherwise.
| The builtins True and False are the only two instances of the class bool.
| The class bool is a subclass of the class int, and cannot be subclassed.
|
| Method resolution order:
| bool
| int
| object
|
| Methods defined here:
|
| __and__(self, value, /)
| Return self&value.
|
| __invert__(self, /)
| ~self
|
| __or__(self, value, /)
| Return self|value.
|
| __rand__(self, value, /)
| Return value&self.
|
| __repr__(self, /)
| Return repr(self).
|
| __ror__(self, value, /)
| Return value|self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __xor__(self, value, /)
| Return self^value.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from int:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods inherited from int:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from int:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
class bytearray(object)
| bytearray(iterable_of_ints) -> bytearray
| bytearray(string, encoding[, errors]) -> bytearray
| bytearray(bytes_or_buffer) -> mutable copy of bytes_or_buffer
| bytearray(int) -> bytes array of size given by the parameter initialized with null bytes
| bytearray() -> empty bytes array
|
| Construct a mutable bytearray object from:
| - an iterable yielding integers in range(256)
| - a text string encoded using the specified encoding
| - a bytes or a buffer object
| - any object implementing the buffer API.
| - an integer
|
| Methods defined here:
|
| __add__(self, value, /)
| Return self+value.
|
| __alloc__(...)
| B.__alloc__() -> int
|
| Return the number of bytes actually allocated.
|
| __buffer__(self, flags, /)
| Return a buffer object that exposes the underlying memory of the object.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __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__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __iadd__(self, value, /)
| Implement self+=value.
|
| __imul__(self, value, /)
| Implement self*=value.
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __reduce__(self, /)
| Return state information for pickling.
|
| __reduce_ex__(self, proto=0, /)
| Return state information for pickling.
|
| __release_buffer__(self, buffer, /)
| Release the buffer object that exposes the underlying memory of the object.
|
| __repr__(self, /)
| Return repr(self).
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(self, /)
| Returns the size of the bytearray object in memory, in bytes.
|
| __str__(self, /)
| Return str(self).
|
| append(self, item, /)
| Append a single item to the end of the bytearray.
|
| item
| The item to be appended.
|
| capitalize(...)
| B.capitalize() -> copy of B
|
| Return a copy of B with only its first character capitalized (ASCII)
| and the rest lower-cased.
|
| center(self, width, fillchar=b' ', /)
| Return a centered string of length width.
|
| Padding is done using the specified fill character.
|
| clear(self, /)
| Remove all items from the bytearray.
|
| copy(self, /)
| Return a copy of B.
|
| count(...)
| B.count(sub[, start[, end]]) -> int
|
| Return the number of non-overlapping occurrences of subsection sub in
| bytes B[start:end]. Optional arguments start and end are interpreted
| as in slice notation.
|
| decode(self, /, encoding='utf-8', errors='strict')
| Decode the bytearray using the codec registered for encoding.
|
| encoding
| The encoding with which to decode the bytearray.
| errors
| The error handling scheme to use for the handling of decoding errors.
| The default is 'strict' meaning that decoding errors raise a
| UnicodeDecodeError. Other possible values are 'ignore' and 'replace'
| as well as any other name registered with codecs.register_error that
| can handle UnicodeDecodeErrors.
|
| endswith(...)
| B.endswith(suffix[, start[, end]]) -> bool
|
| Return True if B ends with the specified suffix, False otherwise.
| With optional start, test B beginning at that position.
| With optional end, stop comparing B at that position.
| suffix can also be a tuple of bytes to try.
|
| expandtabs(self, /, tabsize=8)
| Return a copy where all tab characters are expanded using spaces.
|
| If tabsize is not given, a tab size of 8 characters is assumed.
|
| extend(self, iterable_of_ints, /)
| Append all the items from the iterator or sequence to the end of the bytearray.
|
| iterable_of_ints
| The iterable of items to append.
|
| find(...)
| B.find(sub[, start[, end]]) -> int
|
| Return the lowest index in B where subsection sub is found,
| such that sub is contained within B[start,end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| hex(...)
| Create a string of hexadecimal numbers from a bytearray object.
|
| sep
| An optional single character or byte to separate hex bytes.
| bytes_per_sep
| How many bytes between separators. Positive values count from the
| right, negative values count from the left.
|
| Example:
| >>> value = bytearray([0xb9, 0x01, 0xef])
| >>> value.hex()
| 'b901ef'
| >>> value.hex(':')
| 'b9:01:ef'
| >>> value.hex(':', 2)
| 'b9:01ef'
| >>> value.hex(':', -2)
| 'b901:ef'
|
| index(...)
| B.index(sub[, start[, end]]) -> int
|
| Return the lowest index in B where subsection sub is found,
| such that sub is contained within B[start,end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the subsection is not found.
|
| insert(self, index, item, /)
| Insert a single item into the bytearray before the given index.
|
| index
| The index where the value is to be inserted.
| item
| The item to be inserted.
|
| isalnum(...)
| B.isalnum() -> bool
|
| Return True if all characters in B are alphanumeric
| and there is at least one character in B, False otherwise.
|
| isalpha(...)
| B.isalpha() -> bool
|
| Return True if all characters in B are alphabetic
| and there is at least one character in B, False otherwise.
|
| isascii(...)
| B.isascii() -> bool
|
| Return True if B is empty or all characters in B are ASCII,
| False otherwise.
|
| isdigit(...)
| B.isdigit() -> bool
|
| Return True if all characters in B are digits
| and there is at least one character in B, False otherwise.
|
| islower(...)
| B.islower() -> bool
|
| Return True if all cased characters in B are lowercase and there is
| at least one cased character in B, False otherwise.
|
| isspace(...)
| B.isspace() -> bool
|
| Return True if all characters in B are whitespace
| and there is at least one character in B, False otherwise.
|
| istitle(...)
| B.istitle() -> bool
|
| Return True if B is a titlecased string and there is at least one
| character in B, i.e. uppercase characters may only follow uncased
| characters and lowercase characters only cased ones. Return False
| otherwise.
|
| isupper(...)
| B.isupper() -> bool
|
| Return True if all cased characters in B are uppercase and there is
| at least one cased character in B, False otherwise.
|
| join(self, iterable_of_bytes, /)
| Concatenate any number of bytes/bytearray objects.
|
| The bytearray whose method is called is inserted in between each pair.
|
| The result is returned as a new bytearray object.
|
| ljust(self, width, fillchar=b' ', /)
| Return a left-justified string of length width.
|
| Padding is done using the specified fill character.
|
| lower(...)
| B.lower() -> copy of B
|
| Return a copy of B with all ASCII characters converted to lowercase.
|
| lstrip(self, bytes=None, /)
| Strip leading bytes contained in the argument.
|
| If the argument is omitted or None, strip leading ASCII whitespace.
|
| partition(self, sep, /)
| Partition the bytearray into three parts using the given separator.
|
| This will search for the separator sep in the bytearray. If the separator is
| found, returns a 3-tuple containing the part before the separator, the
| separator itself, and the part after it as new bytearray objects.
|
| If the separator is not found, returns a 3-tuple containing the copy of the
| original bytearray object and two empty bytearray objects.
|
| pop(self, index=-1, /)
| Remove and return a single item from B.
|
| index
| The index from where to remove the item.
| -1 (the default value) means remove the last item.
|
| If no index argument is given, will pop the last item.
|
| remove(self, value, /)
| Remove the first occurrence of a value in the bytearray.
|
| value
| The value to remove.
|
| removeprefix(self, prefix, /)
| Return a bytearray with the given prefix string removed if present.
|
| If the bytearray starts with the prefix string, return
| bytearray[len(prefix):]. Otherwise, return a copy of the original
| bytearray.
|
| removesuffix(self, suffix, /)
| Return a bytearray with the given suffix string removed if present.
|
| If the bytearray ends with the suffix string and that suffix is not
| empty, return bytearray[:-len(suffix)]. Otherwise, return a copy of
| the original bytearray.
|
| replace(self, old, new, count=-1, /)
| Return a copy with all occurrences of substring old replaced by new.
|
| count
| Maximum number of occurrences to replace.
| -1 (the default value) means replace all occurrences.
|
| If the optional argument count is given, only the first count occurrences are
| replaced.
|
| reverse(self, /)
| Reverse the order of the values in B in place.
|
| rfind(...)
| B.rfind(sub[, start[, end]]) -> int
|
| Return the highest index in B where subsection sub is found,
| such that sub is contained within B[start,end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| rindex(...)
| B.rindex(sub[, start[, end]]) -> int
|
| Return the highest index in B where subsection sub is found,
| such that sub is contained within B[start,end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raise ValueError when the subsection is not found.
|
| rjust(self, width, fillchar=b' ', /)
| Return a right-justified string of length width.
|
| Padding is done using the specified fill character.
|
| rpartition(self, sep, /)
| Partition the bytearray into three parts using the given separator.
|
| This will search for the separator sep in the bytearray, starting at the end.
| If the separator is found, returns a 3-tuple containing the part before the
| separator, the separator itself, and the part after it as new bytearray
| objects.
|
| If the separator is not found, returns a 3-tuple containing two empty bytearray
| objects and the copy of the original bytearray object.
|
| rsplit(self, /, sep=None, maxsplit=-1)
| Return a list of the sections in the bytearray, using sep as the delimiter.
|
| sep
| The delimiter according which to split the bytearray.
| None (the default value) means split on ASCII whitespace characters
| (space, tab, return, newline, formfeed, vertical tab).
| maxsplit
| Maximum number of splits to do.
| -1 (the default value) means no limit.
|
| Splitting is done starting at the end of the bytearray and working to the front.
|
| rstrip(self, bytes=None, /)
| Strip trailing bytes contained in the argument.
|
| If the argument is omitted or None, strip trailing ASCII whitespace.
|
| split(self, /, sep=None, maxsplit=-1)
| Return a list of the sections in the bytearray, using sep as the delimiter.
|
| sep
| The delimiter according which to split the bytearray.
| None (the default value) means split on ASCII whitespace characters
| (space, tab, return, newline, formfeed, vertical tab).
| maxsplit
| Maximum number of splits to do.
| -1 (the default value) means no limit.
|
| splitlines(self, /, keepends=False)
| Return a list of the lines in the bytearray, breaking at line boundaries.
|
| Line breaks are not included in the resulting list unless keepends is given and
| true.
|
| startswith(...)
| B.startswith(prefix[, start[, end]]) -> bool
|
| Return True if B starts with the specified prefix, False otherwise.
| With optional start, test B beginning at that position.
| With optional end, stop comparing B at that position.
| prefix can also be a tuple of bytes to try.
|
| strip(self, bytes=None, /)
| Strip leading and trailing bytes contained in the argument.
|
| If the argument is omitted or None, strip leading and trailing ASCII whitespace.
|
| swapcase(...)
| B.swapcase() -> copy of B
|
| Return a copy of B with uppercase ASCII characters converted
| to lowercase ASCII and vice versa.
|
| title(...)
| B.title() -> copy of B
|
| Return a titlecased version of B, i.e. ASCII words start with uppercase
| characters, all remaining cased characters have lowercase.
|
| translate(self, table, /, delete=b'')
| Return a copy with each character mapped by the given translation table.
|
| table
| Translation table, which must be a bytes object of length 256.
|
| All characters occurring in the optional argument delete are removed.
| The remaining characters are mapped through the given translation table.
|
| upper(...)
| B.upper() -> copy of B
|
| Return a copy of B with all ASCII characters converted to uppercase.
|
| zfill(self, width, /)
| Pad a numeric string with zeros on the left, to fill a field of the given width.
|
| The original string is never truncated.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| fromhex(string, /)
| Create a bytearray object from a string of hexadecimal numbers.
|
| Spaces between two numbers are accepted.
| Example: bytearray.fromhex('B9 01EF') -> bytearray(b'\\xb9\\x01\\xef')
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| maketrans(frm, to, /)
| Return a translation table useable for the bytes or bytearray translate method.
|
| The returned table will be one where each byte in frm is mapped to the byte at
| the same position in to.
|
| The bytes objects frm and to must be of the same length.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __hash__ = None
class bytes(object)
| bytes(iterable_of_ints) -> bytes
| bytes(string, encoding[, errors]) -> bytes
| bytes(bytes_or_buffer) -> immutable copy of bytes_or_buffer
| bytes(int) -> bytes object of size given by the parameter initialized with null bytes
| bytes() -> empty bytes object
|
| Construct an immutable array of bytes from:
| - an iterable yielding integers in range(256)
| - a text string encoded using the specified encoding
| - any object implementing the buffer API.
| - an integer
|
| Methods defined here:
|
| __add__(self, value, /)
| Return self+value.
|
| __buffer__(self, flags, /)
| Return a buffer object that exposes the underlying memory of the object.
|
| __bytes__(self, /)
| Convert this value to exact type bytes.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __getnewargs__(...)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __str__(self, /)
| Return str(self).
|
| capitalize(...)
| B.capitalize() -> copy of B
|
| Return a copy of B with only its first character capitalized (ASCII)
| and the rest lower-cased.
|
| center(self, width, fillchar=b' ', /)
| Return a centered string of length width.
|
| Padding is done using the specified fill character.
|
| count(...)
| B.count(sub[, start[, end]]) -> int
|
| Return the number of non-overlapping occurrences of subsection sub in
| bytes B[start:end]. Optional arguments start and end are interpreted
| as in slice notation.
|
| decode(self, /, encoding='utf-8', errors='strict')
| Decode the bytes using the codec registered for encoding.
|
| encoding
| The encoding with which to decode the bytes.
| errors
| The error handling scheme to use for the handling of decoding errors.
| The default is 'strict' meaning that decoding errors raise a
| UnicodeDecodeError. Other possible values are 'ignore' and 'replace'
| as well as any other name registered with codecs.register_error that
| can handle UnicodeDecodeErrors.
|
| endswith(...)
| B.endswith(suffix[, start[, end]]) -> bool
|
| Return True if B ends with the specified suffix, False otherwise.
| With optional start, test B beginning at that position.
| With optional end, stop comparing B at that position.
| suffix can also be a tuple of bytes to try.
|
| expandtabs(self, /, tabsize=8)
| Return a copy where all tab characters are expanded using spaces.
|
| If tabsize is not given, a tab size of 8 characters is assumed.
|
| find(...)
| B.find(sub[, start[, end]]) -> int
|
| Return the lowest index in B where subsection sub is found,
| such that sub is contained within B[start,end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| hex(...)
| Create a string of hexadecimal numbers from a bytes object.
|
| sep
| An optional single character or byte to separate hex bytes.
| bytes_per_sep
| How many bytes between separators. Positive values count from the
| right, negative values count from the left.
|
| Example:
| >>> value = b'\xb9\x01\xef'
| >>> value.hex()
| 'b901ef'
| >>> value.hex(':')
| 'b9:01:ef'
| >>> value.hex(':', 2)
| 'b9:01ef'
| >>> value.hex(':', -2)
| 'b901:ef'
|
| index(...)
| B.index(sub[, start[, end]]) -> int
|
| Return the lowest index in B where subsection sub is found,
| such that sub is contained within B[start,end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the subsection is not found.
|
| isalnum(...)
| B.isalnum() -> bool
|
| Return True if all characters in B are alphanumeric
| and there is at least one character in B, False otherwise.
|
| isalpha(...)
| B.isalpha() -> bool
|
| Return True if all characters in B are alphabetic
| and there is at least one character in B, False otherwise.
|
| isascii(...)
| B.isascii() -> bool
|
| Return True if B is empty or all characters in B are ASCII,
| False otherwise.
|
| isdigit(...)
| B.isdigit() -> bool
|
| Return True if all characters in B are digits
| and there is at least one character in B, False otherwise.
|
| islower(...)
| B.islower() -> bool
|
| Return True if all cased characters in B are lowercase and there is
| at least one cased character in B, False otherwise.
|
| isspace(...)
| B.isspace() -> bool
|
| Return True if all characters in B are whitespace
| and there is at least one character in B, False otherwise.
|
| istitle(...)
| B.istitle() -> bool
|
| Return True if B is a titlecased string and there is at least one
| character in B, i.e. uppercase characters may only follow uncased
| characters and lowercase characters only cased ones. Return False
| otherwise.
|
| isupper(...)
| B.isupper() -> bool
|
| Return True if all cased characters in B are uppercase and there is
| at least one cased character in B, False otherwise.
|
| join(self, iterable_of_bytes, /)
| Concatenate any number of bytes objects.
|
| The bytes whose method is called is inserted in between each pair.
|
| The result is returned as a new bytes object.
|
| Example: b'.'.join([b'ab', b'pq', b'rs']) -> b'ab.pq.rs'.
|
| ljust(self, width, fillchar=b' ', /)
| Return a left-justified string of length width.
|
| Padding is done using the specified fill character.
|
| lower(...)
| B.lower() -> copy of B
|
| Return a copy of B with all ASCII characters converted to lowercase.
|
| lstrip(self, bytes=None, /)
| Strip leading bytes contained in the argument.
|
| If the argument is omitted or None, strip leading ASCII whitespace.
|
| partition(self, sep, /)
| Partition the bytes into three parts using the given separator.
|
| This will search for the separator sep in the bytes. If the separator is found,
| returns a 3-tuple containing the part before the separator, the separator
| itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing the original bytes
| object and two empty bytes objects.
|
| removeprefix(self, prefix, /)
| Return a bytes object with the given prefix string removed if present.
|
| If the bytes starts with the prefix string, return bytes[len(prefix):].
| Otherwise, return a copy of the original bytes.
|
| removesuffix(self, suffix, /)
| Return a bytes object with the given suffix string removed if present.
|
| If the bytes ends with the suffix string and that suffix is not empty,
| return bytes[:-len(prefix)]. Otherwise, return a copy of the original
| bytes.
|
| replace(self, old, new, count=-1, /)
| Return a copy with all occurrences of substring old replaced by new.
|
| count
| Maximum number of occurrences to replace.
| -1 (the default value) means replace all occurrences.
|
| If the optional argument count is given, only the first count occurrences are
| replaced.
|
| rfind(...)
| B.rfind(sub[, start[, end]]) -> int
|
| Return the highest index in B where subsection sub is found,
| such that sub is contained within B[start,end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| rindex(...)
| B.rindex(sub[, start[, end]]) -> int
|
| Return the highest index in B where subsection sub is found,
| such that sub is contained within B[start,end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raise ValueError when the subsection is not found.
|
| rjust(self, width, fillchar=b' ', /)
| Return a right-justified string of length width.
|
| Padding is done using the specified fill character.
|
| rpartition(self, sep, /)
| Partition the bytes into three parts using the given separator.
|
| This will search for the separator sep in the bytes, starting at the end. If
| the separator is found, returns a 3-tuple containing the part before the
| separator, the separator itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing two empty bytes
| objects and the original bytes object.
|
| rsplit(self, /, sep=None, maxsplit=-1)
| Return a list of the sections in the bytes, using sep as the delimiter.
|
| sep
| The delimiter according which to split the bytes.
| None (the default value) means split on ASCII whitespace characters
| (space, tab, return, newline, formfeed, vertical tab).
| maxsplit
| Maximum number of splits to do.
| -1 (the default value) means no limit.
|
| Splitting is done starting at the end of the bytes and working to the front.
|
| rstrip(self, bytes=None, /)
| Strip trailing bytes contained in the argument.
|
| If the argument is omitted or None, strip trailing ASCII whitespace.
|
| split(self, /, sep=None, maxsplit=-1)
| Return a list of the sections in the bytes, using sep as the delimiter.
|
| sep
| The delimiter according which to split the bytes.
| None (the default value) means split on ASCII whitespace characters
| (space, tab, return, newline, formfeed, vertical tab).
| maxsplit
| Maximum number of splits to do.
| -1 (the default value) means no limit.
|
| splitlines(self, /, keepends=False)
| Return a list of the lines in the bytes, breaking at line boundaries.
|
| Line breaks are not included in the resulting list unless keepends is given and
| true.
|
| startswith(...)
| B.startswith(prefix[, start[, end]]) -> bool
|
| Return True if B starts with the specified prefix, False otherwise.
| With optional start, test B beginning at that position.
| With optional end, stop comparing B at that position.
| prefix can also be a tuple of bytes to try.
|
| strip(self, bytes=None, /)
| Strip leading and trailing bytes contained in the argument.
|
| If the argument is omitted or None, strip leading and trailing ASCII whitespace.
|
| swapcase(...)
| B.swapcase() -> copy of B
|
| Return a copy of B with uppercase ASCII characters converted
| to lowercase ASCII and vice versa.
|
| title(...)
| B.title() -> copy of B
|
| Return a titlecased version of B, i.e. ASCII words start with uppercase
| characters, all remaining cased characters have lowercase.
|
| translate(self, table, /, delete=b'')
| Return a copy with each character mapped by the given translation table.
|
| table
| Translation table, which must be a bytes object of length 256.
|
| All characters occurring in the optional argument delete are removed.
| The remaining characters are mapped through the given translation table.
|
| upper(...)
| B.upper() -> copy of B
|
| Return a copy of B with all ASCII characters converted to uppercase.
|
| zfill(self, width, /)
| Pad a numeric string with zeros on the left, to fill a field of the given width.
|
| The original string is never truncated.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| fromhex(string, /)
| Create a bytes object from a string of hexadecimal numbers.
|
| Spaces between two numbers are accepted.
| Example: bytes.fromhex('B9 01EF') -> b'\\xb9\\x01\\xef'.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| maketrans(frm, to, /)
| Return a translation table useable for the bytes or bytearray translate method.
|
| The returned table will be one where each byte in frm is mapped to the byte at
| the same position in to.
|
| The bytes objects frm and to must be of the same length.
class classmethod(object)
| classmethod(function) -> method
|
| Convert a function to be a class method.
|
| A class method receives the class as implicit first argument,
| just like an instance method receives the instance.
| To declare a class method, use this idiom:
|
| class C:
| @classmethod
| def f(cls, arg1, arg2, argN):
| ...
|
| It can be called either on the class (e.g. C.f()) or on an instance
| (e.g. C().f()). The instance is ignored except for its class.
| If a class method is called for a derived class, the derived class
| object is passed as the implied first argument.
|
| Class methods are different than C++ or Java static methods.
| If you want those, see the staticmethod builtin.
|
| Methods defined here:
|
| __get__(self, instance, owner=None, /)
| Return an attribute of instance, which is of type owner.
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
|
| __func__
|
| __isabstractmethod__
|
| __wrapped__
class complex(object)
| complex(real=0, imag=0)
|
| Create a complex number from a string or numbers.
|
| If a string is given, parse it as a complex number.
| If a single number is given, convert it to a complex number.
| If the 'real' or 'imag' arguments are given, create a complex number
| with the specified real and imaginary components.
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __bool__(self, /)
| True if self else False
|
| __complex__(self, /)
| Convert this value to exact type complex.
|
| __eq__(self, value, /)
| Return self==value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __repr__(self, /)
| Return repr(self).
|
| __rmul__(self, value, /)
| Return value*self.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| conjugate(self, /)
| Return the complex conjugate of its argument. (3-4j).conjugate() == 3+4j.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| imag
| the imaginary part of a complex number
|
| real
| the real part of a complex number
class dict(object)
| dict() -> new empty dictionary
| dict(mapping) -> new dictionary initialized from a mapping object's
| (key, value) pairs
| dict(iterable) -> new dictionary initialized as if via:
| d = {}
| for k, v in iterable:
| d[k] = v
| dict(**kwargs) -> new dictionary initialized with the name=value pairs
| in the keyword argument list. For example: dict(one=1, two=2)
|
| Built-in subclasses:
| StgDict
|
| Methods defined here:
|
| __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__(self, key, /)
| Return self[key].
|
| __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 defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __hash__ = None
class enumerate(object)
| enumerate(iterable, start=0)
|
| Return an enumerate object.
|
| iterable
| an object supporting iteration
|
| The enumerate object yields pairs containing a count (from start, which
| defaults to zero) and a value yielded by the iterable argument.
|
| enumerate is useful for obtaining an indexed list:
| (0, seq[0]), (1, seq[1]), (2, seq[2]), ...
|
| Methods defined here:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __iter__(self, /)
| Implement iter(self).
|
| __next__(self, /)
| Implement next(self).
|
| __reduce__(...)
| Return state information for pickling.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
class filter(object)
| filter(function or None, iterable) --> filter object
|
| Return an iterator yielding those items of iterable for which function(item)
| is true. If function is None, return the items that are true.
|
| Methods defined here:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __iter__(self, /)
| Implement iter(self).
|
| __next__(self, /)
| Implement next(self).
|
| __reduce__(...)
| Return state information for pickling.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
class float(object)
| float(x=0, /)
|
| Convert a string or number to a floating-point number, if possible.
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(self, /)
| Return the ceiling as an Integral.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(self, /)
| Return the floor as an Integral.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Formats the float according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __int__(self, /)
| int(self)
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __round__(self, ndigits=None, /)
| Return the Integral closest to x, rounding half toward even.
|
| When an argument is passed, work like built-in round(x, ndigits).
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(self, /)
| Return the Integral closest to x between 0 and x.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is exactly equal to the original float.
|
| The ratio is in lowest terms and has a positive denominator. Raise
| OverflowError on infinities and a ValueError on NaNs.
|
| >>> (10.0).as_integer_ratio()
| (10, 1)
| >>> (0.0).as_integer_ratio()
| (0, 1)
| >>> (-.25).as_integer_ratio()
| (-1, 4)
|
| conjugate(self, /)
| Return self, the complex conjugate of any float.
|
| hex(self, /)
| Return a hexadecimal representation of a floating-point number.
|
| >>> (-0.1).hex()
| '-0x1.999999999999ap-4'
| >>> 3.14159.hex()
| '0x1.921f9f01b866ep+1'
|
| is_integer(self, /)
| Return True if the float is an integer.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __getformat__(typestr, /)
| You probably don't want to use this function.
|
| typestr
| Must be 'double' or 'float'.
|
| It exists mainly to be used in Python's test suite.
|
| This function returns whichever of 'unknown', 'IEEE, big-endian' or 'IEEE,
| little-endian' best describes the format of floating-point numbers used by the
| C type named by typestr.
|
| fromhex(string, /)
| Create a floating-point number from a hexadecimal string.
|
| >>> float.fromhex('0x1.ffffp10')
| 2047.984375
| >>> float.fromhex('-0x1p-1074')
| -5e-324
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| imag
| the imaginary part of a complex number
|
| real
| the real part of a complex number
class frozenset(object)
| frozenset() -> empty frozenset object
| frozenset(iterable) -> frozenset object
|
| Build an immutable unordered collection of unique elements.
|
| Methods defined here:
|
| __and__(self, value, /)
| Return self&value.
|
| __contains__(...)
| x.__contains__(y) <==> y in x.
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __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.
|
| __rand__(self, value, /)
| Return value&self.
|
| __reduce__(...)
| Return state information for pickling.
|
| __repr__(self, /)
| Return repr(self).
|
| __ror__(self, value, /)
| Return value|self.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(...)
| S.__sizeof__() -> size of S in memory, in bytes
|
| __sub__(self, value, /)
| Return self-value.
|
| __xor__(self, value, /)
| Return self^value.
|
| copy(...)
| Return a shallow copy of a set.
|
| difference(...)
| Return the difference of two or more sets as a new set.
|
| (i.e. all elements that are in this set but not the others.)
|
| intersection(...)
| Return the intersection of two sets as a new set.
|
| (i.e. all elements that are in both sets.)
|
| isdisjoint(...)
| Return True if two sets have a null intersection.
|
| issubset(self, other, /)
| Test whether every element in the set is in other.
|
| issuperset(self, other, /)
| Test whether every element in other is in the set.
|
| symmetric_difference(...)
| Return the symmetric difference of two sets as a new set.
|
| (i.e. all elements that are in exactly one of the sets.)
|
| union(...)
| Return the union of sets as a new set.
|
| (i.e. all elements that are in either set.)
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
class list(object)
| list(iterable=(), /)
|
| Built-in mutable sequence.
|
| If no argument is given, the constructor creates a new empty list.
| The argument must be an iterable if specified.
|
| Methods defined here:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __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__(self, index, /)
| Return self[index].
|
| __gt__(self, value, /)
| Return self>value.
|
| __iadd__(self, value, /)
| Implement self+=value.
|
| __imul__(self, value, /)
| Implement self*=value.
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(self, /)
| Return a reverse iterator over the list.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| __sizeof__(self, /)
| Return the size of the list in memory, in bytes.
|
| append(self, object, /)
| Append object to the end of the list.
|
| clear(self, /)
| Remove all items from list.
|
| copy(self, /)
| Return a shallow copy of the list.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| extend(self, iterable, /)
| Extend list by appending elements from the iterable.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| insert(self, index, object, /)
| Insert object before index.
|
| pop(self, index=-1, /)
| Remove and return item at index (default last).
|
| Raises IndexError if list is empty or index is out of range.
|
| remove(self, value, /)
| Remove first occurrence of value.
|
| Raises ValueError if the value is not present.
|
| reverse(self, /)
| Reverse *IN PLACE*.
|
| sort(self, /, *, key=None, reverse=False)
| Sort the list in ascending order and return None.
|
| The sort is in-place (i.e. the list itself is modified) and stable (i.e. the
| order of two equal elements is maintained).
|
| If a key function is given, apply it once to each list item and sort them,
| ascending or descending, according to their function values.
|
| The reverse flag can be set to sort in descending order.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __hash__ = None
class map(object)
| map(func, *iterables) --> map object
|
| Make an iterator that computes the function using arguments from
| each of the iterables. Stops when the shortest iterable is exhausted.
|
| Methods defined here:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __iter__(self, /)
| Implement iter(self).
|
| __next__(self, /)
| Implement next(self).
|
| __reduce__(...)
| Return state information for pickling.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
class memoryview(object)
| memoryview(object)
|
| Create a new memoryview object which references the given object.
|
| Methods defined here:
|
| __buffer__(self, flags, /)
| Return a buffer object that exposes the underlying memory of the object.
|
| __delitem__(self, key, /)
| Delete self[key].
|
| __enter__(...)
|
| __eq__(self, value, /)
| Return self==value.
|
| __exit__(...)
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __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.
|
| __release_buffer__(self, buffer, /)
| Release the buffer object that exposes the underlying memory of the object.
|
| __repr__(self, /)
| Return repr(self).
|
| __setitem__(self, key, value, /)
| Set self[key] to value.
|
| cast(...)
| Cast a memoryview to a new format or shape.
|
| hex(...)
| Return the data in the buffer as a str of hexadecimal numbers.
|
| sep
| An optional single character or byte to separate hex bytes.
| bytes_per_sep
| How many bytes between separators. Positive values count from the
| right, negative values count from the left.
|
| Example:
| >>> value = memoryview(b'\xb9\x01\xef')
| >>> value.hex()
| 'b901ef'
| >>> value.hex(':')
| 'b9:01:ef'
| >>> value.hex(':', 2)
| 'b9:01ef'
| >>> value.hex(':', -2)
| 'b901:ef'
|
| release(self, /)
| Release the underlying buffer exposed by the memoryview object.
|
| tobytes(self, /, order='C')
| Return the data in the buffer as a byte string.
|
| Order can be {'C', 'F', 'A'}. When order is 'C' or 'F', the data of the
| original array is converted to C or Fortran order. For contiguous views,
| 'A' returns an exact copy of the physical memory. In particular, in-memory
| Fortran order is preserved. For non-contiguous views, the data is converted
| to C first. order=None is the same as order='C'.
|
| tolist(self, /)
| Return the data in the buffer as a list of elements.
|
| toreadonly(self, /)
| Return a readonly version of the memoryview.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| c_contiguous
| A bool indicating whether the memory is C contiguous.
|
| contiguous
| A bool indicating whether the memory is contiguous.
|
| f_contiguous
| A bool indicating whether the memory is Fortran contiguous.
|
| format
| A string containing the format (in struct module style)
| for each element in the view.
|
| itemsize
| The size in bytes of each element of the memoryview.
|
| nbytes
| The amount of space in bytes that the array would use in
| a contiguous representation.
|
| ndim
| An integer indicating how many dimensions of a multi-dimensional
| array the memory represents.
|
| obj
| The underlying object of the memoryview.
|
| readonly
| A bool indicating whether the memory is read only.
|
| shape
| A tuple of ndim integers giving the shape of the memory
| as an N-dimensional array.
|
| strides
| A tuple of ndim integers giving the size in bytes to access
| each element for each dimension of the array.
|
| suboffsets
| A tuple of integers used internally for PIL-style arrays.
class object
| The base class of the class hierarchy.
|
| When called, it accepts no arguments and returns a new featureless
| instance that has no instance attributes and cannot be given any.
|
| Built-in subclasses:
| anext_awaitable
| async_generator
| async_generator_asend
| async_generator_athrow
| ... and 90 other subclasses
|
| Methods defined here:
|
| __delattr__(self, name, /)
| Implement delattr(self, name).
|
| __dir__(self, /)
| Default dir() implementation.
|
| __eq__(self, value, /)
| Return self==value.
|
| __format__(self, format_spec, /)
| Default object formatter.
|
| Return str(self) if format_spec is empty. Raise TypeError otherwise.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getstate__(self, /)
| Helper for pickle.
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __reduce__(self, /)
| Helper for pickle.
|
| __reduce_ex__(self, protocol, /)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setattr__(self, name, value, /)
| Implement setattr(self, name, value).
|
| __sizeof__(self, /)
| Size of object in memory, in bytes.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __init_subclass__(...)
| This method is called when a class is subclassed.
|
| The default implementation does nothing. It may be
| overridden to extend subclasses.
|
| __subclasshook__(...)
| Abstract classes can override this to customize issubclass().
|
| This is invoked early on by abc.ABCMeta.__subclasscheck__().
| It should return True, False or NotImplemented. If it returns
| NotImplemented, the normal algorithm is used. Otherwise, it
| overrides the normal algorithm (and the outcome is cached).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __class__ = <class 'type'>
| type(object) -> the object's type
| type(name, bases, dict, **kwds) -> a new type
class property(object)
| property(fget=None, fset=None, fdel=None, doc=None)
|
| Property attribute.
|
| fget
| function to be used for getting an attribute value
| fset
| function to be used for setting an attribute value
| fdel
| function to be used for del'ing an attribute
| doc
| docstring
|
| Typical use is to define a managed attribute x:
|
| class C(object):
| def getx(self): return self._x
| def setx(self, value): self._x = value
| def delx(self): del self._x
| x = property(getx, setx, delx, "I'm the 'x' property.")
|
| Decorators make defining new properties or modifying existing ones easy:
|
| class C(object):
| @property
| def x(self):
| "I am the 'x' property."
| return self._x
| @x.setter
| def x(self, value):
| self._x = value
| @x.deleter
| def x(self):
| del self._x
|
| Methods defined here:
|
| __delete__(self, instance, /)
| Delete an attribute of instance.
|
| __get__(self, instance, owner=None, /)
| Return an attribute of instance, which is of type owner.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __set__(self, instance, value, /)
| Set an attribute of instance to value.
|
| __set_name__(...)
| Method to set name of a property.
|
| deleter(...)
| Descriptor to obtain a copy of the property with a different deleter.
|
| getter(...)
| Descriptor to obtain a copy of the property with a different getter.
|
| setter(...)
| Descriptor to obtain a copy of the property with a different setter.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __isabstractmethod__
|
| fdel
|
| fget
|
| fset
class range(object)
| range(stop) -> range object
| range(start, stop[, step]) -> range object
|
| Return an object that produces a sequence of integers from start (inclusive)
| to stop (exclusive) by step. range(i, j) produces i, i+1, i+2, ..., j-1.
| start defaults to 0, and stop is omitted! range(4) produces 0, 1, 2, 3.
| These are exactly the valid indices for a list of 4 elements.
| When step is given, it specifies the increment (or decrement).
|
| Methods defined here:
|
| __bool__(self, /)
| True if self else False
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __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.
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __reversed__(...)
| Return a reverse iterator.
|
| count(...)
| rangeobject.count(value) -> integer -- return number of occurrences of value
|
| index(...)
| rangeobject.index(value) -> integer -- return index of value.
| Raise ValueError if the value is not present.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| start
|
| step
|
| stop
class reversed(object)
| reversed(sequence, /)
|
| Return a reverse iterator over the values of the given sequence.
|
| Methods defined here:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __iter__(self, /)
| Implement iter(self).
|
| __length_hint__(...)
| Private method returning an estimate of len(list(it)).
|
| __next__(self, /)
| Implement next(self).
|
| __reduce__(...)
| Return state information for pickling.
|
| __setstate__(...)
| Set state information for unpickling.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
class set(object)
| set() -> new empty set object
| set(iterable) -> new set object
|
| Build an unordered collection of unique elements.
|
| Methods defined here:
|
| __and__(self, value, /)
| Return self&value.
|
| __contains__(...)
| x.__contains__(y) <==> y in x.
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __gt__(self, value, /)
| Return self>value.
|
| __iand__(self, value, /)
| Return self&=value.
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __ior__(self, value, /)
| Return self|=value.
|
| __isub__(self, value, /)
| Return self-=value.
|
| __iter__(self, /)
| Implement iter(self).
|
| __ixor__(self, value, /)
| Return self^=value.
|
| __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.
|
| __rand__(self, value, /)
| Return value&self.
|
| __reduce__(...)
| Return state information for pickling.
|
| __repr__(self, /)
| Return repr(self).
|
| __ror__(self, value, /)
| Return value|self.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(...)
| S.__sizeof__() -> size of S in memory, in bytes
|
| __sub__(self, value, /)
| Return self-value.
|
| __xor__(self, value, /)
| Return self^value.
|
| add(...)
| Add an element to a set.
|
| This has no effect if the element is already present.
|
| clear(...)
| Remove all elements from this set.
|
| copy(...)
| Return a shallow copy of a set.
|
| difference(...)
| Return the difference of two or more sets as a new set.
|
| (i.e. all elements that are in this set but not the others.)
|
| difference_update(...)
| Remove all elements of another set from this set.
|
| discard(...)
| Remove an element from a set if it is a member.
|
| Unlike set.remove(), the discard() method does not raise
| an exception when an element is missing from the set.
|
| intersection(...)
| Return the intersection of two sets as a new set.
|
| (i.e. all elements that are in both sets.)
|
| intersection_update(...)
| Update a set with the intersection of itself and another.
|
| isdisjoint(...)
| Return True if two sets have a null intersection.
|
| issubset(self, other, /)
| Test whether every element in the set is in other.
|
| issuperset(self, other, /)
| Test whether every element in other is in the set.
|
| pop(...)
| Remove and return an arbitrary set element.
| Raises KeyError if the set is empty.
|
| remove(...)
| Remove an element from a set; it must be a member.
|
| If the element is not a member, raise a KeyError.
|
| symmetric_difference(...)
| Return the symmetric difference of two sets as a new set.
|
| (i.e. all elements that are in exactly one of the sets.)
|
| symmetric_difference_update(...)
| Update a set with the symmetric difference of itself and another.
|
| union(...)
| Return the union of sets as a new set.
|
| (i.e. all elements that are in either set.)
|
| update(...)
| Update a set with the union of itself and others.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __hash__ = None
class slice(object)
| slice(stop)
| slice(start, stop[, step])
|
| Create a slice object. This is used for extended slicing (e.g. a[0:10:2]).
|
| Methods defined here:
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __reduce__(...)
| Return state information for pickling.
|
| __repr__(self, /)
| Return repr(self).
|
| indices(...)
| S.indices(len) -> (start, stop, stride)
|
| Assuming a sequence of length len, calculate the start and stop
| indices, and the stride length of the extended slice described by
| S. Out of bounds indices are clipped in a manner consistent with the
| handling of normal slices.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| start
|
| step
|
| stop
class staticmethod(object)
| staticmethod(function) -> method
|
| Convert a function to be a static method.
|
| A static method does not receive an implicit first argument.
| To declare a static method, use this idiom:
|
| class C:
| @staticmethod
| def f(arg1, arg2, argN):
| ...
|
| It can be called either on the class (e.g. C.f()) or on an instance
| (e.g. C().f()). Both the class and the instance are ignored, and
| neither is passed implicitly as the first argument to the method.
|
| Static methods in Python are similar to those found in Java or C++.
| For a more advanced concept, see the classmethod builtin.
|
| Methods defined here:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __get__(self, instance, owner=None, /)
| Return an attribute of instance, which is of type owner.
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
|
| __func__
|
| __isabstractmethod__
|
| __wrapped__
class str(object)
| str(object='') -> str
| str(bytes_or_buffer[, encoding[, errors]]) -> str
|
| Create a new string object from the given object. If encoding or
| errors is specified, then the object must expose a data buffer
| that will be decoded using the given encoding and error handler.
| Otherwise, returns the result of object.__str__() (if defined)
| or repr(object).
| encoding defaults to sys.getdefaultencoding().
| errors defaults to 'strict'.
|
| Methods defined here:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __format__(self, format_spec, /)
| Return a formatted version of the string as described by format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getitem__(self, key, /)
| Return self[key].
|
| __getnewargs__(...)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __sizeof__(self, /)
| Return the size of the string in memory, in bytes.
|
| __str__(self, /)
| Return str(self).
|
| capitalize(self, /)
| Return a capitalized version of the string.
|
| More specifically, make the first character have upper case and the rest lower
| case.
|
| casefold(self, /)
| Return a version of the string suitable for caseless comparisons.
|
| center(self, width, fillchar=' ', /)
| Return a centered string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| count(...)
| S.count(sub[, start[, end]]) -> int
|
| Return the number of non-overlapping occurrences of substring sub in
| string S[start:end]. Optional arguments start and end are
| interpreted as in slice notation.
|
| encode(self, /, encoding='utf-8', errors='strict')
| Encode the string using the codec registered for encoding.
|
| encoding
| The encoding in which to encode the string.
| errors
| The error handling scheme to use for encoding errors.
| The default is 'strict' meaning that encoding errors raise a
| UnicodeEncodeError. Other possible values are 'ignore', 'replace' and
| 'xmlcharrefreplace' as well as any other name registered with
| codecs.register_error that can handle UnicodeEncodeErrors.
|
| endswith(...)
| S.endswith(suffix[, start[, end]]) -> bool
|
| Return True if S ends with the specified suffix, False otherwise.
| With optional start, test S beginning at that position.
| With optional end, stop comparing S at that position.
| suffix can also be a tuple of strings to try.
|
| expandtabs(self, /, tabsize=8)
| Return a copy where all tab characters are expanded using spaces.
|
| If tabsize is not given, a tab size of 8 characters is assumed.
|
| find(...)
| S.find(sub[, start[, end]]) -> int
|
| Return the lowest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| format(...)
| S.format(*args, **kwargs) -> str
|
| Return a formatted version of S, using substitutions from args and kwargs.
| The substitutions are identified by braces ('{' and '}').
|
| format_map(...)
| S.format_map(mapping) -> str
|
| Return a formatted version of S, using substitutions from mapping.
| The substitutions are identified by braces ('{' and '}').
|
| index(...)
| S.index(sub[, start[, end]]) -> int
|
| Return the lowest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the substring is not found.
|
| isalnum(self, /)
| Return True if the string is an alpha-numeric string, False otherwise.
|
| A string is alpha-numeric if all characters in the string are alpha-numeric and
| there is at least one character in the string.
|
| isalpha(self, /)
| Return True if the string is an alphabetic string, False otherwise.
|
| A string is alphabetic if all characters in the string are alphabetic and there
| is at least one character in the string.
|
| isascii(self, /)
| Return True if all characters in the string are ASCII, False otherwise.
|
| ASCII characters have code points in the range U+0000-U+007F.
| Empty string is ASCII too.
|
| isdecimal(self, /)
| Return True if the string is a decimal string, False otherwise.
|
| A string is a decimal string if all characters in the string are decimal and
| there is at least one character in the string.
|
| isdigit(self, /)
| Return True if the string is a digit string, False otherwise.
|
| A string is a digit string if all characters in the string are digits and there
| is at least one character in the string.
|
| isidentifier(self, /)
| Return True if the string is a valid Python identifier, False otherwise.
|
| Call keyword.iskeyword(s) to test whether string s is a reserved identifier,
| such as "def" or "class".
|
| islower(self, /)
| Return True if the string is a lowercase string, False otherwise.
|
| A string is lowercase if all cased characters in the string are lowercase and
| there is at least one cased character in the string.
|
| isnumeric(self, /)
| Return True if the string is a numeric string, False otherwise.
|
| A string is numeric if all characters in the string are numeric and there is at
| least one character in the string.
|
| isprintable(self, /)
| Return True if the string is printable, False otherwise.
|
| A string is printable if all of its characters are considered printable in
| repr() or if it is empty.
|
| isspace(self, /)
| Return True if the string is a whitespace string, False otherwise.
|
| A string is whitespace if all characters in the string are whitespace and there
| is at least one character in the string.
|
| istitle(self, /)
| Return True if the string is a title-cased string, False otherwise.
|
| In a title-cased string, upper- and title-case characters may only
| follow uncased characters and lowercase characters only cased ones.
|
| isupper(self, /)
| Return True if the string is an uppercase string, False otherwise.
|
| A string is uppercase if all cased characters in the string are uppercase and
| there is at least one cased character in the string.
|
| join(self, iterable, /)
| Concatenate any number of strings.
|
| The string whose method is called is inserted in between each given string.
| The result is returned as a new string.
|
| Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'
|
| ljust(self, width, fillchar=' ', /)
| Return a left-justified string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| lower(self, /)
| Return a copy of the string converted to lowercase.
|
| lstrip(self, chars=None, /)
| Return a copy of the string with leading whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| partition(self, sep, /)
| Partition the string into three parts using the given separator.
|
| This will search for the separator in the string. If the separator is found,
| returns a 3-tuple containing the part before the separator, the separator
| itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing the original string
| and two empty strings.
|
| removeprefix(self, prefix, /)
| Return a str with the given prefix string removed if present.
|
| If the string starts with the prefix string, return string[len(prefix):].
| Otherwise, return a copy of the original string.
|
| removesuffix(self, suffix, /)
| Return a str with the given suffix string removed if present.
|
| If the string ends with the suffix string and that suffix is not empty,
| return string[:-len(suffix)]. Otherwise, return a copy of the original
| string.
|
| replace(self, old, new, count=-1, /)
| Return a copy with all occurrences of substring old replaced by new.
|
| count
| Maximum number of occurrences to replace.
| -1 (the default value) means replace all occurrences.
|
| If the optional argument count is given, only the first count occurrences are
| replaced.
|
| rfind(...)
| S.rfind(sub[, start[, end]]) -> int
|
| Return the highest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| rindex(...)
| S.rindex(sub[, start[, end]]) -> int
|
| Return the highest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the substring is not found.
|
| rjust(self, width, fillchar=' ', /)
| Return a right-justified string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| rpartition(self, sep, /)
| Partition the string into three parts using the given separator.
|
| This will search for the separator in the string, starting at the end. If
| the separator is found, returns a 3-tuple containing the part before the
| separator, the separator itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing two empty strings
| and the original string.
|
| rsplit(self, /, sep=None, maxsplit=-1)
| Return a list of the substrings in the string, using sep as the separator string.
|
| sep
| The separator used to split the string.
|
| When set to None (the default value), will split on any whitespace
| character (including \n \r \t \f and spaces) and will discard
| empty strings from the result.
| maxsplit
| Maximum number of splits.
| -1 (the default value) means no limit.
|
| Splitting starts at the end of the string and works to the front.
|
| rstrip(self, chars=None, /)
| Return a copy of the string with trailing whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| split(self, /, sep=None, maxsplit=-1)
| Return a list of the substrings in the string, using sep as the separator string.
|
| sep
| The separator used to split the string.
|
| When set to None (the default value), will split on any whitespace
| character (including \n \r \t \f and spaces) and will discard
| empty strings from the result.
| maxsplit
| Maximum number of splits.
| -1 (the default value) means no limit.
|
| Splitting starts at the front of the string and works to the end.
|
| Note, str.split() is mainly useful for data that has been intentionally
| delimited. With natural text that includes punctuation, consider using
| the regular expression module.
|
| splitlines(self, /, keepends=False)
| Return a list of the lines in the string, breaking at line boundaries.
|
| Line breaks are not included in the resulting list unless keepends is given and
| true.
|
| startswith(...)
| S.startswith(prefix[, start[, end]]) -> bool
|
| Return True if S starts with the specified prefix, False otherwise.
| With optional start, test S beginning at that position.
| With optional end, stop comparing S at that position.
| prefix can also be a tuple of strings to try.
|
| strip(self, chars=None, /)
| Return a copy of the string with leading and trailing whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| swapcase(self, /)
| Convert uppercase characters to lowercase and lowercase characters to uppercase.
|
| title(self, /)
| Return a version of the string where each word is titlecased.
|
| More specifically, words start with uppercased characters and all remaining
| cased characters have lower case.
|
| translate(self, table, /)
| Replace each character in the string using the given translation table.
|
| table
| Translation table, which must be a mapping of Unicode ordinals to
| Unicode ordinals, strings, or None.
|
| The table must implement lookup/indexing via __getitem__, for instance a
| dictionary or list. If this operation raises LookupError, the character is
| left untouched. Characters mapped to None are deleted.
|
| upper(self, /)
| Return a copy of the string converted to uppercase.
|
| zfill(self, width, /)
| Pad a numeric string with zeros on the left, to fill a field of the given width.
|
| The string is never truncated.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| maketrans(...)
| Return a translation table usable for str.translate().
|
| If there is only one argument, it must be a dictionary mapping Unicode
| ordinals (integers) or characters to Unicode ordinals, strings or None.
| Character keys will be then converted to ordinals.
| If there are two arguments, they must be strings of equal length, and
| in the resulting dictionary, each character in x will be mapped to the
| character at the same position in y. If there is a third argument, it
| must be a string, whose characters will be mapped to None in the result.
class super(object)
| super() -> same as super(__class__, <first argument>)
| super(type) -> unbound super object
| super(type, obj) -> bound super object; requires isinstance(obj, type)
| super(type, type2) -> bound super object; requires issubclass(type2, type)
| Typical use to call a cooperative superclass method:
| class C(B):
| def meth(self, arg):
| super().meth(arg)
| This works for class methods too:
| class C(B):
| @classmethod
| def cmeth(cls, arg):
| super().cmeth(arg)
|
| Methods defined here:
|
| __get__(self, instance, owner=None, /)
| Return an attribute of instance, which is of type owner.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __self__
| the instance invoking super(); may be None
|
| __self_class__
| the type of the instance invoking super(); may be None
|
| __thisclass__
| the class invoking super()
class tuple(object)
| tuple(iterable=(), /)
|
| Built-in immutable sequence.
|
| If no argument is given, the constructor returns an empty tuple.
| If iterable is specified the tuple is initialized from iterable's items.
|
| If the argument is a tuple, the return value is the same object.
|
| Built-in subclasses:
| AFDGroupAttributes
| AFDPollOpAttributes
| AFDWaitersAttributes
| asyncgen_hooks
| ... and 48 other subclasses
|
| Methods defined here:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| __rmul__(self, value, /)
| Return value*self.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
class type(object)
| type(object) -> the object's type
| type(name, bases, dict, **kwds) -> a new type
|
| Methods defined here:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __delattr__(self, name, /)
| Implement delattr(self, name).
|
| __dir__(self, /)
| Specialized __dir__ implementation for types.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __instancecheck__(self, instance, /)
| Check if an object is an instance.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __ror__(self, value, /)
| Return value|self.
|
| __setattr__(self, name, value, /)
| Implement setattr(self, name, value).
|
| __sizeof__(self, /)
| Return memory consumption of the type object.
|
| __subclasscheck__(self, subclass, /)
| Check if a class is a subclass.
|
| __subclasses__(self, /)
| Return a list of immediate subclasses.
|
| mro(self, /)
| Return a type's method resolution order.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __prepare__(...)
| __prepare__() -> dict
| used to create the namespace for the class statement
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __abstractmethods__
|
| __annotations__
|
| __dict__
|
| __text_signature__
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __base__ = <class 'object'>
| The base class of the class hierarchy.
|
| When called, it accepts no arguments and returns a new featureless
| instance that has no instance attributes and cannot be given any.
|
|
| __bases__ = (<class 'object'>,)
|
| __basicsize__ = 920
|
| __dictoffset__ = 264
|
| __flags__ = 2156420354
|
| __itemsize__ = 40
|
| __mro__ = (<class 'type'>, <class 'object'>)
|
| __type_params__ = ()
|
| __weakrefoffset__ = 368
class zip(object)
| zip(*iterables, strict=False) --> Yield tuples until an input is exhausted.
|
| >>> list(zip('abcdefg', range(3), range(4)))
| [('a', 0, 0), ('b', 1, 1), ('c', 2, 2)]
|
| The zip object yields n-length tuples, where n is the number of iterables
| passed as positional arguments to zip(). The i-th element in every tuple
| comes from the i-th iterable argument to zip(). This continues until the
| shortest argument is exhausted.
|
| If strict is true and one of the arguments is exhausted before the others,
| raise a ValueError.
|
| Methods defined here:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __iter__(self, /)
| Implement iter(self).
|
| __next__(self, /)
| Implement next(self).
|
| __reduce__(...)
| Return state information for pickling.
|
| __setstate__(...)
| Set state information for unpickling.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
FUNCTIONS
__build_class__(...)
__build_class__(func, name, /, *bases, [metaclass], **kwds) -> class
Internal helper function used by the class statement.
__import__(name, globals=None, locals=None, fromlist=(), level=0)
Import a module.
Because this function is meant for use by the Python
interpreter and not for general use, it is better to use
importlib.import_module() to programmatically import a module.
The globals argument is only used to determine the context;
they are not modified. The locals argument is unused. The fromlist
should be a list of names to emulate ``from name import ...``, or an
empty list to emulate ``import name``.
When importing a module from a package, note that __import__('A.B', ...)
returns package A when fromlist is empty, but its submodule B when
fromlist is not empty. The level argument is used to determine whether to
perform absolute or relative imports: 0 is absolute, while a positive number
is the number of parent directories to search relative to the current module.
abs(x, /)
Return the absolute value of the argument.
aiter(async_iterable, /)
Return an AsyncIterator for an AsyncIterable object.
all(iterable, /)
Return True if bool(x) is True for all values x in the iterable.
If the iterable is empty, return True.
anext(...)
async anext(aiterator[, default])
Return the next item from the async iterator. If default is given and the async
iterator is exhausted, it is returned instead of raising StopAsyncIteration.
any(iterable, /)
Return True if bool(x) is True for any x in the iterable.
If the iterable is empty, return False.
ascii(obj, /)
Return an ASCII-only representation of an object.
As repr(), return a string containing a printable representation of an
object, but escape the non-ASCII characters in the string returned by
repr() using \\x, \\u or \\U escapes. This generates a string similar
to that returned by repr() in Python 2.
bin(number, /)
Return the binary representation of an integer.
>>> bin(2796202)
'0b1010101010101010101010'
breakpoint(...)
breakpoint(*args, **kws)
Call sys.breakpointhook(*args, **kws). sys.breakpointhook() must accept
whatever arguments are passed.
By default, this drops you into the pdb debugger.
callable(obj, /)
Return whether the object is callable (i.e., some kind of function).
Note that classes are callable, as are instances of classes with a
__call__() method.
chr(i, /)
Return a Unicode string of one character with ordinal i; 0 <= i <= 0x10ffff.
compile(source, filename, mode, flags=0, dont_inherit=False, optimize=-1, *, _feature_version=-1)
Compile source into a code object that can be executed by exec() or eval().
The source code may represent a Python module, statement or expression.
The filename will be used for run-time error messages.
The mode must be 'exec' to compile a module, 'single' to compile a
single (interactive) statement, or 'eval' to compile an expression.
The flags argument, if present, controls which future statements influence
the compilation of the code.
The dont_inherit argument, if true, stops the compilation inheriting
the effects of any future statements in effect in the code calling
compile; if absent or false these statements do influence the compilation,
in addition to any features explicitly specified.
delattr(obj, name, /)
Deletes the named attribute from the given object.
delattr(x, 'y') is equivalent to ``del x.y``
dir(...)
Show attributes of an object.
If called without an argument, return the names in the current scope.
Else, return an alphabetized list of names comprising (some of) the attributes
of the given object, and of attributes reachable from it.
If the object supplies a method named __dir__, it will be used; otherwise
the default dir() logic is used and returns:
for a module object: the module's attributes.
for a class object: its attributes, and recursively the attributes
of its bases.
for any other object: its attributes, its class's attributes, and
recursively the attributes of its class's base classes.
divmod(x, y, /)
Return the tuple (x//y, x%y). Invariant: div*y + mod == x.
eval(source, globals=None, locals=None, /)
Evaluate the given source in the context of globals and locals.
The source may be a string representing a Python expression
or a code object as returned by compile().
The globals must be a dictionary and locals can be any mapping,
defaulting to the current globals and locals.
If only globals is given, locals defaults to it.
exec(source, globals=None, locals=None, /, *, closure=None)
Execute the given source in the context of globals and locals.
The source may be a string representing one or more Python statements
or a code object as returned by compile().
The globals must be a dictionary and locals can be any mapping,
defaulting to the current globals and locals.
If only globals is given, locals defaults to it.
The closure must be a tuple of cellvars, and can only be used
when source is a code object requiring exactly that many cellvars.
format(value, format_spec='', /)
Return type(value).__format__(value, format_spec)
Many built-in types implement format_spec according to the
Format Specification Mini-language. See help('FORMATTING').
If type(value) does not supply a method named __format__
and format_spec is empty, then str(value) is returned.
See also help('SPECIALMETHODS').
getattr(...)
Get a named attribute from an object.
getattr(x, 'y') is equivalent to x.y
When a default argument is given, it is returned when the attribute doesn't
exist; without it, an exception is raised in that case.
globals()
Return the dictionary containing the current scope's global variables.
NOTE: Updates to this dictionary *will* affect name lookups in the current
global scope and vice-versa.
hasattr(obj, name, /)
Return whether the object has an attribute with the given name.
This is done by calling getattr(obj, name) and catching AttributeError.
hash(obj, /)
Return the hash value for the given object.
Two objects that compare equal must also have the same hash value, but the
reverse is not necessarily true.
hex(number, /)
Return the hexadecimal representation of an integer.
>>> hex(12648430)
'0xc0ffee'
id(obj, /)
Return the identity of an object.
This is guaranteed to be unique among simultaneously existing objects.
(CPython uses the object's memory address.)
input(prompt='', /)
Read a string from standard input. The trailing newline is stripped.
The prompt string, if given, is printed to standard output without a
trailing newline before reading input.
If the user hits EOF (*nix: Ctrl-D, Windows: Ctrl-Z+Return), raise EOFError.
On *nix systems, readline is used if available.
isinstance(obj, class_or_tuple, /)
Return whether an object is an instance of a class or of a subclass thereof.
A tuple, as in ``isinstance(x, (A, B, ...))``, may be given as the target to
check against. This is equivalent to ``isinstance(x, A) or isinstance(x, B)
or ...`` etc.
issubclass(cls, class_or_tuple, /)
Return whether 'cls' is derived from another class or is the same class.
A tuple, as in ``issubclass(x, (A, B, ...))``, may be given as the target to
check against. This is equivalent to ``issubclass(x, A) or issubclass(x, B)
or ...``.
iter(...)
Get an iterator from an object.
In the first form, the argument must supply its own iterator, or be a sequence.
In the second form, the callable is called until it returns the sentinel.
len(obj, /)
Return the number of items in a container.
locals()
Return a dictionary containing the current scope's local variables.
NOTE: Whether or not updates to this dictionary will affect name lookups in
the local scope and vice-versa is *implementation dependent* and not
covered by any backwards compatibility guarantees.
max(...)
max(iterable, *[, default=obj, key=func]) -> value
max(arg1, arg2, *args, *[, key=func]) -> value
With a single iterable argument, return its biggest item. The
default keyword-only argument specifies an object to return if
the provided iterable is empty.
With two or more arguments, return the largest argument.
min(...)
min(iterable, *[, default=obj, key=func]) -> value
min(arg1, arg2, *args, *[, key=func]) -> value
With a single iterable argument, return its smallest item. The
default keyword-only argument specifies an object to return if
the provided iterable is empty.
With two or more arguments, return the smallest argument.
next(...)
Return the next item from the iterator.
If default is given and the iterator is exhausted,
it is returned instead of raising StopIteration.
oct(number, /)
Return the octal representation of an integer.
>>> oct(342391)
'0o1234567'
open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)
Open file and return a stream. Raise OSError upon failure.
file is either a text or byte string giving the name (and the path
if the file isn't in the current working directory) of the file to
be opened or an integer file descriptor of the file to be
wrapped. (If a file descriptor is given, it is closed when the
returned I/O object is closed, unless closefd is set to False.)
mode is an optional string that specifies the mode in which the file
is opened. It defaults to 'r' which means open for reading in text
mode. Other common values are 'w' for writing (truncating the file if
it already exists), 'x' for creating and writing to a new file, and
'a' for appending (which on some Unix systems, means that all writes
append to the end of the file regardless of the current seek position).
In text mode, if encoding is not specified the encoding used is platform
dependent: locale.getencoding() is called to get the current locale encoding.
(For reading and writing raw bytes use binary mode and leave encoding
unspecified.) The available modes are:
========= ===============================================================
Character Meaning
--------- ---------------------------------------------------------------
'r' open for reading (default)
'w' open for writing, truncating the file first
'x' create a new file and open it for writing
'a' open for writing, appending to the end of the file if it exists
'b' binary mode
't' text mode (default)
'+' open a disk file for updating (reading and writing)
========= ===============================================================
The default mode is 'rt' (open for reading text). For binary random
access, the mode 'w+b' opens and truncates the file to 0 bytes, while
'r+b' opens the file without truncation. The 'x' mode implies 'w' and
raises an `FileExistsError` if the file already exists.
Python distinguishes between files opened in binary and text modes,
even when the underlying operating system doesn't. Files opened in
binary mode (appending 'b' to the mode argument) return contents as
bytes objects without any decoding. In text mode (the default, or when
't' is appended to the mode argument), the contents of the file are
returned as strings, the bytes having been first decoded using a
platform-dependent encoding or using the specified encoding if given.
buffering is an optional integer used to set the buffering policy.
Pass 0 to switch buffering off (only allowed in binary mode), 1 to select
line buffering (only usable in text mode), and an integer > 1 to indicate
the size of a fixed-size chunk buffer. When no buffering argument is
given, the default buffering policy works as follows:
* Binary files are buffered in fixed-size chunks; the size of the buffer
is chosen using a heuristic trying to determine the underlying device's
"block size" and falling back on `io.DEFAULT_BUFFER_SIZE`.
On many systems, the buffer will typically be 4096 or 8192 bytes long.
* "Interactive" text files (files for which isatty() returns True)
use line buffering. Other text files use the policy described above
for binary files.
encoding is the name of the encoding used to decode or encode the
file. This should only be used in text mode. The default encoding is
platform dependent, but any encoding supported by Python can be
passed. See the codecs module for the list of supported encodings.
errors is an optional string that specifies how encoding errors are to
be handled---this argument should not be used in binary mode. Pass
'strict' to raise a ValueError exception if there is an encoding error
(the default of None has the same effect), or pass 'ignore' to ignore
errors. (Note that ignoring encoding errors can lead to data loss.)
See the documentation for codecs.register or run 'help(codecs.Codec)'
for a list of the permitted encoding error strings.
newline controls how universal newlines works (it only applies to text
mode). It can be None, '', '\n', '\r', and '\r\n'. It works as
follows:
* On input, if newline is None, universal newlines mode is
enabled. Lines in the input can end in '\n', '\r', or '\r\n', and
these are translated into '\n' before being returned to the
caller. If it is '', universal newline mode is enabled, but line
endings are returned to the caller untranslated. If it has any of
the other legal values, input lines are only terminated by the given
string, and the line ending is returned to the caller untranslated.
* On output, if newline is None, any '\n' characters written are
translated to the system default line separator, os.linesep. If
newline is '' or '\n', no translation takes place. If newline is any
of the other legal values, any '\n' characters written are translated
to the given string.
If closefd is False, the underlying file descriptor will be kept open
when the file is closed. This does not work when a file name is given
and must be True in that case.
A custom opener can be used by passing a callable as *opener*. The
underlying file descriptor for the file object is then obtained by
calling *opener* with (*file*, *flags*). *opener* must return an open
file descriptor (passing os.open as *opener* results in functionality
similar to passing None).
open() returns a file object whose type depends on the mode, and
through which the standard file operations such as reading and writing
are performed. When open() is used to open a file in a text mode ('w',
'r', 'wt', 'rt', etc.), it returns a TextIOWrapper. When used to open
a file in a binary mode, the returned class varies: in read binary
mode, it returns a BufferedReader; in write binary and append binary
modes, it returns a BufferedWriter, and in read/write mode, it returns
a BufferedRandom.
It is also possible to use a string or bytearray as a file for both
reading and writing. For strings StringIO can be used like a file
opened in a text mode, and for bytes a BytesIO can be used like a file
opened in a binary mode.
ord(c, /)
Return the Unicode code point for a one-character string.
pow(base, exp, mod=None)
Equivalent to base**exp with 2 arguments or base**exp % mod with 3 arguments
Some types, such as ints, are able to use a more efficient algorithm when
invoked using the three argument form.
print(*args, sep=' ', end='\n', file=None, flush=False)
Prints the values to a stream, or to sys.stdout by default.
sep
string inserted between values, default a space.
end
string appended after the last value, default a newline.
file
a file-like object (stream); defaults to the current sys.stdout.
flush
whether to forcibly flush the stream.
repr(obj, /)
Return the canonical string representation of the object.
For many object types, including most builtins, eval(repr(obj)) == obj.
round(number, ndigits=None)
Round a number to a given precision in decimal digits.
The return value is an integer if ndigits is omitted or None. Otherwise
the return value has the same type as the number. ndigits may be negative.
setattr(obj, name, value, /)
Sets the named attribute on the given object to the specified value.
setattr(x, 'y', v) is equivalent to ``x.y = v``
sorted(iterable, /, *, key=None, reverse=False)
Return a new list containing all items from the iterable in ascending order.
A custom key function can be supplied to customize the sort order, and the
reverse flag can be set to request the result in descending order.
sum(iterable, /, start=0)
Return the sum of a 'start' value (default: 0) plus an iterable of numbers
When the iterable is empty, return the start value.
This function is intended specifically for use with numeric values and may
reject non-numeric types.
vars(...)
Show vars.
Without arguments, equivalent to locals().
With an argument, equivalent to object.__dict__.
DATA
Ellipsis = Ellipsis
False = False
None = None
NotImplemented = NotImplemented
True = True
__debug__ = True
copyright = Copyright (c) 2001-2023 Python Software Foundati...ematisc...
credits = Thanks to CWI, CNRI, BeOpen.com, Zope Corpor...opment. ...
exit = Use exit() or Ctrl-Z plus Return to exit
help = Type help() for interactive help, or help(object) for help abou...
license = Type license() to see the full license text
quit = Use quit() or Ctrl-Z plus Return to exit
FILE
(built-in)
openai.api_type
Python Library Documentation: 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
_httpx2
_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' from openai._exceptions.APIConnectionError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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' from openai._exceptions.APIError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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' from openai._exceptions.APIResponseValidationError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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' from openai._exceptions.APITimeoutError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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' from openai.lib.bedrock.AsyncBedrockOpenAI
| 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' from openai.lib.bedrock.AsyncBedrockOpenAI
| 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>
| content_provenance_checks = <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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize 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' from openai._client.AsyncOpenAI
| 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>
| content_provenance_checks = <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' from openai._client.AsyncOpenAI
| 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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize 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' from openai._client.AsyncOpenAI
| 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>
| content_provenance_checks = <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' from openai._client.AsyncOpenAI
| 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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize 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' from openai._streaming.AsyncStream
|
| async __aexit__(self, exc_type: 'type[BaseException] | None', exc: 'BaseException | None', exc_tb: 'TracebackType | None') -> 'None' from openai._streaming.AsyncStream
|
| async __aiter__(self) -> 'AsyncIterator[_T]' from openai._streaming.AsyncStream
|
| async __anext__(self) -> '_T' from openai._streaming.AsyncStream
|
| __init__(self, *, cast_to: 'type[_T]', response: 'httpx.Response', client: 'AsyncOpenAI', options: 'Optional[FinalRequestOptions]' = None) -> 'None' from openai._streaming.AsyncStream
| Initialize self. See help(type(self)) for accurate signature.
|
| async __stream__(self) -> 'AsyncIterator[_T]' from openai._streaming.AsyncStream
|
| async close(self) -> 'None' from openai._streaming.AsyncStream
| 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
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| 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__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize 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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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(**extra_data: Any) -> None
|
| Method resolution order:
| BaseModel
| pydantic.main.BaseModel
| builtins.object
|
| Methods defined here:
|
| __str__(self) -> 'str' from openai._models.BaseModel
| 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]' from openai._models.BaseModel
| 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' from openai._models.BaseModel
| 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 openai._models.BaseModel
| # 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 openai._models.BaseModel
| # 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
|
| ----------------------------------------------------------------------
| 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=...
|
| __signature__ = <Signature (**extra_data: Any) -> None>
|
| 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]'
| Helper for pickle.
|
| __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]' from pydantic._internal._repr.Representation
| 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' from pydantic._internal._repr.Representation
| Name of the instance's class, used in __repr__.
|
| __repr_recursion__(self, object: 'Any') -> 'str' from pydantic._internal._repr.Representation
| Returns the string representation of a recursive object.
|
| __repr_str__(self, join_str: 'str') -> 'str' from pydantic._internal._repr.Representation
|
| __rich_repr__(self) -> 'RichReprResult' from pydantic._internal._repr.Representation
| 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'
|
| __get_pydantic_core_schema__(source: 'type[BaseModel]', handler: 'GetCoreSchemaHandler', /) -> 'CoreSchema'
|
| __get_pydantic_json_schema__(core_schema: 'CoreSchema', handler: 'GetJsonSchemaHandler', /) -> 'JsonSchemaValue'
| 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'
| 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'
| 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'
|
| 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]'
| 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'
| 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'
| 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'
| 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'
| !!! 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'
| 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'
|
| parse_obj(obj: 'Any') -> 'Self'
|
| parse_raw(b: 'str | bytes', *, content_type: 'str | None' = None, encoding: 'str' = 'utf8', proto: 'DeprecatedParseProtocol | None' = None, allow_pickle: 'bool' = False) -> 'Self'
|
| schema(by_alias: 'bool' = True, ref_template: 'str' = '#/$defs/{model}') -> 'Dict[str, Any]'
|
| schema_json(*, by_alias: 'bool' = True, ref_template: 'str' = '#/$defs/{model}', **dumps_kwargs: 'Any') -> 'str'
|
| update_forward_refs(**localns: 'Any') -> 'None'
|
| validate(value: 'Any') -> 'Self'
|
| ----------------------------------------------------------------------
| 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
|
| __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' from openai.lib.bedrock.BedrockOpenAI
| 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' from openai.lib.bedrock.BedrockOpenAI
| 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>
| content_provenance_checks = <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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize 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' from openai._client.OpenAI
| 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>
| content_provenance_checks = <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' from openai._client.OpenAI
| 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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize 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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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' from openai._exceptions.ContentFilterFinishReasonError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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' from openai._base_client._DefaultAioHttpClient
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from httpx.AsyncClient:
|
| async __aenter__(self: 'U') -> 'U' from httpx._client.AsyncClient
|
| async __aexit__(self, exc_type: 'type[BaseException] | None' = None, exc_value: 'BaseException | None' = None, traceback: 'TracebackType | None' = None) -> 'None' from httpx._client.AsyncClient
|
| async aclose(self) -> 'None' from httpx._client.AsyncClient
| Close transport and proxies.
|
| async delete(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send a `DELETE` request.
|
| **Parameters**: See `httpx.request`.
|
| async get(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send a `GET` request.
|
| **Parameters**: See `httpx.request`.
|
| async head(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send a `HEAD` request.
|
| **Parameters**: See `httpx.request`.
|
| async options(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send an `OPTIONS` request.
|
| **Parameters**: See `httpx.request`.
|
| async patch(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send a `PATCH` request.
|
| **Parameters**: See `httpx.request`.
|
| async post(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send a `POST` request.
|
| **Parameters**: See `httpx.request`.
|
| async put(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send a `PUT` request.
|
| **Parameters**: See `httpx.request`.
|
| async request(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| 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/#merging-of-configuration
|
| async send(self, request: 'Request', *, stream: 'bool' = False, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>) -> 'Response' from httpx._client.AsyncClient
| 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/#request-instances
|
| stream(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'typing.AsyncIterator[Response]' from httpx._client.AsyncClient
| 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: 'URLTypes', *, 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 0x0000024AD4224DD0>, 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/#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
|
| __weakref__
| list of weak references to the object
|
| 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' from openai._base_client._DefaultAsyncHttpxClient
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from httpx.AsyncClient:
|
| async __aenter__(self: 'U') -> 'U' from httpx._client.AsyncClient
|
| async __aexit__(self, exc_type: 'type[BaseException] | None' = None, exc_value: 'BaseException | None' = None, traceback: 'TracebackType | None' = None) -> 'None' from httpx._client.AsyncClient
|
| async aclose(self) -> 'None' from httpx._client.AsyncClient
| Close transport and proxies.
|
| async delete(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send a `DELETE` request.
|
| **Parameters**: See `httpx.request`.
|
| async get(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send a `GET` request.
|
| **Parameters**: See `httpx.request`.
|
| async head(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send a `HEAD` request.
|
| **Parameters**: See `httpx.request`.
|
| async options(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send an `OPTIONS` request.
|
| **Parameters**: See `httpx.request`.
|
| async patch(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send a `PATCH` request.
|
| **Parameters**: See `httpx.request`.
|
| async post(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send a `POST` request.
|
| **Parameters**: See `httpx.request`.
|
| async put(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| Send a `PUT` request.
|
| **Parameters**: See `httpx.request`.
|
| async request(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.AsyncClient
| 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/#merging-of-configuration
|
| async send(self, request: 'Request', *, stream: 'bool' = False, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>) -> 'Response' from httpx._client.AsyncClient
| 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/#request-instances
|
| stream(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'typing.AsyncIterator[Response]' from httpx._client.AsyncClient
| 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: 'URLTypes', *, 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 0x0000024AD4224DD0>, 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/#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
|
| __weakref__
| list of weak references to the object
|
| 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' from openai._base_client._DefaultHttpxClient
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from httpx.Client:
|
| __enter__(self: 'T') -> 'T' from httpx._client.Client
|
| __exit__(self, exc_type: 'type[BaseException] | None' = None, exc_value: 'BaseException | None' = None, traceback: 'TracebackType | None' = None) -> 'None' from httpx._client.Client
|
| close(self) -> 'None' from httpx._client.Client
| Close transport and proxies.
|
| delete(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client
| Send a `DELETE` request.
|
| **Parameters**: See `httpx.request`.
|
| get(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client
| Send a `GET` request.
|
| **Parameters**: See `httpx.request`.
|
| head(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client
| Send a `HEAD` request.
|
| **Parameters**: See `httpx.request`.
|
| options(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client
| Send an `OPTIONS` request.
|
| **Parameters**: See `httpx.request`.
|
| patch(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client
| Send a `PATCH` request.
|
| **Parameters**: See `httpx.request`.
|
| post(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client
| Send a `POST` request.
|
| **Parameters**: See `httpx.request`.
|
| put(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client
| Send a `PUT` request.
|
| **Parameters**: See `httpx.request`.
|
| request(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client
| 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/#merging-of-configuration
|
| send(self, request: 'Request', *, stream: 'bool' = False, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>) -> 'Response' from httpx._client.Client
| 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/#request-instances
|
| stream(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'typing.Iterator[Response]' from httpx._client.Client
| 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: 'URLTypes', *, 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 0x0000024AD4224DD0>, 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/#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
|
| __weakref__
| list of weak references to the object
|
| 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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
|
| ----------------------------------------------------------------------
| 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) class method of builtins.ValueError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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' from openai._exceptions.LengthFinishReasonError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __repr__(self, /)
| Return repr(self).
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| 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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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]' from openai._types.NotGiven
|
| __repr__(self) -> 'str' from openai._types.NotGiven
| Return repr(self).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
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' from openai._exceptions.OAuthError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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]' from openai._types.Omit
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
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' from openai._client.OpenAI
| 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>
| content_provenance_checks = <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' from openai._client.OpenAI
| 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
|
| __weakref__
| list of weak references to the object
|
| base_url
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize 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
|
| ----------------------------------------------------------------------
| 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) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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) from openai.types.websocket_reconnection.ReconnectingEvent
| Implement delattr(self, name).
|
| __eq__(self, other) from openai.types.websocket_reconnection.ReconnectingEvent
| Return self==value.
|
| __hash__(self) from openai.types.websocket_reconnection.ReconnectingEvent
| Return hash(self).
|
| __init__(self, attempt: 'int', max_attempts: 'int', delay: 'float', close_code: 'int', extra_query: 'Query', extra_headers: 'Headers') -> None from openai.types.websocket_reconnection.ReconnectingEvent
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) from openai.types.websocket_reconnection.ReconnectingEvent
| Return repr(self).
|
| __setattr__(self, name, value) from openai.types.websocket_reconnection.ReconnectingEvent
| Implement setattr(self, name, value).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| 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
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'abort': ForwardRef('bool', module='openai.types.we...
|
| __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__(self, key, /)
| Return self[key].
|
| __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__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| 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
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'extra_json': ForwardRef('AnyMapping', module='open...
|
| __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__(self, key, /)
| Return self[key].
|
| __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__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| 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' from openai._streaming.Stream
|
| __exit__(self, exc_type: 'type[BaseException] | None', exc: 'BaseException | None', exc_tb: 'TracebackType | None') -> 'None' from openai._streaming.Stream
|
| __init__(self, *, cast_to: 'type[_T]', response: 'httpx.Response', client: 'OpenAI', options: 'Optional[FinalRequestOptions]' = None) -> 'None' from openai._streaming.Stream
| Initialize self. See help(type(self)) for accurate signature.
|
| __iter__(self) -> 'Iterator[_T]' from openai._streaming.Stream
|
| __next__(self) -> '_T' from openai._streaming.Stream
|
| __stream__(self) -> 'Iterator[_T]' from openai._streaming.Stream
|
| close(self) -> 'None' from openai._streaming.Stream
| 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
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| 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__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
class Timeout(builtins.object)
| Timeout(timeout: 'TimeoutTypes | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, *, connect: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, read: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, write: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, pool: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>) -> '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' from httpx._config.Timeout
| Return self==value.
|
| __init__(self, timeout: 'TimeoutTypes | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, *, connect: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, read: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, write: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, pool: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>) -> 'None' from httpx._config.Timeout
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) -> 'str' from httpx._config.Timeout
| Return repr(self).
|
| as_dict(self) -> 'dict[str, float | None]' from httpx._config.Timeout
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __hash__ = None
Transport = class BaseTransport(builtins.object)
| Methods defined here:
|
| __enter__(self: 'T') -> 'T' from httpx._transports.base.BaseTransport
|
| __exit__(self, exc_type: 'type[BaseException] | None' = None, exc_value: 'BaseException | None' = None, traceback: 'TracebackType | None' = None) -> 'None' from httpx._transports.base.BaseTransport
|
| close(self) -> 'None' from httpx._transports.base.BaseTransport
|
| handle_request(self, request: 'Request') -> 'Response' from httpx._transports.base.BaseTransport
| 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
|
| __weakref__
| list of weak references to the object
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' from openai._exceptions.APIStatusError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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' from openai._exceptions.WebSocketConnectionClosedError
| 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
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
|
| ----------------------------------------------------------------------
| 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) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| 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
DefaultAsyncHttpx2Client(**kwargs: 'Any') -> 'httpx.AsyncClient'
Create an experimental async HTTPX2 client with the SDK's recommended defaults.
DefaultHttpx2Client(**kwargs: 'Any') -> 'httpx.Client'
Create an experimental HTTPX2 client with the SDK's recommended defaults.
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.52.0
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openai\__init__.py
openai.api_version
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
openai.audio
Python Library Documentation: AudioProxy in module openai._module_client object
class AudioProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| AudioProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Audio'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Audio')],...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.auth
Python Library Documentation: package openai.auth in openai
NAME
openai.auth
PACKAGE CONTENTS
_workload
CLASSES
builtins.dict(builtins.object)
openai.auth._workload.SubjectTokenProvider
openai.auth._workload.WorkloadIdentity
builtins.object
openai.auth._workload.WorkloadIdentityAuth
class SubjectTokenProvider(builtins.dict)
| Method resolution order:
| SubjectTokenProvider
| builtins.dict
| builtins.object
|
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'get_token': ForwardRef('Callable[[], str]', module...
|
| __optional_keys__ = frozenset()
|
| __orig_bases__ = (<function TypedDict>,)
|
| __required_keys__ = frozenset({'get_token', 'token_type'})
|
| __total__ = True
|
| ----------------------------------------------------------------------
| 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__(self, key, /)
| Return self[key].
|
| __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__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class WorkloadIdentity(builtins.dict)
| Identity provider resource id in WIFAPI.
|
| Method resolution order:
| WorkloadIdentity
| builtins.dict
| builtins.object
|
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'identity_provider_id': ForwardRef('str', module='o...
|
| __optional_keys__ = frozenset()
|
| __orig_bases__ = (<function TypedDict>,)
|
| __required_keys__ = frozenset({'identity_provider_id', 'provider', 're...
|
| __total__ = True
|
| ----------------------------------------------------------------------
| 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__(self, key, /)
| Return self[key].
|
| __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__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.dict:
|
| __new__(*args, **kwargs) class method of builtins.dict
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.dict:
|
| __hash__ = None
class WorkloadIdentityAuth(builtins.object)
| WorkloadIdentityAuth(*, workload_identity: 'WorkloadIdentity', token_exchange_url: 'str' = 'https://auth.openai.com/oauth/token', _use_httpx2: 'bool' = False)
|
| Methods defined here:
|
| __init__(self, *, workload_identity: 'WorkloadIdentity', token_exchange_url: 'str' = 'https://auth.openai.com/oauth/token', _use_httpx2: 'bool' = False)
| Initialize self. See help(type(self)) for accurate signature.
|
| get_token(self) -> 'str'
|
| async get_token_async(self) -> 'str'
|
| invalidate_token(self) -> 'None'
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
FUNCTIONS
azure_managed_identity_token_provider(resource: 'str' = 'https://management.azure.com/', *, object_id: 'str | None' = None, client_id: 'str | None' = None, msi_res_id: 'str | None' = None, api_version: 'str' = '2018-02-01', timeout: 'float' = 10.0, http_client: 'httpx.Client | None' = None) -> 'SubjectTokenProvider'
Get a subject token provider for Azure Managed Identities.
See: https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/how-to-use-vm-token#get-a-token-using-http
Args:
resource: the resource URI to request a token for. Defaults to `https://management.azure.com/` (Azure Resource Manager).
object_id: the object ID of the managed identity to use, when multiple are assigned.
client_id: the client ID of the managed identity to use, when multiple are assigned.
msi_res_id: the ARM resource ID of the managed identity to use, when multiple are assigned.
api_version: the Azure IMDS API version. Defaults to `2018-02-01`.
timeout: the request timeout in seconds. Defaults to 10.0.
http_client: optional httpx.Client instance to use for requests. If not provided, a new client will be created for each request.
gcp_id_token_provider(audience: 'str' = 'https://api.openai.com/v1', *, timeout: 'float' = 10.0, http_client: 'httpx.Client | None' = None) -> 'SubjectTokenProvider'
Get a subject token provider for GCP VM instances using the instance metadata server.
See: https://cloud.google.com/compute/docs/instances/verifying-instance-identity
Args:
audience: the unique URI agreed upon by both the instance and the system verifying
the instance's identity. Defaults to `https://api.openai.com/v1`.
timeout: the request timeout in seconds. Defaults to 10.0.
http_client: optional httpx.Client instance to use for requests. If not provided, a new client will be created for each request.
k8s_service_account_token_provider(token_file_path: 'str | Path' = '/var/run/secrets/kubernetes.io/serviceaccount/token') -> 'SubjectTokenProvider'
Get a subject token provider for Kubernetes clusters with Workload Identity configured.
Cloud providers typically mount the subject token as a file in the container.
Args:
token_file_path: path to the mounted service account token file. Defaults to `/var/run/secrets/kubernetes.io/serviceaccount/token`.
DATA
__all__ = ['SubjectTokenProvider', 'WorkloadIdentity', 'WorkloadIdenti...
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openai\auth\__init__.py
openai.azure_ad_token
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
openai.azure_ad_token_provider
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
openai.azure_endpoint
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
openai.base_url
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
openai.batches
Python Library Documentation: BatchesProxy in module openai._module_client object
class BatchesProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| BatchesProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Batches'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Batches')...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.bedrock_token_provider
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
openai.beta
Python Library Documentation: BetaProxy in module openai._module_client object
class BetaProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| BetaProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Beta'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Beta')],)
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.chat
Python Library Documentation: ChatProxy in module openai._module_client object
class ChatProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| ChatProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Chat'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Chat')],)
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.completions
Python Library Documentation: CompletionsProxy in module openai._module_client object
class CompletionsProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| CompletionsProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Completions'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Completio...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.containers
Python Library Documentation: ContainersProxy in module openai._module_client object
class ContainersProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| ContainersProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Containers'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Container...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.content_provenance_checks
Python Library Documentation: ContentProvenanceChecksProxy in module openai._module_client object
class ContentProvenanceChecksProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| ContentProvenanceChecksProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'ContentProvenanceChecks'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('ContentPr...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.conversations
Python Library Documentation: ConversationsProxy in module openai._module_client object
class ConversationsProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| ConversationsProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Conversations'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Conversat...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.default_headers
Python Library Documentation: dict object
class dict(object)
| dict() -> new empty dictionary
| dict(mapping) -> new dictionary initialized from a mapping object's
| (key, value) pairs
| dict(iterable) -> new dictionary initialized as if via:
| d = {}
| for k, v in iterable:
| d[k] = v
| dict(**kwargs) -> new dictionary initialized with the name=value pairs
| in the keyword argument list. For example: dict(one=1, two=2)
|
| Built-in subclasses:
| StgDict
|
| Methods defined here:
|
| __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__(self, key, /)
| Return self[key].
|
| __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 defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __hash__ = None
openai.default_query
Python Library Documentation: dict object
class dict(object)
| dict() -> new empty dictionary
| dict(mapping) -> new dictionary initialized from a mapping object's
| (key, value) pairs
| dict(iterable) -> new dictionary initialized as if via:
| d = {}
| for k, v in iterable:
| d[k] = v
| dict(**kwargs) -> new dictionary initialized with the name=value pairs
| in the keyword argument list. For example: dict(one=1, two=2)
|
| Built-in subclasses:
| StgDict
|
| Methods defined here:
|
| __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__(self, key, /)
| Return self[key].
|
| __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 defined here:
|
| __class_getitem__(...)
| See PEP 585
|
| fromkeys(iterable, value=None, /)
| Create a new dictionary with keys from iterable and values set to value.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __hash__ = None
openai.embeddings
Python Library Documentation: EmbeddingsProxy in module openai._module_client object
class EmbeddingsProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| EmbeddingsProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Embeddings'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Embedding...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.evals
Python Library Documentation: EvalsProxy in module openai._module_client object
class EvalsProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| EvalsProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Evals'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Evals')],...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.file_from_path
Python Library Documentation: function file_from_path in module openai file_from_path(path: 'str') -> 'FileTypes'
openai.files
Python Library Documentation: FilesProxy in module openai._module_client object
class FilesProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| FilesProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Files'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Files')],...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.fine_tuning
Python Library Documentation: FineTuningProxy in module openai._module_client object
class FineTuningProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| FineTuningProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'FineTuning'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('FineTunin...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.http_client
Python Library Documentation: SyncHttpxClientWrapper in module openai._base_client object class SyncHttpxClientWrapper(openai._DefaultHttpxClient) | SyncHttpxClientWrapper(**kwargs: 'Any') -> 'None' | | Method resolution order: | SyncHttpxClientWrapper | openai._DefaultHttpxClient | httpx.Client | httpx._client.BaseClient | builtins.object | | Methods defined here: | | __del__(self) -> 'None' | | ---------------------------------------------------------------------- | Methods inherited from openai._DefaultHttpxClient: | | __init__(self, **kwargs: 'Any') -> 'None' from openai._base_client._DefaultHttpxClient | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from httpx.Client: | | __enter__(self: 'T') -> 'T' from httpx._client.Client | | __exit__(self, exc_type: 'type[BaseException] | None' = None, exc_value: 'BaseException | None' = None, traceback: 'TracebackType | None' = None) -> 'None' from httpx._client.Client | | close(self) -> 'None' from httpx._client.Client | Close transport and proxies. | | delete(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send a `DELETE` request. | | **Parameters**: See `httpx.request`. | | get(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send a `GET` request. | | **Parameters**: See `httpx.request`. | | head(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send a `HEAD` request. | | **Parameters**: See `httpx.request`. | | options(self, url: 'URLTypes', *, params: 'QueryParamTypes | None' = None, headers: 'HeaderTypes | None' = None, cookies: 'CookieTypes | None' = None, auth: 'AuthTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send an `OPTIONS` request. | | **Parameters**: See `httpx.request`. | | patch(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send a `PATCH` request. | | **Parameters**: See `httpx.request`. | | post(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send a `POST` request. | | **Parameters**: See `httpx.request`. | | put(self, url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | Send a `PUT` request. | | **Parameters**: See `httpx.request`. | | request(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'Response' from httpx._client.Client | 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/#merging-of-configuration | | send(self, request: 'Request', *, stream: 'bool' = False, auth: 'AuthTypes | UseClientDefault | None' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>) -> 'Response' from httpx._client.Client | 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/#request-instances | | stream(self, method: 'str', url: 'URLTypes', *, 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 0x0000024AD4224DD0>, follow_redirects: 'bool | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, timeout: 'TimeoutTypes | UseClientDefault' = <httpx._client.UseClientDefault object at 0x0000024AD4224DD0>, extensions: 'RequestExtensions | None' = None) -> 'typing.Iterator[Response]' from httpx._client.Client | 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: 'URLTypes', *, 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 0x0000024AD4224DD0>, 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/#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 | | __weakref__ | list of weak references to the object | | 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
openai.images
Python Library Documentation: ImagesProxy in module openai._module_client object
class ImagesProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| ImagesProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Images'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Images')]...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.lib
Python Library Documentation: package openai.lib in openai
NAME
openai.lib
PACKAGE CONTENTS
_bedrock_auth
_old_api
_parsing (package)
_pydantic
_realtime
_tools
_validators
azure
bedrock
streaming (package)
DATA
ResponseFormatT = ~ResponseFormatT
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openai\lib\__init__.py
openai.max_retries
Python Library Documentation: int object
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
openai.models
Python Library Documentation: ModelsProxy in module openai._module_client object
class ModelsProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| ModelsProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Models'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Models')]...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.moderations
Python Library Documentation: ModerationsProxy in module openai._module_client object
class ModerationsProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| ModerationsProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Moderations'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Moderatio...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.not_given
Python Library Documentation: NotGiven in module openai object 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]' from openai._types.NotGiven | | __repr__(self) -> 'str' from openai._types.NotGiven | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
openai.omit
Python Library Documentation: Omit in module openai object
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]' from openai._types.Omit
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
openai.organization
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
openai.override
Python Library Documentation: function override in module typing
override(method: F, /) -> F
Indicate that a method is intended to override a method in a base class.
Usage::
class Base:
def method(self) -> None:
pass
class Child(Base):
@override
def method(self) -> None:
super().method()
When this decorator is applied to a method, the type checker will
validate that it overrides a method or attribute with the same name on a
base class. This helps prevent bugs that may occur when a base class is
changed without an equivalent change to a child class.
There is no runtime checking of this property. The decorator attempts to
set the ``__override__`` attribute to ``True`` on the decorated object to
allow runtime introspection.
See PEP 698 for details.
openai.project
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
openai.providers
Python Library Documentation: package openai.providers in openai
NAME
openai.providers
PACKAGE CONTENTS
bedrock
FUNCTIONS
bedrock(*, region: 'str | None' = None, base_url: 'str | httpx.URL | None | NotGiven' = NOT_GIVEN, api_key: 'str | None | NotGiven' = NOT_GIVEN, token_provider: 'BedrockTokenProvider | None' = None, access_key_id: 'str | None' = None, secret_access_key: 'str | None' = None, session_token: 'str | None' = None, profile: 'str | None' = None, credential_provider: 'AwsCredentialsProvider | None' = None) -> '_Provider'
Configure the standard OpenAI client for Amazon Bedrock Mantle.
DATA
__all__ = ['bedrock']
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openai\providers\__init__.py
openai.pydantic_function_tool
Python Library Documentation: function pydantic_function_tool in module openai.lib._tools pydantic_function_tool(model: 'type[pydantic.BaseModel]', *, name: 'str | None' = None, description: 'str | None' = None) -> 'ChatCompletionFunctionToolParam'
openai.realtime
Python Library Documentation: RealtimeProxy in module openai._module_client object
class RealtimeProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| RealtimeProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Realtime'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Realtime'...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.resources
Python Library Documentation: package openai.resources in openai
NAME
openai.resources - # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
PACKAGE CONTENTS
admin (package)
audio (package)
batches
beta (package)
chat (package)
completions
containers (package)
content_provenance_checks
conversations (package)
embeddings
evals (package)
files
fine_tuning (package)
images
models
moderations
realtime (package)
responses (package)
skills (package)
uploads (package)
vector_stores (package)
videos
webhooks (package)
CLASSES
builtins.object
openai.resources.admin.admin.AdminWithRawResponse
openai.resources.admin.admin.AdminWithStreamingResponse
openai.resources.admin.admin.AsyncAdminWithRawResponse
openai.resources.admin.admin.AsyncAdminWithStreamingResponse
openai.resources.audio.audio.AsyncAudioWithRawResponse
openai.resources.audio.audio.AsyncAudioWithStreamingResponse
openai.resources.audio.audio.AudioWithRawResponse
openai.resources.audio.audio.AudioWithStreamingResponse
openai.resources.batches.AsyncBatchesWithRawResponse
openai.resources.batches.AsyncBatchesWithStreamingResponse
openai.resources.batches.BatchesWithRawResponse
openai.resources.batches.BatchesWithStreamingResponse
openai.resources.beta.beta.AsyncBetaWithRawResponse
openai.resources.beta.beta.AsyncBetaWithStreamingResponse
openai.resources.beta.beta.BetaWithRawResponse
openai.resources.beta.beta.BetaWithStreamingResponse
openai.resources.chat.chat.AsyncChatWithRawResponse
openai.resources.chat.chat.AsyncChatWithStreamingResponse
openai.resources.chat.chat.ChatWithRawResponse
openai.resources.chat.chat.ChatWithStreamingResponse
openai.resources.completions.AsyncCompletionsWithRawResponse
openai.resources.completions.AsyncCompletionsWithStreamingResponse
openai.resources.completions.CompletionsWithRawResponse
openai.resources.completions.CompletionsWithStreamingResponse
openai.resources.containers.containers.AsyncContainersWithRawResponse
openai.resources.containers.containers.AsyncContainersWithStreamingResponse
openai.resources.containers.containers.ContainersWithRawResponse
openai.resources.containers.containers.ContainersWithStreamingResponse
openai.resources.content_provenance_checks.AsyncContentProvenanceChecksWithRawResponse
openai.resources.content_provenance_checks.AsyncContentProvenanceChecksWithStreamingResponse
openai.resources.content_provenance_checks.ContentProvenanceChecksWithRawResponse
openai.resources.content_provenance_checks.ContentProvenanceChecksWithStreamingResponse
openai.resources.embeddings.AsyncEmbeddingsWithRawResponse
openai.resources.embeddings.AsyncEmbeddingsWithStreamingResponse
openai.resources.embeddings.EmbeddingsWithRawResponse
openai.resources.embeddings.EmbeddingsWithStreamingResponse
openai.resources.evals.evals.AsyncEvalsWithRawResponse
openai.resources.evals.evals.AsyncEvalsWithStreamingResponse
openai.resources.evals.evals.EvalsWithRawResponse
openai.resources.evals.evals.EvalsWithStreamingResponse
openai.resources.files.AsyncFilesWithRawResponse
openai.resources.files.AsyncFilesWithStreamingResponse
openai.resources.files.FilesWithRawResponse
openai.resources.files.FilesWithStreamingResponse
openai.resources.fine_tuning.fine_tuning.AsyncFineTuningWithRawResponse
openai.resources.fine_tuning.fine_tuning.AsyncFineTuningWithStreamingResponse
openai.resources.fine_tuning.fine_tuning.FineTuningWithRawResponse
openai.resources.fine_tuning.fine_tuning.FineTuningWithStreamingResponse
openai.resources.images.AsyncImagesWithRawResponse
openai.resources.images.AsyncImagesWithStreamingResponse
openai.resources.images.ImagesWithRawResponse
openai.resources.images.ImagesWithStreamingResponse
openai.resources.models.AsyncModelsWithRawResponse
openai.resources.models.AsyncModelsWithStreamingResponse
openai.resources.models.ModelsWithRawResponse
openai.resources.models.ModelsWithStreamingResponse
openai.resources.moderations.AsyncModerationsWithRawResponse
openai.resources.moderations.AsyncModerationsWithStreamingResponse
openai.resources.moderations.ModerationsWithRawResponse
openai.resources.moderations.ModerationsWithStreamingResponse
openai.resources.skills.skills.AsyncSkillsWithRawResponse
openai.resources.skills.skills.AsyncSkillsWithStreamingResponse
openai.resources.skills.skills.SkillsWithRawResponse
openai.resources.skills.skills.SkillsWithStreamingResponse
openai.resources.uploads.uploads.AsyncUploadsWithRawResponse
openai.resources.uploads.uploads.AsyncUploadsWithStreamingResponse
openai.resources.uploads.uploads.UploadsWithRawResponse
openai.resources.uploads.uploads.UploadsWithStreamingResponse
openai.resources.vector_stores.vector_stores.AsyncVectorStoresWithRawResponse
openai.resources.vector_stores.vector_stores.AsyncVectorStoresWithStreamingResponse
openai.resources.vector_stores.vector_stores.VectorStoresWithRawResponse
openai.resources.vector_stores.vector_stores.VectorStoresWithStreamingResponse
openai.resources.videos.AsyncVideosWithRawResponse
openai.resources.videos.AsyncVideosWithStreamingResponse
openai.resources.videos.VideosWithRawResponse
openai.resources.videos.VideosWithStreamingResponse
openai._resource.AsyncAPIResource(builtins.object)
openai.resources.admin.admin.AsyncAdmin
openai.resources.audio.audio.AsyncAudio
openai.resources.batches.AsyncBatches
openai.resources.beta.beta.AsyncBeta
openai.resources.chat.chat.AsyncChat
openai.resources.completions.AsyncCompletions
openai.resources.containers.containers.AsyncContainers
openai.resources.content_provenance_checks.AsyncContentProvenanceChecks
openai.resources.embeddings.AsyncEmbeddings
openai.resources.evals.evals.AsyncEvals
openai.resources.files.AsyncFiles
openai.resources.fine_tuning.fine_tuning.AsyncFineTuning
openai.resources.images.AsyncImages
openai.resources.models.AsyncModels
openai.resources.moderations.AsyncModerations
openai.resources.skills.skills.AsyncSkills
openai.resources.uploads.uploads.AsyncUploads
openai.resources.vector_stores.vector_stores.AsyncVectorStores
openai.resources.videos.AsyncVideos
openai._resource.SyncAPIResource(builtins.object)
openai.resources.admin.admin.Admin
openai.resources.audio.audio.Audio
openai.resources.batches.Batches
openai.resources.beta.beta.Beta
openai.resources.chat.chat.Chat
openai.resources.completions.Completions
openai.resources.containers.containers.Containers
openai.resources.content_provenance_checks.ContentProvenanceChecks
openai.resources.embeddings.Embeddings
openai.resources.evals.evals.Evals
openai.resources.files.Files
openai.resources.fine_tuning.fine_tuning.FineTuning
openai.resources.images.Images
openai.resources.models.Models
openai.resources.moderations.Moderations
openai.resources.skills.skills.Skills
openai.resources.uploads.uploads.Uploads
openai.resources.vector_stores.vector_stores.VectorStores
openai.resources.videos.Videos
class Admin(openai._resource.SyncAPIResource)
| Admin(client: 'OpenAI') -> 'None'
|
| Method resolution order:
| Admin
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| organization = <functools.cached_property object>
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AdminWithRawResponse(builtins.object)
| AdminWithRawResponse(admin: 'Admin') -> 'None'
|
| Methods defined here:
|
| __init__(self, admin: 'Admin') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| organization = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AdminWithStreamingResponse(builtins.object)
| AdminWithStreamingResponse(admin: 'Admin') -> 'None'
|
| Methods defined here:
|
| __init__(self, admin: 'Admin') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| organization = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncAdmin(openai._resource.AsyncAPIResource)
| AsyncAdmin(client: 'AsyncOpenAI') -> 'None'
|
| Method resolution order:
| AsyncAdmin
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| organization = <functools.cached_property object>
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncAdminWithRawResponse(builtins.object)
| AsyncAdminWithRawResponse(admin: 'AsyncAdmin') -> 'None'
|
| Methods defined here:
|
| __init__(self, admin: 'AsyncAdmin') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| organization = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncAdminWithStreamingResponse(builtins.object)
| AsyncAdminWithStreamingResponse(admin: 'AsyncAdmin') -> 'None'
|
| Methods defined here:
|
| __init__(self, admin: 'AsyncAdmin') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| organization = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncAudio(openai._resource.AsyncAPIResource)
| AsyncAudio(client: 'AsyncOpenAI') -> 'None'
|
| Method resolution order:
| AsyncAudio
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| speech = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| transcriptions = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| translations = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncAudioWithRawResponse(builtins.object)
| AsyncAudioWithRawResponse(audio: 'AsyncAudio') -> 'None'
|
| Methods defined here:
|
| __init__(self, audio: 'AsyncAudio') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| speech = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| transcriptions = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| translations = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncAudioWithStreamingResponse(builtins.object)
| AsyncAudioWithStreamingResponse(audio: 'AsyncAudio') -> 'None'
|
| Methods defined here:
|
| __init__(self, audio: 'AsyncAudio') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| speech = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| transcriptions = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| translations = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncBatches(openai._resource.AsyncAPIResource)
| AsyncBatches(client: 'AsyncOpenAI') -> 'None'
|
| Create large batches of API requests to run asynchronously.
|
| Method resolution order:
| AsyncBatches
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| async cancel(self, batch_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Batch'
| Cancels an in-progress batch.
|
| The batch will be in status `cancelling` for up to
| 10 minutes, before changing to `cancelled`, where it will have partial results
| (if any) available in the output file.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async create(self, *, completion_window: "Literal['24h']", endpoint: "Literal['/v1/responses', '/v1/chat/completions', '/v1/embeddings', '/v1/completions', '/v1/moderations', '/v1/images/generations', '/v1/images/edits', '/v1/videos']", input_file_id: 'str', metadata: 'Optional[Metadata] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, output_expires_after: 'batch_create_params.OutputExpiresAfter | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Batch'
| Creates and executes a batch from an uploaded file of requests
|
| Args:
| completion_window: The time frame within which the batch should be processed. Currently only `24h`
| is supported.
|
| endpoint: The endpoint to be used for all requests in the batch. Currently
| `/v1/responses`, `/v1/chat/completions`, `/v1/embeddings`, `/v1/completions`,
| `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`, and
| `/v1/videos` are supported. Note that `/v1/embeddings` batches are also
| restricted to a maximum of 50,000 embedding inputs across all requests in the
| batch.
|
| input_file_id: The ID of an uploaded file that contains requests for the new batch.
|
| See [upload file](https://platform.openai.com/docs/api-reference/files/create)
| for how to upload a file.
|
| Your input file must be formatted as a
| [JSONL file](https://platform.openai.com/docs/api-reference/batch/request-input),
| and must be uploaded with the purpose `batch`. The file can contain up to 50,000
| requests, and can be up to 200 MB in size.
|
| metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
| for storing additional information about the object in a structured format, and
| querying for objects via API or the dashboard.
|
| Keys are strings with a maximum length of 64 characters. Values are strings with
| a maximum length of 512 characters.
|
| output_expires_after: The expiration policy for the output and/or error file that are generated for a
| batch.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'AsyncPaginator[Batch, AsyncCursorPage[Batch]]'
| List your organization's batches.
|
| Args:
| after: A cursor for use in pagination.
|
| `after` is an object ID that defines your place
| in the list. For instance, if you make a list request and receive 100 objects,
| ending with obj_foo, your subsequent call can include after=obj_foo in order to
| fetch the next page of the list.
|
| limit: A limit on the number of objects to be returned. Limit can range between 1 and
| 100, and the default is 20.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async retrieve(self, batch_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Batch'
| Retrieves a batch.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncBatchesWithRawResponse(builtins.object)
| AsyncBatchesWithRawResponse(batches: 'AsyncBatches') -> 'None'
|
| Methods defined here:
|
| __init__(self, batches: 'AsyncBatches') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncBatchesWithStreamingResponse(builtins.object)
| AsyncBatchesWithStreamingResponse(batches: 'AsyncBatches') -> 'None'
|
| Methods defined here:
|
| __init__(self, batches: 'AsyncBatches') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncBeta(openai._resource.AsyncAPIResource)
| AsyncBeta(client: 'AsyncOpenAI') -> 'None'
|
| Method resolution order:
| AsyncBeta
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| assistants = <functools.cached_property object>
| Build Assistants that can call models and use tools.
|
| chat = <functools.cached_property object>
| chatkit = <functools.cached_property object>
| realtime = <functools.cached_property object>
| responses = <functools.cached_property object>
| threads = <functools.cached_property object>
| Build Assistants that can call models and use tools.
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncBetaWithRawResponse(builtins.object)
| AsyncBetaWithRawResponse(beta: 'AsyncBeta') -> 'None'
|
| Methods defined here:
|
| __init__(self, beta: 'AsyncBeta') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| assistants = <functools.cached_property object>
| Build Assistants that can call models and use tools.
|
| chatkit = <functools.cached_property object>
| responses = <functools.cached_property object>
| threads = <functools.cached_property object>
| Build Assistants that can call models and use tools.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncBetaWithStreamingResponse(builtins.object)
| AsyncBetaWithStreamingResponse(beta: 'AsyncBeta') -> 'None'
|
| Methods defined here:
|
| __init__(self, beta: 'AsyncBeta') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| assistants = <functools.cached_property object>
| Build Assistants that can call models and use tools.
|
| chatkit = <functools.cached_property object>
| responses = <functools.cached_property object>
| threads = <functools.cached_property object>
| Build Assistants that can call models and use tools.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncChat(openai._resource.AsyncAPIResource)
| AsyncChat(client: 'AsyncOpenAI') -> 'None'
|
| Method resolution order:
| AsyncChat
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| completions = <functools.cached_property object>
| Given a list of messages comprising a conversation, the model will return a response.
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncChatWithRawResponse(builtins.object)
| AsyncChatWithRawResponse(chat: 'AsyncChat') -> 'None'
|
| Methods defined here:
|
| __init__(self, chat: 'AsyncChat') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| completions = <functools.cached_property object>
| Given a list of messages comprising a conversation, the model will return a response.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncChatWithStreamingResponse(builtins.object)
| AsyncChatWithStreamingResponse(chat: 'AsyncChat') -> 'None'
|
| Methods defined here:
|
| __init__(self, chat: 'AsyncChat') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| completions = <functools.cached_property object>
| Given a list of messages comprising a conversation, the model will return a response.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncCompletions(openai._resource.AsyncAPIResource)
| AsyncCompletions(client: 'AsyncOpenAI') -> 'None'
|
| Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position.
|
| Method resolution order:
| AsyncCompletions
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| create(self, *, model: "Union[str, Literal['gpt-3.5-turbo-instruct', 'davinci-002', 'babbage-002']]", prompt: 'Union[str, SequenceNotStr[str], Iterable[int], Iterable[Iterable[int]], None]', best_of: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, echo: 'Optional[bool] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, frequency_penalty: 'Optional[float] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, logit_bias: 'Optional[Dict[str, int]] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, logprobs: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, max_tokens: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, n: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, presence_penalty: 'Optional[float] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, seed: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, stop: 'Union[Optional[str], SequenceNotStr[str], None] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, stream: 'Optional[Literal[False]] | Literal[True] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, stream_options: 'Optional[ChatCompletionStreamOptionsParam] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, suffix: 'Optional[str] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, temperature: 'Optional[float] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, top_p: 'Optional[float] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, user: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Completion | AsyncStream[Completion]'
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncCompletionsWithRawResponse(builtins.object)
| AsyncCompletionsWithRawResponse(completions: 'AsyncCompletions') -> 'None'
|
| Methods defined here:
|
| __init__(self, completions: 'AsyncCompletions') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncCompletionsWithStreamingResponse(builtins.object)
| AsyncCompletionsWithStreamingResponse(completions: 'AsyncCompletions') -> 'None'
|
| Methods defined here:
|
| __init__(self, completions: 'AsyncCompletions') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncContainers(openai._resource.AsyncAPIResource)
| AsyncContainers(client: 'AsyncOpenAI') -> 'None'
|
| Method resolution order:
| AsyncContainers
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| async create(self, *, name: 'str', expires_after: 'container_create_params.ExpiresAfter | Omit' = <openai.Omit object at 0x0000024AD46B0530>, file_ids: 'SequenceNotStr[str] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, memory_limit: "Literal['1g', '4g', '16g', '64g'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, network_policy: 'container_create_params.NetworkPolicy | Omit' = <openai.Omit object at 0x0000024AD46B0530>, skills: 'Iterable[container_create_params.Skill] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ContainerCreateResponse'
| Create Container
|
| Args:
| name: Name of the container to create.
|
| expires_after: Container expiration time in seconds relative to the 'anchor' time.
|
| file_ids: IDs of files to copy to the container.
|
| memory_limit: Optional memory limit for the container. Defaults to "1g".
|
| network_policy: Network access policy for the container.
|
| skills: An optional list of skills referenced by id or inline data.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async delete(self, container_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'None'
| Delete Container
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| files = <functools.cached_property object>
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, name: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, order: "Literal['asc', 'desc'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'AsyncPaginator[ContainerListResponse, AsyncCursorPage[ContainerListResponse]]'
| List Containers
|
| Args:
| after: A cursor for use in pagination.
|
| `after` is an object ID that defines your place
| in the list. For instance, if you make a list request and receive 100 objects,
| ending with obj_foo, your subsequent call can include after=obj_foo in order to
| fetch the next page of the list.
|
| limit: A limit on the number of objects to be returned. Limit can range between 1 and
| 100, and the default is 20.
|
| name: Filter results by container name.
|
| order: Sort order by the `created_at` timestamp of the objects. `asc` for ascending
| order and `desc` for descending order.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async retrieve(self, container_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ContainerRetrieveResponse'
| Retrieve Container
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncContainersWithRawResponse(builtins.object)
| AsyncContainersWithRawResponse(containers: 'AsyncContainers') -> 'None'
|
| Methods defined here:
|
| __init__(self, containers: 'AsyncContainers') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| files = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncContainersWithStreamingResponse(builtins.object)
| AsyncContainersWithStreamingResponse(containers: 'AsyncContainers') -> 'None'
|
| Methods defined here:
|
| __init__(self, containers: 'AsyncContainers') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| files = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncContentProvenanceChecks(openai._resource.AsyncAPIResource)
| AsyncContentProvenanceChecks(client: 'AsyncOpenAI') -> 'None'
|
| Method resolution order:
| AsyncContentProvenanceChecks
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| async create(self, *, file: 'FileTypes', extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ContentProvenanceCheck'
| Check whether an image or audio file contains known OpenAI provenance signals.
| [Learn more about content provenance](/api/docs/guides/content-provenance).
|
| If `not_detected`, it means the tool did not find supported signals in the
| uploaded file. The content could still have been generated by OpenAI if the
| metadata was stripped or has evidence of tampering, the watermark was degraded,
| it comes from a legacy generation model, or it was created before provenance
| signals were available. Content could also still be AI-generated by another
| company's model, which the tool currently does not detect.
|
| Args:
| file: The image or audio file to check for supported OpenAI provenance signals.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncContentProvenanceChecksWithRawResponse(builtins.object)
| AsyncContentProvenanceChecksWithRawResponse(content_provenance_checks: 'AsyncContentProvenanceChecks') -> 'None'
|
| Methods defined here:
|
| __init__(self, content_provenance_checks: 'AsyncContentProvenanceChecks') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncContentProvenanceChecksWithStreamingResponse(builtins.object)
| AsyncContentProvenanceChecksWithStreamingResponse(content_provenance_checks: 'AsyncContentProvenanceChecks') -> 'None'
|
| Methods defined here:
|
| __init__(self, content_provenance_checks: 'AsyncContentProvenanceChecks') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncEmbeddings(openai._resource.AsyncAPIResource)
| AsyncEmbeddings(client: 'AsyncOpenAI') -> 'None'
|
| Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
|
| Method resolution order:
| AsyncEmbeddings
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| async create(self, *, input: 'Union[str, SequenceNotStr[str], Iterable[int], Iterable[Iterable[int]]]', model: 'Union[str, EmbeddingModel]', dimensions: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, encoding_format: "Literal['float', 'base64'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, user: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'CreateEmbeddingResponse'
| Creates an embedding vector representing the input text.
|
| Args:
| input: Input text to embed, encoded as a string or array of tokens. To embed multiple
| inputs in a single request, pass an array of strings or array of token arrays.
| The input must not exceed the max input tokens for the model (8192 tokens for
| all embedding models), cannot be an empty string, and any array must be 2048
| dimensions or less.
| [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken)
| for counting tokens. In addition to the per-input token limit, all embedding
| models enforce a maximum of 300,000 tokens summed across all inputs in a single
| request.
|
| model: ID of the model to use. You can use the
| [List models](https://platform.openai.com/docs/api-reference/models/list) API to
| see all of your available models, or see our
| [Model overview](https://platform.openai.com/docs/models) for descriptions of
| them.
|
| dimensions: The number of dimensions the resulting output embeddings should have. Only
| supported in `text-embedding-3` and later models.
|
| encoding_format: The format to return the embeddings in. Can be either `float` or
| [`base64`](https://pypi.org/project/pybase64/).
|
| user: A unique identifier representing your end-user, which can help OpenAI to monitor
| and detect abuse.
| [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncEmbeddingsWithRawResponse(builtins.object)
| AsyncEmbeddingsWithRawResponse(embeddings: 'AsyncEmbeddings') -> 'None'
|
| Methods defined here:
|
| __init__(self, embeddings: 'AsyncEmbeddings') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncEmbeddingsWithStreamingResponse(builtins.object)
| AsyncEmbeddingsWithStreamingResponse(embeddings: 'AsyncEmbeddings') -> 'None'
|
| Methods defined here:
|
| __init__(self, embeddings: 'AsyncEmbeddings') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncEvals(openai._resource.AsyncAPIResource)
| AsyncEvals(client: 'AsyncOpenAI') -> 'None'
|
| Manage and run evals in the OpenAI platform.
|
| Method resolution order:
| AsyncEvals
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| async create(self, *, data_source_config: 'eval_create_params.DataSourceConfig', testing_criteria: 'Iterable[eval_create_params.TestingCriterion]', metadata: 'Optional[Metadata] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, name: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'EvalCreateResponse'
| Create the structure of an evaluation that can be used to test a model's
| performance. An evaluation is a set of testing criteria and the config for a
| data source, which dictates the schema of the data used in the evaluation. After
| creating an evaluation, you can run it on different models and model parameters.
| We support several types of graders and datasources. For more information, see
| the [Evals guide](https://platform.openai.com/docs/guides/evals).
|
| Args:
| data_source_config: The configuration for the data source used for the evaluation runs. Dictates the
| schema of the data used in the evaluation.
|
| testing_criteria: A list of graders for all eval runs in this group. Graders can reference
| variables in the data source using double curly braces notation, like
| `{{item.variable_name}}`. To reference the model's output, use the `sample`
| namespace (ie, `{{sample.output_text}}`).
|
| metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
| for storing additional information about the object in a structured format, and
| querying for objects via API or the dashboard.
|
| Keys are strings with a maximum length of 64 characters. Values are strings with
| a maximum length of 512 characters.
|
| name: The name of the evaluation.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async delete(self, eval_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'EvalDeleteResponse'
| Delete an evaluation.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, order: "Literal['asc', 'desc'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, order_by: "Literal['created_at', 'updated_at'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'AsyncPaginator[EvalListResponse, AsyncCursorPage[EvalListResponse]]'
| List evaluations for a project.
|
| Args:
| after: Identifier for the last eval from the previous pagination request.
|
| limit: Number of evals to retrieve.
|
| order: Sort order for evals by timestamp. Use `asc` for ascending order or `desc` for
| descending order.
|
| order_by: Evals can be ordered by creation time or last updated time. Use `created_at` for
| creation time or `updated_at` for last updated time.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async retrieve(self, eval_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'EvalRetrieveResponse'
| Get an evaluation by ID.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| runs = <functools.cached_property object>
| Manage and run evals in the OpenAI platform.
|
| async update(self, eval_id: 'str', *, metadata: 'Optional[Metadata] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, name: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'EvalUpdateResponse'
| Update certain properties of an evaluation.
|
| Args:
| metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
| for storing additional information about the object in a structured format, and
| querying for objects via API or the dashboard.
|
| Keys are strings with a maximum length of 64 characters. Values are strings with
| a maximum length of 512 characters.
|
| name: Rename the evaluation.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncEvalsWithRawResponse(builtins.object)
| AsyncEvalsWithRawResponse(evals: 'AsyncEvals') -> 'None'
|
| Methods defined here:
|
| __init__(self, evals: 'AsyncEvals') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| runs = <functools.cached_property object>
| Manage and run evals in the OpenAI platform.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncEvalsWithStreamingResponse(builtins.object)
| AsyncEvalsWithStreamingResponse(evals: 'AsyncEvals') -> 'None'
|
| Methods defined here:
|
| __init__(self, evals: 'AsyncEvals') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| runs = <functools.cached_property object>
| Manage and run evals in the OpenAI platform.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncFiles(openai._resource.AsyncAPIResource)
| AsyncFiles(client: 'AsyncOpenAI') -> 'None'
|
| Files are used to upload documents that can be used with features like Assistants and Fine-tuning.
|
| Method resolution order:
| AsyncFiles
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| async content(self, file_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> '_legacy_response.HttpxBinaryResponseContent'
| Returns the contents of the specified file.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async create(self, *, file: 'FileTypes', purpose: 'FilePurpose', expires_after: 'file_create_params.ExpiresAfter | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'FileObject'
| Upload a file that can be used across various endpoints.
|
| Individual files can be
| up to 512 MB, and each project can store up to 2.5 TB of files in total. There
| is no organization-wide storage limit. Uploads to this endpoint are rate-limited
| to 1,000 requests per minute per authenticated user.
|
| - The Assistants API supports files up to 2 million tokens and of specific file
| types. See the
| [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools)
| for details.
| - The Fine-tuning API only supports `.jsonl` files. The input also has certain
| required formats for fine-tuning
| [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input)
| or
| [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
| models.
| - The Batch API only supports `.jsonl` files up to 200 MB in size. The input
| also has a specific required
| [format](https://platform.openai.com/docs/api-reference/batch/request-input).
| - For Retrieval or `file_search` ingestion, upload files here first. If you need
| to attach multiple uploaded files to the same vector store, use
| [`/vector_stores/{vector_store_id}/file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch)
| instead of attaching them one by one. Vector store attachment has separate
| limits from file upload, including 2,000 attached files per minute per
| organization.
|
| Please [contact us](https://help.openai.com/) if you need to increase these
| storage limits.
|
| Args:
| file: The File object (not file name) to be uploaded.
|
| purpose:
| The intended purpose of the uploaded file. One of:
|
| - `assistants`: Used in the Assistants API
| - `batch`: Used in the Batch API
| - `fine-tune`: Used for fine-tuning
| - `vision`: Images used for vision fine-tuning
| - `user_data`: Flexible file type for any purpose
| - `evals`: Used for eval data sets
|
| expires_after: The expiration policy for a file. By default, files with `purpose=batch` expire
| after 30 days and all other files are persisted until they are manually deleted.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async delete(self, file_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'FileDeleted'
| Delete a file and remove it from all vector stores.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, order: "Literal['asc', 'desc'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, purpose: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'AsyncPaginator[FileObject, AsyncCursorPage[FileObject]]'
| Returns a list of files.
|
| Args:
| after: A cursor for use in pagination.
|
| `after` is an object ID that defines your place
| in the list. For instance, if you make a list request and receive 100 objects,
| ending with obj_foo, your subsequent call can include after=obj_foo in order to
| fetch the next page of the list.
|
| limit: A limit on the number of objects to be returned. Limit can range between 1 and
| 10,000, and the default is 10,000.
|
| order: Sort order by the `created_at` timestamp of the objects. `asc` for ascending
| order and `desc` for descending order.
|
| purpose: Only return files with the given purpose.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async retrieve(self, file_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'FileObject'
| Returns information about a specific file.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async retrieve_content(self, file_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'str'
| Returns the contents of the specified file.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async wait_for_processing(self, id: 'str', *, poll_interval: 'float' = 5.0, max_wait_seconds: 'float' = 1800) -> 'FileObject'
| Waits for the given file to be processed, default timeout is 30 mins.
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncFilesWithRawResponse(builtins.object)
| AsyncFilesWithRawResponse(files: 'AsyncFiles') -> 'None'
|
| Methods defined here:
|
| __init__(self, files: 'AsyncFiles') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncFilesWithStreamingResponse(builtins.object)
| AsyncFilesWithStreamingResponse(files: 'AsyncFiles') -> 'None'
|
| Methods defined here:
|
| __init__(self, files: 'AsyncFiles') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncFineTuning(openai._resource.AsyncAPIResource)
| AsyncFineTuning(client: 'AsyncOpenAI') -> 'None'
|
| Method resolution order:
| AsyncFineTuning
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| alpha = <functools.cached_property object>
| checkpoints = <functools.cached_property object>
| jobs = <functools.cached_property object>
| Manage fine-tuning jobs to tailor a model to your specific training data.
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncFineTuningWithRawResponse(builtins.object)
| AsyncFineTuningWithRawResponse(fine_tuning: 'AsyncFineTuning') -> 'None'
|
| Methods defined here:
|
| __init__(self, fine_tuning: 'AsyncFineTuning') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| alpha = <functools.cached_property object>
| checkpoints = <functools.cached_property object>
| jobs = <functools.cached_property object>
| Manage fine-tuning jobs to tailor a model to your specific training data.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncFineTuningWithStreamingResponse(builtins.object)
| AsyncFineTuningWithStreamingResponse(fine_tuning: 'AsyncFineTuning') -> 'None'
|
| Methods defined here:
|
| __init__(self, fine_tuning: 'AsyncFineTuning') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| alpha = <functools.cached_property object>
| checkpoints = <functools.cached_property object>
| jobs = <functools.cached_property object>
| Manage fine-tuning jobs to tailor a model to your specific training data.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncImages(openai._resource.AsyncAPIResource)
| AsyncImages(client: 'AsyncOpenAI') -> 'None'
|
| Given a prompt and/or an input image, the model will generate a new image.
|
| Method resolution order:
| AsyncImages
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| async create_variation(self, *, image: 'FileTypes', model: 'Union[str, ImageModel, None] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, n: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, response_format: "Optional[Literal['url', 'b64_json']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, size: "Optional[Literal['256x256', '512x512', '1024x1024']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, user: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ImagesResponse'
| Creates a variation of a given image.
|
| This endpoint only supports `dall-e-2`.
|
| Args:
| image: The image to use as the basis for the variation(s). Must be a valid PNG file,
| less than 4MB, and square.
|
| model: The model to use for image generation. Only `dall-e-2` is supported at this
| time.
|
| n: The number of images to generate. Must be between 1 and 10.
|
| response_format: The format in which the generated images are returned. Must be one of `url` or
| `b64_json`. URLs are only valid for 60 minutes after the image has been
| generated.
|
| size: The size of the generated images. Must be one of `256x256`, `512x512`, or
| `1024x1024`.
|
| user: A unique identifier representing your end-user, which can help OpenAI to monitor
| and detect abuse.
| [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| edit(self, *, image: 'Union[FileTypes, SequenceNotStr[FileTypes]]', prompt: 'str', background: "Optional[Literal['transparent', 'opaque', 'auto']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, input_fidelity: "Optional[Literal['high', 'low']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, mask: 'FileTypes | Omit' = <openai.Omit object at 0x0000024AD46B0530>, model: 'Union[str, ImageModel, None] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, n: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, output_compression: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, output_format: "Optional[Literal['png', 'jpeg', 'webp']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, partial_images: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, quality: "Optional[Literal['standard', 'low', 'medium', 'high', 'auto']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, response_format: "Optional[Literal['url', 'b64_json']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, size: "Union[str, Literal['256x256', '512x512', '1024x1024', '1536x1024', '1024x1536', 'auto'], None] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, stream: 'Optional[Literal[False]] | Literal[True] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, user: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ImagesResponse | AsyncStream[ImageEditStreamEvent]'
|
| generate(self, *, prompt: 'str', background: "Optional[Literal['transparent', 'opaque', 'auto']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, model: 'Union[str, ImageModel, None] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, moderation: "Optional[Literal['low', 'auto']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, n: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, output_compression: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, output_format: "Optional[Literal['png', 'jpeg', 'webp']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, partial_images: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, quality: "Optional[Literal['standard', 'hd', 'low', 'medium', 'high', 'auto']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, response_format: "Optional[Literal['url', 'b64_json']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, size: "Union[str, Literal['auto', '1024x1024', '1536x1024', '1024x1536', '256x256', '512x512', '1792x1024', '1024x1792'], None] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, stream: 'Optional[Literal[False]] | Literal[True] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, style: "Optional[Literal['vivid', 'natural']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, user: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ImagesResponse | AsyncStream[ImageGenStreamEvent]'
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncImagesWithRawResponse(builtins.object)
| AsyncImagesWithRawResponse(images: 'AsyncImages') -> 'None'
|
| Methods defined here:
|
| __init__(self, images: 'AsyncImages') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncImagesWithStreamingResponse(builtins.object)
| AsyncImagesWithStreamingResponse(images: 'AsyncImages') -> 'None'
|
| Methods defined here:
|
| __init__(self, images: 'AsyncImages') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncModels(openai._resource.AsyncAPIResource)
| AsyncModels(client: 'AsyncOpenAI') -> 'None'
|
| List and describe the various models available in the API.
|
| Method resolution order:
| AsyncModels
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| async delete(self, model: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ModelDeleted'
| Delete a fine-tuned model.
|
| You must have the Owner role in your organization to
| delete a model.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| list(self, *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'AsyncPaginator[Model, AsyncPage[Model]]'
| Lists the currently available models, and provides basic information about each
| one such as the owner and availability.
|
| async retrieve(self, model: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Model'
| Retrieves a model instance, providing basic information about the model such as
| the owner and permissioning.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncModelsWithRawResponse(builtins.object)
| AsyncModelsWithRawResponse(models: 'AsyncModels') -> 'None'
|
| Methods defined here:
|
| __init__(self, models: 'AsyncModels') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncModelsWithStreamingResponse(builtins.object)
| AsyncModelsWithStreamingResponse(models: 'AsyncModels') -> 'None'
|
| Methods defined here:
|
| __init__(self, models: 'AsyncModels') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncModerations(openai._resource.AsyncAPIResource)
| AsyncModerations(client: 'AsyncOpenAI') -> 'None'
|
| Given text and/or image inputs, classifies if those inputs are potentially harmful.
|
| Method resolution order:
| AsyncModerations
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| async create(self, *, input: 'Union[str, SequenceNotStr[str], Iterable[ModerationMultiModalInputParam]]', model: 'Union[str, ModerationModel] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ModerationCreateResponse'
| Classifies if text and/or image inputs are potentially harmful.
|
| Learn more in
| the [moderation guide](https://platform.openai.com/docs/guides/moderation).
|
| Args:
| input: Input (or inputs) to classify. Can be a single string, an array of strings, or
| an array of multi-modal input objects similar to other models.
|
| model: The content moderation model you would like to use. Learn more in
| [the moderation guide](https://platform.openai.com/docs/guides/moderation), and
| learn about available models
| [here](https://platform.openai.com/docs/models#moderation).
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncModerationsWithRawResponse(builtins.object)
| AsyncModerationsWithRawResponse(moderations: 'AsyncModerations') -> 'None'
|
| Methods defined here:
|
| __init__(self, moderations: 'AsyncModerations') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncModerationsWithStreamingResponse(builtins.object)
| AsyncModerationsWithStreamingResponse(moderations: 'AsyncModerations') -> 'None'
|
| Methods defined here:
|
| __init__(self, moderations: 'AsyncModerations') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncSkills(openai._resource.AsyncAPIResource)
| AsyncSkills(client: 'AsyncOpenAI') -> 'None'
|
| Method resolution order:
| AsyncSkills
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| content = <functools.cached_property object>
| async create(self, *, files: 'Union[SequenceNotStr[FileTypes], FileTypes] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Skill'
| Create a new skill.
|
| Args:
| files: Skill files to upload (directory upload) or a single zip file.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async delete(self, skill_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'DeletedSkill'
| Delete a skill by its ID.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, order: "Literal['asc', 'desc'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'AsyncPaginator[Skill, AsyncCursorPage[Skill]]'
| List all skills for the current project.
|
| Args:
| after: Identifier for the last item from the previous pagination request
|
| limit: Number of items to retrieve
|
| order: Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
| descending order.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async retrieve(self, skill_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Skill'
| Get a skill by its ID.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async update(self, skill_id: 'str', *, default_version: 'str', extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Skill'
| Update the default version pointer for a skill.
|
| Args:
| default_version: The skill version number to set as default.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| versions = <functools.cached_property object>
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncSkillsWithRawResponse(builtins.object)
| AsyncSkillsWithRawResponse(skills: 'AsyncSkills') -> 'None'
|
| Methods defined here:
|
| __init__(self, skills: 'AsyncSkills') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| content = <functools.cached_property object>
| versions = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncSkillsWithStreamingResponse(builtins.object)
| AsyncSkillsWithStreamingResponse(skills: 'AsyncSkills') -> 'None'
|
| Methods defined here:
|
| __init__(self, skills: 'AsyncSkills') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| content = <functools.cached_property object>
| versions = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncUploads(openai._resource.AsyncAPIResource)
| AsyncUploads(client: 'AsyncOpenAI') -> 'None'
|
| Use Uploads to upload large files in multiple parts.
|
| Method resolution order:
| AsyncUploads
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| async cancel(self, upload_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Upload'
| Cancels the Upload.
|
| No Parts may be added after an Upload is cancelled.
|
| Returns the Upload object with status `cancelled`.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async complete(self, upload_id: 'str', *, part_ids: 'SequenceNotStr[str]', md5: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Upload'
| Completes the
| [Upload](https://platform.openai.com/docs/api-reference/uploads/object).
|
| Within the returned Upload object, there is a nested
| [File](https://platform.openai.com/docs/api-reference/files/object) object that
| is ready to use in the rest of the platform.
|
| You can specify the order of the Parts by passing in an ordered list of the Part
| IDs.
|
| The number of bytes uploaded upon completion must match the number of bytes
| initially specified when creating the Upload object. No Parts may be added after
| an Upload is completed. Returns the Upload object with status `completed`,
| including an additional `file` property containing the created usable File
| object.
|
| Args:
| part_ids: The ordered list of Part IDs.
|
| md5: The optional md5 checksum for the file contents to verify if the bytes uploaded
| matches what you expect.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async create(self, *, bytes: 'int', filename: 'str', mime_type: 'str', purpose: 'FilePurpose', expires_after: 'upload_create_params.ExpiresAfter | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Upload'
| Creates an intermediate
| [Upload](https://platform.openai.com/docs/api-reference/uploads/object) object
| that you can add
| [Parts](https://platform.openai.com/docs/api-reference/uploads/part-object) to.
| Currently, an Upload can accept at most 8 GB in total and expires after an hour
| after you create it.
|
| Once you complete the Upload, we will create a
| [File](https://platform.openai.com/docs/api-reference/files/object) object that
| contains all the parts you uploaded. This File is usable in the rest of our
| platform as a regular File object.
|
| For certain `purpose` values, the correct `mime_type` must be specified. Please
| refer to documentation for the
| [supported MIME types for your use case](https://platform.openai.com/docs/assistants/tools/file-search#supported-files).
|
| For guidance on the proper filename extensions for each purpose, please follow
| the documentation on
| [creating a File](https://platform.openai.com/docs/api-reference/files/create).
|
| Returns the Upload object with status `pending`.
|
| Args:
| bytes: The number of bytes in the file you are uploading.
|
| filename: The name of the file to upload.
|
| mime_type: The MIME type of the file.
|
| This must fall within the supported MIME types for your file purpose. See the
| supported MIME types for assistants and vision.
|
| purpose: The intended purpose of the uploaded file.
|
| See the
| [documentation on File purposes](https://platform.openai.com/docs/api-reference/files/create#files-create-purpose).
|
| expires_after: The expiration policy for a file. By default, files with `purpose=batch` expire
| after 30 days and all other files are persisted until they are manually deleted.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| parts = <functools.cached_property object>
| Use Uploads to upload large files in multiple parts.
|
| async upload_file_chunked(self, *, file: 'os.PathLike[str] | bytes', mime_type: 'str', purpose: 'FilePurpose', filename: 'str | None' = None, bytes: 'int | None' = None, part_size: 'int | None' = None, md5: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>) -> 'Upload'
| Splits the given file into multiple parts and uploads them sequentially.
|
| ```py
| from pathlib import Path
|
| client.uploads.upload_file(
| file=Path("my-paper.pdf"),
| mime_type="pdf",
| purpose="assistants",
| )
| ```
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncUploadsWithRawResponse(builtins.object)
| AsyncUploadsWithRawResponse(uploads: 'AsyncUploads') -> 'None'
|
| Methods defined here:
|
| __init__(self, uploads: 'AsyncUploads') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| parts = <functools.cached_property object>
| Use Uploads to upload large files in multiple parts.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncUploadsWithStreamingResponse(builtins.object)
| AsyncUploadsWithStreamingResponse(uploads: 'AsyncUploads') -> 'None'
|
| Methods defined here:
|
| __init__(self, uploads: 'AsyncUploads') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| parts = <functools.cached_property object>
| Use Uploads to upload large files in multiple parts.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncVectorStores(openai._resource.AsyncAPIResource)
| AsyncVectorStores(client: 'AsyncOpenAI') -> 'None'
|
| Method resolution order:
| AsyncVectorStores
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| async create(self, *, chunking_strategy: 'FileChunkingStrategyParam | Omit' = <openai.Omit object at 0x0000024AD46B0530>, description: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, expires_after: 'vector_store_create_params.ExpiresAfter | Omit' = <openai.Omit object at 0x0000024AD46B0530>, file_ids: 'SequenceNotStr[str] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, metadata: 'Optional[Metadata] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, name: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VectorStore'
| Create a vector store.
|
| Args:
| chunking_strategy: The chunking strategy used to chunk the file(s). If not set, will use the `auto`
| strategy. Only applicable if `file_ids` is non-empty.
|
| description: A description for the vector store. Can be used to describe the vector store's
| purpose.
|
| expires_after: The expiration policy for a vector store.
|
| file_ids: A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
| the vector store should use. Useful for tools like `file_search` that can access
| files.
|
| metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
| for storing additional information about the object in a structured format, and
| querying for objects via API or the dashboard.
|
| Keys are strings with a maximum length of 64 characters. Values are strings with
| a maximum length of 512 characters.
|
| name: The name of the vector store.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async delete(self, vector_store_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VectorStoreDeleted'
| Delete a vector store.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| file_batches = <functools.cached_property object>
| files = <functools.cached_property object>
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, before: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, order: "Literal['asc', 'desc'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'AsyncPaginator[VectorStore, AsyncCursorPage[VectorStore]]'
| Returns a list of vector stores.
|
| Args:
| after: A cursor for use in pagination.
|
| `after` is an object ID that defines your place
| in the list. For instance, if you make a list request and receive 100 objects,
| ending with obj_foo, your subsequent call can include after=obj_foo in order to
| fetch the next page of the list.
|
| before: A cursor for use in pagination. `before` is an object ID that defines your place
| in the list. For instance, if you make a list request and receive 100 objects,
| starting with obj_foo, your subsequent call can include before=obj_foo in order
| to fetch the previous page of the list.
|
| limit: A limit on the number of objects to be returned. Limit can range between 1 and
| 100, and the default is 20.
|
| order: Sort order by the `created_at` timestamp of the objects. `asc` for ascending
| order and `desc` for descending order.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async retrieve(self, vector_store_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VectorStore'
| Retrieves a vector store.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| search(self, vector_store_id: 'str', *, query: 'Union[str, SequenceNotStr[str]]', filters: 'vector_store_search_params.Filters | Omit' = <openai.Omit object at 0x0000024AD46B0530>, max_num_results: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, ranking_options: 'vector_store_search_params.RankingOptions | Omit' = <openai.Omit object at 0x0000024AD46B0530>, rewrite_query: 'bool | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'AsyncPaginator[VectorStoreSearchResponse, AsyncPage[VectorStoreSearchResponse]]'
| Search a vector store for relevant chunks based on a query and file attributes
| filter.
|
| Args:
| query: A query string for a search
|
| filters: A filter to apply based on file attributes.
|
| max_num_results: The maximum number of results to return. This number should be between 1 and 50
| inclusive.
|
| ranking_options: Ranking options for search.
|
| rewrite_query: Whether to rewrite the natural language query for vector search.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async update(self, vector_store_id: 'str', *, expires_after: 'Optional[vector_store_update_params.ExpiresAfter] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, metadata: 'Optional[Metadata] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, name: 'Optional[str] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VectorStore'
| Modifies a vector store.
|
| Args:
| expires_after: The expiration policy for a vector store.
|
| metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
| for storing additional information about the object in a structured format, and
| querying for objects via API or the dashboard.
|
| Keys are strings with a maximum length of 64 characters. Values are strings with
| a maximum length of 512 characters.
|
| name: The name of the vector store.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncVectorStoresWithRawResponse(builtins.object)
| AsyncVectorStoresWithRawResponse(vector_stores: 'AsyncVectorStores') -> 'None'
|
| Methods defined here:
|
| __init__(self, vector_stores: 'AsyncVectorStores') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| file_batches = <functools.cached_property object>
| files = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncVectorStoresWithStreamingResponse(builtins.object)
| AsyncVectorStoresWithStreamingResponse(vector_stores: 'AsyncVectorStores') -> 'None'
|
| Methods defined here:
|
| __init__(self, vector_stores: 'AsyncVectorStores') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| file_batches = <functools.cached_property object>
| files = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncVideos(openai._resource.AsyncAPIResource)
| AsyncVideos(client: 'AsyncOpenAI') -> 'None'
|
| Method resolution order:
| AsyncVideos
| openai._resource.AsyncAPIResource
| builtins.object
|
| Methods defined here:
|
| async create(self, *, prompt: 'str', input_reference: 'video_create_params.InputReference | Omit' = <openai.Omit object at 0x0000024AD46B0530>, model: 'VideoModelParam | Omit' = <openai.Omit object at 0x0000024AD46B0530>, seconds: 'VideoSeconds | Omit' = <openai.Omit object at 0x0000024AD46B0530>, size: 'VideoSize | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Video'
| Create a new video generation job from a prompt and optional reference assets.
|
| Args:
| prompt: Text prompt that describes the video to generate.
|
| input_reference: Optional reference asset upload or reference object that guides generation.
|
| model: The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults
| to `sora-2`.
|
| seconds: Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.
|
| size: Output resolution formatted as width x height (allowed values: 720x1280,
| 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async create_and_poll(self, *, prompt: 'str', input_reference: 'video_create_params.InputReference | Omit' = <openai.Omit object at 0x0000024AD46B0530>, model: 'VideoModelParam | Omit' = <openai.Omit object at 0x0000024AD46B0530>, seconds: 'VideoSeconds | Omit' = <openai.Omit object at 0x0000024AD46B0530>, size: 'VideoSize | Omit' = <openai.Omit object at 0x0000024AD46B0530>, poll_interval_ms: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Video'
| Create a video and wait for it to be processed.
|
| async create_character(self, *, name: 'str', video: 'FileTypes', extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VideoCreateCharacterResponse'
| Create a character from an uploaded video.
|
| Args:
| name: Display name for this API character.
|
| video: Video file used to create a character.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async delete(self, video_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VideoDeleteResponse'
| Permanently delete a completed or failed video and its stored assets.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async download_content(self, video_id: 'str', *, variant: "Literal['video', 'thumbnail', 'spritesheet'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> '_legacy_response.HttpxBinaryResponseContent'
| Download the generated video bytes or a derived preview asset.
|
| Streams the rendered video content for the specified video job.
|
| Args:
| variant: Which downloadable asset to return. Defaults to the MP4 video.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async edit(self, *, prompt: 'str', video: 'video_edit_params.Video', extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Video'
| Create a new video generation job by editing a source video or existing
| generated video.
|
| Args:
| prompt: Text prompt that describes how to edit the source video.
|
| video: Reference to the completed video to edit.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async extend(self, *, prompt: 'str', seconds: 'VideoSeconds', video: 'video_extend_params.Video', extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Video'
| Create an extension of a completed video.
|
| Args:
| prompt: Updated text prompt that directs the extension generation.
|
| seconds: Length of the newly generated extension segment in seconds (allowed values: 4,
| 8, 12, 16, 20).
|
| video: Reference to the completed video to extend.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async get_character(self, character_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VideoGetCharacterResponse'
| Fetch a character.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, order: "Literal['asc', 'desc'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'AsyncPaginator[Video, AsyncConversationCursorPage[Video]]'
| List recently generated videos for the current project.
|
| Args:
| after: Identifier for the last item from the previous pagination request
|
| limit: Number of items to retrieve
|
| order: Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
| descending order.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async poll(self, video_id: 'str', *, poll_interval_ms: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>) -> 'Video'
| Wait for the vector store file to finish processing.
|
| Note: this will return even if the file failed to process, you need to check
| file.last_error and file.status to handle these cases
|
| async remix(self, video_id: 'str', *, prompt: 'str', extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Video'
| Create a remix of a completed video using a refreshed prompt.
|
| Args:
| prompt: Updated text prompt that directs the remix generation.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| async retrieve(self, video_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Video'
| Fetch the latest metadata for a generated video.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.AsyncAPIResource:
|
| __init__(self, client: 'AsyncOpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.AsyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncVideosWithRawResponse(builtins.object)
| AsyncVideosWithRawResponse(videos: 'AsyncVideos') -> 'None'
|
| Methods defined here:
|
| __init__(self, videos: 'AsyncVideos') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AsyncVideosWithStreamingResponse(builtins.object)
| AsyncVideosWithStreamingResponse(videos: 'AsyncVideos') -> 'None'
|
| Methods defined here:
|
| __init__(self, videos: 'AsyncVideos') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Audio(openai._resource.SyncAPIResource)
| Audio(client: 'OpenAI') -> 'None'
|
| Method resolution order:
| Audio
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| speech = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| transcriptions = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| translations = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AudioWithRawResponse(builtins.object)
| AudioWithRawResponse(audio: 'Audio') -> 'None'
|
| Methods defined here:
|
| __init__(self, audio: 'Audio') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| speech = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| transcriptions = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| translations = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class AudioWithStreamingResponse(builtins.object)
| AudioWithStreamingResponse(audio: 'Audio') -> 'None'
|
| Methods defined here:
|
| __init__(self, audio: 'Audio') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| speech = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| transcriptions = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| translations = <functools.cached_property object>
| Turn audio into text or text into audio.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Batches(openai._resource.SyncAPIResource)
| Batches(client: 'OpenAI') -> 'None'
|
| Create large batches of API requests to run asynchronously.
|
| Method resolution order:
| Batches
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| cancel(self, batch_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Batch'
| Cancels an in-progress batch.
|
| The batch will be in status `cancelling` for up to
| 10 minutes, before changing to `cancelled`, where it will have partial results
| (if any) available in the output file.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| create(self, *, completion_window: "Literal['24h']", endpoint: "Literal['/v1/responses', '/v1/chat/completions', '/v1/embeddings', '/v1/completions', '/v1/moderations', '/v1/images/generations', '/v1/images/edits', '/v1/videos']", input_file_id: 'str', metadata: 'Optional[Metadata] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, output_expires_after: 'batch_create_params.OutputExpiresAfter | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Batch'
| Creates and executes a batch from an uploaded file of requests
|
| Args:
| completion_window: The time frame within which the batch should be processed. Currently only `24h`
| is supported.
|
| endpoint: The endpoint to be used for all requests in the batch. Currently
| `/v1/responses`, `/v1/chat/completions`, `/v1/embeddings`, `/v1/completions`,
| `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`, and
| `/v1/videos` are supported. Note that `/v1/embeddings` batches are also
| restricted to a maximum of 50,000 embedding inputs across all requests in the
| batch.
|
| input_file_id: The ID of an uploaded file that contains requests for the new batch.
|
| See [upload file](https://platform.openai.com/docs/api-reference/files/create)
| for how to upload a file.
|
| Your input file must be formatted as a
| [JSONL file](https://platform.openai.com/docs/api-reference/batch/request-input),
| and must be uploaded with the purpose `batch`. The file can contain up to 50,000
| requests, and can be up to 200 MB in size.
|
| metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
| for storing additional information about the object in a structured format, and
| querying for objects via API or the dashboard.
|
| Keys are strings with a maximum length of 64 characters. Values are strings with
| a maximum length of 512 characters.
|
| output_expires_after: The expiration policy for the output and/or error file that are generated for a
| batch.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'SyncCursorPage[Batch]'
| List your organization's batches.
|
| Args:
| after: A cursor for use in pagination.
|
| `after` is an object ID that defines your place
| in the list. For instance, if you make a list request and receive 100 objects,
| ending with obj_foo, your subsequent call can include after=obj_foo in order to
| fetch the next page of the list.
|
| limit: A limit on the number of objects to be returned. Limit can range between 1 and
| 100, and the default is 20.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| retrieve(self, batch_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Batch'
| Retrieves a batch.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class BatchesWithRawResponse(builtins.object)
| BatchesWithRawResponse(batches: 'Batches') -> 'None'
|
| Methods defined here:
|
| __init__(self, batches: 'Batches') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class BatchesWithStreamingResponse(builtins.object)
| BatchesWithStreamingResponse(batches: 'Batches') -> 'None'
|
| Methods defined here:
|
| __init__(self, batches: 'Batches') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Beta(openai._resource.SyncAPIResource)
| Beta(client: 'OpenAI') -> 'None'
|
| Method resolution order:
| Beta
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| assistants = <functools.cached_property object>
| Build Assistants that can call models and use tools.
|
| chat = <functools.cached_property object>
| chatkit = <functools.cached_property object>
| realtime = <functools.cached_property object>
| responses = <functools.cached_property object>
| threads = <functools.cached_property object>
| Build Assistants that can call models and use tools.
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class BetaWithRawResponse(builtins.object)
| BetaWithRawResponse(beta: 'Beta') -> 'None'
|
| Methods defined here:
|
| __init__(self, beta: 'Beta') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| assistants = <functools.cached_property object>
| Build Assistants that can call models and use tools.
|
| chatkit = <functools.cached_property object>
| responses = <functools.cached_property object>
| threads = <functools.cached_property object>
| Build Assistants that can call models and use tools.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class BetaWithStreamingResponse(builtins.object)
| BetaWithStreamingResponse(beta: 'Beta') -> 'None'
|
| Methods defined here:
|
| __init__(self, beta: 'Beta') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| assistants = <functools.cached_property object>
| Build Assistants that can call models and use tools.
|
| chatkit = <functools.cached_property object>
| responses = <functools.cached_property object>
| threads = <functools.cached_property object>
| Build Assistants that can call models and use tools.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Chat(openai._resource.SyncAPIResource)
| Chat(client: 'OpenAI') -> 'None'
|
| Method resolution order:
| Chat
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| completions = <functools.cached_property object>
| Given a list of messages comprising a conversation, the model will return a response.
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ChatWithRawResponse(builtins.object)
| ChatWithRawResponse(chat: 'Chat') -> 'None'
|
| Methods defined here:
|
| __init__(self, chat: 'Chat') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| completions = <functools.cached_property object>
| Given a list of messages comprising a conversation, the model will return a response.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ChatWithStreamingResponse(builtins.object)
| ChatWithStreamingResponse(chat: 'Chat') -> 'None'
|
| Methods defined here:
|
| __init__(self, chat: 'Chat') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| completions = <functools.cached_property object>
| Given a list of messages comprising a conversation, the model will return a response.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Completions(openai._resource.SyncAPIResource)
| Completions(client: 'OpenAI') -> 'None'
|
| Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position.
|
| Method resolution order:
| Completions
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| create(self, *, model: "Union[str, Literal['gpt-3.5-turbo-instruct', 'davinci-002', 'babbage-002']]", prompt: 'Union[str, SequenceNotStr[str], Iterable[int], Iterable[Iterable[int]], None]', best_of: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, echo: 'Optional[bool] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, frequency_penalty: 'Optional[float] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, logit_bias: 'Optional[Dict[str, int]] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, logprobs: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, max_tokens: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, n: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, presence_penalty: 'Optional[float] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, seed: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, stop: 'Union[Optional[str], SequenceNotStr[str], None] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, stream: 'Optional[Literal[False]] | Literal[True] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, stream_options: 'Optional[ChatCompletionStreamOptionsParam] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, suffix: 'Optional[str] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, temperature: 'Optional[float] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, top_p: 'Optional[float] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, user: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Completion | Stream[Completion]'
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class CompletionsWithRawResponse(builtins.object)
| CompletionsWithRawResponse(completions: 'Completions') -> 'None'
|
| Methods defined here:
|
| __init__(self, completions: 'Completions') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class CompletionsWithStreamingResponse(builtins.object)
| CompletionsWithStreamingResponse(completions: 'Completions') -> 'None'
|
| Methods defined here:
|
| __init__(self, completions: 'Completions') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Containers(openai._resource.SyncAPIResource)
| Containers(client: 'OpenAI') -> 'None'
|
| Method resolution order:
| Containers
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| create(self, *, name: 'str', expires_after: 'container_create_params.ExpiresAfter | Omit' = <openai.Omit object at 0x0000024AD46B0530>, file_ids: 'SequenceNotStr[str] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, memory_limit: "Literal['1g', '4g', '16g', '64g'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, network_policy: 'container_create_params.NetworkPolicy | Omit' = <openai.Omit object at 0x0000024AD46B0530>, skills: 'Iterable[container_create_params.Skill] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ContainerCreateResponse'
| Create Container
|
| Args:
| name: Name of the container to create.
|
| expires_after: Container expiration time in seconds relative to the 'anchor' time.
|
| file_ids: IDs of files to copy to the container.
|
| memory_limit: Optional memory limit for the container. Defaults to "1g".
|
| network_policy: Network access policy for the container.
|
| skills: An optional list of skills referenced by id or inline data.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| delete(self, container_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'None'
| Delete Container
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| files = <functools.cached_property object>
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, name: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, order: "Literal['asc', 'desc'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'SyncCursorPage[ContainerListResponse]'
| List Containers
|
| Args:
| after: A cursor for use in pagination.
|
| `after` is an object ID that defines your place
| in the list. For instance, if you make a list request and receive 100 objects,
| ending with obj_foo, your subsequent call can include after=obj_foo in order to
| fetch the next page of the list.
|
| limit: A limit on the number of objects to be returned. Limit can range between 1 and
| 100, and the default is 20.
|
| name: Filter results by container name.
|
| order: Sort order by the `created_at` timestamp of the objects. `asc` for ascending
| order and `desc` for descending order.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| retrieve(self, container_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ContainerRetrieveResponse'
| Retrieve Container
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ContainersWithRawResponse(builtins.object)
| ContainersWithRawResponse(containers: 'Containers') -> 'None'
|
| Methods defined here:
|
| __init__(self, containers: 'Containers') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| files = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ContainersWithStreamingResponse(builtins.object)
| ContainersWithStreamingResponse(containers: 'Containers') -> 'None'
|
| Methods defined here:
|
| __init__(self, containers: 'Containers') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| files = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ContentProvenanceChecks(openai._resource.SyncAPIResource)
| ContentProvenanceChecks(client: 'OpenAI') -> 'None'
|
| Method resolution order:
| ContentProvenanceChecks
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| create(self, *, file: 'FileTypes', extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ContentProvenanceCheck'
| Check whether an image or audio file contains known OpenAI provenance signals.
| [Learn more about content provenance](/api/docs/guides/content-provenance).
|
| If `not_detected`, it means the tool did not find supported signals in the
| uploaded file. The content could still have been generated by OpenAI if the
| metadata was stripped or has evidence of tampering, the watermark was degraded,
| it comes from a legacy generation model, or it was created before provenance
| signals were available. Content could also still be AI-generated by another
| company's model, which the tool currently does not detect.
|
| Args:
| file: The image or audio file to check for supported OpenAI provenance signals.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ContentProvenanceChecksWithRawResponse(builtins.object)
| ContentProvenanceChecksWithRawResponse(content_provenance_checks: 'ContentProvenanceChecks') -> 'None'
|
| Methods defined here:
|
| __init__(self, content_provenance_checks: 'ContentProvenanceChecks') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ContentProvenanceChecksWithStreamingResponse(builtins.object)
| ContentProvenanceChecksWithStreamingResponse(content_provenance_checks: 'ContentProvenanceChecks') -> 'None'
|
| Methods defined here:
|
| __init__(self, content_provenance_checks: 'ContentProvenanceChecks') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Embeddings(openai._resource.SyncAPIResource)
| Embeddings(client: 'OpenAI') -> 'None'
|
| Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
|
| Method resolution order:
| Embeddings
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| create(self, *, input: 'Union[str, SequenceNotStr[str], Iterable[int], Iterable[Iterable[int]]]', model: 'Union[str, EmbeddingModel]', dimensions: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, encoding_format: "Literal['float', 'base64'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, user: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'CreateEmbeddingResponse'
| Creates an embedding vector representing the input text.
|
| Args:
| input: Input text to embed, encoded as a string or array of tokens. To embed multiple
| inputs in a single request, pass an array of strings or array of token arrays.
| The input must not exceed the max input tokens for the model (8192 tokens for
| all embedding models), cannot be an empty string, and any array must be 2048
| dimensions or less.
| [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken)
| for counting tokens. In addition to the per-input token limit, all embedding
| models enforce a maximum of 300,000 tokens summed across all inputs in a single
| request.
|
| model: ID of the model to use. You can use the
| [List models](https://platform.openai.com/docs/api-reference/models/list) API to
| see all of your available models, or see our
| [Model overview](https://platform.openai.com/docs/models) for descriptions of
| them.
|
| dimensions: The number of dimensions the resulting output embeddings should have. Only
| supported in `text-embedding-3` and later models.
|
| encoding_format: The format to return the embeddings in. Can be either `float` or
| [`base64`](https://pypi.org/project/pybase64/).
|
| user: A unique identifier representing your end-user, which can help OpenAI to monitor
| and detect abuse.
| [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class EmbeddingsWithRawResponse(builtins.object)
| EmbeddingsWithRawResponse(embeddings: 'Embeddings') -> 'None'
|
| Methods defined here:
|
| __init__(self, embeddings: 'Embeddings') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class EmbeddingsWithStreamingResponse(builtins.object)
| EmbeddingsWithStreamingResponse(embeddings: 'Embeddings') -> 'None'
|
| Methods defined here:
|
| __init__(self, embeddings: 'Embeddings') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Evals(openai._resource.SyncAPIResource)
| Evals(client: 'OpenAI') -> 'None'
|
| Manage and run evals in the OpenAI platform.
|
| Method resolution order:
| Evals
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| create(self, *, data_source_config: 'eval_create_params.DataSourceConfig', testing_criteria: 'Iterable[eval_create_params.TestingCriterion]', metadata: 'Optional[Metadata] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, name: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'EvalCreateResponse'
| Create the structure of an evaluation that can be used to test a model's
| performance. An evaluation is a set of testing criteria and the config for a
| data source, which dictates the schema of the data used in the evaluation. After
| creating an evaluation, you can run it on different models and model parameters.
| We support several types of graders and datasources. For more information, see
| the [Evals guide](https://platform.openai.com/docs/guides/evals).
|
| Args:
| data_source_config: The configuration for the data source used for the evaluation runs. Dictates the
| schema of the data used in the evaluation.
|
| testing_criteria: A list of graders for all eval runs in this group. Graders can reference
| variables in the data source using double curly braces notation, like
| `{{item.variable_name}}`. To reference the model's output, use the `sample`
| namespace (ie, `{{sample.output_text}}`).
|
| metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
| for storing additional information about the object in a structured format, and
| querying for objects via API or the dashboard.
|
| Keys are strings with a maximum length of 64 characters. Values are strings with
| a maximum length of 512 characters.
|
| name: The name of the evaluation.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| delete(self, eval_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'EvalDeleteResponse'
| Delete an evaluation.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, order: "Literal['asc', 'desc'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, order_by: "Literal['created_at', 'updated_at'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'SyncCursorPage[EvalListResponse]'
| List evaluations for a project.
|
| Args:
| after: Identifier for the last eval from the previous pagination request.
|
| limit: Number of evals to retrieve.
|
| order: Sort order for evals by timestamp. Use `asc` for ascending order or `desc` for
| descending order.
|
| order_by: Evals can be ordered by creation time or last updated time. Use `created_at` for
| creation time or `updated_at` for last updated time.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| retrieve(self, eval_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'EvalRetrieveResponse'
| Get an evaluation by ID.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| runs = <functools.cached_property object>
| Manage and run evals in the OpenAI platform.
|
| update(self, eval_id: 'str', *, metadata: 'Optional[Metadata] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, name: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'EvalUpdateResponse'
| Update certain properties of an evaluation.
|
| Args:
| metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
| for storing additional information about the object in a structured format, and
| querying for objects via API or the dashboard.
|
| Keys are strings with a maximum length of 64 characters. Values are strings with
| a maximum length of 512 characters.
|
| name: Rename the evaluation.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class EvalsWithRawResponse(builtins.object)
| EvalsWithRawResponse(evals: 'Evals') -> 'None'
|
| Methods defined here:
|
| __init__(self, evals: 'Evals') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| runs = <functools.cached_property object>
| Manage and run evals in the OpenAI platform.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class EvalsWithStreamingResponse(builtins.object)
| EvalsWithStreamingResponse(evals: 'Evals') -> 'None'
|
| Methods defined here:
|
| __init__(self, evals: 'Evals') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| runs = <functools.cached_property object>
| Manage and run evals in the OpenAI platform.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Files(openai._resource.SyncAPIResource)
| Files(client: 'OpenAI') -> 'None'
|
| Files are used to upload documents that can be used with features like Assistants and Fine-tuning.
|
| Method resolution order:
| Files
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| content(self, file_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> '_legacy_response.HttpxBinaryResponseContent'
| Returns the contents of the specified file.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| create(self, *, file: 'FileTypes', purpose: 'FilePurpose', expires_after: 'file_create_params.ExpiresAfter | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'FileObject'
| Upload a file that can be used across various endpoints.
|
| Individual files can be
| up to 512 MB, and each project can store up to 2.5 TB of files in total. There
| is no organization-wide storage limit. Uploads to this endpoint are rate-limited
| to 1,000 requests per minute per authenticated user.
|
| - The Assistants API supports files up to 2 million tokens and of specific file
| types. See the
| [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools)
| for details.
| - The Fine-tuning API only supports `.jsonl` files. The input also has certain
| required formats for fine-tuning
| [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input)
| or
| [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
| models.
| - The Batch API only supports `.jsonl` files up to 200 MB in size. The input
| also has a specific required
| [format](https://platform.openai.com/docs/api-reference/batch/request-input).
| - For Retrieval or `file_search` ingestion, upload files here first. If you need
| to attach multiple uploaded files to the same vector store, use
| [`/vector_stores/{vector_store_id}/file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch)
| instead of attaching them one by one. Vector store attachment has separate
| limits from file upload, including 2,000 attached files per minute per
| organization.
|
| Please [contact us](https://help.openai.com/) if you need to increase these
| storage limits.
|
| Args:
| file: The File object (not file name) to be uploaded.
|
| purpose:
| The intended purpose of the uploaded file. One of:
|
| - `assistants`: Used in the Assistants API
| - `batch`: Used in the Batch API
| - `fine-tune`: Used for fine-tuning
| - `vision`: Images used for vision fine-tuning
| - `user_data`: Flexible file type for any purpose
| - `evals`: Used for eval data sets
|
| expires_after: The expiration policy for a file. By default, files with `purpose=batch` expire
| after 30 days and all other files are persisted until they are manually deleted.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| delete(self, file_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'FileDeleted'
| Delete a file and remove it from all vector stores.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, order: "Literal['asc', 'desc'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, purpose: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'SyncCursorPage[FileObject]'
| Returns a list of files.
|
| Args:
| after: A cursor for use in pagination.
|
| `after` is an object ID that defines your place
| in the list. For instance, if you make a list request and receive 100 objects,
| ending with obj_foo, your subsequent call can include after=obj_foo in order to
| fetch the next page of the list.
|
| limit: A limit on the number of objects to be returned. Limit can range between 1 and
| 10,000, and the default is 10,000.
|
| order: Sort order by the `created_at` timestamp of the objects. `asc` for ascending
| order and `desc` for descending order.
|
| purpose: Only return files with the given purpose.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| retrieve(self, file_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'FileObject'
| Returns information about a specific file.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| retrieve_content(self, file_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'str'
| Returns the contents of the specified file.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| wait_for_processing(self, id: 'str', *, poll_interval: 'float' = 5.0, max_wait_seconds: 'float' = 1800) -> 'FileObject'
| Waits for the given file to be processed, default timeout is 30 mins.
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class FilesWithRawResponse(builtins.object)
| FilesWithRawResponse(files: 'Files') -> 'None'
|
| Methods defined here:
|
| __init__(self, files: 'Files') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class FilesWithStreamingResponse(builtins.object)
| FilesWithStreamingResponse(files: 'Files') -> 'None'
|
| Methods defined here:
|
| __init__(self, files: 'Files') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class FineTuning(openai._resource.SyncAPIResource)
| FineTuning(client: 'OpenAI') -> 'None'
|
| Method resolution order:
| FineTuning
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| alpha = <functools.cached_property object>
| checkpoints = <functools.cached_property object>
| jobs = <functools.cached_property object>
| Manage fine-tuning jobs to tailor a model to your specific training data.
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class FineTuningWithRawResponse(builtins.object)
| FineTuningWithRawResponse(fine_tuning: 'FineTuning') -> 'None'
|
| Methods defined here:
|
| __init__(self, fine_tuning: 'FineTuning') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| alpha = <functools.cached_property object>
| checkpoints = <functools.cached_property object>
| jobs = <functools.cached_property object>
| Manage fine-tuning jobs to tailor a model to your specific training data.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class FineTuningWithStreamingResponse(builtins.object)
| FineTuningWithStreamingResponse(fine_tuning: 'FineTuning') -> 'None'
|
| Methods defined here:
|
| __init__(self, fine_tuning: 'FineTuning') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| alpha = <functools.cached_property object>
| checkpoints = <functools.cached_property object>
| jobs = <functools.cached_property object>
| Manage fine-tuning jobs to tailor a model to your specific training data.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Images(openai._resource.SyncAPIResource)
| Images(client: 'OpenAI') -> 'None'
|
| Given a prompt and/or an input image, the model will generate a new image.
|
| Method resolution order:
| Images
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| create_variation(self, *, image: 'FileTypes', model: 'Union[str, ImageModel, None] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, n: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, response_format: "Optional[Literal['url', 'b64_json']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, size: "Optional[Literal['256x256', '512x512', '1024x1024']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, user: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ImagesResponse'
| Creates a variation of a given image.
|
| This endpoint only supports `dall-e-2`.
|
| Args:
| image: The image to use as the basis for the variation(s). Must be a valid PNG file,
| less than 4MB, and square.
|
| model: The model to use for image generation. Only `dall-e-2` is supported at this
| time.
|
| n: The number of images to generate. Must be between 1 and 10.
|
| response_format: The format in which the generated images are returned. Must be one of `url` or
| `b64_json`. URLs are only valid for 60 minutes after the image has been
| generated.
|
| size: The size of the generated images. Must be one of `256x256`, `512x512`, or
| `1024x1024`.
|
| user: A unique identifier representing your end-user, which can help OpenAI to monitor
| and detect abuse.
| [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| edit(self, *, image: 'Union[FileTypes, SequenceNotStr[FileTypes]]', prompt: 'str', background: "Optional[Literal['transparent', 'opaque', 'auto']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, input_fidelity: "Optional[Literal['high', 'low']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, mask: 'FileTypes | Omit' = <openai.Omit object at 0x0000024AD46B0530>, model: 'Union[str, ImageModel, None] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, n: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, output_compression: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, output_format: "Optional[Literal['png', 'jpeg', 'webp']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, partial_images: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, quality: "Optional[Literal['standard', 'low', 'medium', 'high', 'auto']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, response_format: "Optional[Literal['url', 'b64_json']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, size: "Union[str, Literal['256x256', '512x512', '1024x1024', '1536x1024', '1024x1536', 'auto'], None] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, stream: 'Optional[Literal[False]] | Literal[True] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, user: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ImagesResponse | Stream[ImageEditStreamEvent]'
|
| generate(self, *, prompt: 'str', background: "Optional[Literal['transparent', 'opaque', 'auto']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, model: 'Union[str, ImageModel, None] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, moderation: "Optional[Literal['low', 'auto']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, n: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, output_compression: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, output_format: "Optional[Literal['png', 'jpeg', 'webp']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, partial_images: 'Optional[int] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, quality: "Optional[Literal['standard', 'hd', 'low', 'medium', 'high', 'auto']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, response_format: "Optional[Literal['url', 'b64_json']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, size: "Union[str, Literal['auto', '1024x1024', '1536x1024', '1024x1536', '256x256', '512x512', '1792x1024', '1024x1792'], None] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, stream: 'Optional[Literal[False]] | Literal[True] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, style: "Optional[Literal['vivid', 'natural']] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, user: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ImagesResponse | Stream[ImageGenStreamEvent]'
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ImagesWithRawResponse(builtins.object)
| ImagesWithRawResponse(images: 'Images') -> 'None'
|
| Methods defined here:
|
| __init__(self, images: 'Images') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ImagesWithStreamingResponse(builtins.object)
| ImagesWithStreamingResponse(images: 'Images') -> 'None'
|
| Methods defined here:
|
| __init__(self, images: 'Images') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Models(openai._resource.SyncAPIResource)
| Models(client: 'OpenAI') -> 'None'
|
| List and describe the various models available in the API.
|
| Method resolution order:
| Models
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| delete(self, model: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ModelDeleted'
| Delete a fine-tuned model.
|
| You must have the Owner role in your organization to
| delete a model.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| list(self, *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'SyncPage[Model]'
| Lists the currently available models, and provides basic information about each
| one such as the owner and availability.
|
| retrieve(self, model: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Model'
| Retrieves a model instance, providing basic information about the model such as
| the owner and permissioning.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ModelsWithRawResponse(builtins.object)
| ModelsWithRawResponse(models: 'Models') -> 'None'
|
| Methods defined here:
|
| __init__(self, models: 'Models') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ModelsWithStreamingResponse(builtins.object)
| ModelsWithStreamingResponse(models: 'Models') -> 'None'
|
| Methods defined here:
|
| __init__(self, models: 'Models') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Moderations(openai._resource.SyncAPIResource)
| Moderations(client: 'OpenAI') -> 'None'
|
| Given text and/or image inputs, classifies if those inputs are potentially harmful.
|
| Method resolution order:
| Moderations
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| create(self, *, input: 'Union[str, SequenceNotStr[str], Iterable[ModerationMultiModalInputParam]]', model: 'Union[str, ModerationModel] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'ModerationCreateResponse'
| Classifies if text and/or image inputs are potentially harmful.
|
| Learn more in
| the [moderation guide](https://platform.openai.com/docs/guides/moderation).
|
| Args:
| input: Input (or inputs) to classify. Can be a single string, an array of strings, or
| an array of multi-modal input objects similar to other models.
|
| model: The content moderation model you would like to use. Learn more in
| [the moderation guide](https://platform.openai.com/docs/guides/moderation), and
| learn about available models
| [here](https://platform.openai.com/docs/models#moderation).
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ModerationsWithRawResponse(builtins.object)
| ModerationsWithRawResponse(moderations: 'Moderations') -> 'None'
|
| Methods defined here:
|
| __init__(self, moderations: 'Moderations') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class ModerationsWithStreamingResponse(builtins.object)
| ModerationsWithStreamingResponse(moderations: 'Moderations') -> 'None'
|
| Methods defined here:
|
| __init__(self, moderations: 'Moderations') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Skills(openai._resource.SyncAPIResource)
| Skills(client: 'OpenAI') -> 'None'
|
| Method resolution order:
| Skills
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| content = <functools.cached_property object>
| create(self, *, files: 'Union[SequenceNotStr[FileTypes], FileTypes] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Skill'
| Create a new skill.
|
| Args:
| files: Skill files to upload (directory upload) or a single zip file.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| delete(self, skill_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'DeletedSkill'
| Delete a skill by its ID.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, order: "Literal['asc', 'desc'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'SyncCursorPage[Skill]'
| List all skills for the current project.
|
| Args:
| after: Identifier for the last item from the previous pagination request
|
| limit: Number of items to retrieve
|
| order: Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
| descending order.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| retrieve(self, skill_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Skill'
| Get a skill by its ID.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| update(self, skill_id: 'str', *, default_version: 'str', extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Skill'
| Update the default version pointer for a skill.
|
| Args:
| default_version: The skill version number to set as default.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| versions = <functools.cached_property object>
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class SkillsWithRawResponse(builtins.object)
| SkillsWithRawResponse(skills: 'Skills') -> 'None'
|
| Methods defined here:
|
| __init__(self, skills: 'Skills') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| content = <functools.cached_property object>
| versions = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class SkillsWithStreamingResponse(builtins.object)
| SkillsWithStreamingResponse(skills: 'Skills') -> 'None'
|
| Methods defined here:
|
| __init__(self, skills: 'Skills') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| content = <functools.cached_property object>
| versions = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Uploads(openai._resource.SyncAPIResource)
| Uploads(client: 'OpenAI') -> 'None'
|
| Use Uploads to upload large files in multiple parts.
|
| Method resolution order:
| Uploads
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| cancel(self, upload_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Upload'
| Cancels the Upload.
|
| No Parts may be added after an Upload is cancelled.
|
| Returns the Upload object with status `cancelled`.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| complete(self, upload_id: 'str', *, part_ids: 'SequenceNotStr[str]', md5: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Upload'
| Completes the
| [Upload](https://platform.openai.com/docs/api-reference/uploads/object).
|
| Within the returned Upload object, there is a nested
| [File](https://platform.openai.com/docs/api-reference/files/object) object that
| is ready to use in the rest of the platform.
|
| You can specify the order of the Parts by passing in an ordered list of the Part
| IDs.
|
| The number of bytes uploaded upon completion must match the number of bytes
| initially specified when creating the Upload object. No Parts may be added after
| an Upload is completed. Returns the Upload object with status `completed`,
| including an additional `file` property containing the created usable File
| object.
|
| Args:
| part_ids: The ordered list of Part IDs.
|
| md5: The optional md5 checksum for the file contents to verify if the bytes uploaded
| matches what you expect.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| create(self, *, bytes: 'int', filename: 'str', mime_type: 'str', purpose: 'FilePurpose', expires_after: 'upload_create_params.ExpiresAfter | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Upload'
| Creates an intermediate
| [Upload](https://platform.openai.com/docs/api-reference/uploads/object) object
| that you can add
| [Parts](https://platform.openai.com/docs/api-reference/uploads/part-object) to.
| Currently, an Upload can accept at most 8 GB in total and expires after an hour
| after you create it.
|
| Once you complete the Upload, we will create a
| [File](https://platform.openai.com/docs/api-reference/files/object) object that
| contains all the parts you uploaded. This File is usable in the rest of our
| platform as a regular File object.
|
| For certain `purpose` values, the correct `mime_type` must be specified. Please
| refer to documentation for the
| [supported MIME types for your use case](https://platform.openai.com/docs/assistants/tools/file-search#supported-files).
|
| For guidance on the proper filename extensions for each purpose, please follow
| the documentation on
| [creating a File](https://platform.openai.com/docs/api-reference/files/create).
|
| Returns the Upload object with status `pending`.
|
| Args:
| bytes: The number of bytes in the file you are uploading.
|
| filename: The name of the file to upload.
|
| mime_type: The MIME type of the file.
|
| This must fall within the supported MIME types for your file purpose. See the
| supported MIME types for assistants and vision.
|
| purpose: The intended purpose of the uploaded file.
|
| See the
| [documentation on File purposes](https://platform.openai.com/docs/api-reference/files/create#files-create-purpose).
|
| expires_after: The expiration policy for a file. By default, files with `purpose=batch` expire
| after 30 days and all other files are persisted until they are manually deleted.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| parts = <functools.cached_property object>
| Use Uploads to upload large files in multiple parts.
|
| upload_file_chunked(self, *, file: 'os.PathLike[str] | bytes', mime_type: 'str', purpose: 'FilePurpose', filename: 'str | None' = None, bytes: 'int | None' = None, part_size: 'int | None' = None, md5: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>) -> 'Upload'
| Splits the given file into multiple parts and uploads them sequentially.
|
| ```py
| from pathlib import Path
|
| client.uploads.upload_file(
| file=Path("my-paper.pdf"),
| mime_type="pdf",
| purpose="assistants",
| )
| ```
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class UploadsWithRawResponse(builtins.object)
| UploadsWithRawResponse(uploads: 'Uploads') -> 'None'
|
| Methods defined here:
|
| __init__(self, uploads: 'Uploads') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| parts = <functools.cached_property object>
| Use Uploads to upload large files in multiple parts.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class UploadsWithStreamingResponse(builtins.object)
| UploadsWithStreamingResponse(uploads: 'Uploads') -> 'None'
|
| Methods defined here:
|
| __init__(self, uploads: 'Uploads') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| parts = <functools.cached_property object>
| Use Uploads to upload large files in multiple parts.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class VectorStores(openai._resource.SyncAPIResource)
| VectorStores(client: 'OpenAI') -> 'None'
|
| Method resolution order:
| VectorStores
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| create(self, *, chunking_strategy: 'FileChunkingStrategyParam | Omit' = <openai.Omit object at 0x0000024AD46B0530>, description: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, expires_after: 'vector_store_create_params.ExpiresAfter | Omit' = <openai.Omit object at 0x0000024AD46B0530>, file_ids: 'SequenceNotStr[str] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, metadata: 'Optional[Metadata] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, name: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VectorStore'
| Create a vector store.
|
| Args:
| chunking_strategy: The chunking strategy used to chunk the file(s). If not set, will use the `auto`
| strategy. Only applicable if `file_ids` is non-empty.
|
| description: A description for the vector store. Can be used to describe the vector store's
| purpose.
|
| expires_after: The expiration policy for a vector store.
|
| file_ids: A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
| the vector store should use. Useful for tools like `file_search` that can access
| files.
|
| metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
| for storing additional information about the object in a structured format, and
| querying for objects via API or the dashboard.
|
| Keys are strings with a maximum length of 64 characters. Values are strings with
| a maximum length of 512 characters.
|
| name: The name of the vector store.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| delete(self, vector_store_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VectorStoreDeleted'
| Delete a vector store.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| file_batches = <functools.cached_property object>
| files = <functools.cached_property object>
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, before: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, order: "Literal['asc', 'desc'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'SyncCursorPage[VectorStore]'
| Returns a list of vector stores.
|
| Args:
| after: A cursor for use in pagination.
|
| `after` is an object ID that defines your place
| in the list. For instance, if you make a list request and receive 100 objects,
| ending with obj_foo, your subsequent call can include after=obj_foo in order to
| fetch the next page of the list.
|
| before: A cursor for use in pagination. `before` is an object ID that defines your place
| in the list. For instance, if you make a list request and receive 100 objects,
| starting with obj_foo, your subsequent call can include before=obj_foo in order
| to fetch the previous page of the list.
|
| limit: A limit on the number of objects to be returned. Limit can range between 1 and
| 100, and the default is 20.
|
| order: Sort order by the `created_at` timestamp of the objects. `asc` for ascending
| order and `desc` for descending order.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| retrieve(self, vector_store_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VectorStore'
| Retrieves a vector store.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| search(self, vector_store_id: 'str', *, query: 'Union[str, SequenceNotStr[str]]', filters: 'vector_store_search_params.Filters | Omit' = <openai.Omit object at 0x0000024AD46B0530>, max_num_results: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, ranking_options: 'vector_store_search_params.RankingOptions | Omit' = <openai.Omit object at 0x0000024AD46B0530>, rewrite_query: 'bool | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'SyncPage[VectorStoreSearchResponse]'
| Search a vector store for relevant chunks based on a query and file attributes
| filter.
|
| Args:
| query: A query string for a search
|
| filters: A filter to apply based on file attributes.
|
| max_num_results: The maximum number of results to return. This number should be between 1 and 50
| inclusive.
|
| ranking_options: Ranking options for search.
|
| rewrite_query: Whether to rewrite the natural language query for vector search.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| update(self, vector_store_id: 'str', *, expires_after: 'Optional[vector_store_update_params.ExpiresAfter] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, metadata: 'Optional[Metadata] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, name: 'Optional[str] | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VectorStore'
| Modifies a vector store.
|
| Args:
| expires_after: The expiration policy for a vector store.
|
| metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
| for storing additional information about the object in a structured format, and
| querying for objects via API or the dashboard.
|
| Keys are strings with a maximum length of 64 characters. Values are strings with
| a maximum length of 512 characters.
|
| name: The name of the vector store.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class VectorStoresWithRawResponse(builtins.object)
| VectorStoresWithRawResponse(vector_stores: 'VectorStores') -> 'None'
|
| Methods defined here:
|
| __init__(self, vector_stores: 'VectorStores') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| file_batches = <functools.cached_property object>
| files = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class VectorStoresWithStreamingResponse(builtins.object)
| VectorStoresWithStreamingResponse(vector_stores: 'VectorStores') -> 'None'
|
| Methods defined here:
|
| __init__(self, vector_stores: 'VectorStores') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| file_batches = <functools.cached_property object>
| files = <functools.cached_property object>
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class Videos(openai._resource.SyncAPIResource)
| Videos(client: 'OpenAI') -> 'None'
|
| Method resolution order:
| Videos
| openai._resource.SyncAPIResource
| builtins.object
|
| Methods defined here:
|
| create(self, *, prompt: 'str', input_reference: 'video_create_params.InputReference | Omit' = <openai.Omit object at 0x0000024AD46B0530>, model: 'VideoModelParam | Omit' = <openai.Omit object at 0x0000024AD46B0530>, seconds: 'VideoSeconds | Omit' = <openai.Omit object at 0x0000024AD46B0530>, size: 'VideoSize | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Video'
| Create a new video generation job from a prompt and optional reference assets.
|
| Args:
| prompt: Text prompt that describes the video to generate.
|
| input_reference: Optional reference asset upload or reference object that guides generation.
|
| model: The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults
| to `sora-2`.
|
| seconds: Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.
|
| size: Output resolution formatted as width x height (allowed values: 720x1280,
| 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| create_and_poll(self, *, prompt: 'str', input_reference: 'video_create_params.InputReference | Omit' = <openai.Omit object at 0x0000024AD46B0530>, model: 'VideoModelParam | Omit' = <openai.Omit object at 0x0000024AD46B0530>, seconds: 'VideoSeconds | Omit' = <openai.Omit object at 0x0000024AD46B0530>, size: 'VideoSize | Omit' = <openai.Omit object at 0x0000024AD46B0530>, poll_interval_ms: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Video'
| Create a video and wait for it to be processed.
|
| create_character(self, *, name: 'str', video: 'FileTypes', extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VideoCreateCharacterResponse'
| Create a character from an uploaded video.
|
| Args:
| name: Display name for this API character.
|
| video: Video file used to create a character.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| delete(self, video_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VideoDeleteResponse'
| Permanently delete a completed or failed video and its stored assets.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| download_content(self, video_id: 'str', *, variant: "Literal['video', 'thumbnail', 'spritesheet'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> '_legacy_response.HttpxBinaryResponseContent'
| Download the generated video bytes or a derived preview asset.
|
| Streams the rendered video content for the specified video job.
|
| Args:
| variant: Which downloadable asset to return. Defaults to the MP4 video.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| edit(self, *, prompt: 'str', video: 'video_edit_params.Video', extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Video'
| Create a new video generation job by editing a source video or existing
| generated video.
|
| Args:
| prompt: Text prompt that describes how to edit the source video.
|
| video: Reference to the completed video to edit.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| extend(self, *, prompt: 'str', seconds: 'VideoSeconds', video: 'video_extend_params.Video', extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Video'
| Create an extension of a completed video.
|
| Args:
| prompt: Updated text prompt that directs the extension generation.
|
| seconds: Length of the newly generated extension segment in seconds (allowed values: 4,
| 8, 12, 16, 20).
|
| video: Reference to the completed video to extend.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| get_character(self, character_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'VideoGetCharacterResponse'
| Fetch a character.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| list(self, *, after: 'str | Omit' = <openai.Omit object at 0x0000024AD46B0530>, limit: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>, order: "Literal['asc', 'desc'] | Omit" = <openai.Omit object at 0x0000024AD46B0530>, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'SyncConversationCursorPage[Video]'
| List recently generated videos for the current project.
|
| Args:
| after: Identifier for the last item from the previous pagination request
|
| limit: Number of items to retrieve
|
| order: Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
| descending order.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| poll(self, video_id: 'str', *, poll_interval_ms: 'int | Omit' = <openai.Omit object at 0x0000024AD46B0530>) -> 'Video'
| Wait for the vector store file to finish processing.
|
| Note: this will return even if the file failed to process, you need to check
| file.last_error and file.status to handle these cases
|
| remix(self, video_id: 'str', *, prompt: 'str', extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Video'
| Create a remix of a completed video using a refreshed prompt.
|
| Args:
| prompt: Updated text prompt that directs the remix generation.
|
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| retrieve(self, video_id: 'str', *, extra_headers: 'Headers | None' = None, extra_query: 'Query | None' = None, extra_body: 'Body | None' = None, timeout: 'float | httpx.Timeout | None | NotGiven' = NOT_GIVEN) -> 'Video'
| Fetch the latest metadata for a generated video.
|
| Args:
| extra_headers: Send extra headers
|
| extra_query: Add additional query parameters to the request
|
| extra_body: Add additional JSON properties to the request
|
| timeout: Override the client-level default timeout for this request, in seconds
|
| with_raw_response = <functools.cached_property object>
| This property can be used as a prefix for any HTTP method call to return
| the raw response object instead of the parsed content.
|
| For more information, see https://www.github.com/openai/openai-python#accessing-raw-response-data-eg-headers
|
| with_streaming_response = <functools.cached_property object>
| An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
| For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from openai._resource.SyncAPIResource:
|
| __init__(self, client: 'OpenAI') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._resource.SyncAPIResource:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class VideosWithRawResponse(builtins.object)
| VideosWithRawResponse(videos: 'Videos') -> 'None'
|
| Methods defined here:
|
| __init__(self, videos: 'Videos') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
class VideosWithStreamingResponse(builtins.object)
| VideosWithStreamingResponse(videos: 'Videos') -> 'None'
|
| Methods defined here:
|
| __init__(self, videos: 'Videos') -> 'None'
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
DATA
__all__ = ['Completions', 'AsyncCompletions', 'CompletionsWithRawRespo...
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openai\resources\__init__.py
openai.responses
Python Library Documentation: ResponsesProxy in module openai._module_client object
class ResponsesProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| ResponsesProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Responses'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Responses...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.skills
Python Library Documentation: SkillsProxy in module openai._module_client object
class SkillsProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| SkillsProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Skills'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Skills')]...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.timeout
Python Library Documentation: Timeout in module openai object class Timeout(builtins.object) | Timeout(timeout: 'TimeoutTypes | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, *, connect: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, read: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, write: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, pool: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>) -> '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' from httpx._config.Timeout | Return self==value. | | __init__(self, timeout: 'TimeoutTypes | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, *, connect: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, read: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, write: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>, pool: 'None | float | UnsetType' = <httpx._config.UnsetType object at 0x0000024AD1872AB0>) -> 'None' from httpx._config.Timeout | Initialize self. See help(type(self)) for accurate signature. | | __repr__(self) -> 'str' from httpx._config.Timeout | Return repr(self). | | as_dict(self) -> 'dict[str, float | None]' from httpx._config.Timeout | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __hash__ = None
openai.types
Python Library Documentation: package openai.types in openai
NAME
openai.types - # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
PACKAGE CONTENTS
admin (package)
audio (package)
audio_model
audio_response_format
auto_file_chunking_strategy_param
batch
batch_create_params
batch_error
batch_list_params
batch_request_counts
batch_usage
beta (package)
chat (package)
chat_model
completion
completion_choice
completion_create_params
completion_usage
container_create_params
container_create_response
container_list_params
container_list_response
container_retrieve_response
containers (package)
content_provenance_check
content_provenance_check_create_params
conversations (package)
create_embedding_response
deleted_skill
embedding
embedding_create_params
embedding_model
eval_create_params
eval_create_response
eval_custom_data_source_config
eval_delete_response
eval_list_params
eval_list_response
eval_retrieve_response
eval_stored_completions_data_source_config
eval_update_params
eval_update_response
evals (package)
file_chunking_strategy
file_chunking_strategy_param
file_content
file_create_params
file_deleted
file_list_params
file_object
file_purpose
fine_tuning (package)
graders (package)
image
image_create_variation_params
image_edit_completed_event
image_edit_params
image_edit_partial_image_event
image_edit_stream_event
image_gen_completed_event
image_gen_partial_image_event
image_gen_stream_event
image_generate_params
image_input_reference_param
image_model
images_response
model
model_deleted
moderation
moderation_create_params
moderation_create_response
moderation_image_url_input_param
moderation_model
moderation_multi_modal_input_param
moderation_text_input_param
other_file_chunking_strategy_object
realtime (package)
responses (package)
shared (package)
shared_params (package)
skill
skill_create_params
skill_list
skill_list_params
skill_update_params
skills (package)
static_file_chunking_strategy
static_file_chunking_strategy_object
static_file_chunking_strategy_object_param
static_file_chunking_strategy_param
upload
upload_complete_params
upload_create_params
uploads (package)
vector_store
vector_store_create_params
vector_store_deleted
vector_store_list_params
vector_store_search_params
vector_store_search_response
vector_store_update_params
vector_stores (package)
video
video_create_character_params
video_create_character_response
video_create_error
video_create_params
video_delete_response
video_download_content_params
video_edit_params
video_extend_params
video_get_character_response
video_list_params
video_model
video_model_param
video_remix_params
video_seconds
video_size
webhooks (package)
websocket_connection_options
websocket_reconnection
DATA
AllModels = typing.Union[str, typing.Literal['gpt-5.6-sol', ...o', 'gp...
AudioModel = typing.Literal['whisper-1', 'gpt-transcribe', 'g...nscrib...
AudioResponseFormat = typing.Literal['json', 'text', 'srt', 'verbose_j...
ChatModel = typing.Literal['gpt-5.6-sol', 'gpt-5.6-terra', '..., 'gpt-...
CompletionCreateParams = typing.Union[openai.types.completion_create_p...
CustomToolInputFormat = typing.Annotated[typing.Union[openai.types.sha...
EmbeddingModel = typing.Literal['text-embedding-ada-002', 'text-embedd...
FileChunkingStrategy = typing.Annotated[typing.Union[openai.types.stat...
FileChunkingStrategyParam = typing.Union[openai.types.auto_file_chunki...
FilePurpose = typing.Literal['assistants', 'batch', 'fine-tune', 'visi...
FunctionParameters = typing.Dict[str, object]
ImageEditParams = typing.Union[openai.types.image_edit_params.Imag...t...
ImageEditStreamEvent = typing.Annotated[typing.Union[openai.types.imag...
ImageGenStreamEvent = typing.Annotated[typing.Union[openai.types.image...
ImageGenerateParams = typing.Union[openai.types.image_generate_params....
ImageModel = typing.Literal['gpt-image-1', 'gpt-image-1-mini'..., 'cha...
Metadata = typing.Dict[str, str]
ModerationModel = typing.Literal['omni-moderation-latest', 'omni-m...e...
ModerationMultiModalInputParam = typing.Union[openai.types.moderation_...
OAuthErrorCode = typing.Union[typing.Literal['invalid_grant', 'invalid...
ReasoningEffort = typing.Optional[typing.Literal['none', 'minimal', 'l...
ResponsesModel = typing.Union[str, typing.Literal['gpt-5.6-sol', ...o'...
VideoModel = typing.Union[str, typing.Literal['sora-2', 'sora...', 'so...
VideoModelParam = typing.Union[str, typing.Literal['sora-2', 'sora...'...
VideoSeconds = typing.Literal['4', '8', '12']
VideoSize = typing.Literal['720x1280', '1280x720', '1024x1792', '1792x...
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openai\types\__init__.py
openai.uploads
Python Library Documentation: UploadsProxy in module openai._module_client object
class UploadsProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| UploadsProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Uploads'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Uploads')...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.vector_stores
Python Library Documentation: VectorStoresProxy in module openai._module_client object
class VectorStoresProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| VectorStoresProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'VectorStores'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('VectorSto...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.version
Python Library Documentation: module openai.version in openai
NAME
openai.version
DATA
VERSION = '2.52.0'
__annotations__ = {'VERSION': <class 'str'>}
VERSION
2.52.0
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openai\version.py
openai.videos
Python Library Documentation: VideosProxy in module openai._module_client object
class VideosProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| VideosProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Videos'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Videos')]...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.
openai.webhook_secret
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
openai.webhooks
Python Library Documentation: WebhooksProxy in module openai._module_client object
class WebhooksProxy(openai._utils._proxy.LazyProxy)
| Method resolution order:
| WebhooksProxy
| openai._utils._proxy.LazyProxy
| typing.Generic
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __load__(self) -> 'Webhooks'
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| __orig_bases__ = (openai._utils._proxy.LazyProxy[ForwardRef('Webhooks'...
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from openai._utils._proxy.LazyProxy:
|
| __as_proxied__(self) -> 'T'
| Helper method that returns the current proxy, typed as the loaded object
|
| __dir__(self) -> 'Iterable[str]'
| Default dir() implementation.
|
| __get_proxied__(self) -> 'T'
|
| __getattr__(self, attr: 'str') -> 'object'
|
| __repr__(self) -> 'str'
| Return repr(self).
|
| __str__(self) -> 'str'
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from openai._utils._proxy.LazyProxy:
|
| __class__
|
| ----------------------------------------------------------------------
| Data descriptors inherited from openai._utils._proxy.LazyProxy:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __class_getitem__(...)
| Parameterizes a generic class.
|
| At least, parameterizing a generic class is the *main* thing this
| method does. For example, for some generic class `Foo`, this is called
| when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
|
| However, note that this method is also called when defining generic
| classes in the first place with `class Foo[T]: ...`.
|
| __init_subclass__(...)
| Function to initialize subclasses.