Upgrading openai 0.28 to 1
Breaking0.28.1 → 1.109.1Breaking8Security1Platform3Deprecated3New103Changed61Fixed151Other345
BreakingUpgrade verdict
8 breaking changes and 3 platform requirement changes and a security fix.
In plain terms
- An API field that was not supported has been removed.
- If you installed the optional audio helpers using the old extra name, you now need to use the new name instead.
- Code that called createAndStream must now call stream instead.
- Some old API endpoints that were already marked deprecated have been removed, so code calling them will stop working.
Must act Top 5 of 15 that need code or config changes
Python requirement changed in 1.54.0: >=3.7.1 → >=3.8.
Adds anyio <5,>=3.5.0, distro <2,>=1.7.0, httpx <1,>=0.23.0, jiter <1,>=0.4.0, pydantic <3,>=1.9.0, sniffio, typing-extensions <5,>=4.11.
Drops aiohttp, requests.
Installs 15 packages in all (was 14).
What you must change
Breaking8
Removes an unsupported API property.
Renames the audio extra to voice_helpers.
voice_helpersRenames createAndStream to stream.
createAndStreamstreamRemoves deprecated API endpoints.
Renames FunctionObject to FunctionDefinition.
FunctionObjectFunctionDefinitionSimplifies client cleanup, requiring OpenTelemetry instrumentation to run before openai is imported.
openaiCorrects broken type names in moderation categories, which is a breaking change.
Releases a new major version of the openai package with breaking changes and a migration guide.
Security1
Redacts sensitive headers in logs.
Platform3
Marks Python 3.13 as supported.
Drops support for Python 3.7.
Bumps minimum typing-extensions to 4.7.
typing-extensionsDeprecations to plan for
Deprecated3
Marks some API methods as deprecated.
Deprecates the Assistants API.
Assistants APIDeprecates files.retrieve_content in favour of files.content.
files.retrieve_contentfiles.contentAPI changes
Generated by DepDelta from published Python source. Not mixed with prose notes.
- removed:
export Audio - removed:
export ChatCompletion - removed:
export Completion - removed:
export Customer - removed:
export Deployment - removed:
export Edit - removed:
export Embedding - removed:
export Engine - removed:
export ErrorObject - removed:
export File - removed:
export FineTune - removed:
export FineTuningJob - removed:
export Image - removed:
export InvalidRequestError - removed:
export Model - removed:
export Moderation - removed:
variable api_base - removed:
variable api_key - removed:
variable api_key_path: Optional[str] - removed:
variable api_type - removed:
variable api_version - removed:
variable app_info - removed:
variable ca_bundle_path - removed:
variable debug - removed:
variable enable_telemetry - removed:
variable log - removed:
variable organization - removed:
variable proxy - removed:
variable verify_ssl_certs - added:
export APIConnectionError - added:
export APIResponseValidationError - added:
export APIStatusError - added:
export APITimeoutError - added:
export AsyncClient - added:
export AsyncOpenAI - added:
export AsyncStream - added:
export AuthenticationError - added:
export BadRequestError - added:
export BaseModel - added:
export Client - added:
export ConflictError - added:
export ContentFilterFinishReasonError - added:
export DEFAULT_CONNECTION_LIMITS - added:
export DEFAULT_MAX_RETRIES - added:
export DEFAULT_TIMEOUT - added:
export DefaultAioHttpClient - added:
export DefaultAsyncHttpxClient - added:
export DefaultHttpxClient - added:
export InternalServerError - added:
export InvalidWebhookSignatureError - added:
export LengthFinishReasonError - added:
export NOT_GIVEN - added:
export NoneType - added:
export NotFoundError - added:
export NotGiven - added:
export Omit - added:
export OpenAI - added:
export PermissionDeniedError - added:
export ProxiesTypes - added:
export RateLimitError - added:
export RequestOptions - added:
export Stream - added:
export Timeout - added:
export Transport - added:
export UnprocessableEntityError - added:
export __title__ - added:
export __version__ - added:
export file_from_path - added:
export not_given - added:
export omit - added:
export types
- removed:
async function parse_stream_async(rbody: aiohttp.StreamReader) - removed:
async method APIRequestor.arequest(method, url, params, headers, files, stream: Literal[True], request_id: Optional[str]=…, request_timeout: Optional[Union[float, Tuple[float, float]]]=…) -> Tuple[AsyncGenerator[OpenAIResponse, None], bool, str] | (method, url, params=…, headers=…, files=…, *, stream: Literal[True], request_id: Optional[str]=…, request_timeout: Optional[Union[float, Tuple[float,… - removed:
async method APIRequestor.arequest_raw(method, url, session, *, params=…, supplied_headers: Optional[Dict[str, str]]=…, files=…, request_id: Optional[str]=…, request_timeout: Optional[Union[float, Tuple[float, float]]]=…) -> aiohttp.ClientResponse - removed:
class APIRequestor - removed:
class AioHTTPSession(AsyncContextManager) - removed:
constructor APIRequestor(key=…, api_base=…, api_type=…, api_version=…, organization=…) - removed:
constructor AioHTTPSession() - removed:
function parse_stream(rbody: Iterator[bytes]) -> Iterator[str] - removed:
function parse_stream_helper(line: bytes) -> Optional[str] - removed:
method APIRequestor.handle_error_response(rbody, rcode, resp, rheaders, stream_error=…) - removed:
method APIRequestor.request(method, url, params, headers, files, stream: Literal[True], request_id: Optional[str]=…, request_timeout: Optional[Union[float, Tuple[float, float]]]=…) -> Tuple[Iterator[OpenAIResponse], bool, str] | (method, url, params=…, headers=…, files=…, *, stream: Literal[True], request_id: Optional[str]=…, request_timeout: Optional[Union[float, Tuple[float, float]]]=…) -> Tupl… - removed:
method APIRequestor.request_headers(method: str, extra, request_id: Optional[str]) -> Dict[str, str] - removed:
method APIRequestor.request_raw(method, url, *, params=…, supplied_headers: Optional[Dict[str, str]]=…, files=…, stream: bool=…, request_id: Optional[str]=…, request_timeout: Optional[Union[float, Tuple[float, float]]]=…) -> requests.Response - removed:
static method APIRequestor.format_app_info(info) - removed:
variable MAX_CONNECTION_RETRIES - removed:
variable MAX_SESSION_LIFETIME_SECS - removed:
variable TIMEOUT_SECS
- removed:
export Audio - removed:
export ChatCompletion - removed:
export Completion - removed:
export Customer - removed:
export Deployment - removed:
export Edit - removed:
export Embedding - removed:
export Engine - removed:
export ErrorObject - removed:
export File - removed:
export FineTune - removed:
export FineTuningJob - removed:
export Image - removed:
export Model - removed:
export Moderation
- removed:
export APIResource - removed:
export CreateableAPIResource - removed:
export DeletableAPIResource - removed:
export ListableAPIResource - removed:
export PaginatableAPIResource - removed:
export UpdateableAPIResource - removed:
export nested_resource_class_methods
- removed:
async method APIResource.arefresh(request_id=…, request_timeout=…) - removed:
class APIResource(OpenAIObject) - removed:
field APIResource.api_prefix - removed:
field APIResource.azure_api_prefix - removed:
field APIResource.azure_deployments_prefix - removed:
method APIResource.instance_url(operation=…) - removed:
method APIResource.refresh(request_id=…, request_timeout=…) - removed:
static method APIResource.aretrieve(id, api_key=…, request_id=…, request_timeout=…, **params) - removed:
static method APIResource.class_url() - removed:
static method APIResource.retrieve(id, api_key=…, request_id=…, request_timeout=…, **params)
- removed:
async static method CreateableAPIResource.acreate(api_key=…, api_base=…, api_type=…, request_id=…, api_version=…, organization=…, **params) - removed:
class CreateableAPIResource(APIResource) - removed:
field CreateableAPIResource.plain_old_data - removed:
static method CreateableAPIResource.create(api_key=…, api_base=…, api_type=…, request_id=…, api_version=…, organization=…, **params)
- removed:
class DeletableAPIResource(APIResource) - removed:
static method DeletableAPIResource.adelete(sid, api_type=…, api_version=…, **params) -> Awaitable - removed:
static method DeletableAPIResource.delete(sid, api_type=…, api_version=…, **params)
- removed:
async method EngineAPIResource.await_(timeout=…) - removed:
async static method EngineAPIResource.acreate(api_key=…, api_base=…, api_type=…, request_id=…, api_version=…, organization=…, **params) - removed:
class EngineAPIResource(APIResource) - removed:
constructor EngineAPIResource(engine: Optional[str]=…, **kwargs) - removed:
field EngineAPIResource.plain_old_data - removed:
method EngineAPIResource.instance_url() - removed:
method EngineAPIResource.wait(timeout=…) - removed:
static method EngineAPIResource.class_url(engine: Optional[str]=…, api_type: Optional[str]=…, api_version: Optional[str]=…) - removed:
static method EngineAPIResource.create(api_key=…, api_base=…, api_type=…, request_id=…, api_version=…, organization=…, **params) - removed:
variable MAX_TIMEOUT
- removed:
async static method ListableAPIResource.alist(api_key=…, request_id=…, api_version=…, organization=…, api_base=…, api_type=…, **params) - removed:
class ListableAPIResource(APIResource) - removed:
static method ListableAPIResource.auto_paging_iter(*args, **params) - removed:
static method ListableAPIResource.list(api_key=…, request_id=…, api_version=…, organization=…, api_base=…, api_type=…, **params)
- removed:
function anested_resource_class_methods(resource, path=…, operations=…, resource_plural=…) - removed:
function nested_resource_class_methods(resource, path=…, operations=…, resource_plural=…)
- removed:
async static method PaginatableAPIResource.alist(limit=…, starting_after=…, api_key=…, request_id=…, api_version=…, organization=…, api_base=…, api_type=…, **params) - removed:
class PaginatableAPIResource(ListableAPIResource) - removed:
static method PaginatableAPIResource.auto_paging_iter(*args, **params) - removed:
static method PaginatableAPIResource.list(limit=…, starting_after=…, api_key=…, request_id=…, api_version=…, organization=…, api_base=…, api_type=…, **params)
- removed:
class UpdateableAPIResource(APIResource) - removed:
static method UpdateableAPIResource.amodify(sid, **params) -> Awaitable - removed:
static method UpdateableAPIResource.modify(sid, **params)
- removed:
async static method Audio.atranscribe(model, file, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, *, deployment_id=…, **params) - removed:
async static method Audio.atranscribe_raw(model, file, filename, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, *, deployment_id=…, **params) - removed:
async static method Audio.atranslate(model, file, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, *, deployment_id=…, **params) - removed:
async static method Audio.atranslate_raw(model, file, filename, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, *, deployment_id=…, **params) - removed:
class Audio(APIResource) - removed:
field Audio.OBJECT_NAME - removed:
static method Audio.transcribe(model, file, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, *, deployment_id=…, **params) - removed:
static method Audio.transcribe_raw(model, file, filename, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, *, deployment_id=…, **params) - removed:
static method Audio.translate(model, file, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, *, deployment_id=…, **params) - removed:
static method Audio.translate_raw(model, file, filename, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, *, deployment_id=…, **params)
- removed:
async static method ChatCompletion.acreate(*args, **kwargs) - removed:
class ChatCompletion(EngineAPIResource) - removed:
field ChatCompletion.OBJECT_NAME - removed:
field ChatCompletion.engine_required - removed:
static method ChatCompletion.create(*args, **kwargs)
- removed:
async static method Completion.acreate(*args, **kwargs) - removed:
class Completion(EngineAPIResource) - removed:
field Completion.OBJECT_NAME - removed:
static method Completion.create(*args, **kwargs)
- removed:
class Customer(OpenAIObject) - removed:
static method Customer.acreate(customer, endpoint, **params) - removed:
static method Customer.create(customer, endpoint, **params) - removed:
static method Customer.get_url(customer, endpoint)
- removed:
class Deployment(CreateableAPIResource, ListableAPIResource, DeletableAPIResource) - removed:
field Deployment.OBJECT_NAME - removed:
static method Deployment.acreate(*args, **kwargs) - removed:
static method Deployment.adelete(*args, **kwargs) - removed:
static method Deployment.alist(*args, **kwargs) - removed:
static method Deployment.aretrieve(*args, **kwargs) - removed:
static method Deployment.create(*args, **kwargs) - removed:
static method Deployment.delete(*args, **kwargs) - removed:
static method Deployment.list(*args, **kwargs) - removed:
static method Deployment.retrieve(*args, **kwargs)
- removed:
async static method Edit.acreate(*args, **kwargs) - removed:
class Edit(EngineAPIResource) - removed:
field Edit.OBJECT_NAME - removed:
static method Edit.create(*args, **kwargs)
- removed:
async static method Embedding.acreate(*args, **kwargs) - removed:
class Embedding(EngineAPIResource) - removed:
field Embedding.OBJECT_NAME - removed:
static method Embedding.create(*args, **kwargs)
- removed:
async method Engine.agenerate(timeout=…, **params) - removed:
class Engine(ListableAPIResource, UpdateableAPIResource) - removed:
field Engine.OBJECT_NAME - removed:
method Engine.embeddings(**params) - removed:
method Engine.generate(timeout=…, **params)
- removed:
class ErrorObject(OpenAIObject) - removed:
method ErrorObject.refresh_from(values, api_key=…, api_version=…, api_type=…, organization=…, response_ms: Optional[int]=…)
- removed:
export CompletionConfig
- removed:
class CompletionConfig(CreateableAPIResource, ListableAPIResource, DeletableAPIResource) - removed:
field CompletionConfig.OBJECT_NAME
- removed:
async static method File.acreate(file, purpose, model=…, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, user_provided_filename=…) - removed:
async static method File.adownload(id, api_key=…, api_base=…, api_type=…, api_version=…, organization=…) - removed:
async static method File.afind_matching_files(name, bytes, purpose, api_key=…, api_base=…, api_type=…, api_version=…, organization=…) - removed:
class File(ListableAPIResource, DeletableAPIResource) - removed:
field File.OBJECT_NAME - removed:
static method File.create(file, purpose, model=…, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, user_provided_filename=…) - removed:
static method File.download(id, api_key=…, api_base=…, api_type=…, api_version=…, organization=…) - removed:
static method File.find_matching_files(name, bytes, purpose, api_key=…, api_base=…, api_type=…, api_version=…, organization=…) - removed:
static method File.wait_for_processing(id, max_wait_seconds=…)
- removed:
async static method FineTune.astream_events(id, api_key=…, api_base=…, api_type=…, request_id=…, api_version=…, organization=…, **params) - removed:
class FineTune(ListableAPIResource, CreateableAPIResource, DeletableAPIResource) - removed:
field FineTune.OBJECT_NAME - removed:
static method FineTune.acancel(id, api_key=…, api_type=…, request_id=…, api_version=…, **params) - removed:
static method FineTune.cancel(id, api_key=…, api_type=…, request_id=…, api_version=…, **params) - removed:
static method FineTune.stream_events(id, api_key=…, api_base=…, api_type=…, request_id=…, api_version=…, organization=…, **params)
- removed:
class FineTuningJob(PaginatableAPIResource, CreateableAPIResource, DeletableAPIResource) - removed:
field FineTuningJob.OBJECT_NAME - removed:
static method FineTuningJob.acancel(id, api_key=…, api_type=…, request_id=…, api_version=…, **params) - removed:
static method FineTuningJob.cancel(id, api_key=…, api_type=…, request_id=…, api_version=…, **params)
- removed:
async static method Image.acreate(api_key=…, api_base=…, api_type=…, api_version=…, organization=…, **params) - removed:
async static method Image.acreate_edit(image, mask=…, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, **params) - removed:
async static method Image.acreate_variation(image, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, **params) - removed:
class Image(APIResource) - removed:
field Image.OBJECT_NAME - removed:
static method Image.create(api_key=…, api_base=…, api_type=…, api_version=…, organization=…, **params) - removed:
static method Image.create_edit(image, mask=…, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, **params) - removed:
static method Image.create_variation(image, api_key=…, api_base=…, api_type=…, api_version=…, organization=…, **params)
- removed:
class Model(ListableAPIResource, DeletableAPIResource) - removed:
field Model.OBJECT_NAME
- removed:
class Moderation(OpenAIObject) - removed:
field Moderation.VALID_MODEL_NAMES: List[str] - removed:
static method Moderation.acreate(input: Union[str, List[str]], model: Optional[str]=…, api_key: Optional[str]=…) - removed:
static method Moderation.create(input: Union[str, List[str]], model: Optional[str]=…, api_key: Optional[str]=…) - removed:
static method Moderation.get_url()
- removed:
class Audio - removed:
class ChatCompletion - removed:
class Completion - removed:
class Deployment - removed:
class Engine - removed:
class File - removed:
class FineTune - removed:
class FineTuningJob - removed:
class Image - removed:
class Model - removed:
class WandbLogger - removed:
class bcolors - removed:
field bcolors.BOLD - removed:
field bcolors.ENDC - removed:
field bcolors.FAIL - removed:
field bcolors.HEADER - removed:
field bcolors.OKBLUE - removed:
field bcolors.OKGREEN - removed:
field bcolors.UNDERLINE - removed:
field bcolors.WARNING - removed:
function api_register(parser) - removed:
function display(obj) - removed:
function display_error(e) - removed:
function organization_info(obj) - removed:
function tools_register(parser) - removed:
function wandb_register(parser) - removed:
static method Audio.transcribe(args) - removed:
static method Audio.translate(args) - removed:
static method ChatCompletion.create(args) - removed:
static method Completion.create(args) - removed:
static method Deployment.create(args) - removed:
static method Deployment.delete(args) - removed:
static method Deployment.get(args) - removed:
static method Deployment.list(args) - removed:
static method Engine.generate(args) - removed:
static method Engine.get(args) - removed:
static method Engine.list(args) - removed:
static method Engine.update(args) - removed:
static method File.create(args) - removed:
static method File.delete(args) - removed:
static method File.get(args) - removed:
static method File.list(args) - removed:
static method FineTune.cancel(args) - removed:
static method FineTune.create(args) - removed:
static method FineTune.delete(args) - removed:
static method FineTune.events(args) - removed:
static method FineTune.follow(args) - removed:
static method FineTune.get(args) - removed:
static method FineTune.list(args) - removed:
static method FineTune.prepare_data(args) - removed:
static method FineTune.results(args) - removed:
static method FineTuningJob.cancel(args) - removed:
static method FineTuningJob.create(args) - removed:
static method FineTuningJob.events(args) - removed:
static method FineTuningJob.follow(args) - removed:
static method FineTuningJob.get(args) - removed:
static method FineTuningJob.list(args) - removed:
static method FineTuningJob.results(args) - removed:
static method Image.create(args) - removed:
static method Image.create_edit(args) - removed:
static method Image.create_variation(args) - removed:
static method Model.delete(args) - removed:
static method Model.get(args) - removed:
static method Model.list(args) - removed:
static method WandbLogger.sync(args) - added:
export main
- removed:
class MissingDependencyError(Exception) - removed:
variable INSTRUCTIONS - removed:
variable NUMPY_INSTRUCTIONS
- removed:
function assert_has_numpy() - removed:
variable HAS_NUMPY - removed:
variable NUMPY_INSTRUCTIONS - removed:
variable numpy
- removed:
function assert_has_pandas() - removed:
variable HAS_PANDAS - removed:
variable PANDAS_INSTRUCTIONS - removed:
variable pandas
- removed:
async function aget_embedding(text: str, engine=…, **kwargs) -> List[float] - removed:
async function aget_embeddings(list_of_text: List[str], engine=…, **kwargs) -> List[List[float]] - removed:
function chart_from_components(components: np.ndarray, labels: Optional[List[str]]=…, strings: Optional[List[str]]=…, x_title=…, y_title=…, mark_size=…, **kwargs) - removed:
function chart_from_components_3D(components: np.ndarray, labels: Optional[List[str]]=…, strings: Optional[List[str]]=…, x_title: str=…, y_title: str=…, z_title: str=…, mark_size: int=…, **kwargs) - removed:
function cosine_similarity(a, b) - removed:
function distances_from_embeddings(query_embedding: List[float], embeddings: List[List[float]], distance_metric=…) -> List[List] - removed:
function get_embedding(text: str, engine=…, **kwargs) -> List[float] - removed:
function get_embeddings(list_of_text: List[str], engine=…, **kwargs) -> List[List[float]] - removed:
function indices_of_nearest_neighbors_from_distances(distances) -> np.ndarray - removed:
function pca_components_from_embeddings(embeddings: List[List[float]], n_components=…) -> np.ndarray - removed:
function plot_multiclass_precision_recall(y_score, y_true_untransformed, class_list, classifier_name) - removed:
function tsne_components_from_embeddings(embeddings: List[List[float]], n_components=…, **kwargs) -> np.ndarray
- removed:
class APIConnectionError(OpenAIError) - removed:
class APIError(OpenAIError) - removed:
class AuthenticationError(OpenAIError) - removed:
class InvalidAPIType(OpenAIError) - removed:
class InvalidRequestError(OpenAIError) - removed:
class OpenAIError(Exception) - removed:
class PermissionError(OpenAIError) - removed:
class RateLimitError(OpenAIError) - removed:
class ServiceUnavailableError(OpenAIError) - removed:
class SignatureVerificationError(OpenAIError) - removed:
class Timeout(OpenAIError) - removed:
class TryAgain(OpenAIError) - removed:
constructor APIConnectionError(message, http_body=…, http_status=…, json_body=…, headers=…, code=…, should_retry=…) - removed:
constructor InvalidRequestError(message, param, code=…, http_body=…, http_status=…, json_body=…, headers=…) - removed:
constructor OpenAIError(message=…, http_body=…, http_status=…, json_body=…, headers=…, code=…) - removed:
constructor SignatureVerificationError(message, sig_header, http_body=…) - removed:
method OpenAIError.construct_error_object() - removed:
property OpenAIError.user_message
- added:
export LocalAudioPlayer - added:
export Microphone
- added:
async method LocalAudioPlayer.play(input: Union[npt.NDArray[np.int16], npt.NDArray[np.float32], _legacy_response.HttpxBinaryResponseContent, AsyncStreamedBinaryAPIResponse, StreamedBinaryAPIResponse]) -> None - added:
async method LocalAudioPlayer.play_stream(buffer_stream: AsyncGenerator[Union[npt.NDArray[np.float32], npt.NDArray[np.int16], None], None]) -> None - added:
class LocalAudioPlayer - added:
constructor LocalAudioPlayer(should_stop: Union[Callable[[], bool], None]=…) - added:
variable SAMPLE_RATE
- added:
async method Microphone.record(return_ndarray: Literal[True]) -> npt.NDArray[DType] | (return_ndarray: Literal[False]) -> FileTypes | (return_ndarray: None=…) -> FileTypes - added:
class Microphone(Generic[DType]) - added:
constructor Microphone(channels: int=…, dtype: Type[DType]=…, should_record: Union[Callable[[], bool], None]=…, timeout: Union[float, None]=…) - added:
variable DType - added:
variable SAMPLE_RATE
- added:
export ResponseFormatT - added:
export pydantic_function_tool
- added:
class AsyncAzureOpenAI(BaseAzureClient[httpx.AsyncClient, AsyncStream[Any]], AsyncOpenAI) - added:
class AzureOpenAI(BaseAzureClient[httpx.Client, Stream[Any]], OpenAI) - added:
class BaseAzureClient(BaseClient[_HttpxClientT, _DefaultStreamT]) - added:
class MutuallyExclusiveAuthError(OpenAIError) - added:
constructor AsyncAzureOpenAI(*, azure_endpoint: str, azure_deployment: str | None=…, api_version: str | None=…, api_key: str | Callable[[], Awaitable[str]] | None=…, azure_ad_token: str | None=…, azure_ad_token_provider: AsyncAzureADTokenProvider | None=…, organization: str | None=…, project: str | None=…, webhook_secret: str | None=…, websocket_base_url: str | httpx.URL | None=…, timeout: float… - added:
constructor AzureOpenAI(*, azure_endpoint: str, azure_deployment: str | None=…, api_version: str | None=…, api_key: str | Callable[[], str] | None=…, azure_ad_token: str | None=…, azure_ad_token_provider: AzureADTokenProvider | None=…, organization: str | None=…, webhook_secret: str | None=…, websocket_base_url: str | httpx.URL | None=…, timeout: float | Timeout | None | NotGiven=…, max_retries:… - added:
constructor MutuallyExclusiveAuthError() -> None - added:
field AsyncAzureOpenAI.with_options - added:
field AzureOpenAI.with_options - added:
method AsyncAzureOpenAI.copy(*, api_key: str | Callable[[], Awaitable[str]] | None=…, organization: str | None=…, project: str | None=…, webhook_secret: str | None=…, websocket_base_url: str | httpx.URL | None=…, api_version: str | None=…, azure_ad_token: str | None=…, azure_ad_token_provider: AsyncAzureADTokenProvider | None=…, base_url: str | httpx.URL | None=…, timeout: float | Timeout | None… - added:
method AzureOpenAI.copy(*, api_key: str | Callable[[], str] | None=…, organization: str | None=…, project: str | None=…, webhook_secret: str | None=…, websocket_base_url: str | httpx.URL | None=…, api_version: str | None=…, azure_ad_token: str | None=…, azure_ad_token_provider: AzureADTokenProvider | None=…, base_url: str | httpx.URL | None=…, timeout: float | Timeout | None | NotGiven=…, http_cl… - added:
variable API_KEY_SENTINEL - added:
variable AsyncAzureADTokenProvider - added:
variable AzureADTokenProvider
- added:
export AssistantEventHandler - added:
export AssistantEventHandlerT - added:
export AssistantStreamManager - added:
export AsyncAssistantEventHandler - added:
export AsyncAssistantEventHandlerT - added:
export AsyncAssistantStreamManager
- added:
export AsyncChatCompletionStream - added:
export AsyncChatCompletionStreamManager - added:
export ChatCompletionStream - added:
export ChatCompletionStreamEvent - added:
export ChatCompletionStreamManager - added:
export ChatCompletionStreamState - added:
export ChunkEvent - added:
export ContentDeltaEvent - added:
export ContentDoneEvent - added:
export FunctionToolCallArgumentsDeltaEvent - added:
export FunctionToolCallArgumentsDoneEvent - added:
export LogprobsContentDeltaEvent - added:
export LogprobsContentDoneEvent - added:
export LogprobsRefusalDeltaEvent - added:
export LogprobsRefusalDoneEvent - added:
export ParsedChatCompletionMessageSnapshot - added:
export ParsedChatCompletionSnapshot - added:
export ParsedChoiceSnapshot - added:
export RefusalDeltaEvent - added:
export RefusalDoneEvent
- added:
export AsyncResponseStream - added:
export AsyncResponseStreamManager - added:
export ResponseFunctionCallArgumentsDeltaEvent - added:
export ResponseStream - added:
export ResponseStreamEvent - added:
export ResponseStreamManager - added:
export ResponseStreamState - added:
export ResponseTextDeltaEvent - added:
export ResponseTextDoneEvent
- removed:
variable OBJECT_CLASSES
- removed:
async method OpenAIObject.arequest(method, url, params=…, headers=…, stream=…, plain_old_data=…, request_id: Optional[str]=…, request_timeout: Optional[Union[float, Tuple[float, float]]]=…) - removed:
class OpenAIObject(dict) - removed:
constructor OpenAIObject(id=…, api_key=…, api_version=…, api_type=…, organization=…, response_ms: Optional[int]=…, api_base=…, engine=…, **params) - removed:
field OpenAIObject.api_base_override - removed:
method OpenAIObject.refresh_from(values, api_key=…, api_version=…, api_type=…, organization=…, response_ms: Optional[int]=…) - removed:
method OpenAIObject.request(method, url, params=…, headers=…, stream=…, plain_old_data=…, request_id: Optional[str]=…, request_timeout: Optional[Union[float, Tuple[float, float]]]=…) - removed:
method OpenAIObject.to_dict() - removed:
method OpenAIObject.to_dict_recursive() - removed:
property OpenAIObject.openai_id - removed:
property OpenAIObject.response_ms -> Optional[int] - removed:
property OpenAIObject.typed_api_type - removed:
static method OpenAIObject.api_base() - removed:
static method OpenAIObject.construct_from(values, api_key: Optional[str]=…, api_version=…, organization=…, engine=…, response_ms: Optional[int]=…)
- removed:
class OpenAIResponse - removed:
constructor OpenAIResponse(data, headers) - removed:
property OpenAIResponse.operation_location -> Optional[str] - removed:
property OpenAIResponse.organization -> Optional[str] - removed:
property OpenAIResponse.request_id -> Optional[str] - removed:
property OpenAIResponse.response_ms -> Optional[int] - removed:
property OpenAIResponse.retry_after -> Optional[int]
- added:
class AsyncConversationCursorPage(BaseAsyncPage[_T], BasePage[_T], Generic[_T]) - added:
class AsyncCursorPage(BaseAsyncPage[_T], BasePage[_T], Generic[_T]) - added:
class AsyncPage(BaseAsyncPage[_T], BasePage[_T], Generic[_T]) - added:
class SyncConversationCursorPage(BaseSyncPage[_T], BasePage[_T], Generic[_T]) - added:
class SyncCursorPage(BaseSyncPage[_T], BasePage[_T], Generic[_T]) - added:
class SyncPage(BaseSyncPage[_T], BasePage[_T], Generic[_T]) - added:
field AsyncConversationCursorPage.data: List[_T] - added:
field AsyncConversationCursorPage.has_more: Optional[bool] - added:
field AsyncConversationCursorPage.last_id: Optional[str] - added:
field AsyncCursorPage.data: List[_T] - added:
field AsyncCursorPage.has_more: Optional[bool] - added:
field AsyncPage.data: List[_T] - added:
field AsyncPage.object: str - added:
field SyncConversationCursorPage.data: List[_T] - added:
field SyncConversationCursorPage.has_more: Optional[bool] - added:
field SyncConversationCursorPage.last_id: Optional[str] - added:
field SyncCursorPage.data: List[_T] - added:
field SyncCursorPage.has_more: Optional[bool] - added:
field SyncPage.data: List[_T] - added:
field SyncPage.object: str - added:
method AsyncConversationCursorPage.has_next_page() -> bool - added:
method AsyncConversationCursorPage.next_page_info() -> Optional[PageInfo] - added:
method AsyncCursorPage.has_next_page() -> bool - added:
method AsyncCursorPage.next_page_info() -> Optional[PageInfo] - added:
method AsyncPage.next_page_info() -> None - added:
method SyncConversationCursorPage.has_next_page() -> bool - added:
method SyncConversationCursorPage.next_page_info() -> Optional[PageInfo] - added:
method SyncCursorPage.has_next_page() -> bool - added:
method SyncCursorPage.next_page_info() -> Optional[PageInfo] - added:
method SyncPage.next_page_info() -> None
- added:
export AsyncAudio - added:
export AsyncAudioWithRawResponse - added:
export AsyncAudioWithStreamingResponse - added:
export AsyncBatches - added:
export AsyncBatchesWithRawResponse - added:
export AsyncBatchesWithStreamingResponse - added:
export AsyncBeta - added:
export AsyncBetaWithRawResponse - added:
export AsyncBetaWithStreamingResponse - added:
export AsyncChat - added:
export AsyncChatWithRawResponse - added:
export AsyncChatWithStreamingResponse - added:
export AsyncCompletions - added:
export AsyncCompletionsWithRawResponse - added:
export AsyncCompletionsWithStreamingResponse - added:
export AsyncContainers - added:
export AsyncContainersWithRawResponse - added:
export AsyncContainersWithStreamingResponse - added:
export AsyncEmbeddings - added:
export AsyncEmbeddingsWithRawResponse - added:
export AsyncEmbeddingsWithStreamingResponse - added:
export AsyncEvals - added:
export AsyncEvalsWithRawResponse - added:
export AsyncEvalsWithStreamingResponse - added:
export AsyncFiles - added:
export AsyncFilesWithRawResponse - added:
export AsyncFilesWithStreamingResponse - added:
export AsyncFineTuning - added:
export AsyncFineTuningWithRawResponse - added:
export AsyncFineTuningWithStreamingResponse - added:
export AsyncImages - added:
export AsyncImagesWithRawResponse - added:
export AsyncImagesWithStreamingResponse - added:
export AsyncModels - added:
export AsyncModelsWithRawResponse - added:
export AsyncModelsWithStreamingResponse - added:
export AsyncModerations - added:
export AsyncModerationsWithRawResponse - added:
export AsyncModerationsWithStreamingResponse - added:
export AsyncUploads - added:
export AsyncUploadsWithRawResponse - added:
export AsyncUploadsWithStreamingResponse - added:
export AsyncVectorStores - added:
export AsyncVectorStoresWithRawResponse - added:
export AsyncVectorStoresWithStreamingResponse - added:
export Audio - added:
export AudioWithRawResponse - added:
export AudioWithStreamingResponse - added:
export Batches - added:
export BatchesWithRawResponse - added:
export BatchesWithStreamingResponse - added:
export Beta - added:
export BetaWithRawResponse - added:
export BetaWithStreamingResponse - added:
export Chat - added:
export ChatWithRawResponse - added:
export ChatWithStreamingResponse - added:
export Completions - added:
export CompletionsWithRawResponse - added:
export CompletionsWithStreamingResponse - added:
export Containers - added:
export ContainersWithRawResponse - added:
export ContainersWithStreamingResponse - added:
export Embeddings - added:
export EmbeddingsWithRawResponse - added:
export EmbeddingsWithStreamingResponse - added:
export Evals - added:
export EvalsWithRawResponse - added:
export EvalsWithStreamingResponse - added:
export Files - added:
export FilesWithRawResponse - added:
export FilesWithStreamingResponse - added:
export FineTuning - added:
export FineTuningWithRawResponse - added:
export FineTuningWithStreamingResponse - added:
export Images - added:
export ImagesWithRawResponse - added:
export ImagesWithStreamingResponse - added:
export Models - added:
export ModelsWithRawResponse - added:
export ModelsWithStreamingResponse - added:
export Moderations - added:
export ModerationsWithRawResponse - added:
export ModerationsWithStreamingResponse - added:
export Uploads - added:
export UploadsWithRawResponse - added:
export UploadsWithStreamingResponse - added:
export VectorStores - added:
export VectorStoresWithRawResponse - added:
export VectorStoresWithStreamingResponse
- added:
export AsyncAudio - added:
export AsyncAudioWithRawResponse - added:
export AsyncAudioWithStreamingResponse - added:
export AsyncSpeech - added:
export AsyncSpeechWithRawResponse - added:
export AsyncSpeechWithStreamingResponse - added:
export AsyncTranscriptions - added:
export AsyncTranscriptionsWithRawResponse - added:
export AsyncTranscriptionsWithStreamingResponse - added:
export AsyncTranslations - added:
export AsyncTranslationsWithRawResponse - added:
export AsyncTranslationsWithStreamingResponse - added:
export Audio - added:
export AudioWithRawResponse - added:
export AudioWithStreamingResponse - added:
export Speech - added:
export SpeechWithRawResponse - added:
export SpeechWithStreamingResponse - added:
export Transcriptions - added:
export TranscriptionsWithRawResponse - added:
export TranscriptionsWithStreamingResponse - added:
export Translations - added:
export TranslationsWithRawResponse - added:
export TranslationsWithStreamingResponse
- added:
class AsyncAudio(AsyncAPIResource) - added:
class Audio(SyncAPIResource) - added:
property AsyncAudio.speech -> AsyncSpeech - added:
property AsyncAudio.transcriptions -> AsyncTranscriptions - added:
property AsyncAudio.translations -> AsyncTranslations - added:
property AsyncAudio.with_raw_response -> AsyncAudioWithRawResponse - added:
property AsyncAudio.with_streaming_response -> AsyncAudioWithStreamingResponse - added:
property Audio.speech -> Speech - added:
property Audio.transcriptions -> Transcriptions - added:
property Audio.translations -> Translations - added:
property Audio.with_raw_response -> AudioWithRawResponse - added:
property Audio.with_streaming_response -> AudioWithStreamingResponse
- added:
async method AsyncSpeech.create(*, input: str, model: Union[str, SpeechModel], voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse', 'marin', 'cedar']], instructions: str | Omit=…, response_format: Literal['mp3', 'opus', 'aac', 'flac', 'wav', 'pcm'] | Omit=…, speed: float | Omit=…, stream_format: Literal['sse', 'audio'] | Omit=…, extra_headers: Headers |… - added:
class AsyncSpeech(AsyncAPIResource) - added:
class Speech(SyncAPIResource) - added:
method Speech.create(*, input: str, model: Union[str, SpeechModel], voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse', 'marin', 'cedar']], instructions: str | Omit=…, response_format: Literal['mp3', 'opus', 'aac', 'flac', 'wav', 'pcm'] | Omit=…, speed: float | Omit=…, stream_format: Literal['sse', 'audio'] | Omit=…, extra_headers: Headers | None=…, ex… - added:
property AsyncSpeech.with_raw_response -> AsyncSpeechWithRawResponse - added:
property AsyncSpeech.with_streaming_response -> AsyncSpeechWithStreamingResponse - added:
property Speech.with_raw_response -> SpeechWithRawResponse - added:
property Speech.with_streaming_response -> SpeechWithStreamingResponse
- added:
async method AsyncTranscriptions.create(*, file: FileTypes, model: Union[str, AudioModel], chunking_strategy: Optional[transcription_create_params.ChunkingStrategy] | Omit=…, include: List[TranscriptionInclude] | Omit=…, language: str | Omit=…, prompt: str | Omit=…, response_format: Union[Literal['json'], Omit]=…, stream: Optional[Literal[False]] | Omit=…, temperature: float | Omit=…, timestamp_g… - added:
class AsyncTranscriptions(AsyncAPIResource) - added:
class Transcriptions(SyncAPIResource) - added:
method Transcriptions.create(*, file: FileTypes, model: Union[str, AudioModel], chunking_strategy: Optional[transcription_create_params.ChunkingStrategy] | Omit=…, include: List[TranscriptionInclude] | Omit=…, response_format: Union[Literal['json'], Omit]=…, language: str | Omit=…, prompt: str | Omit=…, temperature: float | Omit=…, timestamp_granularities: List[Literal['word', 'segment']] | Omit=… - added:
property AsyncTranscriptions.with_raw_response -> AsyncTranscriptionsWithRawResponse - added:
property AsyncTranscriptions.with_streaming_response -> AsyncTranscriptionsWithStreamingResponse - added:
property Transcriptions.with_raw_response -> TranscriptionsWithRawResponse - added:
property Transcriptions.with_streaming_response -> TranscriptionsWithStreamingResponse
- added:
async method AsyncTranslations.create(*, file: FileTypes, model: Union[str, AudioModel], response_format: Union[Literal['json'], Omit]=…, prompt: str | Omit=…, temperature: float | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Translation | (*, file: FileTypes, model: Union[str, AudioModel],… - added:
class AsyncTranslations(AsyncAPIResource) - added:
class Translations(SyncAPIResource) - added:
method Translations.create(*, file: FileTypes, model: Union[str, AudioModel], response_format: Union[Literal['json'], Omit]=…, prompt: str | Omit=…, temperature: float | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Translation | (*, file: FileTypes, model: Union[str, AudioModel], response_fo… - added:
property AsyncTranslations.with_raw_response -> AsyncTranslationsWithRawResponse - added:
property AsyncTranslations.with_streaming_response -> AsyncTranslationsWithStreamingResponse - added:
property Translations.with_raw_response -> TranslationsWithRawResponse - added:
property Translations.with_streaming_response -> TranslationsWithStreamingResponse
- added:
async method AsyncBatches.cancel(batch_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Batch - added:
async method AsyncBatches.create(*, completion_window: Literal['24h'], endpoint: Literal['/v1/responses', '/v1/chat/completions', '/v1/embeddings', '/v1/completions'], input_file_id: str, metadata: Optional[Metadata] | Omit=…, output_expires_after: batch_create_params.OutputExpiresAfter | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: flo… - added:
async method AsyncBatches.retrieve(batch_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Batch - added:
class AsyncBatches(AsyncAPIResource) - added:
class Batches(SyncAPIResource) - added:
method AsyncBatches.list(*, after: str | Omit=…, limit: int | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[Batch, AsyncCursorPage[Batch]] - added:
method Batches.cancel(batch_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Batch - added:
method Batches.create(*, completion_window: Literal['24h'], endpoint: Literal['/v1/responses', '/v1/chat/completions', '/v1/embeddings', '/v1/completions'], input_file_id: str, metadata: Optional[Metadata] | Omit=…, output_expires_after: batch_create_params.OutputExpiresAfter | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.… - added:
method Batches.list(*, after: str | Omit=…, limit: int | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[Batch] - added:
method Batches.retrieve(batch_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Batch - added:
property AsyncBatches.with_raw_response -> AsyncBatchesWithRawResponse - added:
property AsyncBatches.with_streaming_response -> AsyncBatchesWithStreamingResponse - added:
property Batches.with_raw_response -> BatchesWithRawResponse - added:
property Batches.with_streaming_response -> BatchesWithStreamingResponse
- added:
export Assistants - added:
export AssistantsWithRawResponse - added:
export AssistantsWithStreamingResponse - added:
export AsyncAssistants - added:
export AsyncAssistantsWithRawResponse - added:
export AsyncAssistantsWithStreamingResponse - added:
export AsyncBeta - added:
export AsyncBetaWithRawResponse - added:
export AsyncBetaWithStreamingResponse - added:
export AsyncThreads - added:
export AsyncThreadsWithRawResponse - added:
export AsyncThreadsWithStreamingResponse - added:
export Beta - added:
export BetaWithRawResponse - added:
export BetaWithStreamingResponse - added:
export Threads - added:
export ThreadsWithRawResponse - added:
export ThreadsWithStreamingResponse
- added:
async method AsyncAssistants.create(*, model: Union[str, ChatModel], description: Optional[str] | Omit=…, instructions: Optional[str] | Omit=…, metadata: Optional[Metadata] | Omit=…, name: Optional[str] | Omit=…, reasoning_effort: Optional[ReasoningEffort] | Omit=…, response_format: Optional[AssistantResponseFormatOptionParam] | Omit=…, temperature: Optional[float] | Omit=…, tool_resources: Optio… - added:
async method AsyncAssistants.delete(assistant_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AssistantDeleted - added:
async method AsyncAssistants.retrieve(assistant_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Assistant - added:
async method AsyncAssistants.update(assistant_id: str, *, description: Optional[str] | Omit=…, instructions: Optional[str] | Omit=…, metadata: Optional[Metadata] | Omit=…, model: Union[str, Literal['gpt-5', 'gpt-5-mini', 'gpt-5-nano', 'gpt-5-2025-08-07', 'gpt-5-mini-2025-08-07', 'gpt-5-nano-2025-08-07', 'gpt-4.1', 'gpt-4.1-mini', 'gpt-4.1-nano', 'gpt-4.1-2025-04-14', 'gpt-4.1-mini-2025-04-14', 'g… - added:
class Assistants(SyncAPIResource) - added:
class AsyncAssistants(AsyncAPIResource) - added:
method Assistants.create(*, model: Union[str, ChatModel], description: Optional[str] | Omit=…, instructions: Optional[str] | Omit=…, metadata: Optional[Metadata] | Omit=…, name: Optional[str] | Omit=…, reasoning_effort: Optional[ReasoningEffort] | Omit=…, response_format: Optional[AssistantResponseFormatOptionParam] | Omit=…, temperature: Optional[float] | Omit=…, tool_resources: Optional[assista… - added:
method Assistants.delete(assistant_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AssistantDeleted - added:
method Assistants.list(*, after: str | Omit=…, before: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[Assistant] - added:
method Assistants.retrieve(assistant_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Assistant - added:
method Assistants.update(assistant_id: str, *, description: Optional[str] | Omit=…, instructions: Optional[str] | Omit=…, metadata: Optional[Metadata] | Omit=…, model: Union[str, Literal['gpt-5', 'gpt-5-mini', 'gpt-5-nano', 'gpt-5-2025-08-07', 'gpt-5-mini-2025-08-07', 'gpt-5-nano-2025-08-07', 'gpt-4.1', 'gpt-4.1-mini', 'gpt-4.1-nano', 'gpt-4.1-2025-04-14', 'gpt-4.1-mini-2025-04-14', 'gpt-4.1-nano… - added:
method AsyncAssistants.list(*, after: str | Omit=…, before: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[Assistant, AsyncCursorPage[Assistant]] - added:
property Assistants.with_raw_response -> AssistantsWithRawResponse - added:
property Assistants.with_streaming_response -> AssistantsWithStreamingResponse - added:
property AsyncAssistants.with_raw_response -> AsyncAssistantsWithRawResponse - added:
property AsyncAssistants.with_streaming_response -> AsyncAssistantsWithStreamingResponse
- added:
class AsyncBeta(AsyncAPIResource) - added:
class Beta(SyncAPIResource) - added:
property AsyncBeta.assistants -> AsyncAssistants - added:
property AsyncBeta.chat -> AsyncChat - added:
property AsyncBeta.realtime -> AsyncRealtime - added:
property AsyncBeta.threads -> AsyncThreads - added:
property AsyncBeta.with_raw_response -> AsyncBetaWithRawResponse - added:
property AsyncBeta.with_streaming_response -> AsyncBetaWithStreamingResponse - added:
property Beta.assistants -> Assistants - added:
property Beta.chat -> Chat - added:
property Beta.realtime -> Realtime - added:
property Beta.threads -> Threads - added:
property Beta.with_raw_response -> BetaWithRawResponse - added:
property Beta.with_streaming_response -> BetaWithStreamingResponse
- added:
export AsyncRealtime - added:
export AsyncRealtimeWithRawResponse - added:
export AsyncRealtimeWithStreamingResponse - added:
export AsyncSessions - added:
export AsyncSessionsWithRawResponse - added:
export AsyncSessionsWithStreamingResponse - added:
export AsyncTranscriptionSessions - added:
export AsyncTranscriptionSessionsWithRawResponse - added:
export AsyncTranscriptionSessionsWithStreamingResponse - added:
export Realtime - added:
export RealtimeWithRawResponse - added:
export RealtimeWithStreamingResponse - added:
export Sessions - added:
export SessionsWithRawResponse - added:
export SessionsWithStreamingResponse - added:
export TranscriptionSessions - added:
export TranscriptionSessionsWithRawResponse - added:
export TranscriptionSessionsWithStreamingResponse
- added:
class AsyncRealtime(AsyncAPIResource) - added:
class Realtime(SyncAPIResource) - added:
method AsyncRealtime.connect(*, model: str, extra_query: Query=…, extra_headers: Headers=…, websocket_connection_options: WebsocketConnectionOptions=…) -> AsyncRealtimeConnectionManager - added:
method Realtime.connect(*, model: str, extra_query: Query=…, extra_headers: Headers=…, websocket_connection_options: WebsocketConnectionOptions=…) -> RealtimeConnectionManager - added:
property AsyncRealtime.sessions -> AsyncSessions - added:
property AsyncRealtime.transcription_sessions -> AsyncTranscriptionSessions - added:
property AsyncRealtime.with_raw_response -> AsyncRealtimeWithRawResponse - added:
property AsyncRealtime.with_streaming_response -> AsyncRealtimeWithStreamingResponse - added:
property Realtime.sessions -> Sessions - added:
property Realtime.transcription_sessions -> TranscriptionSessions - added:
property Realtime.with_raw_response -> RealtimeWithRawResponse - added:
property Realtime.with_streaming_response -> RealtimeWithStreamingResponse
- added:
async method AsyncSessions.create(*, client_secret: session_create_params.ClientSecret | NotGiven=…, input_audio_format: Literal['pcm16', 'g711_ulaw', 'g711_alaw'] | NotGiven=…, input_audio_noise_reduction: session_create_params.InputAudioNoiseReduction | NotGiven=…, input_audio_transcription: session_create_params.InputAudioTranscription | NotGiven=…, instructions: str | NotGiven=…, max_response… - added:
class AsyncSessions(AsyncAPIResource) - added:
class Sessions(SyncAPIResource) - added:
method Sessions.create(*, client_secret: session_create_params.ClientSecret | NotGiven=…, input_audio_format: Literal['pcm16', 'g711_ulaw', 'g711_alaw'] | NotGiven=…, input_audio_noise_reduction: session_create_params.InputAudioNoiseReduction | NotGiven=…, input_audio_transcription: session_create_params.InputAudioTranscription | NotGiven=…, instructions: str | NotGiven=…, max_response_output_tok… - added:
property AsyncSessions.with_raw_response -> AsyncSessionsWithRawResponse - added:
property AsyncSessions.with_streaming_response -> AsyncSessionsWithStreamingResponse - added:
property Sessions.with_raw_response -> SessionsWithRawResponse - added:
property Sessions.with_streaming_response -> SessionsWithStreamingResponse
- added:
async method AsyncTranscriptionSessions.create(*, client_secret: transcription_session_create_params.ClientSecret | NotGiven=…, include: List[str] | NotGiven=…, input_audio_format: Literal['pcm16', 'g711_ulaw', 'g711_alaw'] | NotGiven=…, input_audio_noise_reduction: transcription_session_create_params.InputAudioNoiseReduction | NotGiven=…, input_audio_transcription: transcription_session_create_p… - added:
class AsyncTranscriptionSessions(AsyncAPIResource) - added:
class TranscriptionSessions(SyncAPIResource) - added:
method TranscriptionSessions.create(*, client_secret: transcription_session_create_params.ClientSecret | NotGiven=…, include: List[str] | NotGiven=…, input_audio_format: Literal['pcm16', 'g711_ulaw', 'g711_alaw'] | NotGiven=…, input_audio_noise_reduction: transcription_session_create_params.InputAudioNoiseReduction | NotGiven=…, input_audio_transcription: transcription_session_create_params.Input… - added:
property AsyncTranscriptionSessions.with_raw_response -> AsyncTranscriptionSessionsWithRawResponse - added:
property AsyncTranscriptionSessions.with_streaming_response -> AsyncTranscriptionSessionsWithStreamingResponse - added:
property TranscriptionSessions.with_raw_response -> TranscriptionSessionsWithRawResponse - added:
property TranscriptionSessions.with_streaming_response -> TranscriptionSessionsWithStreamingResponse
- added:
export AsyncMessages - added:
export AsyncMessagesWithRawResponse - added:
export AsyncMessagesWithStreamingResponse - added:
export AsyncRuns - added:
export AsyncRunsWithRawResponse - added:
export AsyncRunsWithStreamingResponse - added:
export AsyncThreads - added:
export AsyncThreadsWithRawResponse - added:
export AsyncThreadsWithStreamingResponse - added:
export Messages - added:
export MessagesWithRawResponse - added:
export MessagesWithStreamingResponse - added:
export Runs - added:
export RunsWithRawResponse - added:
export RunsWithStreamingResponse - added:
export Threads - added:
export ThreadsWithRawResponse - added:
export ThreadsWithStreamingResponse
- added:
async method AsyncMessages.create(thread_id: str, *, content: Union[str, Iterable[MessageContentPartParam]], role: Literal['user', 'assistant'], attachments: Optional[Iterable[message_create_params.Attachment]] | Omit=…, metadata: Optional[Metadata] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…… - added:
async method AsyncMessages.delete(message_id: str, *, thread_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> MessageDeleted - added:
async method AsyncMessages.retrieve(message_id: str, *, thread_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Message - added:
async method AsyncMessages.update(message_id: str, *, thread_id: str, metadata: Optional[Metadata] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Message - added:
class AsyncMessages(AsyncAPIResource) - added:
class Messages(SyncAPIResource) - added:
method AsyncMessages.list(thread_id: str, *, after: str | Omit=…, before: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, run_id: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[Message, AsyncCursorPage[Message]] - added:
method Messages.create(thread_id: str, *, content: Union[str, Iterable[MessageContentPartParam]], role: Literal['user', 'assistant'], attachments: Optional[Iterable[message_create_params.Attachment]] | Omit=…, metadata: Optional[Metadata] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Message - added:
method Messages.delete(message_id: str, *, thread_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> MessageDeleted - added:
method Messages.list(thread_id: str, *, after: str | Omit=…, before: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, run_id: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[Message] - added:
method Messages.retrieve(message_id: str, *, thread_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Message - added:
method Messages.update(message_id: str, *, thread_id: str, metadata: Optional[Metadata] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Message - added:
property AsyncMessages.with_raw_response -> AsyncMessagesWithRawResponse - added:
property AsyncMessages.with_streaming_response -> AsyncMessagesWithStreamingResponse - added:
property Messages.with_raw_response -> MessagesWithRawResponse - added:
property Messages.with_streaming_response -> MessagesWithStreamingResponse
- added:
export AsyncRuns - added:
export AsyncRunsWithRawResponse - added:
export AsyncRunsWithStreamingResponse - added:
export AsyncSteps - added:
export AsyncStepsWithRawResponse - added:
export AsyncStepsWithStreamingResponse - added:
export Runs - added:
export RunsWithRawResponse - added:
export RunsWithStreamingResponse - added:
export Steps - added:
export StepsWithRawResponse - added:
export StepsWithStreamingResponse
- added:
async method AsyncRuns.cancel(run_id: str, *, thread_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Run - added:
async method AsyncRuns.create(thread_id: str, *, assistant_id: str, include: List[RunStepInclude] | Omit=…, additional_instructions: Optional[str] | Omit=…, additional_messages: Optional[Iterable[run_create_params.AdditionalMessage]] | Omit=…, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata… - added:
async method AsyncRuns.create_and_poll(*, assistant_id: str, include: List[RunStepInclude] | Omit=…, additional_instructions: Optional[str] | Omit=…, additional_messages: Optional[Iterable[run_create_params.AdditionalMessage]] | Omit=…, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omi… - added:
async method AsyncRuns.poll(run_id: str, thread_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…, poll_interval_ms: int | Omit=…) -> Run - added:
async method AsyncRuns.retrieve(run_id: str, *, thread_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Run - added:
async method AsyncRuns.submit_tool_outputs(run_id: str, *, thread_id: str, tool_outputs: Iterable[run_submit_tool_outputs_params.ToolOutput], stream: Optional[Literal[False]] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Run | (run_id: str, *, thread_id: str, stream: Literal[True], tool_out… - added:
async method AsyncRuns.submit_tool_outputs_and_poll(*, tool_outputs: Iterable[run_submit_tool_outputs_params.ToolOutput], run_id: str, thread_id: str, poll_interval_ms: int | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Run - added:
async method AsyncRuns.update(run_id: str, *, thread_id: str, metadata: Optional[Metadata] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Run - added:
class AsyncRuns(AsyncAPIResource) - added:
class Runs(SyncAPIResource) - added:
method AsyncRuns.create_and_stream(*, assistant_id: str, additional_instructions: Optional[str] | Omit=…, additional_messages: Optional[Iterable[run_create_params.AdditionalMessage]] | Omit=…, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omit=…, model: Union[str, ChatModel, None] | Om… - added:
method AsyncRuns.list(thread_id: str, *, after: str | Omit=…, before: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[Run, AsyncCursorPage[Run]] - added:
method AsyncRuns.stream(*, assistant_id: str, additional_instructions: Optional[str] | Omit=…, additional_messages: Optional[Iterable[run_create_params.AdditionalMessage]] | Omit=…, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omit=…, model: Union[str, ChatModel, None] | Omit=…, paral… - added:
method AsyncRuns.submit_tool_outputs_stream(*, tool_outputs: Iterable[run_submit_tool_outputs_params.ToolOutput], run_id: str, thread_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncAssistantStreamManager[AsyncAssistantEventHandler] | (*, tool_outputs: Iterable[run_submit_tool_outputs_par… - added:
method Runs.cancel(run_id: str, *, thread_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Run - added:
method Runs.create(thread_id: str, *, assistant_id: str, include: List[RunStepInclude] | Omit=…, additional_instructions: Optional[str] | Omit=…, additional_messages: Optional[Iterable[run_create_params.AdditionalMessage]] | Omit=…, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omit=…,… - added:
method Runs.create_and_poll(*, assistant_id: str, include: List[RunStepInclude] | Omit=…, additional_instructions: Optional[str] | Omit=…, additional_messages: Optional[Iterable[run_create_params.AdditionalMessage]] | Omit=…, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omit=…, model:… - added:
method Runs.create_and_stream(*, assistant_id: str, additional_instructions: Optional[str] | Omit=…, additional_messages: Optional[Iterable[run_create_params.AdditionalMessage]] | Omit=…, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omit=…, model: Union[str, ChatModel, None] | Omit=…,… - added:
method Runs.list(thread_id: str, *, after: str | Omit=…, before: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[Run] - added:
method Runs.poll(run_id: str, thread_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…, poll_interval_ms: int | Omit=…) -> Run - added:
method Runs.retrieve(run_id: str, *, thread_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Run - added:
method Runs.stream(*, assistant_id: str, include: List[RunStepInclude] | Omit=…, additional_instructions: Optional[str] | Omit=…, additional_messages: Optional[Iterable[run_create_params.AdditionalMessage]] | Omit=…, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omit=…, model: Union[st… - added:
method Runs.submit_tool_outputs(run_id: str, *, thread_id: str, tool_outputs: Iterable[run_submit_tool_outputs_params.ToolOutput], stream: Optional[Literal[False]] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Run | (run_id: str, *, thread_id: str, stream: Literal[True], tool_outputs: Itera… - added:
method Runs.submit_tool_outputs_and_poll(*, tool_outputs: Iterable[run_submit_tool_outputs_params.ToolOutput], run_id: str, thread_id: str, poll_interval_ms: int | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Run - added:
method Runs.submit_tool_outputs_stream(*, tool_outputs: Iterable[run_submit_tool_outputs_params.ToolOutput], run_id: str, thread_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AssistantStreamManager[AssistantEventHandler] | (*, tool_outputs: Iterable[run_submit_tool_outputs_params.ToolOutput]… - added:
method Runs.update(run_id: str, *, thread_id: str, metadata: Optional[Metadata] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Run - added:
property AsyncRuns.steps -> AsyncSteps - added:
property AsyncRuns.with_raw_response -> AsyncRunsWithRawResponse - added:
property AsyncRuns.with_streaming_response -> AsyncRunsWithStreamingResponse - added:
property Runs.steps -> Steps - added:
property Runs.with_raw_response -> RunsWithRawResponse - added:
property Runs.with_streaming_response -> RunsWithStreamingResponse
- added:
async method AsyncSteps.retrieve(step_id: str, *, thread_id: str, run_id: str, include: List[RunStepInclude] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> RunStep - added:
class AsyncSteps(AsyncAPIResource) - added:
class Steps(SyncAPIResource) - added:
method AsyncSteps.list(run_id: str, *, thread_id: str, after: str | Omit=…, before: str | Omit=…, include: List[RunStepInclude] | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[RunStep, AsyncCursorPage[RunStep]] - added:
method Steps.list(run_id: str, *, thread_id: str, after: str | Omit=…, before: str | Omit=…, include: List[RunStepInclude] | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[RunStep] - added:
method Steps.retrieve(step_id: str, *, thread_id: str, run_id: str, include: List[RunStepInclude] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> RunStep - added:
property AsyncSteps.with_raw_response -> AsyncStepsWithRawResponse - added:
property AsyncSteps.with_streaming_response -> AsyncStepsWithStreamingResponse - added:
property Steps.with_raw_response -> StepsWithRawResponse - added:
property Steps.with_streaming_response -> StepsWithStreamingResponse
- added:
async method AsyncThreads.create(*, messages: Iterable[thread_create_params.Message] | Omit=…, metadata: Optional[Metadata] | Omit=…, tool_resources: Optional[thread_create_params.ToolResources] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Thread - added:
async method AsyncThreads.create_and_run(*, assistant_id: str, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omit=…, model: Union[str, ChatModel, None] | Omit=…, parallel_tool_calls: bool | Omit=…, response_format: Optional[AssistantResponseFormatOptionParam] | Omit=…, stream: Optional… - added:
async method AsyncThreads.create_and_run_poll(*, assistant_id: str, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omit=…, model: Union[str, ChatModel, None] | Omit=…, parallel_tool_calls: bool | Omit=…, response_format: Optional[AssistantResponseFormatOptionParam] | Omit=…, temperature… - added:
async method AsyncThreads.delete(thread_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ThreadDeleted - added:
async method AsyncThreads.retrieve(thread_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Thread - added:
async method AsyncThreads.update(thread_id: str, *, metadata: Optional[Metadata] | Omit=…, tool_resources: Optional[thread_update_params.ToolResources] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Thread - added:
class AsyncThreads(AsyncAPIResource) - added:
class Threads(SyncAPIResource) - added:
method AsyncThreads.create_and_run_stream(*, assistant_id: str, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omit=…, model: Union[str, ChatModel, None] | Omit=…, parallel_tool_calls: bool | Omit=…, response_format: Optional[AssistantResponseFormatOptionParam] | Omit=…, temperature: Op… - added:
method Threads.create(*, messages: Iterable[thread_create_params.Message] | Omit=…, metadata: Optional[Metadata] | Omit=…, tool_resources: Optional[thread_create_params.ToolResources] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Thread - added:
method Threads.create_and_run(*, assistant_id: str, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omit=…, model: Union[str, ChatModel, None] | Omit=…, parallel_tool_calls: bool | Omit=…, response_format: Optional[AssistantResponseFormatOptionParam] | Omit=…, stream: Optional[Literal[Fa… - added:
method Threads.create_and_run_poll(*, assistant_id: str, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omit=…, model: Union[str, ChatModel, None] | Omit=…, parallel_tool_calls: bool | Omit=…, response_format: Optional[AssistantResponseFormatOptionParam] | Omit=…, temperature: Optional[… - added:
method Threads.create_and_run_stream(*, assistant_id: str, instructions: Optional[str] | Omit=…, max_completion_tokens: Optional[int] | Omit=…, max_prompt_tokens: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omit=…, model: Union[str, ChatModel, None] | Omit=…, parallel_tool_calls: bool | Omit=…, response_format: Optional[AssistantResponseFormatOptionParam] | Omit=…, temperature: Optiona… - added:
method Threads.delete(thread_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ThreadDeleted - added:
method Threads.retrieve(thread_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Thread - added:
method Threads.update(thread_id: str, *, metadata: Optional[Metadata] | Omit=…, tool_resources: Optional[thread_update_params.ToolResources] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Thread - added:
property AsyncThreads.messages -> AsyncMessages - added:
property AsyncThreads.runs -> AsyncRuns - added:
property AsyncThreads.with_raw_response -> AsyncThreadsWithRawResponse - added:
property AsyncThreads.with_streaming_response -> AsyncThreadsWithStreamingResponse - added:
property Threads.messages -> Messages - added:
property Threads.runs -> Runs - added:
property Threads.with_raw_response -> ThreadsWithRawResponse - added:
property Threads.with_streaming_response -> ThreadsWithStreamingResponse
- added:
export AsyncChat - added:
export AsyncChatWithRawResponse - added:
export AsyncChatWithStreamingResponse - added:
export AsyncCompletions - added:
export AsyncCompletionsWithRawResponse - added:
export AsyncCompletionsWithStreamingResponse - added:
export Chat - added:
export ChatWithRawResponse - added:
export ChatWithStreamingResponse - added:
export Completions - added:
export CompletionsWithRawResponse - added:
export CompletionsWithStreamingResponse
- added:
class AsyncChat(AsyncAPIResource) - added:
class Chat(SyncAPIResource) - added:
property AsyncChat.completions -> AsyncCompletions - added:
property AsyncChat.with_raw_response -> AsyncChatWithRawResponse - added:
property AsyncChat.with_streaming_response -> AsyncChatWithStreamingResponse - added:
property Chat.completions -> Completions - added:
property Chat.with_raw_response -> ChatWithRawResponse - added:
property Chat.with_streaming_response -> ChatWithStreamingResponse
- added:
export AsyncCompletions - added:
export AsyncCompletionsWithRawResponse - added:
export AsyncCompletionsWithStreamingResponse - added:
export AsyncMessages - added:
export AsyncMessagesWithRawResponse - added:
export AsyncMessagesWithStreamingResponse - added:
export Completions - added:
export CompletionsWithRawResponse - added:
export CompletionsWithStreamingResponse - added:
export Messages - added:
export MessagesWithRawResponse - added:
export MessagesWithStreamingResponse
- added:
async method AsyncCompletions.create(*, messages: Iterable[ChatCompletionMessageParam], model: Union[str, ChatModel], audio: Optional[ChatCompletionAudioParam] | Omit=…, frequency_penalty: Optional[float] | Omit=…, function_call: completion_create_params.FunctionCall | Omit=…, functions: Iterable[completion_create_params.Function] | Omit=…, logit_bias: Optional[Dict[str, int]] | Omit=…, logprobs:… - added:
async method AsyncCompletions.delete(completion_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ChatCompletionDeleted - added:
async method AsyncCompletions.parse(*, messages: Iterable[ChatCompletionMessageParam], model: Union[str, ChatModel], audio: Optional[ChatCompletionAudioParam] | Omit=…, response_format: type[ResponseFormatT] | Omit=…, frequency_penalty: Optional[float] | Omit=…, function_call: completion_create_params.FunctionCall | Omit=…, functions: Iterable[completion_create_params.Function] | Omit=…, logit_bi… - added:
async method AsyncCompletions.retrieve(completion_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ChatCompletion - added:
async method AsyncCompletions.update(completion_id: str, *, metadata: Optional[Metadata], extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ChatCompletion - added:
class AsyncCompletions(AsyncAPIResource) - added:
class Completions(SyncAPIResource) - added:
method AsyncCompletions.list(*, after: str | Omit=…, limit: int | Omit=…, metadata: Optional[Metadata] | Omit=…, model: str | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[ChatCompletion, AsyncCursorPage[ChatCompletion]] - added:
method AsyncCompletions.stream(*, messages: Iterable[ChatCompletionMessageParam], model: Union[str, ChatModel], audio: Optional[ChatCompletionAudioParam] | Omit=…, response_format: completion_create_params.ResponseFormat | type[ResponseFormatT] | Omit=…, frequency_penalty: Optional[float] | Omit=…, function_call: completion_create_params.FunctionCall | Omit=…, functions: Iterable[completion_creat… - added:
method Completions.create(*, messages: Iterable[ChatCompletionMessageParam], model: Union[str, ChatModel], audio: Optional[ChatCompletionAudioParam] | Omit=…, frequency_penalty: Optional[float] | Omit=…, function_call: completion_create_params.FunctionCall | Omit=…, functions: Iterable[completion_create_params.Function] | Omit=…, logit_bias: Optional[Dict[str, int]] | Omit=…, logprobs: Optional[b… - added:
method Completions.delete(completion_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ChatCompletionDeleted - added:
method Completions.list(*, after: str | Omit=…, limit: int | Omit=…, metadata: Optional[Metadata] | Omit=…, model: str | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[ChatCompletion] - added:
method Completions.parse(*, messages: Iterable[ChatCompletionMessageParam], model: Union[str, ChatModel], audio: Optional[ChatCompletionAudioParam] | Omit=…, response_format: type[ResponseFormatT] | Omit=…, frequency_penalty: Optional[float] | Omit=…, function_call: completion_create_params.FunctionCall | Omit=…, functions: Iterable[completion_create_params.Function] | Omit=…, logit_bias: Optiona… - added:
method Completions.retrieve(completion_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ChatCompletion - added:
method Completions.stream(*, messages: Iterable[ChatCompletionMessageParam], model: Union[str, ChatModel], audio: Optional[ChatCompletionAudioParam] | Omit=…, response_format: completion_create_params.ResponseFormat | type[ResponseFormatT] | Omit=…, frequency_penalty: Optional[float] | Omit=…, function_call: completion_create_params.FunctionCall | Omit=…, functions: Iterable[completion_create_par… - added:
method Completions.update(completion_id: str, *, metadata: Optional[Metadata], extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ChatCompletion - added:
property AsyncCompletions.messages -> AsyncMessages - added:
property AsyncCompletions.with_raw_response -> AsyncCompletionsWithRawResponse - added:
property AsyncCompletions.with_streaming_response -> AsyncCompletionsWithStreamingResponse - added:
property Completions.messages -> Messages - added:
property Completions.with_raw_response -> CompletionsWithRawResponse - added:
property Completions.with_streaming_response -> CompletionsWithStreamingResponse
- added:
class AsyncMessages(AsyncAPIResource) - added:
class Messages(SyncAPIResource) - added:
method AsyncMessages.list(completion_id: str, *, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[ChatCompletionStoreMessage, AsyncCursorPage[ChatCompletionStoreMessage]] - added:
method Messages.list(completion_id: str, *, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[ChatCompletionStoreMessage] - added:
property AsyncMessages.with_raw_response -> AsyncMessagesWithRawResponse - added:
property AsyncMessages.with_streaming_response -> AsyncMessagesWithStreamingResponse - added:
property Messages.with_raw_response -> MessagesWithRawResponse - added:
property Messages.with_streaming_response -> MessagesWithStreamingResponse
- added:
async method AsyncCompletions.create(*, 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=…, echo: Optional[bool] | Omit=…, frequency_penalty: Optional[float] | Omit=…, logit_bias: Optional[Dict[str, int]] | Omit=…, logprobs: Optional[int] | Omit=…… - added:
class AsyncCompletions(AsyncAPIResource) - added:
class Completions(SyncAPIResource) - added:
method Completions.create(*, 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=…, echo: Optional[bool] | Omit=…, frequency_penalty: Optional[float] | Omit=…, logit_bias: Optional[Dict[str, int]] | Omit=…, logprobs: Optional[int] | Omit=…, max_token… - added:
property AsyncCompletions.with_raw_response -> AsyncCompletionsWithRawResponse - added:
property AsyncCompletions.with_streaming_response -> AsyncCompletionsWithStreamingResponse - added:
property Completions.with_raw_response -> CompletionsWithRawResponse - added:
property Completions.with_streaming_response -> CompletionsWithStreamingResponse
- added:
export AsyncContainers - added:
export AsyncContainersWithRawResponse - added:
export AsyncContainersWithStreamingResponse - added:
export AsyncFiles - added:
export AsyncFilesWithRawResponse - added:
export AsyncFilesWithStreamingResponse - added:
export Containers - added:
export ContainersWithRawResponse - added:
export ContainersWithStreamingResponse - added:
export Files - added:
export FilesWithRawResponse - added:
export FilesWithStreamingResponse
- added:
async method AsyncContainers.create(*, name: str, expires_after: container_create_params.ExpiresAfter | Omit=…, file_ids: SequenceNotStr[str] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ContainerCreateResponse - added:
async method AsyncContainers.delete(container_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> None - added:
async method AsyncContainers.retrieve(container_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ContainerRetrieveResponse - added:
class AsyncContainers(AsyncAPIResource) - added:
class Containers(SyncAPIResource) - added:
method AsyncContainers.list(*, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[ContainerListResponse, AsyncCursorPage[ContainerListResponse]] - added:
method Containers.create(*, name: str, expires_after: container_create_params.ExpiresAfter | Omit=…, file_ids: SequenceNotStr[str] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ContainerCreateResponse - added:
method Containers.delete(container_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> None - added:
method Containers.list(*, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[ContainerListResponse] - added:
method Containers.retrieve(container_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ContainerRetrieveResponse - added:
property AsyncContainers.files -> AsyncFiles - added:
property AsyncContainers.with_raw_response -> AsyncContainersWithRawResponse - added:
property AsyncContainers.with_streaming_response -> AsyncContainersWithStreamingResponse - added:
property Containers.files -> Files - added:
property Containers.with_raw_response -> ContainersWithRawResponse - added:
property Containers.with_streaming_response -> ContainersWithStreamingResponse
- added:
export AsyncContent - added:
export AsyncContentWithRawResponse - added:
export AsyncContentWithStreamingResponse - added:
export AsyncFiles - added:
export AsyncFilesWithRawResponse - added:
export AsyncFilesWithStreamingResponse - added:
export Content - added:
export ContentWithRawResponse - added:
export ContentWithStreamingResponse - added:
export Files - added:
export FilesWithRawResponse - added:
export FilesWithStreamingResponse
- added:
async method AsyncContent.retrieve(file_id: str, *, container_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> _legacy_response.HttpxBinaryResponseContent - added:
class AsyncContent(AsyncAPIResource) - added:
class Content(SyncAPIResource) - added:
method Content.retrieve(file_id: str, *, container_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> _legacy_response.HttpxBinaryResponseContent - added:
property AsyncContent.with_raw_response -> AsyncContentWithRawResponse - added:
property AsyncContent.with_streaming_response -> AsyncContentWithStreamingResponse - added:
property Content.with_raw_response -> ContentWithRawResponse - added:
property Content.with_streaming_response -> ContentWithStreamingResponse
- added:
async method AsyncFiles.create(container_id: str, *, file: FileTypes | Omit=…, file_id: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FileCreateResponse - added:
async method AsyncFiles.delete(file_id: str, *, container_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> None - added:
async method AsyncFiles.retrieve(file_id: str, *, container_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FileRetrieveResponse - added:
class AsyncFiles(AsyncAPIResource) - added:
class Files(SyncAPIResource) - added:
method AsyncFiles.list(container_id: str, *, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[FileListResponse, AsyncCursorPage[FileListResponse]] - added:
method Files.create(container_id: str, *, file: FileTypes | Omit=…, file_id: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FileCreateResponse - added:
method Files.delete(file_id: str, *, container_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> None - added:
method Files.list(container_id: str, *, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[FileListResponse] - added:
method Files.retrieve(file_id: str, *, container_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FileRetrieveResponse - added:
property AsyncFiles.content -> AsyncContent - added:
property AsyncFiles.with_raw_response -> AsyncFilesWithRawResponse - added:
property AsyncFiles.with_streaming_response -> AsyncFilesWithStreamingResponse - added:
property Files.content -> Content - added:
property Files.with_raw_response -> FilesWithRawResponse - added:
property Files.with_streaming_response -> FilesWithStreamingResponse
- added:
export AsyncConversations - added:
export AsyncConversationsWithRawResponse - added:
export AsyncConversationsWithStreamingResponse - added:
export AsyncItems - added:
export AsyncItemsWithRawResponse - added:
export AsyncItemsWithStreamingResponse - added:
export Conversations - added:
export ConversationsWithRawResponse - added:
export ConversationsWithStreamingResponse - added:
export Items - added:
export ItemsWithRawResponse - added:
export ItemsWithStreamingResponse
- added:
async method AsyncConversations.create(*, items: Optional[Iterable[ResponseInputItemParam]] | Omit=…, metadata: Optional[Metadata] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Conversation - added:
async method AsyncConversations.delete(conversation_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ConversationDeletedResource - added:
async method AsyncConversations.retrieve(conversation_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Conversation - added:
async method AsyncConversations.update(conversation_id: str, *, metadata: Optional[Metadata], extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Conversation - added:
class AsyncConversations(AsyncAPIResource) - added:
class Conversations(SyncAPIResource) - added:
method Conversations.create(*, items: Optional[Iterable[ResponseInputItemParam]] | Omit=…, metadata: Optional[Metadata] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Conversation - added:
method Conversations.delete(conversation_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ConversationDeletedResource - added:
method Conversations.retrieve(conversation_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Conversation - added:
method Conversations.update(conversation_id: str, *, metadata: Optional[Metadata], extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Conversation - added:
property AsyncConversations.items -> AsyncItems - added:
property AsyncConversations.with_raw_response -> AsyncConversationsWithRawResponse - added:
property AsyncConversations.with_streaming_response -> AsyncConversationsWithStreamingResponse - added:
property Conversations.items -> Items - added:
property Conversations.with_raw_response -> ConversationsWithRawResponse - added:
property Conversations.with_streaming_response -> ConversationsWithStreamingResponse
- added:
async method AsyncItems.create(conversation_id: str, *, items: Iterable[ResponseInputItemParam], include: List[ResponseIncludable] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ConversationItemList - added:
async method AsyncItems.delete(item_id: str, *, conversation_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Conversation - added:
async method AsyncItems.retrieve(item_id: str, *, conversation_id: str, include: List[ResponseIncludable] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ConversationItem - added:
class AsyncItems(AsyncAPIResource) - added:
class Items(SyncAPIResource) - added:
method AsyncItems.list(conversation_id: str, *, after: str | Omit=…, include: List[ResponseIncludable] | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[ConversationItem, AsyncConversationCursorPage[ConversationItem]] - added:
method Items.create(conversation_id: str, *, items: Iterable[ResponseInputItemParam], include: List[ResponseIncludable] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ConversationItemList - added:
method Items.delete(item_id: str, *, conversation_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Conversation - added:
method Items.list(conversation_id: str, *, after: str | Omit=…, include: List[ResponseIncludable] | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncConversationCursorPage[ConversationItem] - added:
method Items.retrieve(item_id: str, *, conversation_id: str, include: List[ResponseIncludable] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ConversationItem - added:
property AsyncItems.with_raw_response -> AsyncItemsWithRawResponse - added:
property AsyncItems.with_streaming_response -> AsyncItemsWithStreamingResponse - added:
property Items.with_raw_response -> ItemsWithRawResponse - added:
property Items.with_streaming_response -> ItemsWithStreamingResponse
- added:
async method AsyncEmbeddings.create(*, input: Union[str, SequenceNotStr[str], Iterable[int], Iterable[Iterable[int]]], model: Union[str, EmbeddingModel], dimensions: int | Omit=…, encoding_format: Literal['float', 'base64'] | Omit=…, user: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> C… - added:
class AsyncEmbeddings(AsyncAPIResource) - added:
class Embeddings(SyncAPIResource) - added:
method Embeddings.create(*, input: Union[str, SequenceNotStr[str], Iterable[int], Iterable[Iterable[int]]], model: Union[str, EmbeddingModel], dimensions: int | Omit=…, encoding_format: Literal['float', 'base64'] | Omit=…, user: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> CreateEmbedd… - added:
property AsyncEmbeddings.with_raw_response -> AsyncEmbeddingsWithRawResponse - added:
property AsyncEmbeddings.with_streaming_response -> AsyncEmbeddingsWithStreamingResponse - added:
property Embeddings.with_raw_response -> EmbeddingsWithRawResponse - added:
property Embeddings.with_streaming_response -> EmbeddingsWithStreamingResponse
- added:
export AsyncEvals - added:
export AsyncEvalsWithRawResponse - added:
export AsyncEvalsWithStreamingResponse - added:
export AsyncRuns - added:
export AsyncRunsWithRawResponse - added:
export AsyncRunsWithStreamingResponse - added:
export Evals - added:
export EvalsWithRawResponse - added:
export EvalsWithStreamingResponse - added:
export Runs - added:
export RunsWithRawResponse - added:
export RunsWithStreamingResponse
- added:
async method AsyncEvals.create(*, data_source_config: eval_create_params.DataSourceConfig, testing_criteria: Iterable[eval_create_params.TestingCriterion], metadata: Optional[Metadata] | Omit=…, name: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> EvalCreateResponse - added:
async method AsyncEvals.delete(eval_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> EvalDeleteResponse - added:
async method AsyncEvals.retrieve(eval_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> EvalRetrieveResponse - added:
async method AsyncEvals.update(eval_id: str, *, metadata: Optional[Metadata] | Omit=…, name: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> EvalUpdateResponse - added:
class AsyncEvals(AsyncAPIResource) - added:
class Evals(SyncAPIResource) - added:
method AsyncEvals.list(*, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, order_by: Literal['created_at', 'updated_at'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[EvalListResponse, AsyncCursorPage[EvalListResponse]] - added:
method Evals.create(*, data_source_config: eval_create_params.DataSourceConfig, testing_criteria: Iterable[eval_create_params.TestingCriterion], metadata: Optional[Metadata] | Omit=…, name: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> EvalCreateResponse - added:
method Evals.delete(eval_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> EvalDeleteResponse - added:
method Evals.list(*, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, order_by: Literal['created_at', 'updated_at'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[EvalListResponse] - added:
method Evals.retrieve(eval_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> EvalRetrieveResponse - added:
method Evals.update(eval_id: str, *, metadata: Optional[Metadata] | Omit=…, name: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> EvalUpdateResponse - added:
property AsyncEvals.runs -> AsyncRuns - added:
property AsyncEvals.with_raw_response -> AsyncEvalsWithRawResponse - added:
property AsyncEvals.with_streaming_response -> AsyncEvalsWithStreamingResponse - added:
property Evals.runs -> Runs - added:
property Evals.with_raw_response -> EvalsWithRawResponse - added:
property Evals.with_streaming_response -> EvalsWithStreamingResponse
- added:
export AsyncOutputItems - added:
export AsyncOutputItemsWithRawResponse - added:
export AsyncOutputItemsWithStreamingResponse - added:
export AsyncRuns - added:
export AsyncRunsWithRawResponse - added:
export AsyncRunsWithStreamingResponse - added:
export OutputItems - added:
export OutputItemsWithRawResponse - added:
export OutputItemsWithStreamingResponse - added:
export Runs - added:
export RunsWithRawResponse - added:
export RunsWithStreamingResponse
- added:
async method AsyncOutputItems.retrieve(output_item_id: str, *, eval_id: str, run_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> OutputItemRetrieveResponse - added:
class AsyncOutputItems(AsyncAPIResource) - added:
class OutputItems(SyncAPIResource) - added:
method AsyncOutputItems.list(run_id: str, *, eval_id: str, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, status: Literal['fail', 'pass'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[OutputItemListResponse, AsyncCursorPage[OutputItemListRes… - added:
method OutputItems.list(run_id: str, *, eval_id: str, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, status: Literal['fail', 'pass'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[OutputItemListResponse] - added:
method OutputItems.retrieve(output_item_id: str, *, eval_id: str, run_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> OutputItemRetrieveResponse - added:
property AsyncOutputItems.with_raw_response -> AsyncOutputItemsWithRawResponse - added:
property AsyncOutputItems.with_streaming_response -> AsyncOutputItemsWithStreamingResponse - added:
property OutputItems.with_raw_response -> OutputItemsWithRawResponse - added:
property OutputItems.with_streaming_response -> OutputItemsWithStreamingResponse
- added:
async method AsyncRuns.cancel(run_id: str, *, eval_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> RunCancelResponse - added:
async method AsyncRuns.create(eval_id: str, *, data_source: run_create_params.DataSource, metadata: Optional[Metadata] | Omit=…, name: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> RunCreateResponse - added:
async method AsyncRuns.delete(run_id: str, *, eval_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> RunDeleteResponse - added:
async method AsyncRuns.retrieve(run_id: str, *, eval_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> RunRetrieveResponse - added:
class AsyncRuns(AsyncAPIResource) - added:
class Runs(SyncAPIResource) - added:
method AsyncRuns.list(eval_id: str, *, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, status: Literal['queued', 'in_progress', 'completed', 'canceled', 'failed'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[RunListResponse, AsyncCursorPage[… - added:
method Runs.cancel(run_id: str, *, eval_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> RunCancelResponse - added:
method Runs.create(eval_id: str, *, data_source: run_create_params.DataSource, metadata: Optional[Metadata] | Omit=…, name: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> RunCreateResponse - added:
method Runs.delete(run_id: str, *, eval_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> RunDeleteResponse - added:
method Runs.list(eval_id: str, *, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, status: Literal['queued', 'in_progress', 'completed', 'canceled', 'failed'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[RunListResponse] - added:
method Runs.retrieve(run_id: str, *, eval_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> RunRetrieveResponse - added:
property AsyncRuns.output_items -> AsyncOutputItems - added:
property AsyncRuns.with_raw_response -> AsyncRunsWithRawResponse - added:
property AsyncRuns.with_streaming_response -> AsyncRunsWithStreamingResponse - added:
property Runs.output_items -> OutputItems - added:
property Runs.with_raw_response -> RunsWithRawResponse - added:
property Runs.with_streaming_response -> RunsWithStreamingResponse
- added:
async method AsyncFiles.content(file_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> _legacy_response.HttpxBinaryResponseContent - added:
async method AsyncFiles.create(*, file: FileTypes, purpose: FilePurpose, expires_after: file_create_params.ExpiresAfter | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FileObject - added:
async method AsyncFiles.delete(file_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FileDeleted - added:
async method AsyncFiles.retrieve(file_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FileObject - added:
async method AsyncFiles.retrieve_content(file_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> str - added:
async method AsyncFiles.wait_for_processing(id: str, *, poll_interval: float=…, max_wait_seconds: float=…) -> FileObject - added:
class AsyncFiles(AsyncAPIResource) - added:
class Files(SyncAPIResource) - added:
method AsyncFiles.list(*, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, purpose: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[FileObject, AsyncCursorPage[FileObject]] - added:
method Files.content(file_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> _legacy_response.HttpxBinaryResponseContent - added:
method Files.create(*, file: FileTypes, purpose: FilePurpose, expires_after: file_create_params.ExpiresAfter | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FileObject - added:
method Files.delete(file_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FileDeleted - added:
method Files.list(*, after: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, purpose: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[FileObject] - added:
method Files.retrieve(file_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FileObject - added:
method Files.retrieve_content(file_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> str - added:
method Files.wait_for_processing(id: str, *, poll_interval: float=…, max_wait_seconds: float=…) -> FileObject - added:
property AsyncFiles.with_raw_response -> AsyncFilesWithRawResponse - added:
property AsyncFiles.with_streaming_response -> AsyncFilesWithStreamingResponse - added:
property Files.with_raw_response -> FilesWithRawResponse - added:
property Files.with_streaming_response -> FilesWithStreamingResponse
- added:
export Alpha - added:
export AlphaWithRawResponse - added:
export AlphaWithStreamingResponse - added:
export AsyncAlpha - added:
export AsyncAlphaWithRawResponse - added:
export AsyncAlphaWithStreamingResponse - added:
export AsyncCheckpoints - added:
export AsyncCheckpointsWithRawResponse - added:
export AsyncCheckpointsWithStreamingResponse - added:
export AsyncFineTuning - added:
export AsyncFineTuningWithRawResponse - added:
export AsyncFineTuningWithStreamingResponse - added:
export AsyncJobs - added:
export AsyncJobsWithRawResponse - added:
export AsyncJobsWithStreamingResponse - added:
export Checkpoints - added:
export CheckpointsWithRawResponse - added:
export CheckpointsWithStreamingResponse - added:
export FineTuning - added:
export FineTuningWithRawResponse - added:
export FineTuningWithStreamingResponse - added:
export Jobs - added:
export JobsWithRawResponse - added:
export JobsWithStreamingResponse
- added:
export Alpha - added:
export AlphaWithRawResponse - added:
export AlphaWithStreamingResponse - added:
export AsyncAlpha - added:
export AsyncAlphaWithRawResponse - added:
export AsyncAlphaWithStreamingResponse - added:
export AsyncGraders - added:
export AsyncGradersWithRawResponse - added:
export AsyncGradersWithStreamingResponse - added:
export Graders - added:
export GradersWithRawResponse - added:
export GradersWithStreamingResponse
- added:
class Alpha(SyncAPIResource) - added:
class AsyncAlpha(AsyncAPIResource) - added:
property Alpha.graders -> Graders - added:
property Alpha.with_raw_response -> AlphaWithRawResponse - added:
property Alpha.with_streaming_response -> AlphaWithStreamingResponse - added:
property AsyncAlpha.graders -> AsyncGraders - added:
property AsyncAlpha.with_raw_response -> AsyncAlphaWithRawResponse - added:
property AsyncAlpha.with_streaming_response -> AsyncAlphaWithStreamingResponse
- added:
async method AsyncGraders.run(*, grader: grader_run_params.Grader, model_sample: str, item: object | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> GraderRunResponse - added:
async method AsyncGraders.validate(*, grader: grader_validate_params.Grader, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> GraderValidateResponse - added:
class AsyncGraders(AsyncAPIResource) - added:
class Graders(SyncAPIResource) - added:
method Graders.run(*, grader: grader_run_params.Grader, model_sample: str, item: object | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> GraderRunResponse - added:
method Graders.validate(*, grader: grader_validate_params.Grader, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> GraderValidateResponse - added:
property AsyncGraders.with_raw_response -> AsyncGradersWithRawResponse - added:
property AsyncGraders.with_streaming_response -> AsyncGradersWithStreamingResponse - added:
property Graders.with_raw_response -> GradersWithRawResponse - added:
property Graders.with_streaming_response -> GradersWithStreamingResponse
- added:
export AsyncCheckpoints - added:
export AsyncCheckpointsWithRawResponse - added:
export AsyncCheckpointsWithStreamingResponse - added:
export AsyncPermissions - added:
export AsyncPermissionsWithRawResponse - added:
export AsyncPermissionsWithStreamingResponse - added:
export Checkpoints - added:
export CheckpointsWithRawResponse - added:
export CheckpointsWithStreamingResponse - added:
export Permissions - added:
export PermissionsWithRawResponse - added:
export PermissionsWithStreamingResponse
- added:
class AsyncCheckpoints(AsyncAPIResource) - added:
class Checkpoints(SyncAPIResource) - added:
property AsyncCheckpoints.permissions -> AsyncPermissions - added:
property AsyncCheckpoints.with_raw_response -> AsyncCheckpointsWithRawResponse - added:
property AsyncCheckpoints.with_streaming_response -> AsyncCheckpointsWithStreamingResponse - added:
property Checkpoints.permissions -> Permissions - added:
property Checkpoints.with_raw_response -> CheckpointsWithRawResponse - added:
property Checkpoints.with_streaming_response -> CheckpointsWithStreamingResponse
- added:
async method AsyncPermissions.delete(permission_id: str, *, fine_tuned_model_checkpoint: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> PermissionDeleteResponse - added:
async method AsyncPermissions.retrieve(fine_tuned_model_checkpoint: str, *, after: str | Omit=…, limit: int | Omit=…, order: Literal['ascending', 'descending'] | Omit=…, project_id: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> PermissionRetrieveResponse - added:
class AsyncPermissions(AsyncAPIResource) - added:
class Permissions(SyncAPIResource) - added:
method AsyncPermissions.create(fine_tuned_model_checkpoint: str, *, project_ids: SequenceNotStr[str], extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[PermissionCreateResponse, AsyncPage[PermissionCreateResponse]] - added:
method Permissions.create(fine_tuned_model_checkpoint: str, *, project_ids: SequenceNotStr[str], extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncPage[PermissionCreateResponse] - added:
method Permissions.delete(permission_id: str, *, fine_tuned_model_checkpoint: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> PermissionDeleteResponse - added:
method Permissions.retrieve(fine_tuned_model_checkpoint: str, *, after: str | Omit=…, limit: int | Omit=…, order: Literal['ascending', 'descending'] | Omit=…, project_id: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> PermissionRetrieveResponse - added:
property AsyncPermissions.with_raw_response -> AsyncPermissionsWithRawResponse - added:
property AsyncPermissions.with_streaming_response -> AsyncPermissionsWithStreamingResponse - added:
property Permissions.with_raw_response -> PermissionsWithRawResponse - added:
property Permissions.with_streaming_response -> PermissionsWithStreamingResponse
- added:
class AsyncFineTuning(AsyncAPIResource) - added:
class FineTuning(SyncAPIResource) - added:
property AsyncFineTuning.alpha -> AsyncAlpha - added:
property AsyncFineTuning.checkpoints -> AsyncCheckpoints - added:
property AsyncFineTuning.jobs -> AsyncJobs - added:
property AsyncFineTuning.with_raw_response -> AsyncFineTuningWithRawResponse - added:
property AsyncFineTuning.with_streaming_response -> AsyncFineTuningWithStreamingResponse - added:
property FineTuning.alpha -> Alpha - added:
property FineTuning.checkpoints -> Checkpoints - added:
property FineTuning.jobs -> Jobs - added:
property FineTuning.with_raw_response -> FineTuningWithRawResponse - added:
property FineTuning.with_streaming_response -> FineTuningWithStreamingResponse
- added:
export AsyncCheckpoints - added:
export AsyncCheckpointsWithRawResponse - added:
export AsyncCheckpointsWithStreamingResponse - added:
export AsyncJobs - added:
export AsyncJobsWithRawResponse - added:
export AsyncJobsWithStreamingResponse - added:
export Checkpoints - added:
export CheckpointsWithRawResponse - added:
export CheckpointsWithStreamingResponse - added:
export Jobs - added:
export JobsWithRawResponse - added:
export JobsWithStreamingResponse
- added:
class AsyncCheckpoints(AsyncAPIResource) - added:
class Checkpoints(SyncAPIResource) - added:
method AsyncCheckpoints.list(fine_tuning_job_id: str, *, after: str | Omit=…, limit: int | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[FineTuningJobCheckpoint, AsyncCursorPage[FineTuningJobCheckpoint]] - added:
method Checkpoints.list(fine_tuning_job_id: str, *, after: str | Omit=…, limit: int | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[FineTuningJobCheckpoint] - added:
property AsyncCheckpoints.with_raw_response -> AsyncCheckpointsWithRawResponse - added:
property AsyncCheckpoints.with_streaming_response -> AsyncCheckpointsWithStreamingResponse - added:
property Checkpoints.with_raw_response -> CheckpointsWithRawResponse - added:
property Checkpoints.with_streaming_response -> CheckpointsWithStreamingResponse
- added:
async method AsyncJobs.cancel(fine_tuning_job_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FineTuningJob - added:
async method AsyncJobs.create(*, model: Union[str, Literal['babbage-002', 'davinci-002', 'gpt-3.5-turbo', 'gpt-4o-mini']], training_file: str, hyperparameters: job_create_params.Hyperparameters | Omit=…, integrations: Optional[Iterable[job_create_params.Integration]] | Omit=…, metadata: Optional[Metadata] | Omit=…, method: job_create_params.Method | Omit=…, seed: Optional[int] | Omit=…, suffix: O… - added:
async method AsyncJobs.pause(fine_tuning_job_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FineTuningJob - added:
async method AsyncJobs.resume(fine_tuning_job_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FineTuningJob - added:
async method AsyncJobs.retrieve(fine_tuning_job_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FineTuningJob - added:
class AsyncJobs(AsyncAPIResource) - added:
class Jobs(SyncAPIResource) - added:
method AsyncJobs.list(*, after: str | Omit=…, limit: int | Omit=…, metadata: Optional[Dict[str, str]] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[FineTuningJob, AsyncCursorPage[FineTuningJob]] - added:
method AsyncJobs.list_events(fine_tuning_job_id: str, *, after: str | Omit=…, limit: int | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[FineTuningJobEvent, AsyncCursorPage[FineTuningJobEvent]] - added:
method Jobs.cancel(fine_tuning_job_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FineTuningJob - added:
method Jobs.create(*, model: Union[str, Literal['babbage-002', 'davinci-002', 'gpt-3.5-turbo', 'gpt-4o-mini']], training_file: str, hyperparameters: job_create_params.Hyperparameters | Omit=…, integrations: Optional[Iterable[job_create_params.Integration]] | Omit=…, metadata: Optional[Metadata] | Omit=…, method: job_create_params.Method | Omit=…, seed: Optional[int] | Omit=…, suffix: Optional[str… - added:
method Jobs.list(*, after: str | Omit=…, limit: int | Omit=…, metadata: Optional[Dict[str, str]] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[FineTuningJob] - added:
method Jobs.list_events(fine_tuning_job_id: str, *, after: str | Omit=…, limit: int | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[FineTuningJobEvent] - added:
method Jobs.pause(fine_tuning_job_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FineTuningJob - added:
method Jobs.resume(fine_tuning_job_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FineTuningJob - added:
method Jobs.retrieve(fine_tuning_job_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> FineTuningJob - added:
property AsyncJobs.checkpoints -> AsyncCheckpoints - added:
property AsyncJobs.with_raw_response -> AsyncJobsWithRawResponse - added:
property AsyncJobs.with_streaming_response -> AsyncJobsWithStreamingResponse - added:
property Jobs.checkpoints -> Checkpoints - added:
property Jobs.with_raw_response -> JobsWithRawResponse - added:
property Jobs.with_streaming_response -> JobsWithStreamingResponse
- added:
async method AsyncImages.create_variation(*, image: FileTypes, model: Union[str, ImageModel, None] | Omit=…, n: Optional[int] | Omit=…, response_format: Optional[Literal['url', 'b64_json']] | Omit=…, size: Optional[Literal['256x256', '512x512', '1024x1024']] | Omit=…, user: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | http… - added:
async method AsyncImages.edit(*, image: Union[FileTypes, SequenceNotStr[FileTypes]], prompt: str, background: Optional[Literal['transparent', 'opaque', 'auto']] | Omit=…, input_fidelity: Optional[Literal['high', 'low']] | Omit=…, mask: FileTypes | Omit=…, model: Union[str, ImageModel, None] | Omit=…, n: Optional[int] | Omit=…, output_compression: Optional[int] | Omit=…, output_format: Optional[Li… - added:
async method AsyncImages.generate(*, prompt: str, background: Optional[Literal['transparent', 'opaque', 'auto']] | Omit=…, model: Union[str, ImageModel, None] | Omit=…, moderation: Optional[Literal['low', 'auto']] | Omit=…, n: Optional[int] | Omit=…, output_compression: Optional[int] | Omit=…, output_format: Optional[Literal['png', 'jpeg', 'webp']] | Omit=…, partial_images: Optional[int] | Omit=…… - added:
class AsyncImages(AsyncAPIResource) - added:
class Images(SyncAPIResource) - added:
method Images.create_variation(*, image: FileTypes, model: Union[str, ImageModel, None] | Omit=…, n: Optional[int] | Omit=…, response_format: Optional[Literal['url', 'b64_json']] | Omit=…, size: Optional[Literal['256x256', '512x512', '1024x1024']] | Omit=…, user: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout |… - added:
method Images.edit(*, image: Union[FileTypes, SequenceNotStr[FileTypes]], prompt: str, background: Optional[Literal['transparent', 'opaque', 'auto']] | Omit=…, input_fidelity: Optional[Literal['high', 'low']] | Omit=…, mask: FileTypes | Omit=…, model: Union[str, ImageModel, None] | Omit=…, n: Optional[int] | Omit=…, output_compression: Optional[int] | Omit=…, output_format: Optional[Literal['png'… - added:
method Images.generate(*, prompt: str, background: Optional[Literal['transparent', 'opaque', 'auto']] | Omit=…, model: Union[str, ImageModel, None] | Omit=…, moderation: Optional[Literal['low', 'auto']] | Omit=…, n: Optional[int] | Omit=…, output_compression: Optional[int] | Omit=…, output_format: Optional[Literal['png', 'jpeg', 'webp']] | Omit=…, partial_images: Optional[int] | Omit=…, quality:… - added:
property AsyncImages.with_raw_response -> AsyncImagesWithRawResponse - added:
property AsyncImages.with_streaming_response -> AsyncImagesWithStreamingResponse - added:
property Images.with_raw_response -> ImagesWithRawResponse - added:
property Images.with_streaming_response -> ImagesWithStreamingResponse
- added:
async method AsyncModels.delete(model: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ModelDeleted - added:
async method AsyncModels.retrieve(model: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Model - added:
class AsyncModels(AsyncAPIResource) - added:
class Models(SyncAPIResource) - added:
method AsyncModels.list(*, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[Model, AsyncPage[Model]] - added:
method Models.delete(model: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ModelDeleted - added:
method Models.list(*, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncPage[Model] - added:
method Models.retrieve(model: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Model - added:
property AsyncModels.with_raw_response -> AsyncModelsWithRawResponse - added:
property AsyncModels.with_streaming_response -> AsyncModelsWithStreamingResponse - added:
property Models.with_raw_response -> ModelsWithRawResponse - added:
property Models.with_streaming_response -> ModelsWithStreamingResponse
- added:
async method AsyncModerations.create(*, input: Union[str, SequenceNotStr[str], Iterable[ModerationMultiModalInputParam]], model: Union[str, ModerationModel] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ModerationCreateResponse - added:
class AsyncModerations(AsyncAPIResource) - added:
class Moderations(SyncAPIResource) - added:
method Moderations.create(*, input: Union[str, SequenceNotStr[str], Iterable[ModerationMultiModalInputParam]], model: Union[str, ModerationModel] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ModerationCreateResponse - added:
property AsyncModerations.with_raw_response -> AsyncModerationsWithRawResponse - added:
property AsyncModerations.with_streaming_response -> AsyncModerationsWithStreamingResponse - added:
property Moderations.with_raw_response -> ModerationsWithRawResponse - added:
property Moderations.with_streaming_response -> ModerationsWithStreamingResponse
- added:
export AsyncClientSecrets - added:
export AsyncClientSecretsWithRawResponse - added:
export AsyncClientSecretsWithStreamingResponse - added:
export AsyncRealtime - added:
export AsyncRealtimeWithRawResponse - added:
export AsyncRealtimeWithStreamingResponse - added:
export ClientSecrets - added:
export ClientSecretsWithRawResponse - added:
export ClientSecretsWithStreamingResponse - added:
export Realtime - added:
export RealtimeWithRawResponse - added:
export RealtimeWithStreamingResponse
- added:
async method AsyncClientSecrets.create(*, expires_after: client_secret_create_params.ExpiresAfter | Omit=…, session: client_secret_create_params.Session | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ClientSecretCreateResponse - added:
class AsyncClientSecrets(AsyncAPIResource) - added:
class ClientSecrets(SyncAPIResource) - added:
method ClientSecrets.create(*, expires_after: client_secret_create_params.ExpiresAfter | Omit=…, session: client_secret_create_params.Session | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ClientSecretCreateResponse - added:
property AsyncClientSecrets.with_raw_response -> AsyncClientSecretsWithRawResponse - added:
property AsyncClientSecrets.with_streaming_response -> AsyncClientSecretsWithStreamingResponse - added:
property ClientSecrets.with_raw_response -> ClientSecretsWithRawResponse - added:
property ClientSecrets.with_streaming_response -> ClientSecretsWithStreamingResponse
- added:
class AsyncRealtime(AsyncAPIResource) - added:
class Realtime(SyncAPIResource) - added:
method AsyncRealtime.connect(*, model: str, extra_query: Query=…, extra_headers: Headers=…, websocket_connection_options: WebsocketConnectionOptions=…) -> AsyncRealtimeConnectionManager - added:
method Realtime.connect(*, model: str, extra_query: Query=…, extra_headers: Headers=…, websocket_connection_options: WebsocketConnectionOptions=…) -> RealtimeConnectionManager - added:
property AsyncRealtime.client_secrets -> AsyncClientSecrets - added:
property AsyncRealtime.with_raw_response -> AsyncRealtimeWithRawResponse - added:
property AsyncRealtime.with_streaming_response -> AsyncRealtimeWithStreamingResponse - added:
property Realtime.client_secrets -> ClientSecrets - added:
property Realtime.with_raw_response -> RealtimeWithRawResponse - added:
property Realtime.with_streaming_response -> RealtimeWithStreamingResponse
- added:
export AsyncInputItems - added:
export AsyncInputItemsWithRawResponse - added:
export AsyncInputItemsWithStreamingResponse - added:
export AsyncResponses - added:
export AsyncResponsesWithRawResponse - added:
export AsyncResponsesWithStreamingResponse - added:
export InputItems - added:
export InputItemsWithRawResponse - added:
export InputItemsWithStreamingResponse - added:
export Responses - added:
export ResponsesWithRawResponse - added:
export ResponsesWithStreamingResponse
- added:
class AsyncInputItems(AsyncAPIResource) - added:
class InputItems(SyncAPIResource) - added:
method AsyncInputItems.list(response_id: str, *, after: str | Omit=…, include: List[ResponseIncludable] | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[ResponseItem, AsyncCursorPage[ResponseItem]] - added:
method InputItems.list(response_id: str, *, after: str | Omit=…, include: List[ResponseIncludable] | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[ResponseItem] - added:
property AsyncInputItems.with_raw_response -> AsyncInputItemsWithRawResponse - added:
property AsyncInputItems.with_streaming_response -> AsyncInputItemsWithStreamingResponse - added:
property InputItems.with_raw_response -> InputItemsWithRawResponse - added:
property InputItems.with_streaming_response -> InputItemsWithStreamingResponse
- added:
async method AsyncResponses.cancel(response_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Response - added:
async method AsyncResponses.create(*, background: Optional[bool] | Omit=…, conversation: Optional[response_create_params.Conversation] | Omit=…, include: Optional[List[ResponseIncludable]] | Omit=…, input: Union[str, ResponseInputParam] | Omit=…, instructions: Optional[str] | Omit=…, max_output_tokens: Optional[int] | Omit=…, max_tool_calls: Optional[int] | Omit=…, metadata: Optional[Metadata] |… - added:
async method AsyncResponses.delete(response_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> None - added:
async method AsyncResponses.parse(*, text_format: type[TextFormatT] | Omit=…, background: Optional[bool] | Omit=…, conversation: Optional[response_create_params.Conversation] | Omit=…, include: Optional[List[ResponseIncludable]] | Omit=…, input: Union[str, ResponseInputParam] | Omit=…, instructions: Optional[str] | Omit=…, max_output_tokens: Optional[int] | Omit=…, max_tool_calls: Optional[int] |… - added:
async method AsyncResponses.retrieve(response_id: str, *, include: List[ResponseIncludable] | Omit=…, include_obfuscation: bool | Omit=…, starting_after: int | Omit=…, stream: Literal[False] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Response | (response_id: str, *, stream: Literal[True]… - added:
class AsyncResponses(AsyncAPIResource) - added:
class Responses(SyncAPIResource) - added:
method AsyncResponses.stream(*, response_id: str, text_format: type[TextFormatT] | Omit=…, starting_after: int | Omit=…, tools: Iterable[ParseableToolParam] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncResponseStreamManager[TextFormatT] | (*, input: Union[str, ResponseInputParam], mod… - added:
method Responses.cancel(response_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Response - added:
method Responses.create(*, background: Optional[bool] | Omit=…, conversation: Optional[response_create_params.Conversation] | Omit=…, include: Optional[List[ResponseIncludable]] | Omit=…, input: Union[str, ResponseInputParam] | Omit=…, instructions: Optional[str] | Omit=…, max_output_tokens: Optional[int] | Omit=…, max_tool_calls: Optional[int] | Omit=…, metadata: Optional[Metadata] | Omit=…, mod… - added:
method Responses.delete(response_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> None - added:
method Responses.parse(*, text_format: type[TextFormatT] | Omit=…, background: Optional[bool] | Omit=…, conversation: Optional[response_create_params.Conversation] | Omit=…, include: Optional[List[ResponseIncludable]] | Omit=…, input: Union[str, ResponseInputParam] | Omit=…, instructions: Optional[str] | Omit=…, max_output_tokens: Optional[int] | Omit=…, max_tool_calls: Optional[int] | Omit=…, me… - added:
method Responses.retrieve(response_id: str, *, include: List[ResponseIncludable] | Omit=…, include_obfuscation: bool | Omit=…, starting_after: int | Omit=…, stream: Literal[False] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Response | (response_id: str, *, stream: Literal[True], include:… - added:
method Responses.stream(*, response_id: str, text_format: type[TextFormatT] | Omit=…, starting_after: int | Omit=…, tools: Iterable[ParseableToolParam] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> ResponseStreamManager[TextFormatT] | (*, input: Union[str, ResponseInputParam], model: Respon… - added:
property AsyncResponses.input_items -> AsyncInputItems - added:
property AsyncResponses.with_raw_response -> AsyncResponsesWithRawResponse - added:
property AsyncResponses.with_streaming_response -> AsyncResponsesWithStreamingResponse - added:
property Responses.input_items -> InputItems - added:
property Responses.with_raw_response -> ResponsesWithRawResponse - added:
property Responses.with_streaming_response -> ResponsesWithStreamingResponse
- added:
export AsyncParts - added:
export AsyncPartsWithRawResponse - added:
export AsyncPartsWithStreamingResponse - added:
export AsyncUploads - added:
export AsyncUploadsWithRawResponse - added:
export AsyncUploadsWithStreamingResponse - added:
export Parts - added:
export PartsWithRawResponse - added:
export PartsWithStreamingResponse - added:
export Uploads - added:
export UploadsWithRawResponse - added:
export UploadsWithStreamingResponse
- added:
async method AsyncParts.create(upload_id: str, *, data: FileTypes, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> UploadPart - added:
class AsyncParts(AsyncAPIResource) - added:
class Parts(SyncAPIResource) - added:
method Parts.create(upload_id: str, *, data: FileTypes, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> UploadPart - added:
property AsyncParts.with_raw_response -> AsyncPartsWithRawResponse - added:
property AsyncParts.with_streaming_response -> AsyncPartsWithStreamingResponse - added:
property Parts.with_raw_response -> PartsWithRawResponse - added:
property Parts.with_streaming_response -> PartsWithStreamingResponse
- added:
async method AsyncUploads.cancel(upload_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Upload - added:
async method AsyncUploads.complete(upload_id: str, *, part_ids: SequenceNotStr[str], md5: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Upload - added:
async method AsyncUploads.create(*, bytes: int, filename: str, mime_type: str, purpose: FilePurpose, expires_after: upload_create_params.ExpiresAfter | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Upload - added:
async method AsyncUploads.upload_file_chunked(*, file: os.PathLike[str], mime_type: str, purpose: FilePurpose, bytes: int | None=…, part_size: int | None=…, md5: str | Omit=…) -> Upload | (*, file: bytes, filename: str, bytes: int, mime_type: str, purpose: FilePurpose, part_size: int | None=…, md5: str | Omit=…) -> Upload - added:
class AsyncUploads(AsyncAPIResource) - added:
class Uploads(SyncAPIResource) - added:
method Uploads.cancel(upload_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Upload - added:
method Uploads.complete(upload_id: str, *, part_ids: SequenceNotStr[str], md5: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Upload - added:
method Uploads.create(*, bytes: int, filename: str, mime_type: str, purpose: FilePurpose, expires_after: upload_create_params.ExpiresAfter | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Upload - added:
method Uploads.upload_file_chunked(*, file: os.PathLike[str], mime_type: str, purpose: FilePurpose, bytes: int | None=…, part_size: int | None=…, md5: str | Omit=…) -> Upload | (*, file: bytes, filename: str, bytes: int, mime_type: str, purpose: FilePurpose, part_size: int | None=…, md5: str | Omit=…) -> Upload - added:
property AsyncUploads.parts -> AsyncParts - added:
property AsyncUploads.with_raw_response -> AsyncUploadsWithRawResponse - added:
property AsyncUploads.with_streaming_response -> AsyncUploadsWithStreamingResponse - added:
property Uploads.parts -> Parts - added:
property Uploads.with_raw_response -> UploadsWithRawResponse - added:
property Uploads.with_streaming_response -> UploadsWithStreamingResponse
- added:
export AsyncFileBatches - added:
export AsyncFileBatchesWithRawResponse - added:
export AsyncFileBatchesWithStreamingResponse - added:
export AsyncFiles - added:
export AsyncFilesWithRawResponse - added:
export AsyncFilesWithStreamingResponse - added:
export AsyncVectorStores - added:
export AsyncVectorStoresWithRawResponse - added:
export AsyncVectorStoresWithStreamingResponse - added:
export FileBatches - added:
export FileBatchesWithRawResponse - added:
export FileBatchesWithStreamingResponse - added:
export Files - added:
export FilesWithRawResponse - added:
export FilesWithStreamingResponse - added:
export VectorStores - added:
export VectorStoresWithRawResponse - added:
export VectorStoresWithStreamingResponse
- added:
async method AsyncFileBatches.cancel(batch_id: str, *, vector_store_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFileBatch - added:
async method AsyncFileBatches.create(vector_store_id: str, *, file_ids: SequenceNotStr[str], attributes: Optional[Dict[str, Union[str, float, bool]]] | Omit=…, chunking_strategy: FileChunkingStrategyParam | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFileBatch - added:
async method AsyncFileBatches.create_and_poll(vector_store_id: str, *, file_ids: SequenceNotStr[str], poll_interval_ms: int | Omit=…, chunking_strategy: FileChunkingStrategyParam | Omit=…) -> VectorStoreFileBatch - added:
async method AsyncFileBatches.poll(batch_id: str, *, vector_store_id: str, poll_interval_ms: int | Omit=…) -> VectorStoreFileBatch - added:
async method AsyncFileBatches.retrieve(batch_id: str, *, vector_store_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFileBatch - added:
async method AsyncFileBatches.upload_and_poll(vector_store_id: str, *, files: Iterable[FileTypes], max_concurrency: int=…, file_ids: SequenceNotStr[str]=…, poll_interval_ms: int | Omit=…, chunking_strategy: FileChunkingStrategyParam | Omit=…) -> VectorStoreFileBatch - added:
class AsyncFileBatches(AsyncAPIResource) - added:
class FileBatches(SyncAPIResource) - added:
method AsyncFileBatches.list_files(batch_id: str, *, vector_store_id: str, after: str | Omit=…, before: str | Omit=…, filter: Literal['in_progress', 'completed', 'failed', 'cancelled'] | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) ->… - added:
method FileBatches.cancel(batch_id: str, *, vector_store_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFileBatch - added:
method FileBatches.create(vector_store_id: str, *, file_ids: SequenceNotStr[str], attributes: Optional[Dict[str, Union[str, float, bool]]] | Omit=…, chunking_strategy: FileChunkingStrategyParam | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFileBatch - added:
method FileBatches.create_and_poll(vector_store_id: str, *, file_ids: SequenceNotStr[str], poll_interval_ms: int | Omit=…, chunking_strategy: FileChunkingStrategyParam | Omit=…) -> VectorStoreFileBatch - added:
method FileBatches.list_files(batch_id: str, *, vector_store_id: str, after: str | Omit=…, before: str | Omit=…, filter: Literal['in_progress', 'completed', 'failed', 'cancelled'] | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Sync… - added:
method FileBatches.poll(batch_id: str, *, vector_store_id: str, poll_interval_ms: int | Omit=…) -> VectorStoreFileBatch - added:
method FileBatches.retrieve(batch_id: str, *, vector_store_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFileBatch - added:
method FileBatches.upload_and_poll(vector_store_id: str, *, files: Iterable[FileTypes], max_concurrency: int=…, file_ids: SequenceNotStr[str]=…, poll_interval_ms: int | Omit=…, chunking_strategy: FileChunkingStrategyParam | Omit=…) -> VectorStoreFileBatch - added:
property AsyncFileBatches.with_raw_response -> AsyncFileBatchesWithRawResponse - added:
property AsyncFileBatches.with_streaming_response -> AsyncFileBatchesWithStreamingResponse - added:
property FileBatches.with_raw_response -> FileBatchesWithRawResponse - added:
property FileBatches.with_streaming_response -> FileBatchesWithStreamingResponse
- added:
async method AsyncFiles.create(vector_store_id: str, *, file_id: str, attributes: Optional[Dict[str, Union[str, float, bool]]] | Omit=…, chunking_strategy: FileChunkingStrategyParam | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFile - added:
async method AsyncFiles.create_and_poll(file_id: str, *, vector_store_id: str, attributes: Optional[Dict[str, Union[str, float, bool]]] | Omit=…, poll_interval_ms: int | Omit=…, chunking_strategy: FileChunkingStrategyParam | Omit=…) -> VectorStoreFile - added:
async method AsyncFiles.delete(file_id: str, *, vector_store_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFileDeleted - added:
async method AsyncFiles.poll(file_id: str, *, vector_store_id: str, poll_interval_ms: int | Omit=…) -> VectorStoreFile - added:
async method AsyncFiles.retrieve(file_id: str, *, vector_store_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFile - added:
async method AsyncFiles.update(file_id: str, *, vector_store_id: str, attributes: Optional[Dict[str, Union[str, float, bool]]], extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFile - added:
async method AsyncFiles.upload(*, vector_store_id: str, file: FileTypes, chunking_strategy: FileChunkingStrategyParam | Omit=…) -> VectorStoreFile - added:
async method AsyncFiles.upload_and_poll(*, vector_store_id: str, file: FileTypes, attributes: Optional[Dict[str, Union[str, float, bool]]] | Omit=…, poll_interval_ms: int | Omit=…, chunking_strategy: FileChunkingStrategyParam | Omit=…) -> VectorStoreFile - added:
class AsyncFiles(AsyncAPIResource) - added:
class Files(SyncAPIResource) - added:
method AsyncFiles.content(file_id: str, *, vector_store_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[FileContentResponse, AsyncPage[FileContentResponse]] - added:
method AsyncFiles.list(vector_store_id: str, *, after: str | Omit=…, before: str | Omit=…, filter: Literal['in_progress', 'completed', 'failed', 'cancelled'] | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[VectorStore… - added:
method Files.content(file_id: str, *, vector_store_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncPage[FileContentResponse] - added:
method Files.create(vector_store_id: str, *, file_id: str, attributes: Optional[Dict[str, Union[str, float, bool]]] | Omit=…, chunking_strategy: FileChunkingStrategyParam | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFile - added:
method Files.create_and_poll(file_id: str, *, vector_store_id: str, attributes: Optional[Dict[str, Union[str, float, bool]]] | Omit=…, poll_interval_ms: int | Omit=…, chunking_strategy: FileChunkingStrategyParam | Omit=…) -> VectorStoreFile - added:
method Files.delete(file_id: str, *, vector_store_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFileDeleted - added:
method Files.list(vector_store_id: str, *, after: str | Omit=…, before: str | Omit=…, filter: Literal['in_progress', 'completed', 'failed', 'cancelled'] | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[VectorStoreFile] - added:
method Files.poll(file_id: str, *, vector_store_id: str, poll_interval_ms: int | Omit=…) -> VectorStoreFile - added:
method Files.retrieve(file_id: str, *, vector_store_id: str, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFile - added:
method Files.update(file_id: str, *, vector_store_id: str, attributes: Optional[Dict[str, Union[str, float, bool]]], extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreFile - added:
method Files.upload(*, vector_store_id: str, file: FileTypes, chunking_strategy: FileChunkingStrategyParam | Omit=…) -> VectorStoreFile - added:
method Files.upload_and_poll(*, vector_store_id: str, file: FileTypes, attributes: Optional[Dict[str, Union[str, float, bool]]] | Omit=…, poll_interval_ms: int | Omit=…, chunking_strategy: FileChunkingStrategyParam | Omit=…) -> VectorStoreFile - added:
property AsyncFiles.with_raw_response -> AsyncFilesWithRawResponse - added:
property AsyncFiles.with_streaming_response -> AsyncFilesWithStreamingResponse - added:
property Files.with_raw_response -> FilesWithRawResponse - added:
property Files.with_streaming_response -> FilesWithStreamingResponse
- added:
async method AsyncVectorStores.create(*, chunking_strategy: FileChunkingStrategyParam | Omit=…, expires_after: vector_store_create_params.ExpiresAfter | Omit=…, file_ids: SequenceNotStr[str] | Omit=…, metadata: Optional[Metadata] | Omit=…, name: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…… - added:
async method AsyncVectorStores.delete(vector_store_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreDeleted - added:
async method AsyncVectorStores.retrieve(vector_store_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStore - added:
async method AsyncVectorStores.update(vector_store_id: str, *, expires_after: Optional[vector_store_update_params.ExpiresAfter] | Omit=…, metadata: Optional[Metadata] | Omit=…, name: Optional[str] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStore - added:
class AsyncVectorStores(AsyncAPIResource) - added:
class VectorStores(SyncAPIResource) - added:
method AsyncVectorStores.list(*, after: str | Omit=…, before: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> AsyncPaginator[VectorStore, AsyncCursorPage[VectorStore]] - added:
method AsyncVectorStores.search(vector_store_id: str, *, query: Union[str, SequenceNotStr[str]], filters: vector_store_search_params.Filters | Omit=…, max_num_results: int | Omit=…, ranking_options: vector_store_search_params.RankingOptions | Omit=…, rewrite_query: bool | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeou… - added:
method VectorStores.create(*, chunking_strategy: FileChunkingStrategyParam | Omit=…, expires_after: vector_store_create_params.ExpiresAfter | Omit=…, file_ids: SequenceNotStr[str] | Omit=…, metadata: Optional[Metadata] | Omit=…, name: str | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> Vector… - added:
method VectorStores.delete(vector_store_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStoreDeleted - added:
method VectorStores.list(*, after: str | Omit=…, before: str | Omit=…, limit: int | Omit=…, order: Literal['asc', 'desc'] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> SyncCursorPage[VectorStore] - added:
method VectorStores.retrieve(vector_store_id: str, *, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStore - added:
method VectorStores.search(vector_store_id: str, *, query: Union[str, SequenceNotStr[str]], filters: vector_store_search_params.Filters | Omit=…, max_num_results: int | Omit=…, ranking_options: vector_store_search_params.RankingOptions | Omit=…, rewrite_query: bool | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | N… - added:
method VectorStores.update(vector_store_id: str, *, expires_after: Optional[vector_store_update_params.ExpiresAfter] | Omit=…, metadata: Optional[Metadata] | Omit=…, name: Optional[str] | Omit=…, extra_headers: Headers | None=…, extra_query: Query | None=…, extra_body: Body | None=…, timeout: float | httpx.Timeout | None | NotGiven=…) -> VectorStore - added:
property AsyncVectorStores.file_batches -> AsyncFileBatches - added:
property AsyncVectorStores.files -> AsyncFiles - added:
property AsyncVectorStores.with_raw_response -> AsyncVectorStoresWithRawResponse - added:
property AsyncVectorStores.with_streaming_response -> AsyncVectorStoresWithStreamingResponse - added:
property VectorStores.file_batches -> FileBatches - added:
property VectorStores.files -> Files - added:
property VectorStores.with_raw_response -> VectorStoresWithRawResponse - added:
property VectorStores.with_streaming_response -> VectorStoresWithStreamingResponse
- added:
class AsyncWebhooks(AsyncAPIResource) - added:
class Webhooks(SyncAPIResource) - added:
method AsyncWebhooks.unwrap(payload: str | bytes, headers: HeadersLike, *, secret: str | None=…) -> UnwrapWebhookEvent - added:
method AsyncWebhooks.verify_signature(payload: str | bytes, headers: HeadersLike, *, secret: str | None=…, tolerance: int=…) -> None - added:
method Webhooks.unwrap(payload: str | bytes, headers: HeadersLike, *, secret: str | None=…) -> UnwrapWebhookEvent - added:
method Webhooks.verify_signature(payload: str | bytes, headers: HeadersLike, *, secret: str | None=…, tolerance: int=…) -> None
- added:
export AllModels - added:
export AudioModel - added:
export AudioResponseFormat - added:
export AutoFileChunkingStrategyParam - added:
export Batch - added:
export BatchCreateParams - added:
export BatchError - added:
export BatchListParams - added:
export BatchRequestCounts - added:
export ChatModel - added:
export ComparisonFilter - added:
export Completion - added:
export CompletionChoice - added:
export CompletionCreateParams - added:
export CompletionUsage - added:
export CompoundFilter - added:
export ContainerCreateParams - added:
export ContainerCreateResponse - added:
export ContainerListParams - added:
export ContainerListResponse - added:
export ContainerRetrieveResponse - added:
export CreateEmbeddingResponse - added:
export CustomToolInputFormat - added:
export Embedding - added:
export EmbeddingCreateParams - added:
export EmbeddingModel - added:
export ErrorObject - added:
export EvalCreateParams - added:
export EvalCreateResponse - added:
export EvalCustomDataSourceConfig - added:
export EvalDeleteResponse - added:
export EvalListParams - added:
export EvalListResponse - added:
export EvalRetrieveResponse - added:
export EvalStoredCompletionsDataSourceConfig - added:
export EvalUpdateParams - added:
export EvalUpdateResponse - added:
export FileChunkingStrategy - added:
export FileChunkingStrategyParam - added:
export FileContent - added:
export FileCreateParams - added:
export FileDeleted - added:
export FileListParams - added:
export FileObject - added:
export FilePurpose - added:
export FunctionDefinition - added:
export FunctionParameters - added:
export Image - added:
export ImageCreateVariationParams - added:
export ImageEditCompletedEvent - added:
export ImageEditParams - added:
export ImageEditPartialImageEvent - added:
export ImageEditStreamEvent - added:
export ImageGenCompletedEvent - added:
export ImageGenPartialImageEvent - added:
export ImageGenStreamEvent - added:
export ImageGenerateParams - added:
export ImageModel - added:
export ImagesResponse - added:
export Metadata - added:
export Model - added:
export ModelDeleted - added:
export Moderation - added:
export ModerationCreateParams - added:
export ModerationCreateResponse - added:
export ModerationImageURLInputParam - added:
export ModerationModel - added:
export ModerationMultiModalInputParam - added:
export ModerationTextInputParam - added:
export OtherFileChunkingStrategyObject - added:
export Reasoning - added:
export ReasoningEffort - added:
export ResponseFormatJSONObject - added:
export ResponseFormatJSONSchema - added:
export ResponseFormatText - added:
export ResponseFormatTextGrammar - added:
export ResponseFormatTextPython - added:
export ResponsesModel - added:
export StaticFileChunkingStrategy - added:
export StaticFileChunkingStrategyObject - added:
export StaticFileChunkingStrategyObjectParam - added:
export StaticFileChunkingStrategyParam - added:
export Upload - added:
export UploadCompleteParams - added:
export UploadCreateParams - added:
export VectorStore - added:
export VectorStoreCreateParams - added:
export VectorStoreDeleted - added:
export VectorStoreListParams - added:
export VectorStoreSearchParams - added:
export VectorStoreSearchResponse - added:
export VectorStoreUpdateParams - added:
export WebsocketConnectionOptions
- added:
export SpeechCreateParams - added:
export SpeechModel - added:
export Transcription - added:
export TranscriptionCreateParams - added:
export TranscriptionCreateResponse - added:
export TranscriptionInclude - added:
export TranscriptionSegment - added:
export TranscriptionStreamEvent - added:
export TranscriptionTextDeltaEvent - added:
export TranscriptionTextDoneEvent - added:
export TranscriptionVerbose - added:
export TranscriptionWord - added:
export Translation - added:
export TranslationCreateParams - added:
export TranslationCreateResponse - added:
export TranslationVerbose
- added:
class SpeechCreateParams(TypedDict) - added:
field SpeechCreateParams.input: Required[str] - added:
field SpeechCreateParams.instructions: str - added:
field SpeechCreateParams.model: Required[Union[str, SpeechModel]] - added:
field SpeechCreateParams.response_format: Literal['mp3', 'opus', 'aac', 'flac', 'wav', 'pcm'] - added:
field SpeechCreateParams.speed: float - added:
field SpeechCreateParams.stream_format: Literal['sse', 'audio'] - added:
field SpeechCreateParams.voice: Required[Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse', 'marin', 'cedar']]]
- added:
variable SpeechModel: TypeAlias
- added:
class Logprob(BaseModel) - added:
class Transcription(BaseModel) - added:
class UsageDuration(BaseModel) - added:
class UsageTokens(BaseModel) - added:
class UsageTokensInputTokenDetails(BaseModel) - added:
field Logprob.bytes: Optional[List[float]] - added:
field Logprob.logprob: Optional[float] - added:
field Logprob.token: Optional[str] - added:
field Transcription.logprobs: Optional[List[Logprob]] - added:
field Transcription.text: str - added:
field Transcription.usage: Optional[Usage] - added:
field UsageDuration.seconds: float - added:
field UsageDuration.type: Literal['duration'] - added:
field UsageTokens.input_token_details: Optional[UsageTokensInputTokenDetails] - added:
field UsageTokens.input_tokens: int - added:
field UsageTokens.output_tokens: int - added:
field UsageTokens.total_tokens: int - added:
field UsageTokens.type: Literal['tokens'] - added:
field UsageTokensInputTokenDetails.audio_tokens: Optional[int] - added:
field UsageTokensInputTokenDetails.text_tokens: Optional[int] - added:
variable Usage: TypeAlias
- added:
class ChunkingStrategyVadConfig(TypedDict) - added:
class TranscriptionCreateParamsBase(TypedDict) - added:
class TranscriptionCreateParamsNonStreaming(TranscriptionCreateParamsBase) - added:
class TranscriptionCreateParamsStreaming(TranscriptionCreateParamsBase) - added:
field ChunkingStrategyVadConfig.prefix_padding_ms: int - added:
field ChunkingStrategyVadConfig.silence_duration_ms: int - added:
field ChunkingStrategyVadConfig.threshold: float - added:
field ChunkingStrategyVadConfig.type: Required[Literal['server_vad']] - added:
field TranscriptionCreateParamsBase.chunking_strategy: Optional[ChunkingStrategy] - added:
field TranscriptionCreateParamsBase.file: Required[FileTypes] - added:
field TranscriptionCreateParamsBase.include: List[TranscriptionInclude] - added:
field TranscriptionCreateParamsBase.language: str - added:
field TranscriptionCreateParamsBase.model: Required[Union[str, AudioModel]] - added:
field TranscriptionCreateParamsBase.prompt: str - added:
field TranscriptionCreateParamsBase.response_format: AudioResponseFormat - added:
field TranscriptionCreateParamsBase.temperature: float - added:
field TranscriptionCreateParamsBase.timestamp_granularities: List[Literal['word', 'segment']] - added:
field TranscriptionCreateParamsNonStreaming.stream: Optional[Literal[False]] - added:
field TranscriptionCreateParamsStreaming.stream: Required[Literal[True]] - added:
variable ChunkingStrategy: TypeAlias
- added:
variable TranscriptionCreateResponse: TypeAlias
- added:
variable TranscriptionInclude: TypeAlias
- added:
class TranscriptionSegment(BaseModel) - added:
field TranscriptionSegment.avg_logprob: float - added:
field TranscriptionSegment.compression_ratio: float - added:
field TranscriptionSegment.end: float - added:
field TranscriptionSegment.id: int - added:
field TranscriptionSegment.no_speech_prob: float - added:
field TranscriptionSegment.seek: int - added:
field TranscriptionSegment.start: float - added:
field TranscriptionSegment.temperature: float - added:
field TranscriptionSegment.text: str - added:
field TranscriptionSegment.tokens: List[int]
- added:
variable TranscriptionStreamEvent: TypeAlias
- added:
class Logprob(BaseModel) - added:
class TranscriptionTextDeltaEvent(BaseModel) - added:
field Logprob.bytes: Optional[List[int]] - added:
field Logprob.logprob: Optional[float] - added:
field Logprob.token: Optional[str] - added:
field TranscriptionTextDeltaEvent.delta: str - added:
field TranscriptionTextDeltaEvent.logprobs: Optional[List[Logprob]] - added:
field TranscriptionTextDeltaEvent.type: Literal['transcript.text.delta']
- added:
class Logprob(BaseModel) - added:
class TranscriptionTextDoneEvent(BaseModel) - added:
class Usage(BaseModel) - added:
class UsageInputTokenDetails(BaseModel) - added:
field Logprob.bytes: Optional[List[int]] - added:
field Logprob.logprob: Optional[float] - added:
field Logprob.token: Optional[str] - added:
field TranscriptionTextDoneEvent.logprobs: Optional[List[Logprob]] - added:
field TranscriptionTextDoneEvent.text: str - added:
field TranscriptionTextDoneEvent.type: Literal['transcript.text.done'] - added:
field TranscriptionTextDoneEvent.usage: Optional[Usage] - added:
field Usage.input_token_details: Optional[UsageInputTokenDetails] - added:
field Usage.input_tokens: int - added:
field Usage.output_tokens: int - added:
field Usage.total_tokens: int - added:
field Usage.type: Literal['tokens'] - added:
field UsageInputTokenDetails.audio_tokens: Optional[int] - added:
field UsageInputTokenDetails.text_tokens: Optional[int]
- added:
class TranscriptionVerbose(BaseModel) - added:
class Usage(BaseModel) - added:
field TranscriptionVerbose.duration: float - added:
field TranscriptionVerbose.language: str - added:
field TranscriptionVerbose.segments: Optional[List[TranscriptionSegment]] - added:
field TranscriptionVerbose.text: str - added:
field TranscriptionVerbose.usage: Optional[Usage] - added:
field TranscriptionVerbose.words: Optional[List[TranscriptionWord]] - added:
field Usage.seconds: float - added:
field Usage.type: Literal['duration']
- added:
class TranscriptionWord(BaseModel) - added:
field TranscriptionWord.end: float - added:
field TranscriptionWord.start: float - added:
field TranscriptionWord.word: str
- added:
class Translation(BaseModel) - added:
field Translation.text: str
- added:
class TranslationCreateParams(TypedDict) - added:
field TranslationCreateParams.file: Required[FileTypes] - added:
field TranslationCreateParams.model: Required[Union[str, AudioModel]] - added:
field TranslationCreateParams.prompt: str - added:
field TranslationCreateParams.response_format: Literal['json', 'text', 'srt', 'verbose_json', 'vtt'] - added:
field TranslationCreateParams.temperature: float
- added:
variable TranslationCreateResponse: TypeAlias
- added:
class TranslationVerbose(BaseModel) - added:
field TranslationVerbose.duration: float - added:
field TranslationVerbose.language: str - added:
field TranslationVerbose.segments: Optional[List[TranscriptionSegment]] - added:
field TranslationVerbose.text: str
- added:
variable AudioModel: TypeAlias
- added:
variable AudioResponseFormat: TypeAlias
- added:
class AutoFileChunkingStrategyParam(TypedDict) - added:
field AutoFileChunkingStrategyParam.type: Required[Literal['auto']]
- added:
class Batch(BaseModel) - added:
class Errors(BaseModel) - added:
field Batch.cancelled_at: Optional[int] - added:
field Batch.cancelling_at: Optional[int] - added:
field Batch.completed_at: Optional[int] - added:
field Batch.completion_window: str - added:
field Batch.created_at: int - added:
field Batch.endpoint: str - added:
field Batch.error_file_id: Optional[str] - added:
field Batch.errors: Optional[Errors] - added:
field Batch.expired_at: Optional[int] - added:
field Batch.expires_at: Optional[int] - added:
field Batch.failed_at: Optional[int] - added:
field Batch.finalizing_at: Optional[int] - added:
field Batch.id: str - added:
field Batch.in_progress_at: Optional[int] - added:
field Batch.input_file_id: str - added:
field Batch.metadata: Optional[Metadata] - added:
field Batch.object: Literal['batch'] - added:
field Batch.output_file_id: Optional[str] - added:
field Batch.request_counts: Optional[BatchRequestCounts] - added:
field Batch.status: Literal['validating', 'failed', 'in_progress', 'finalizing', 'completed', 'expired', 'cancelling', 'cancelled'] - added:
field Errors.data: Optional[List[BatchError]] - added:
field Errors.object: Optional[str]
- added:
class BatchCreateParams(TypedDict) - added:
class OutputExpiresAfter(TypedDict) - added:
field BatchCreateParams.completion_window: Required[Literal['24h']] - added:
field BatchCreateParams.endpoint: Required[Literal['/v1/responses', '/v1/chat/completions', '/v1/embeddings', '/v1/completions']] - added:
field BatchCreateParams.input_file_id: Required[str] - added:
field BatchCreateParams.metadata: Optional[Metadata] - added:
field BatchCreateParams.output_expires_after: OutputExpiresAfter - added:
field OutputExpiresAfter.anchor: Required[Literal['created_at']] - added:
field OutputExpiresAfter.seconds: Required[int]
- added:
class BatchError(BaseModel) - added:
field BatchError.code: Optional[str] - added:
field BatchError.line: Optional[int] - added:
field BatchError.message: Optional[str] - added:
field BatchError.param: Optional[str]
- added:
class BatchListParams(TypedDict) - added:
field BatchListParams.after: str - added:
field BatchListParams.limit: int
- added:
class BatchRequestCounts(BaseModel) - added:
field BatchRequestCounts.completed: int - added:
field BatchRequestCounts.failed: int - added:
field BatchRequestCounts.total: int
- added:
export Assistant - added:
export AssistantCreateParams - added:
export AssistantDeleted - added:
export AssistantListParams - added:
export AssistantResponseFormatOption - added:
export AssistantResponseFormatOptionParam - added:
export AssistantStreamEvent - added:
export AssistantTool - added:
export AssistantToolChoice - added:
export AssistantToolChoiceFunction - added:
export AssistantToolChoiceFunctionParam - added:
export AssistantToolChoiceOption - added:
export AssistantToolChoiceOptionParam - added:
export AssistantToolChoiceParam - added:
export AssistantToolParam - added:
export AssistantUpdateParams - added:
export CodeInterpreterTool - added:
export CodeInterpreterToolParam - added:
export FileSearchTool - added:
export FileSearchToolParam - added:
export FunctionTool - added:
export FunctionToolParam - added:
export Thread - added:
export ThreadCreateAndRunParams - added:
export ThreadCreateParams - added:
export ThreadDeleted - added:
export ThreadUpdateParams
- added:
class Assistant(BaseModel) - added:
class ToolResources(BaseModel) - added:
class ToolResourcesCodeInterpreter(BaseModel) - added:
class ToolResourcesFileSearch(BaseModel) - added:
field Assistant.created_at: int - added:
field Assistant.description: Optional[str] - added:
field Assistant.id: str - added:
field Assistant.instructions: Optional[str] - added:
field Assistant.metadata: Optional[Metadata] - added:
field Assistant.model: str - added:
field Assistant.name: Optional[str] - added:
field Assistant.object: Literal['assistant'] - added:
field Assistant.response_format: Optional[AssistantResponseFormatOption] - added:
field Assistant.temperature: Optional[float] - added:
field Assistant.tool_resources: Optional[ToolResources] - added:
field Assistant.tools: List[AssistantTool] - added:
field Assistant.top_p: Optional[float] - added:
field ToolResources.code_interpreter: Optional[ToolResourcesCodeInterpreter] - added:
field ToolResources.file_search: Optional[ToolResourcesFileSearch] - added:
field ToolResourcesCodeInterpreter.file_ids: Optional[List[str]] - added:
field ToolResourcesFileSearch.vector_store_ids: Optional[List[str]]
- added:
class AssistantCreateParams(TypedDict) - added:
class ToolResources(TypedDict) - added:
class ToolResourcesCodeInterpreter(TypedDict) - added:
class ToolResourcesFileSearch(TypedDict) - added:
class ToolResourcesFileSearchVectorStore(TypedDict) - added:
class ToolResourcesFileSearchVectorStoreChunkingStrategyAuto(TypedDict) - added:
class ToolResourcesFileSearchVectorStoreChunkingStrategyStatic(TypedDict) - added:
class ToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic(TypedDict) - added:
field AssistantCreateParams.description: Optional[str] - added:
field AssistantCreateParams.instructions: Optional[str] - added:
field AssistantCreateParams.metadata: Optional[Metadata] - added:
field AssistantCreateParams.model: Required[Union[str, ChatModel]] - added:
field AssistantCreateParams.name: Optional[str] - added:
field AssistantCreateParams.reasoning_effort: Optional[ReasoningEffort] - added:
field AssistantCreateParams.response_format: Optional[AssistantResponseFormatOptionParam] - added:
field AssistantCreateParams.temperature: Optional[float] - added:
field AssistantCreateParams.tool_resources: Optional[ToolResources] - added:
field AssistantCreateParams.tools: Iterable[AssistantToolParam] - added:
field AssistantCreateParams.top_p: Optional[float] - added:
field ToolResources.code_interpreter: ToolResourcesCodeInterpreter - added:
field ToolResources.file_search: ToolResourcesFileSearch - added:
field ToolResourcesCodeInterpreter.file_ids: SequenceNotStr[str] - added:
field ToolResourcesFileSearch.vector_store_ids: SequenceNotStr[str] - added:
field ToolResourcesFileSearch.vector_stores: Iterable[ToolResourcesFileSearchVectorStore] - added:
field ToolResourcesFileSearchVectorStore.chunking_strategy: ToolResourcesFileSearchVectorStoreChunkingStrategy - added:
field ToolResourcesFileSearchVectorStore.file_ids: SequenceNotStr[str] - added:
field ToolResourcesFileSearchVectorStore.metadata: Optional[Metadata] - added:
field ToolResourcesFileSearchVectorStoreChunkingStrategyAuto.type: Required[Literal['auto']] - added:
field ToolResourcesFileSearchVectorStoreChunkingStrategyStatic.static: Required[ToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic] - added:
field ToolResourcesFileSearchVectorStoreChunkingStrategyStatic.type: Required[Literal['static']] - added:
field ToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic.chunk_overlap_tokens: Required[int] - added:
field ToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic.max_chunk_size_tokens: Required[int] - added:
variable ToolResourcesFileSearchVectorStoreChunkingStrategy: TypeAlias
- added:
class AssistantDeleted(BaseModel) - added:
field AssistantDeleted.deleted: bool - added:
field AssistantDeleted.id: str - added:
field AssistantDeleted.object: Literal['assistant.deleted']
- added:
class AssistantListParams(TypedDict) - added:
field AssistantListParams.after: str - added:
field AssistantListParams.before: str - added:
field AssistantListParams.limit: int - added:
field AssistantListParams.order: Literal['asc', 'desc']
- added:
variable AssistantResponseFormatOption: TypeAlias
- added:
variable AssistantResponseFormatOptionParam: TypeAlias
- added:
class ErrorEvent(BaseModel) - added:
class ThreadCreated(BaseModel) - added:
class ThreadMessageCompleted(BaseModel) - added:
class ThreadMessageCreated(BaseModel) - added:
class ThreadMessageDelta(BaseModel) - added:
class ThreadMessageInProgress(BaseModel) - added:
class ThreadMessageIncomplete(BaseModel) - added:
class ThreadRunCancelled(BaseModel) - added:
class ThreadRunCancelling(BaseModel) - added:
class ThreadRunCompleted(BaseModel) - added:
class ThreadRunCreated(BaseModel) - added:
class ThreadRunExpired(BaseModel) - added:
class ThreadRunFailed(BaseModel) - added:
class ThreadRunInProgress(BaseModel) - added:
class ThreadRunIncomplete(BaseModel) - added:
class ThreadRunQueued(BaseModel) - added:
class ThreadRunRequiresAction(BaseModel) - added:
class ThreadRunStepCancelled(BaseModel) - added:
class ThreadRunStepCompleted(BaseModel) - added:
class ThreadRunStepCreated(BaseModel) - added:
class ThreadRunStepDelta(BaseModel) - added:
class ThreadRunStepExpired(BaseModel) - added:
class ThreadRunStepFailed(BaseModel) - added:
class ThreadRunStepInProgress(BaseModel) - added:
field ErrorEvent.data: ErrorObject - added:
field ErrorEvent.event: Literal['error'] - added:
field ThreadCreated.data: Thread - added:
field ThreadCreated.enabled: Optional[bool] - added:
field ThreadCreated.event: Literal['thread.created'] - added:
field ThreadMessageCompleted.data: Message - added:
field ThreadMessageCompleted.event: Literal['thread.message.completed'] - added:
field ThreadMessageCreated.data: Message - added:
field ThreadMessageCreated.event: Literal['thread.message.created'] - added:
field ThreadMessageDelta.data: MessageDeltaEvent - added:
field ThreadMessageDelta.event: Literal['thread.message.delta'] - added:
field ThreadMessageInProgress.data: Message - added:
field ThreadMessageInProgress.event: Literal['thread.message.in_progress'] - added:
field ThreadMessageIncomplete.data: Message - added:
field ThreadMessageIncomplete.event: Literal['thread.message.incomplete'] - added:
field ThreadRunCancelled.data: Run - added:
field ThreadRunCancelled.event: Literal['thread.run.cancelled'] - added:
field ThreadRunCancelling.data: Run - added:
field ThreadRunCancelling.event: Literal['thread.run.cancelling'] - added:
field ThreadRunCompleted.data: Run - added:
field ThreadRunCompleted.event: Literal['thread.run.completed'] - added:
field ThreadRunCreated.data: Run - added:
field ThreadRunCreated.event: Literal['thread.run.created'] - added:
field ThreadRunExpired.data: Run - added:
field ThreadRunExpired.event: Literal['thread.run.expired'] - added:
field ThreadRunFailed.data: Run - added:
field ThreadRunFailed.event: Literal['thread.run.failed'] - added:
field ThreadRunInProgress.data: Run - added:
field ThreadRunInProgress.event: Literal['thread.run.in_progress'] - added:
field ThreadRunIncomplete.data: Run - added:
field ThreadRunIncomplete.event: Literal['thread.run.incomplete'] - added:
field ThreadRunQueued.data: Run - added:
field ThreadRunQueued.event: Literal['thread.run.queued'] - added:
field ThreadRunRequiresAction.data: Run - added:
field ThreadRunRequiresAction.event: Literal['thread.run.requires_action'] - added:
field ThreadRunStepCancelled.data: RunStep - added:
field ThreadRunStepCancelled.event: Literal['thread.run.step.cancelled'] - added:
field ThreadRunStepCompleted.data: RunStep - added:
field ThreadRunStepCompleted.event: Literal['thread.run.step.completed'] - added:
field ThreadRunStepCreated.data: RunStep - added:
field ThreadRunStepCreated.event: Literal['thread.run.step.created'] - added:
field ThreadRunStepDelta.data: RunStepDeltaEvent - added:
field ThreadRunStepDelta.event: Literal['thread.run.step.delta'] - added:
field ThreadRunStepExpired.data: RunStep - added:
field ThreadRunStepExpired.event: Literal['thread.run.step.expired'] - added:
field ThreadRunStepFailed.data: RunStep - added:
field ThreadRunStepFailed.event: Literal['thread.run.step.failed'] - added:
field ThreadRunStepInProgress.data: RunStep - added:
field ThreadRunStepInProgress.event: Literal['thread.run.step.in_progress'] - added:
variable AssistantStreamEvent: TypeAlias
- added:
variable AssistantTool: TypeAlias
- added:
class AssistantToolChoice(BaseModel) - added:
field AssistantToolChoice.function: Optional[AssistantToolChoiceFunction] - added:
field AssistantToolChoice.type: Literal['function', 'code_interpreter', 'file_search']
- added:
class AssistantToolChoiceFunction(BaseModel) - added:
field AssistantToolChoiceFunction.name: str
- added:
class AssistantToolChoiceFunctionParam(TypedDict) - added:
field AssistantToolChoiceFunctionParam.name: Required[str]
- added:
variable AssistantToolChoiceOption: TypeAlias
- added:
variable AssistantToolChoiceOptionParam: TypeAlias
- added:
class AssistantToolChoiceParam(TypedDict) - added:
field AssistantToolChoiceParam.function: AssistantToolChoiceFunctionParam - added:
field AssistantToolChoiceParam.type: Required[Literal['function', 'code_interpreter', 'file_search']]
- added:
variable AssistantToolParam: TypeAlias
- added:
class AssistantUpdateParams(TypedDict) - added:
class ToolResources(TypedDict) - added:
class ToolResourcesCodeInterpreter(TypedDict) - added:
class ToolResourcesFileSearch(TypedDict) - added:
field AssistantUpdateParams.description: Optional[str] - added:
field AssistantUpdateParams.instructions: Optional[str] - added:
field AssistantUpdateParams.metadata: Optional[Metadata] - added:
field AssistantUpdateParams.model: Union[str, Literal['gpt-5', 'gpt-5-mini', 'gpt-5-nano', 'gpt-5-2025-08-07', 'gpt-5-mini-2025-08-07', 'gpt-5-nano-2025-08-07', 'gpt-4.1', 'gpt-4.1-mini', 'gpt-4.1-nano', 'gpt-4.1-2025-04-14', 'gpt-4.1-mini-2025-04-14', 'gpt-4.1-nano-2025-04-14', 'o3-mini', 'o3-mini-2025-01-31', 'o1', 'o1-2024-12-17', 'gpt-4o', 'gpt-4o-2024-11-20', 'gpt-4o-2024-08-06', 'gpt-4o-202… - added:
field AssistantUpdateParams.name: Optional[str] - added:
field AssistantUpdateParams.reasoning_effort: Optional[ReasoningEffort] - added:
field AssistantUpdateParams.response_format: Optional[AssistantResponseFormatOptionParam] - added:
field AssistantUpdateParams.temperature: Optional[float] - added:
field AssistantUpdateParams.tool_resources: Optional[ToolResources] - added:
field AssistantUpdateParams.tools: Iterable[AssistantToolParam] - added:
field AssistantUpdateParams.top_p: Optional[float] - added:
field ToolResources.code_interpreter: ToolResourcesCodeInterpreter - added:
field ToolResources.file_search: ToolResourcesFileSearch - added:
field ToolResourcesCodeInterpreter.file_ids: SequenceNotStr[str] - added:
field ToolResourcesFileSearch.vector_store_ids: SequenceNotStr[str]
- added:
class CodeInterpreterTool(BaseModel) - added:
field CodeInterpreterTool.type: Literal['code_interpreter']
- added:
class CodeInterpreterToolParam(TypedDict) - added:
field CodeInterpreterToolParam.type: Required[Literal['code_interpreter']]
- added:
class FileSearch(BaseModel) - added:
class FileSearchRankingOptions(BaseModel) - added:
class FileSearchTool(BaseModel) - added:
field FileSearch.max_num_results: Optional[int] - added:
field FileSearch.ranking_options: Optional[FileSearchRankingOptions] - added:
field FileSearchRankingOptions.ranker: Optional[Literal['auto', 'default_2024_08_21']] - added:
field FileSearchRankingOptions.score_threshold: float - added:
field FileSearchTool.file_search: Optional[FileSearch] - added:
field FileSearchTool.type: Literal['file_search']
- added:
class FileSearch(TypedDict) - added:
class FileSearchRankingOptions(TypedDict) - added:
class FileSearchToolParam(TypedDict) - added:
field FileSearch.max_num_results: int - added:
field FileSearch.ranking_options: FileSearchRankingOptions - added:
field FileSearchRankingOptions.ranker: Literal['auto', 'default_2024_08_21'] - added:
field FileSearchRankingOptions.score_threshold: Required[float] - added:
field FileSearchToolParam.file_search: FileSearch - added:
field FileSearchToolParam.type: Required[Literal['file_search']]
- added:
class FunctionTool(BaseModel) - added:
field FunctionTool.function: FunctionDefinition - added:
field FunctionTool.type: Literal['function']
- added:
class FunctionToolParam(TypedDict) - added:
field FunctionToolParam.function: Required[FunctionDefinition] - added:
field FunctionToolParam.type: Required[Literal['function']]
- added:
export ConversationCreatedEvent - added:
export ConversationItem - added:
export ConversationItemContent - added:
export ConversationItemContentParam - added:
export ConversationItemCreateEvent - added:
export ConversationItemCreateEventParam - added:
export ConversationItemCreatedEvent - added:
export ConversationItemDeleteEvent - added:
export ConversationItemDeleteEventParam - added:
export ConversationItemDeletedEvent - added:
export ConversationItemInputAudioTranscriptionCompletedEvent - added:
export ConversationItemInputAudioTranscriptionDeltaEvent - added:
export ConversationItemInputAudioTranscriptionFailedEvent - added:
export ConversationItemParam - added:
export ConversationItemRetrieveEvent - added:
export ConversationItemRetrieveEventParam - added:
export ConversationItemTruncateEvent - added:
export ConversationItemTruncateEventParam - added:
export ConversationItemTruncatedEvent - added:
export ConversationItemWithReference - added:
export ConversationItemWithReferenceParam - added:
export ErrorEvent - added:
export InputAudioBufferAppendEvent - added:
export InputAudioBufferAppendEventParam - added:
export InputAudioBufferClearEvent - added:
export InputAudioBufferClearEventParam - added:
export InputAudioBufferClearedEvent - added:
export InputAudioBufferCommitEvent - added:
export InputAudioBufferCommitEventParam - added:
export InputAudioBufferCommittedEvent - added:
export InputAudioBufferSpeechStartedEvent - added:
export InputAudioBufferSpeechStoppedEvent - added:
export RateLimitsUpdatedEvent - added:
export RealtimeClientEvent - added:
export RealtimeClientEventParam - added:
export RealtimeConnectParams - added:
export RealtimeResponse - added:
export RealtimeResponseStatus - added:
export RealtimeResponseUsage - added:
export RealtimeServerEvent - added:
export ResponseAudioDeltaEvent - added:
export ResponseAudioDoneEvent - added:
export ResponseAudioTranscriptDeltaEvent - added:
export ResponseAudioTranscriptDoneEvent - added:
export ResponseCancelEvent - added:
export ResponseCancelEventParam - added:
export ResponseContentPartAddedEvent - added:
export ResponseContentPartDoneEvent - added:
export ResponseCreateEvent - added:
export ResponseCreateEventParam - added:
export ResponseCreatedEvent - added:
export ResponseDoneEvent - added:
export ResponseFunctionCallArgumentsDeltaEvent - added:
export ResponseFunctionCallArgumentsDoneEvent - added:
export ResponseOutputItemAddedEvent - added:
export ResponseOutputItemDoneEvent - added:
export ResponseTextDeltaEvent - added:
export ResponseTextDoneEvent - added:
export Session - added:
export SessionCreateParams - added:
export SessionCreateResponse - added:
export SessionCreatedEvent - added:
export SessionUpdateEvent - added:
export SessionUpdateEventParam - added:
export SessionUpdatedEvent - added:
export TranscriptionSession - added:
export TranscriptionSessionCreateParams - added:
export TranscriptionSessionUpdate - added:
export TranscriptionSessionUpdateParam - added:
export TranscriptionSessionUpdatedEvent
- added:
class Conversation(BaseModel) - added:
class ConversationCreatedEvent(BaseModel) - added:
field Conversation.id: Optional[str] - added:
field Conversation.object: Optional[Literal['realtime.conversation']] - added:
field ConversationCreatedEvent.conversation: Conversation - added:
field ConversationCreatedEvent.event_id: str - added:
field ConversationCreatedEvent.type: Literal['conversation.created']
- added:
class ConversationItem(BaseModel) - added:
field ConversationItem.arguments: Optional[str] - added:
field ConversationItem.call_id: Optional[str] - added:
field ConversationItem.content: Optional[List[ConversationItemContent]] - added:
field ConversationItem.id: Optional[str] - added:
field ConversationItem.name: Optional[str] - added:
field ConversationItem.object: Optional[Literal['realtime.item']] - added:
field ConversationItem.output: Optional[str] - added:
field ConversationItem.role: Optional[Literal['user', 'assistant', 'system']] - added:
field ConversationItem.status: Optional[Literal['completed', 'incomplete', 'in_progress']] - added:
field ConversationItem.type: Optional[Literal['message', 'function_call', 'function_call_output']]
- added:
class ConversationItemContent(BaseModel) - added:
field ConversationItemContent.audio: Optional[str] - added:
field ConversationItemContent.id: Optional[str] - added:
field ConversationItemContent.text: Optional[str] - added:
field ConversationItemContent.transcript: Optional[str] - added:
field ConversationItemContent.type: Optional[Literal['input_text', 'input_audio', 'item_reference', 'text', 'audio']]
- added:
class ConversationItemContentParam(TypedDict) - added:
field ConversationItemContentParam.audio: str - added:
field ConversationItemContentParam.id: str - added:
field ConversationItemContentParam.text: str - added:
field ConversationItemContentParam.transcript: str - added:
field ConversationItemContentParam.type: Literal['input_text', 'input_audio', 'item_reference', 'text', 'audio']
- added:
class ConversationItemCreateEvent(BaseModel) - added:
field ConversationItemCreateEvent.event_id: Optional[str] - added:
field ConversationItemCreateEvent.item: ConversationItem - added:
field ConversationItemCreateEvent.previous_item_id: Optional[str] - added:
field ConversationItemCreateEvent.type: Literal['conversation.item.create']
- added:
class ConversationItemCreateEventParam(TypedDict) - added:
field ConversationItemCreateEventParam.event_id: str - added:
field ConversationItemCreateEventParam.item: Required[ConversationItemParam] - added:
field ConversationItemCreateEventParam.previous_item_id: str - added:
field ConversationItemCreateEventParam.type: Required[Literal['conversation.item.create']]
- added:
class ConversationItemCreatedEvent(BaseModel) - added:
field ConversationItemCreatedEvent.event_id: str - added:
field ConversationItemCreatedEvent.item: ConversationItem - added:
field ConversationItemCreatedEvent.previous_item_id: Optional[str] - added:
field ConversationItemCreatedEvent.type: Literal['conversation.item.created']
- added:
class ConversationItemDeleteEvent(BaseModel) - added:
field ConversationItemDeleteEvent.event_id: Optional[str] - added:
field ConversationItemDeleteEvent.item_id: str - added:
field ConversationItemDeleteEvent.type: Literal['conversation.item.delete']
- added:
class ConversationItemDeleteEventParam(TypedDict) - added:
field ConversationItemDeleteEventParam.event_id: str - added:
field ConversationItemDeleteEventParam.item_id: Required[str] - added:
field ConversationItemDeleteEventParam.type: Required[Literal['conversation.item.delete']]
- added:
class ConversationItemDeletedEvent(BaseModel) - added:
field ConversationItemDeletedEvent.event_id: str - added:
field ConversationItemDeletedEvent.item_id: str - added:
field ConversationItemDeletedEvent.type: Literal['conversation.item.deleted']
- added:
class ConversationItemInputAudioTranscriptionCompletedEvent(BaseModel) - added:
class Logprob(BaseModel) - added:
class UsageTranscriptTextUsageDuration(BaseModel) - added:
class UsageTranscriptTextUsageTokens(BaseModel) - added:
class UsageTranscriptTextUsageTokensInputTokenDetails(BaseModel) - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.content_index: int - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.event_id: str - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.item_id: str - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.logprobs: Optional[List[Logprob]] - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.transcript: str - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.type: Literal['conversation.item.input_audio_transcription.completed'] - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.usage: Usage - added:
field Logprob.bytes: List[int] - added:
field Logprob.logprob: float - added:
field Logprob.token: str - added:
field UsageTranscriptTextUsageDuration.seconds: float - added:
field UsageTranscriptTextUsageDuration.type: Literal['duration'] - added:
field UsageTranscriptTextUsageTokens.input_token_details: Optional[UsageTranscriptTextUsageTokensInputTokenDetails] - added:
field UsageTranscriptTextUsageTokens.input_tokens: int - added:
field UsageTranscriptTextUsageTokens.output_tokens: int - added:
field UsageTranscriptTextUsageTokens.total_tokens: int - added:
field UsageTranscriptTextUsageTokens.type: Literal['tokens'] - added:
field UsageTranscriptTextUsageTokensInputTokenDetails.audio_tokens: Optional[int] - added:
field UsageTranscriptTextUsageTokensInputTokenDetails.text_tokens: Optional[int] - added:
variable Usage: TypeAlias
- added:
class ConversationItemInputAudioTranscriptionDeltaEvent(BaseModel) - added:
class Logprob(BaseModel) - added:
field ConversationItemInputAudioTranscriptionDeltaEvent.content_index: Optional[int] - added:
field ConversationItemInputAudioTranscriptionDeltaEvent.delta: Optional[str] - added:
field ConversationItemInputAudioTranscriptionDeltaEvent.event_id: str - added:
field ConversationItemInputAudioTranscriptionDeltaEvent.item_id: str - added:
field ConversationItemInputAudioTranscriptionDeltaEvent.logprobs: Optional[List[Logprob]] - added:
field ConversationItemInputAudioTranscriptionDeltaEvent.type: Literal['conversation.item.input_audio_transcription.delta'] - added:
field Logprob.bytes: List[int] - added:
field Logprob.logprob: float - added:
field Logprob.token: str
- added:
class ConversationItemInputAudioTranscriptionFailedEvent(BaseModel) - added:
class Error(BaseModel) - added:
field ConversationItemInputAudioTranscriptionFailedEvent.content_index: int - added:
field ConversationItemInputAudioTranscriptionFailedEvent.error: Error - added:
field ConversationItemInputAudioTranscriptionFailedEvent.event_id: str - added:
field ConversationItemInputAudioTranscriptionFailedEvent.item_id: str - added:
field ConversationItemInputAudioTranscriptionFailedEvent.type: Literal['conversation.item.input_audio_transcription.failed'] - added:
field Error.code: Optional[str] - added:
field Error.message: Optional[str] - added:
field Error.param: Optional[str] - added:
field Error.type: Optional[str]
- added:
class ConversationItemParam(TypedDict) - added:
field ConversationItemParam.arguments: str - added:
field ConversationItemParam.call_id: str - added:
field ConversationItemParam.content: Iterable[ConversationItemContentParam] - added:
field ConversationItemParam.id: str - added:
field ConversationItemParam.name: str - added:
field ConversationItemParam.object: Literal['realtime.item'] - added:
field ConversationItemParam.output: str - added:
field ConversationItemParam.role: Literal['user', 'assistant', 'system'] - added:
field ConversationItemParam.status: Literal['completed', 'incomplete', 'in_progress'] - added:
field ConversationItemParam.type: Literal['message', 'function_call', 'function_call_output']
- added:
class ConversationItemRetrieveEvent(BaseModel) - added:
field ConversationItemRetrieveEvent.event_id: Optional[str] - added:
field ConversationItemRetrieveEvent.item_id: str - added:
field ConversationItemRetrieveEvent.type: Literal['conversation.item.retrieve']
- added:
class ConversationItemRetrieveEventParam(TypedDict) - added:
field ConversationItemRetrieveEventParam.event_id: str - added:
field ConversationItemRetrieveEventParam.item_id: Required[str] - added:
field ConversationItemRetrieveEventParam.type: Required[Literal['conversation.item.retrieve']]
- added:
class ConversationItemTruncateEvent(BaseModel) - added:
field ConversationItemTruncateEvent.audio_end_ms: int - added:
field ConversationItemTruncateEvent.content_index: int - added:
field ConversationItemTruncateEvent.event_id: Optional[str] - added:
field ConversationItemTruncateEvent.item_id: str - added:
field ConversationItemTruncateEvent.type: Literal['conversation.item.truncate']
- added:
class ConversationItemTruncateEventParam(TypedDict) - added:
field ConversationItemTruncateEventParam.audio_end_ms: Required[int] - added:
field ConversationItemTruncateEventParam.content_index: Required[int] - added:
field ConversationItemTruncateEventParam.event_id: str - added:
field ConversationItemTruncateEventParam.item_id: Required[str] - added:
field ConversationItemTruncateEventParam.type: Required[Literal['conversation.item.truncate']]
- added:
class ConversationItemTruncatedEvent(BaseModel) - added:
field ConversationItemTruncatedEvent.audio_end_ms: int - added:
field ConversationItemTruncatedEvent.content_index: int - added:
field ConversationItemTruncatedEvent.event_id: str - added:
field ConversationItemTruncatedEvent.item_id: str - added:
field ConversationItemTruncatedEvent.type: Literal['conversation.item.truncated']
- added:
class Content(BaseModel) - added:
class ConversationItemWithReference(BaseModel) - added:
field Content.audio: Optional[str] - added:
field Content.id: Optional[str] - added:
field Content.text: Optional[str] - added:
field Content.transcript: Optional[str] - added:
field Content.type: Optional[Literal['input_text', 'input_audio', 'item_reference', 'text']] - added:
field ConversationItemWithReference.arguments: Optional[str] - added:
field ConversationItemWithReference.call_id: Optional[str] - added:
field ConversationItemWithReference.content: Optional[List[Content]] - added:
field ConversationItemWithReference.id: Optional[str] - added:
field ConversationItemWithReference.name: Optional[str] - added:
field ConversationItemWithReference.object: Optional[Literal['realtime.item']] - added:
field ConversationItemWithReference.output: Optional[str] - added:
field ConversationItemWithReference.role: Optional[Literal['user', 'assistant', 'system']] - added:
field ConversationItemWithReference.status: Optional[Literal['completed', 'incomplete', 'in_progress']] - added:
field ConversationItemWithReference.type: Optional[Literal['message', 'function_call', 'function_call_output', 'item_reference']]
- added:
class Content(TypedDict) - added:
class ConversationItemWithReferenceParam(TypedDict) - added:
field Content.audio: str - added:
field Content.id: str - added:
field Content.text: str - added:
field Content.transcript: str - added:
field Content.type: Literal['input_text', 'input_audio', 'item_reference', 'text'] - added:
field ConversationItemWithReferenceParam.arguments: str - added:
field ConversationItemWithReferenceParam.call_id: str - added:
field ConversationItemWithReferenceParam.content: Iterable[Content] - added:
field ConversationItemWithReferenceParam.id: str - added:
field ConversationItemWithReferenceParam.name: str - added:
field ConversationItemWithReferenceParam.object: Literal['realtime.item'] - added:
field ConversationItemWithReferenceParam.output: str - added:
field ConversationItemWithReferenceParam.role: Literal['user', 'assistant', 'system'] - added:
field ConversationItemWithReferenceParam.status: Literal['completed', 'incomplete', 'in_progress'] - added:
field ConversationItemWithReferenceParam.type: Literal['message', 'function_call', 'function_call_output', 'item_reference']
- added:
class Error(BaseModel) - added:
class ErrorEvent(BaseModel) - added:
field Error.code: Optional[str] - added:
field Error.event_id: Optional[str] - added:
field Error.message: str - added:
field Error.param: Optional[str] - added:
field Error.type: str - added:
field ErrorEvent.error: Error - added:
field ErrorEvent.event_id: str - added:
field ErrorEvent.type: Literal['error']
- added:
class InputAudioBufferAppendEvent(BaseModel) - added:
field InputAudioBufferAppendEvent.audio: str - added:
field InputAudioBufferAppendEvent.event_id: Optional[str] - added:
field InputAudioBufferAppendEvent.type: Literal['input_audio_buffer.append']
- added:
class InputAudioBufferAppendEventParam(TypedDict) - added:
field InputAudioBufferAppendEventParam.audio: Required[str] - added:
field InputAudioBufferAppendEventParam.event_id: str - added:
field InputAudioBufferAppendEventParam.type: Required[Literal['input_audio_buffer.append']]
- added:
class InputAudioBufferClearEvent(BaseModel) - added:
field InputAudioBufferClearEvent.event_id: Optional[str] - added:
field InputAudioBufferClearEvent.type: Literal['input_audio_buffer.clear']
- added:
class InputAudioBufferClearEventParam(TypedDict) - added:
field InputAudioBufferClearEventParam.event_id: str - added:
field InputAudioBufferClearEventParam.type: Required[Literal['input_audio_buffer.clear']]
- added:
class InputAudioBufferClearedEvent(BaseModel) - added:
field InputAudioBufferClearedEvent.event_id: str - added:
field InputAudioBufferClearedEvent.type: Literal['input_audio_buffer.cleared']
- added:
class InputAudioBufferCommitEvent(BaseModel) - added:
field InputAudioBufferCommitEvent.event_id: Optional[str] - added:
field InputAudioBufferCommitEvent.type: Literal['input_audio_buffer.commit']
- added:
class InputAudioBufferCommitEventParam(TypedDict) - added:
field InputAudioBufferCommitEventParam.event_id: str - added:
field InputAudioBufferCommitEventParam.type: Required[Literal['input_audio_buffer.commit']]
- added:
class InputAudioBufferCommittedEvent(BaseModel) - added:
field InputAudioBufferCommittedEvent.event_id: str - added:
field InputAudioBufferCommittedEvent.item_id: str - added:
field InputAudioBufferCommittedEvent.previous_item_id: Optional[str] - added:
field InputAudioBufferCommittedEvent.type: Literal['input_audio_buffer.committed']
- added:
class InputAudioBufferSpeechStartedEvent(BaseModel) - added:
field InputAudioBufferSpeechStartedEvent.audio_start_ms: int - added:
field InputAudioBufferSpeechStartedEvent.event_id: str - added:
field InputAudioBufferSpeechStartedEvent.item_id: str - added:
field InputAudioBufferSpeechStartedEvent.type: Literal['input_audio_buffer.speech_started']
- added:
class InputAudioBufferSpeechStoppedEvent(BaseModel) - added:
field InputAudioBufferSpeechStoppedEvent.audio_end_ms: int - added:
field InputAudioBufferSpeechStoppedEvent.event_id: str - added:
field InputAudioBufferSpeechStoppedEvent.item_id: str - added:
field InputAudioBufferSpeechStoppedEvent.type: Literal['input_audio_buffer.speech_stopped']
- added:
class RateLimit(BaseModel) - added:
class RateLimitsUpdatedEvent(BaseModel) - added:
field RateLimit.limit: Optional[int] - added:
field RateLimit.name: Optional[Literal['requests', 'tokens']] - added:
field RateLimit.remaining: Optional[int] - added:
field RateLimit.reset_seconds: Optional[float] - added:
field RateLimitsUpdatedEvent.event_id: str - added:
field RateLimitsUpdatedEvent.rate_limits: List[RateLimit] - added:
field RateLimitsUpdatedEvent.type: Literal['rate_limits.updated']
- added:
class OutputAudioBufferClear(BaseModel) - added:
field OutputAudioBufferClear.event_id: Optional[str] - added:
field OutputAudioBufferClear.type: Literal['output_audio_buffer.clear'] - added:
variable RealtimeClientEvent: TypeAlias
- added:
class OutputAudioBufferClear(TypedDict) - added:
field OutputAudioBufferClear.event_id: str - added:
field OutputAudioBufferClear.type: Required[Literal['output_audio_buffer.clear']] - added:
variable RealtimeClientEventParam: TypeAlias
- added:
class RealtimeConnectParams(TypedDict) - added:
field RealtimeConnectParams.model: Required[str]
- added:
class RealtimeResponse(BaseModel) - added:
field RealtimeResponse.conversation_id: Optional[str] - added:
field RealtimeResponse.id: Optional[str] - added:
field RealtimeResponse.max_output_tokens: Union[int, Literal['inf'], None] - added:
field RealtimeResponse.metadata: Optional[Metadata] - added:
field RealtimeResponse.modalities: Optional[List[Literal['text', 'audio']]] - added:
field RealtimeResponse.object: Optional[Literal['realtime.response']] - added:
field RealtimeResponse.output: Optional[List[ConversationItem]] - added:
field RealtimeResponse.output_audio_format: Optional[Literal['pcm16', 'g711_ulaw', 'g711_alaw']] - added:
field RealtimeResponse.status: Optional[Literal['completed', 'cancelled', 'failed', 'incomplete', 'in_progress']] - added:
field RealtimeResponse.status_details: Optional[RealtimeResponseStatus] - added:
field RealtimeResponse.temperature: Optional[float] - added:
field RealtimeResponse.usage: Optional[RealtimeResponseUsage] - added:
field RealtimeResponse.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse'], None]
- added:
class Error(BaseModel) - added:
class RealtimeResponseStatus(BaseModel) - added:
field Error.code: Optional[str] - added:
field Error.type: Optional[str] - added:
field RealtimeResponseStatus.error: Optional[Error] - added:
field RealtimeResponseStatus.reason: Optional[Literal['turn_detected', 'client_cancelled', 'max_output_tokens', 'content_filter']] - added:
field RealtimeResponseStatus.type: Optional[Literal['completed', 'cancelled', 'incomplete', 'failed']]
- added:
class InputTokenDetails(BaseModel) - added:
class OutputTokenDetails(BaseModel) - added:
class RealtimeResponseUsage(BaseModel) - added:
field InputTokenDetails.audio_tokens: Optional[int] - added:
field InputTokenDetails.cached_tokens: Optional[int] - added:
field InputTokenDetails.text_tokens: Optional[int] - added:
field OutputTokenDetails.audio_tokens: Optional[int] - added:
field OutputTokenDetails.text_tokens: Optional[int] - added:
field RealtimeResponseUsage.input_token_details: Optional[InputTokenDetails] - added:
field RealtimeResponseUsage.input_tokens: Optional[int] - added:
field RealtimeResponseUsage.output_token_details: Optional[OutputTokenDetails] - added:
field RealtimeResponseUsage.output_tokens: Optional[int] - added:
field RealtimeResponseUsage.total_tokens: Optional[int]
- added:
class ConversationItemRetrieved(BaseModel) - added:
class OutputAudioBufferCleared(BaseModel) - added:
class OutputAudioBufferStarted(BaseModel) - added:
class OutputAudioBufferStopped(BaseModel) - added:
field ConversationItemRetrieved.event_id: str - added:
field ConversationItemRetrieved.item: ConversationItem - added:
field ConversationItemRetrieved.type: Literal['conversation.item.retrieved'] - added:
field OutputAudioBufferCleared.event_id: str - added:
field OutputAudioBufferCleared.response_id: str - added:
field OutputAudioBufferCleared.type: Literal['output_audio_buffer.cleared'] - added:
field OutputAudioBufferStarted.event_id: str - added:
field OutputAudioBufferStarted.response_id: str - added:
field OutputAudioBufferStarted.type: Literal['output_audio_buffer.started'] - added:
field OutputAudioBufferStopped.event_id: str - added:
field OutputAudioBufferStopped.response_id: str - added:
field OutputAudioBufferStopped.type: Literal['output_audio_buffer.stopped'] - added:
variable RealtimeServerEvent: TypeAlias
- added:
class ResponseAudioDeltaEvent(BaseModel) - added:
field ResponseAudioDeltaEvent.content_index: int - added:
field ResponseAudioDeltaEvent.delta: str - added:
field ResponseAudioDeltaEvent.event_id: str - added:
field ResponseAudioDeltaEvent.item_id: str - added:
field ResponseAudioDeltaEvent.output_index: int - added:
field ResponseAudioDeltaEvent.response_id: str - added:
field ResponseAudioDeltaEvent.type: Literal['response.audio.delta']
- added:
class ResponseAudioDoneEvent(BaseModel) - added:
field ResponseAudioDoneEvent.content_index: int - added:
field ResponseAudioDoneEvent.event_id: str - added:
field ResponseAudioDoneEvent.item_id: str - added:
field ResponseAudioDoneEvent.output_index: int - added:
field ResponseAudioDoneEvent.response_id: str - added:
field ResponseAudioDoneEvent.type: Literal['response.audio.done']
- added:
class ResponseAudioTranscriptDeltaEvent(BaseModel) - added:
field ResponseAudioTranscriptDeltaEvent.content_index: int - added:
field ResponseAudioTranscriptDeltaEvent.delta: str - added:
field ResponseAudioTranscriptDeltaEvent.event_id: str - added:
field ResponseAudioTranscriptDeltaEvent.item_id: str - added:
field ResponseAudioTranscriptDeltaEvent.output_index: int - added:
field ResponseAudioTranscriptDeltaEvent.response_id: str - added:
field ResponseAudioTranscriptDeltaEvent.type: Literal['response.audio_transcript.delta']
- added:
class ResponseAudioTranscriptDoneEvent(BaseModel) - added:
field ResponseAudioTranscriptDoneEvent.content_index: int - added:
field ResponseAudioTranscriptDoneEvent.event_id: str - added:
field ResponseAudioTranscriptDoneEvent.item_id: str - added:
field ResponseAudioTranscriptDoneEvent.output_index: int - added:
field ResponseAudioTranscriptDoneEvent.response_id: str - added:
field ResponseAudioTranscriptDoneEvent.transcript: str - added:
field ResponseAudioTranscriptDoneEvent.type: Literal['response.audio_transcript.done']
- added:
class ResponseCancelEvent(BaseModel) - added:
field ResponseCancelEvent.event_id: Optional[str] - added:
field ResponseCancelEvent.response_id: Optional[str] - added:
field ResponseCancelEvent.type: Literal['response.cancel']
- added:
class ResponseCancelEventParam(TypedDict) - added:
field ResponseCancelEventParam.event_id: str - added:
field ResponseCancelEventParam.response_id: str - added:
field ResponseCancelEventParam.type: Required[Literal['response.cancel']]
- added:
class Part(BaseModel) - added:
class ResponseContentPartAddedEvent(BaseModel) - added:
field Part.audio: Optional[str] - added:
field Part.text: Optional[str] - added:
field Part.transcript: Optional[str] - added:
field Part.type: Optional[Literal['text', 'audio']] - added:
field ResponseContentPartAddedEvent.content_index: int - added:
field ResponseContentPartAddedEvent.event_id: str - added:
field ResponseContentPartAddedEvent.item_id: str - added:
field ResponseContentPartAddedEvent.output_index: int - added:
field ResponseContentPartAddedEvent.part: Part - added:
field ResponseContentPartAddedEvent.response_id: str - added:
field ResponseContentPartAddedEvent.type: Literal['response.content_part.added']
- added:
class Part(BaseModel) - added:
class ResponseContentPartDoneEvent(BaseModel) - added:
field Part.audio: Optional[str] - added:
field Part.text: Optional[str] - added:
field Part.transcript: Optional[str] - added:
field Part.type: Optional[Literal['text', 'audio']] - added:
field ResponseContentPartDoneEvent.content_index: int - added:
field ResponseContentPartDoneEvent.event_id: str - added:
field ResponseContentPartDoneEvent.item_id: str - added:
field ResponseContentPartDoneEvent.output_index: int - added:
field ResponseContentPartDoneEvent.part: Part - added:
field ResponseContentPartDoneEvent.response_id: str - added:
field ResponseContentPartDoneEvent.type: Literal['response.content_part.done']
- added:
class Response(BaseModel) - added:
class ResponseCreateEvent(BaseModel) - added:
class ResponseTool(BaseModel) - added:
field Response.conversation: Union[str, Literal['auto', 'none'], None] - added:
field Response.input: Optional[List[ConversationItemWithReference]] - added:
field Response.instructions: Optional[str] - added:
field Response.max_response_output_tokens: Union[int, Literal['inf'], None] - added:
field Response.metadata: Optional[Metadata] - added:
field Response.modalities: Optional[List[Literal['text', 'audio']]] - added:
field Response.output_audio_format: Optional[Literal['pcm16', 'g711_ulaw', 'g711_alaw']] - added:
field Response.temperature: Optional[float] - added:
field Response.tool_choice: Optional[str] - added:
field Response.tools: Optional[List[ResponseTool]] - added:
field Response.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse'], None] - added:
field ResponseCreateEvent.event_id: Optional[str] - added:
field ResponseCreateEvent.response: Optional[Response] - added:
field ResponseCreateEvent.type: Literal['response.create'] - added:
field ResponseTool.description: Optional[str] - added:
field ResponseTool.name: Optional[str] - added:
field ResponseTool.parameters: Optional[object] - added:
field ResponseTool.type: Optional[Literal['function']]
- added:
class Response(TypedDict) - added:
class ResponseCreateEventParam(TypedDict) - added:
class ResponseTool(TypedDict) - added:
field Response.conversation: Union[str, Literal['auto', 'none']] - added:
field Response.input: Iterable[ConversationItemWithReferenceParam] - added:
field Response.instructions: str - added:
field Response.max_response_output_tokens: Union[int, Literal['inf']] - added:
field Response.metadata: Optional[Metadata] - added:
field Response.modalities: List[Literal['text', 'audio']] - added:
field Response.output_audio_format: Literal['pcm16', 'g711_ulaw', 'g711_alaw'] - added:
field Response.temperature: float - added:
field Response.tool_choice: str - added:
field Response.tools: Iterable[ResponseTool] - added:
field Response.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse']] - added:
field ResponseCreateEventParam.event_id: str - added:
field ResponseCreateEventParam.response: Response - added:
field ResponseCreateEventParam.type: Required[Literal['response.create']] - added:
field ResponseTool.description: str - added:
field ResponseTool.name: str - added:
field ResponseTool.parameters: object - added:
field ResponseTool.type: Literal['function']
- added:
class ResponseCreatedEvent(BaseModel) - added:
field ResponseCreatedEvent.event_id: str - added:
field ResponseCreatedEvent.response: RealtimeResponse - added:
field ResponseCreatedEvent.type: Literal['response.created']
- added:
class ResponseDoneEvent(BaseModel) - added:
field ResponseDoneEvent.event_id: str - added:
field ResponseDoneEvent.response: RealtimeResponse - added:
field ResponseDoneEvent.type: Literal['response.done']
- added:
class ResponseFunctionCallArgumentsDeltaEvent(BaseModel) - added:
field ResponseFunctionCallArgumentsDeltaEvent.call_id: str - added:
field ResponseFunctionCallArgumentsDeltaEvent.delta: str - added:
field ResponseFunctionCallArgumentsDeltaEvent.event_id: str - added:
field ResponseFunctionCallArgumentsDeltaEvent.item_id: str - added:
field ResponseFunctionCallArgumentsDeltaEvent.output_index: int - added:
field ResponseFunctionCallArgumentsDeltaEvent.response_id: str - added:
field ResponseFunctionCallArgumentsDeltaEvent.type: Literal['response.function_call_arguments.delta']
- added:
class ResponseFunctionCallArgumentsDoneEvent(BaseModel) - added:
field ResponseFunctionCallArgumentsDoneEvent.arguments: str - added:
field ResponseFunctionCallArgumentsDoneEvent.call_id: str - added:
field ResponseFunctionCallArgumentsDoneEvent.event_id: str - added:
field ResponseFunctionCallArgumentsDoneEvent.item_id: str - added:
field ResponseFunctionCallArgumentsDoneEvent.output_index: int - added:
field ResponseFunctionCallArgumentsDoneEvent.response_id: str - added:
field ResponseFunctionCallArgumentsDoneEvent.type: Literal['response.function_call_arguments.done']
- added:
class ResponseOutputItemAddedEvent(BaseModel) - added:
field ResponseOutputItemAddedEvent.event_id: str - added:
field ResponseOutputItemAddedEvent.item: ConversationItem - added:
field ResponseOutputItemAddedEvent.output_index: int - added:
field ResponseOutputItemAddedEvent.response_id: str - added:
field ResponseOutputItemAddedEvent.type: Literal['response.output_item.added']
- added:
class ResponseOutputItemDoneEvent(BaseModel) - added:
field ResponseOutputItemDoneEvent.event_id: str - added:
field ResponseOutputItemDoneEvent.item: ConversationItem - added:
field ResponseOutputItemDoneEvent.output_index: int - added:
field ResponseOutputItemDoneEvent.response_id: str - added:
field ResponseOutputItemDoneEvent.type: Literal['response.output_item.done']
- added:
class ResponseTextDeltaEvent(BaseModel) - added:
field ResponseTextDeltaEvent.content_index: int - added:
field ResponseTextDeltaEvent.delta: str - added:
field ResponseTextDeltaEvent.event_id: str - added:
field ResponseTextDeltaEvent.item_id: str - added:
field ResponseTextDeltaEvent.output_index: int - added:
field ResponseTextDeltaEvent.response_id: str - added:
field ResponseTextDeltaEvent.type: Literal['response.text.delta']
- added:
class ResponseTextDoneEvent(BaseModel) - added:
field ResponseTextDoneEvent.content_index: int - added:
field ResponseTextDoneEvent.event_id: str - added:
field ResponseTextDoneEvent.item_id: str - added:
field ResponseTextDoneEvent.output_index: int - added:
field ResponseTextDoneEvent.response_id: str - added:
field ResponseTextDoneEvent.text: str - added:
field ResponseTextDoneEvent.type: Literal['response.text.done']
- added:
class InputAudioNoiseReduction(BaseModel) - added:
class InputAudioTranscription(BaseModel) - added:
class Session(BaseModel) - added:
class Tool(BaseModel) - added:
class TracingTracingConfiguration(BaseModel) - added:
class TurnDetection(BaseModel) - added:
field InputAudioNoiseReduction.type: Optional[Literal['near_field', 'far_field']] - added:
field InputAudioTranscription.language: Optional[str] - added:
field InputAudioTranscription.model: Optional[str] - added:
field InputAudioTranscription.prompt: Optional[str] - added:
field Session.id: Optional[str] - added:
field Session.input_audio_format: Optional[Literal['pcm16', 'g711_ulaw', 'g711_alaw']] - added:
field Session.input_audio_noise_reduction: Optional[InputAudioNoiseReduction] - added:
field Session.input_audio_transcription: Optional[InputAudioTranscription] - added:
field Session.instructions: Optional[str] - added:
field Session.max_response_output_tokens: Union[int, Literal['inf'], None] - added:
field Session.modalities: Optional[List[Literal['text', 'audio']]] - added:
field Session.model: Optional[Literal['gpt-4o-realtime-preview', 'gpt-4o-realtime-preview-2024-10-01', 'gpt-4o-realtime-preview-2024-12-17', 'gpt-4o-realtime-preview-2025-06-03', 'gpt-4o-mini-realtime-preview', 'gpt-4o-mini-realtime-preview-2024-12-17']] - added:
field Session.output_audio_format: Optional[Literal['pcm16', 'g711_ulaw', 'g711_alaw']] - added:
field Session.speed: Optional[float] - added:
field Session.temperature: Optional[float] - added:
field Session.tool_choice: Optional[str] - added:
field Session.tools: Optional[List[Tool]] - added:
field Session.tracing: Optional[Tracing] - added:
field Session.turn_detection: Optional[TurnDetection] - added:
field Session.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse'], None] - added:
field Tool.description: Optional[str] - added:
field Tool.name: Optional[str] - added:
field Tool.parameters: Optional[object] - added:
field Tool.type: Optional[Literal['function']] - added:
field TracingTracingConfiguration.group_id: Optional[str] - added:
field TracingTracingConfiguration.metadata: Optional[object] - added:
field TracingTracingConfiguration.workflow_name: Optional[str] - added:
field TurnDetection.create_response: Optional[bool] - added:
field TurnDetection.eagerness: Optional[Literal['low', 'medium', 'high', 'auto']] - added:
field TurnDetection.interrupt_response: Optional[bool] - added:
field TurnDetection.prefix_padding_ms: Optional[int] - added:
field TurnDetection.silence_duration_ms: Optional[int] - added:
field TurnDetection.threshold: Optional[float] - added:
field TurnDetection.type: Optional[Literal['server_vad', 'semantic_vad']] - added:
variable Tracing: TypeAlias
- added:
class ClientSecret(TypedDict) - added:
class ClientSecretExpiresAfter(TypedDict) - added:
class InputAudioNoiseReduction(TypedDict) - added:
class InputAudioTranscription(TypedDict) - added:
class SessionCreateParams(TypedDict) - added:
class Tool(TypedDict) - added:
class TracingTracingConfiguration(TypedDict) - added:
class TurnDetection(TypedDict) - added:
field ClientSecret.expires_after: ClientSecretExpiresAfter - added:
field ClientSecretExpiresAfter.anchor: Required[Literal['created_at']] - added:
field ClientSecretExpiresAfter.seconds: int - added:
field InputAudioNoiseReduction.type: Literal['near_field', 'far_field'] - added:
field InputAudioTranscription.language: str - added:
field InputAudioTranscription.model: str - added:
field InputAudioTranscription.prompt: str - added:
field SessionCreateParams.client_secret: ClientSecret - added:
field SessionCreateParams.input_audio_format: Literal['pcm16', 'g711_ulaw', 'g711_alaw'] - added:
field SessionCreateParams.input_audio_noise_reduction: InputAudioNoiseReduction - added:
field SessionCreateParams.input_audio_transcription: InputAudioTranscription - added:
field SessionCreateParams.instructions: str - added:
field SessionCreateParams.max_response_output_tokens: Union[int, Literal['inf']] - added:
field SessionCreateParams.modalities: List[Literal['text', 'audio']] - added:
field SessionCreateParams.model: Literal['gpt-4o-realtime-preview', 'gpt-4o-realtime-preview-2024-10-01', 'gpt-4o-realtime-preview-2024-12-17', 'gpt-4o-realtime-preview-2025-06-03', 'gpt-4o-mini-realtime-preview', 'gpt-4o-mini-realtime-preview-2024-12-17'] - added:
field SessionCreateParams.output_audio_format: Literal['pcm16', 'g711_ulaw', 'g711_alaw'] - added:
field SessionCreateParams.speed: float - added:
field SessionCreateParams.temperature: float - added:
field SessionCreateParams.tool_choice: str - added:
field SessionCreateParams.tools: Iterable[Tool] - added:
field SessionCreateParams.tracing: Tracing - added:
field SessionCreateParams.turn_detection: TurnDetection - added:
field SessionCreateParams.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse']] - added:
field Tool.description: str - added:
field Tool.name: str - added:
field Tool.parameters: object - added:
field Tool.type: Literal['function'] - added:
field TracingTracingConfiguration.group_id: str - added:
field TracingTracingConfiguration.metadata: object - added:
field TracingTracingConfiguration.workflow_name: str - added:
field TurnDetection.create_response: bool - added:
field TurnDetection.eagerness: Literal['low', 'medium', 'high', 'auto'] - added:
field TurnDetection.interrupt_response: bool - added:
field TurnDetection.prefix_padding_ms: int - added:
field TurnDetection.silence_duration_ms: int - added:
field TurnDetection.threshold: float - added:
field TurnDetection.type: Literal['server_vad', 'semantic_vad'] - added:
variable Tracing: TypeAlias
- added:
class ClientSecret(BaseModel) - added:
class InputAudioTranscription(BaseModel) - added:
class SessionCreateResponse(BaseModel) - added:
class Tool(BaseModel) - added:
class TracingTracingConfiguration(BaseModel) - added:
class TurnDetection(BaseModel) - added:
field ClientSecret.expires_at: int - added:
field ClientSecret.value: str - added:
field InputAudioTranscription.model: Optional[str] - added:
field SessionCreateResponse.client_secret: ClientSecret - added:
field SessionCreateResponse.input_audio_format: Optional[str] - added:
field SessionCreateResponse.input_audio_transcription: Optional[InputAudioTranscription] - added:
field SessionCreateResponse.instructions: Optional[str] - added:
field SessionCreateResponse.max_response_output_tokens: Union[int, Literal['inf'], None] - added:
field SessionCreateResponse.modalities: Optional[List[Literal['text', 'audio']]] - added:
field SessionCreateResponse.output_audio_format: Optional[str] - added:
field SessionCreateResponse.speed: Optional[float] - added:
field SessionCreateResponse.temperature: Optional[float] - added:
field SessionCreateResponse.tool_choice: Optional[str] - added:
field SessionCreateResponse.tools: Optional[List[Tool]] - added:
field SessionCreateResponse.tracing: Optional[Tracing] - added:
field SessionCreateResponse.turn_detection: Optional[TurnDetection] - added:
field SessionCreateResponse.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse'], None] - added:
field Tool.description: Optional[str] - added:
field Tool.name: Optional[str] - added:
field Tool.parameters: Optional[object] - added:
field Tool.type: Optional[Literal['function']] - added:
field TracingTracingConfiguration.group_id: Optional[str] - added:
field TracingTracingConfiguration.metadata: Optional[object] - added:
field TracingTracingConfiguration.workflow_name: Optional[str] - added:
field TurnDetection.prefix_padding_ms: Optional[int] - added:
field TurnDetection.silence_duration_ms: Optional[int] - added:
field TurnDetection.threshold: Optional[float] - added:
field TurnDetection.type: Optional[str] - added:
variable Tracing: TypeAlias
- added:
class SessionCreatedEvent(BaseModel) - added:
field SessionCreatedEvent.event_id: str - added:
field SessionCreatedEvent.session: Session - added:
field SessionCreatedEvent.type: Literal['session.created']
- added:
class Session(BaseModel) - added:
class SessionClientSecret(BaseModel) - added:
class SessionClientSecretExpiresAfter(BaseModel) - added:
class SessionInputAudioNoiseReduction(BaseModel) - added:
class SessionInputAudioTranscription(BaseModel) - added:
class SessionTool(BaseModel) - added:
class SessionTracingTracingConfiguration(BaseModel) - added:
class SessionTurnDetection(BaseModel) - added:
class SessionUpdateEvent(BaseModel) - added:
field Session.client_secret: Optional[SessionClientSecret] - added:
field Session.input_audio_format: Optional[Literal['pcm16', 'g711_ulaw', 'g711_alaw']] - added:
field Session.input_audio_noise_reduction: Optional[SessionInputAudioNoiseReduction] - added:
field Session.input_audio_transcription: Optional[SessionInputAudioTranscription] - added:
field Session.instructions: Optional[str] - added:
field Session.max_response_output_tokens: Union[int, Literal['inf'], None] - added:
field Session.modalities: Optional[List[Literal['text', 'audio']]] - added:
field Session.model: Optional[Literal['gpt-4o-realtime-preview', 'gpt-4o-realtime-preview-2024-10-01', 'gpt-4o-realtime-preview-2024-12-17', 'gpt-4o-realtime-preview-2025-06-03', 'gpt-4o-mini-realtime-preview', 'gpt-4o-mini-realtime-preview-2024-12-17']] - added:
field Session.output_audio_format: Optional[Literal['pcm16', 'g711_ulaw', 'g711_alaw']] - added:
field Session.speed: Optional[float] - added:
field Session.temperature: Optional[float] - added:
field Session.tool_choice: Optional[str] - added:
field Session.tools: Optional[List[SessionTool]] - added:
field Session.tracing: Optional[SessionTracing] - added:
field Session.turn_detection: Optional[SessionTurnDetection] - added:
field Session.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse'], None] - added:
field SessionClientSecret.expires_after: Optional[SessionClientSecretExpiresAfter] - added:
field SessionClientSecretExpiresAfter.anchor: Literal['created_at'] - added:
field SessionClientSecretExpiresAfter.seconds: Optional[int] - added:
field SessionInputAudioNoiseReduction.type: Optional[Literal['near_field', 'far_field']] - added:
field SessionInputAudioTranscription.language: Optional[str] - added:
field SessionInputAudioTranscription.model: Optional[str] - added:
field SessionInputAudioTranscription.prompt: Optional[str] - added:
field SessionTool.description: Optional[str] - added:
field SessionTool.name: Optional[str] - added:
field SessionTool.parameters: Optional[object] - added:
field SessionTool.type: Optional[Literal['function']] - added:
field SessionTracingTracingConfiguration.group_id: Optional[str] - added:
field SessionTracingTracingConfiguration.metadata: Optional[object] - added:
field SessionTracingTracingConfiguration.workflow_name: Optional[str] - added:
field SessionTurnDetection.create_response: Optional[bool] - added:
field SessionTurnDetection.eagerness: Optional[Literal['low', 'medium', 'high', 'auto']] - added:
field SessionTurnDetection.interrupt_response: Optional[bool] - added:
field SessionTurnDetection.prefix_padding_ms: Optional[int] - added:
field SessionTurnDetection.silence_duration_ms: Optional[int] - added:
field SessionTurnDetection.threshold: Optional[float] - added:
field SessionTurnDetection.type: Optional[Literal['server_vad', 'semantic_vad']] - added:
field SessionUpdateEvent.event_id: Optional[str] - added:
field SessionUpdateEvent.session: Session - added:
field SessionUpdateEvent.type: Literal['session.update'] - added:
variable SessionTracing: TypeAlias
- added:
class Session(TypedDict) - added:
class SessionClientSecret(TypedDict) - added:
class SessionClientSecretExpiresAfter(TypedDict) - added:
class SessionInputAudioNoiseReduction(TypedDict) - added:
class SessionInputAudioTranscription(TypedDict) - added:
class SessionTool(TypedDict) - added:
class SessionTracingTracingConfiguration(TypedDict) - added:
class SessionTurnDetection(TypedDict) - added:
class SessionUpdateEventParam(TypedDict) - added:
field Session.client_secret: SessionClientSecret - added:
field Session.input_audio_format: Literal['pcm16', 'g711_ulaw', 'g711_alaw'] - added:
field Session.input_audio_noise_reduction: SessionInputAudioNoiseReduction - added:
field Session.input_audio_transcription: SessionInputAudioTranscription - added:
field Session.instructions: str - added:
field Session.max_response_output_tokens: Union[int, Literal['inf']] - added:
field Session.modalities: List[Literal['text', 'audio']] - added:
field Session.model: Literal['gpt-4o-realtime-preview', 'gpt-4o-realtime-preview-2024-10-01', 'gpt-4o-realtime-preview-2024-12-17', 'gpt-4o-realtime-preview-2025-06-03', 'gpt-4o-mini-realtime-preview', 'gpt-4o-mini-realtime-preview-2024-12-17'] - added:
field Session.output_audio_format: Literal['pcm16', 'g711_ulaw', 'g711_alaw'] - added:
field Session.speed: float - added:
field Session.temperature: float - added:
field Session.tool_choice: str - added:
field Session.tools: Iterable[SessionTool] - added:
field Session.tracing: SessionTracing - added:
field Session.turn_detection: SessionTurnDetection - added:
field Session.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse']] - added:
field SessionClientSecret.expires_after: SessionClientSecretExpiresAfter - added:
field SessionClientSecretExpiresAfter.anchor: Required[Literal['created_at']] - added:
field SessionClientSecretExpiresAfter.seconds: int - added:
field SessionInputAudioNoiseReduction.type: Literal['near_field', 'far_field'] - added:
field SessionInputAudioTranscription.language: str - added:
field SessionInputAudioTranscription.model: str - added:
field SessionInputAudioTranscription.prompt: str - added:
field SessionTool.description: str - added:
field SessionTool.name: str - added:
field SessionTool.parameters: object - added:
field SessionTool.type: Literal['function'] - added:
field SessionTracingTracingConfiguration.group_id: str - added:
field SessionTracingTracingConfiguration.metadata: object - added:
field SessionTracingTracingConfiguration.workflow_name: str - added:
field SessionTurnDetection.create_response: bool - added:
field SessionTurnDetection.eagerness: Literal['low', 'medium', 'high', 'auto'] - added:
field SessionTurnDetection.interrupt_response: bool - added:
field SessionTurnDetection.prefix_padding_ms: int - added:
field SessionTurnDetection.silence_duration_ms: int - added:
field SessionTurnDetection.threshold: float - added:
field SessionTurnDetection.type: Literal['server_vad', 'semantic_vad'] - added:
field SessionUpdateEventParam.event_id: str - added:
field SessionUpdateEventParam.session: Required[Session] - added:
field SessionUpdateEventParam.type: Required[Literal['session.update']] - added:
variable SessionTracing: TypeAlias
- added:
class SessionUpdatedEvent(BaseModel) - added:
field SessionUpdatedEvent.event_id: str - added:
field SessionUpdatedEvent.session: Session - added:
field SessionUpdatedEvent.type: Literal['session.updated']
- added:
class ClientSecret(BaseModel) - added:
class InputAudioTranscription(BaseModel) - added:
class TranscriptionSession(BaseModel) - added:
class TurnDetection(BaseModel) - added:
field ClientSecret.expires_at: int - added:
field ClientSecret.value: str - added:
field InputAudioTranscription.language: Optional[str] - added:
field InputAudioTranscription.model: Optional[Literal['gpt-4o-transcribe', 'gpt-4o-mini-transcribe', 'whisper-1']] - added:
field InputAudioTranscription.prompt: Optional[str] - added:
field TranscriptionSession.client_secret: ClientSecret - added:
field TranscriptionSession.input_audio_format: Optional[str] - added:
field TranscriptionSession.input_audio_transcription: Optional[InputAudioTranscription] - added:
field TranscriptionSession.modalities: Optional[List[Literal['text', 'audio']]] - added:
field TranscriptionSession.turn_detection: Optional[TurnDetection] - added:
field TurnDetection.prefix_padding_ms: Optional[int] - added:
field TurnDetection.silence_duration_ms: Optional[int] - added:
field TurnDetection.threshold: Optional[float] - added:
field TurnDetection.type: Optional[str]
- added:
class ClientSecret(TypedDict) - added:
class ClientSecretExpiresAt(TypedDict) - added:
class InputAudioNoiseReduction(TypedDict) - added:
class InputAudioTranscription(TypedDict) - added:
class TranscriptionSessionCreateParams(TypedDict) - added:
class TurnDetection(TypedDict) - added:
field ClientSecret.expires_at: ClientSecretExpiresAt - added:
field ClientSecretExpiresAt.anchor: Literal['created_at'] - added:
field ClientSecretExpiresAt.seconds: int - added:
field InputAudioNoiseReduction.type: Literal['near_field', 'far_field'] - added:
field InputAudioTranscription.language: str - added:
field InputAudioTranscription.model: Literal['gpt-4o-transcribe', 'gpt-4o-mini-transcribe', 'whisper-1'] - added:
field InputAudioTranscription.prompt: str - added:
field TranscriptionSessionCreateParams.client_secret: ClientSecret - added:
field TranscriptionSessionCreateParams.include: List[str] - added:
field TranscriptionSessionCreateParams.input_audio_format: Literal['pcm16', 'g711_ulaw', 'g711_alaw'] - added:
field TranscriptionSessionCreateParams.input_audio_noise_reduction: InputAudioNoiseReduction - added:
field TranscriptionSessionCreateParams.input_audio_transcription: InputAudioTranscription - added:
field TranscriptionSessionCreateParams.modalities: List[Literal['text', 'audio']] - added:
field TranscriptionSessionCreateParams.turn_detection: TurnDetection - added:
field TurnDetection.create_response: bool - added:
field TurnDetection.eagerness: Literal['low', 'medium', 'high', 'auto'] - added:
field TurnDetection.interrupt_response: bool - added:
field TurnDetection.prefix_padding_ms: int - added:
field TurnDetection.silence_duration_ms: int - added:
field TurnDetection.threshold: float - added:
field TurnDetection.type: Literal['server_vad', 'semantic_vad']
- added:
class Session(BaseModel) - added:
class SessionClientSecret(BaseModel) - added:
class SessionClientSecretExpiresAt(BaseModel) - added:
class SessionInputAudioNoiseReduction(BaseModel) - added:
class SessionInputAudioTranscription(BaseModel) - added:
class SessionTurnDetection(BaseModel) - added:
class TranscriptionSessionUpdate(BaseModel) - added:
field Session.client_secret: Optional[SessionClientSecret] - added:
field Session.include: Optional[List[str]] - added:
field Session.input_audio_format: Optional[Literal['pcm16', 'g711_ulaw', 'g711_alaw']] - added:
field Session.input_audio_noise_reduction: Optional[SessionInputAudioNoiseReduction] - added:
field Session.input_audio_transcription: Optional[SessionInputAudioTranscription] - added:
field Session.modalities: Optional[List[Literal['text', 'audio']]] - added:
field Session.turn_detection: Optional[SessionTurnDetection] - added:
field SessionClientSecret.expires_at: Optional[SessionClientSecretExpiresAt] - added:
field SessionClientSecretExpiresAt.anchor: Optional[Literal['created_at']] - added:
field SessionClientSecretExpiresAt.seconds: Optional[int] - added:
field SessionInputAudioNoiseReduction.type: Optional[Literal['near_field', 'far_field']] - added:
field SessionInputAudioTranscription.language: Optional[str] - added:
field SessionInputAudioTranscription.model: Optional[Literal['gpt-4o-transcribe', 'gpt-4o-mini-transcribe', 'whisper-1']] - added:
field SessionInputAudioTranscription.prompt: Optional[str] - added:
field SessionTurnDetection.create_response: Optional[bool] - added:
field SessionTurnDetection.eagerness: Optional[Literal['low', 'medium', 'high', 'auto']] - added:
field SessionTurnDetection.interrupt_response: Optional[bool] - added:
field SessionTurnDetection.prefix_padding_ms: Optional[int] - added:
field SessionTurnDetection.silence_duration_ms: Optional[int] - added:
field SessionTurnDetection.threshold: Optional[float] - added:
field SessionTurnDetection.type: Optional[Literal['server_vad', 'semantic_vad']] - added:
field TranscriptionSessionUpdate.event_id: Optional[str] - added:
field TranscriptionSessionUpdate.session: Session - added:
field TranscriptionSessionUpdate.type: Literal['transcription_session.update']
- added:
class Session(TypedDict) - added:
class SessionClientSecret(TypedDict) - added:
class SessionClientSecretExpiresAt(TypedDict) - added:
class SessionInputAudioNoiseReduction(TypedDict) - added:
class SessionInputAudioTranscription(TypedDict) - added:
class SessionTurnDetection(TypedDict) - added:
class TranscriptionSessionUpdateParam(TypedDict) - added:
field Session.client_secret: SessionClientSecret - added:
field Session.include: List[str] - added:
field Session.input_audio_format: Literal['pcm16', 'g711_ulaw', 'g711_alaw'] - added:
field Session.input_audio_noise_reduction: SessionInputAudioNoiseReduction - added:
field Session.input_audio_transcription: SessionInputAudioTranscription - added:
field Session.modalities: List[Literal['text', 'audio']] - added:
field Session.turn_detection: SessionTurnDetection - added:
field SessionClientSecret.expires_at: SessionClientSecretExpiresAt - added:
field SessionClientSecretExpiresAt.anchor: Literal['created_at'] - added:
field SessionClientSecretExpiresAt.seconds: int - added:
field SessionInputAudioNoiseReduction.type: Literal['near_field', 'far_field'] - added:
field SessionInputAudioTranscription.language: str - added:
field SessionInputAudioTranscription.model: Literal['gpt-4o-transcribe', 'gpt-4o-mini-transcribe', 'whisper-1'] - added:
field SessionInputAudioTranscription.prompt: str - added:
field SessionTurnDetection.create_response: bool - added:
field SessionTurnDetection.eagerness: Literal['low', 'medium', 'high', 'auto'] - added:
field SessionTurnDetection.interrupt_response: bool - added:
field SessionTurnDetection.prefix_padding_ms: int - added:
field SessionTurnDetection.silence_duration_ms: int - added:
field SessionTurnDetection.threshold: float - added:
field SessionTurnDetection.type: Literal['server_vad', 'semantic_vad'] - added:
field TranscriptionSessionUpdateParam.event_id: str - added:
field TranscriptionSessionUpdateParam.session: Required[Session] - added:
field TranscriptionSessionUpdateParam.type: Required[Literal['transcription_session.update']]
- added:
class TranscriptionSessionUpdatedEvent(BaseModel) - added:
field TranscriptionSessionUpdatedEvent.event_id: str - added:
field TranscriptionSessionUpdatedEvent.session: TranscriptionSession - added:
field TranscriptionSessionUpdatedEvent.type: Literal['transcription_session.updated']
- added:
class Thread(BaseModel) - added:
class ToolResources(BaseModel) - added:
class ToolResourcesCodeInterpreter(BaseModel) - added:
class ToolResourcesFileSearch(BaseModel) - added:
field Thread.created_at: int - added:
field Thread.id: str - added:
field Thread.metadata: Optional[Metadata] - added:
field Thread.object: Literal['thread'] - added:
field Thread.tool_resources: Optional[ToolResources] - added:
field ToolResources.code_interpreter: Optional[ToolResourcesCodeInterpreter] - added:
field ToolResources.file_search: Optional[ToolResourcesFileSearch] - added:
field ToolResourcesCodeInterpreter.file_ids: Optional[List[str]] - added:
field ToolResourcesFileSearch.vector_store_ids: Optional[List[str]]
- added:
class Thread(TypedDict) - added:
class ThreadCreateAndRunParamsBase(TypedDict) - added:
class ThreadCreateAndRunParamsNonStreaming(ThreadCreateAndRunParamsBase) - added:
class ThreadCreateAndRunParamsStreaming(ThreadCreateAndRunParamsBase) - added:
class ThreadMessage(TypedDict) - added:
class ThreadMessageAttachment(TypedDict) - added:
class ThreadMessageAttachmentToolFileSearch(TypedDict) - added:
class ThreadToolResources(TypedDict) - added:
class ThreadToolResourcesCodeInterpreter(TypedDict) - added:
class ThreadToolResourcesFileSearch(TypedDict) - added:
class ThreadToolResourcesFileSearchVectorStore(TypedDict) - added:
class ThreadToolResourcesFileSearchVectorStoreChunkingStrategyAuto(TypedDict) - added:
class ThreadToolResourcesFileSearchVectorStoreChunkingStrategyStatic(TypedDict) - added:
class ThreadToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic(TypedDict) - added:
class ToolResources(TypedDict) - added:
class ToolResourcesCodeInterpreter(TypedDict) - added:
class ToolResourcesFileSearch(TypedDict) - added:
class TruncationStrategy(TypedDict) - added:
field Thread.messages: Iterable[ThreadMessage] - added:
field Thread.metadata: Optional[Metadata] - added:
field Thread.tool_resources: Optional[ThreadToolResources] - added:
field ThreadCreateAndRunParamsBase.assistant_id: Required[str] - added:
field ThreadCreateAndRunParamsBase.instructions: Optional[str] - added:
field ThreadCreateAndRunParamsBase.max_completion_tokens: Optional[int] - added:
field ThreadCreateAndRunParamsBase.max_prompt_tokens: Optional[int] - added:
field ThreadCreateAndRunParamsBase.metadata: Optional[Metadata] - added:
field ThreadCreateAndRunParamsBase.model: Union[str, ChatModel, None] - added:
field ThreadCreateAndRunParamsBase.parallel_tool_calls: bool - added:
field ThreadCreateAndRunParamsBase.response_format: Optional[AssistantResponseFormatOptionParam] - added:
field ThreadCreateAndRunParamsBase.temperature: Optional[float] - added:
field ThreadCreateAndRunParamsBase.thread: Thread - added:
field ThreadCreateAndRunParamsBase.tool_choice: Optional[AssistantToolChoiceOptionParam] - added:
field ThreadCreateAndRunParamsBase.tool_resources: Optional[ToolResources] - added:
field ThreadCreateAndRunParamsBase.tools: Optional[Iterable[AssistantToolParam]] - added:
field ThreadCreateAndRunParamsBase.top_p: Optional[float] - added:
field ThreadCreateAndRunParamsBase.truncation_strategy: Optional[TruncationStrategy] - added:
field ThreadCreateAndRunParamsNonStreaming.stream: Optional[Literal[False]] - added:
field ThreadCreateAndRunParamsStreaming.stream: Required[Literal[True]] - added:
field ThreadMessage.attachments: Optional[Iterable[ThreadMessageAttachment]] - added:
field ThreadMessage.content: Required[Union[str, Iterable[MessageContentPartParam]]] - added:
field ThreadMessage.metadata: Optional[Metadata] - added:
field ThreadMessage.role: Required[Literal['user', 'assistant']] - added:
field ThreadMessageAttachment.file_id: str - added:
field ThreadMessageAttachment.tools: Iterable[ThreadMessageAttachmentTool] - added:
field ThreadMessageAttachmentToolFileSearch.type: Required[Literal['file_search']] - added:
field ThreadToolResources.code_interpreter: ThreadToolResourcesCodeInterpreter - added:
field ThreadToolResources.file_search: ThreadToolResourcesFileSearch - added:
field ThreadToolResourcesCodeInterpreter.file_ids: SequenceNotStr[str] - added:
field ThreadToolResourcesFileSearch.vector_store_ids: SequenceNotStr[str] - added:
field ThreadToolResourcesFileSearch.vector_stores: Iterable[ThreadToolResourcesFileSearchVectorStore] - added:
field ThreadToolResourcesFileSearchVectorStore.chunking_strategy: ThreadToolResourcesFileSearchVectorStoreChunkingStrategy - added:
field ThreadToolResourcesFileSearchVectorStore.file_ids: SequenceNotStr[str] - added:
field ThreadToolResourcesFileSearchVectorStore.metadata: Optional[Metadata] - added:
field ThreadToolResourcesFileSearchVectorStoreChunkingStrategyAuto.type: Required[Literal['auto']] - added:
field ThreadToolResourcesFileSearchVectorStoreChunkingStrategyStatic.static: Required[ThreadToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic] - added:
field ThreadToolResourcesFileSearchVectorStoreChunkingStrategyStatic.type: Required[Literal['static']] - added:
field ThreadToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic.chunk_overlap_tokens: Required[int] - added:
field ThreadToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic.max_chunk_size_tokens: Required[int] - added:
field ToolResources.code_interpreter: ToolResourcesCodeInterpreter - added:
field ToolResources.file_search: ToolResourcesFileSearch - added:
field ToolResourcesCodeInterpreter.file_ids: SequenceNotStr[str] - added:
field ToolResourcesFileSearch.vector_store_ids: SequenceNotStr[str] - added:
field TruncationStrategy.last_messages: Optional[int] - added:
field TruncationStrategy.type: Required[Literal['auto', 'last_messages']] - added:
variable ThreadMessageAttachmentTool: TypeAlias - added:
variable ThreadToolResourcesFileSearchVectorStoreChunkingStrategy: TypeAlias
- added:
class Message(TypedDict) - added:
class MessageAttachment(TypedDict) - added:
class MessageAttachmentToolFileSearch(TypedDict) - added:
class ThreadCreateParams(TypedDict) - added:
class ToolResources(TypedDict) - added:
class ToolResourcesCodeInterpreter(TypedDict) - added:
class ToolResourcesFileSearch(TypedDict) - added:
class ToolResourcesFileSearchVectorStore(TypedDict) - added:
class ToolResourcesFileSearchVectorStoreChunkingStrategyAuto(TypedDict) - added:
class ToolResourcesFileSearchVectorStoreChunkingStrategyStatic(TypedDict) - added:
class ToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic(TypedDict) - added:
field Message.attachments: Optional[Iterable[MessageAttachment]] - added:
field Message.content: Required[Union[str, Iterable[MessageContentPartParam]]] - added:
field Message.metadata: Optional[Metadata] - added:
field Message.role: Required[Literal['user', 'assistant']] - added:
field MessageAttachment.file_id: str - added:
field MessageAttachment.tools: Iterable[MessageAttachmentTool] - added:
field MessageAttachmentToolFileSearch.type: Required[Literal['file_search']] - added:
field ThreadCreateParams.messages: Iterable[Message] - added:
field ThreadCreateParams.metadata: Optional[Metadata] - added:
field ThreadCreateParams.tool_resources: Optional[ToolResources] - added:
field ToolResources.code_interpreter: ToolResourcesCodeInterpreter - added:
field ToolResources.file_search: ToolResourcesFileSearch - added:
field ToolResourcesCodeInterpreter.file_ids: SequenceNotStr[str] - added:
field ToolResourcesFileSearch.vector_store_ids: SequenceNotStr[str] - added:
field ToolResourcesFileSearch.vector_stores: Iterable[ToolResourcesFileSearchVectorStore] - added:
field ToolResourcesFileSearchVectorStore.chunking_strategy: ToolResourcesFileSearchVectorStoreChunkingStrategy - added:
field ToolResourcesFileSearchVectorStore.file_ids: SequenceNotStr[str] - added:
field ToolResourcesFileSearchVectorStore.metadata: Optional[Metadata] - added:
field ToolResourcesFileSearchVectorStoreChunkingStrategyAuto.type: Required[Literal['auto']] - added:
field ToolResourcesFileSearchVectorStoreChunkingStrategyStatic.static: Required[ToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic] - added:
field ToolResourcesFileSearchVectorStoreChunkingStrategyStatic.type: Required[Literal['static']] - added:
field ToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic.chunk_overlap_tokens: Required[int] - added:
field ToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic.max_chunk_size_tokens: Required[int] - added:
variable MessageAttachmentTool: TypeAlias - added:
variable ToolResourcesFileSearchVectorStoreChunkingStrategy: TypeAlias
- added:
class ThreadDeleted(BaseModel) - added:
field ThreadDeleted.deleted: bool - added:
field ThreadDeleted.id: str - added:
field ThreadDeleted.object: Literal['thread.deleted']
- added:
class ThreadUpdateParams(TypedDict) - added:
class ToolResources(TypedDict) - added:
class ToolResourcesCodeInterpreter(TypedDict) - added:
class ToolResourcesFileSearch(TypedDict) - added:
field ThreadUpdateParams.metadata: Optional[Metadata] - added:
field ThreadUpdateParams.tool_resources: Optional[ToolResources] - added:
field ToolResources.code_interpreter: ToolResourcesCodeInterpreter - added:
field ToolResources.file_search: ToolResourcesFileSearch - added:
field ToolResourcesCodeInterpreter.file_ids: SequenceNotStr[str] - added:
field ToolResourcesFileSearch.vector_store_ids: SequenceNotStr[str]
- added:
export Annotation - added:
export AnnotationDelta - added:
export FileCitationAnnotation - added:
export FileCitationDeltaAnnotation - added:
export FilePathAnnotation - added:
export FilePathDeltaAnnotation - added:
export ImageFile - added:
export ImageFileContentBlock - added:
export ImageFileContentBlockParam - added:
export ImageFileDelta - added:
export ImageFileDeltaBlock - added:
export ImageFileParam - added:
export ImageURL - added:
export ImageURLContentBlock - added:
export ImageURLContentBlockParam - added:
export ImageURLDelta - added:
export ImageURLDeltaBlock - added:
export ImageURLParam - added:
export Message - added:
export MessageContent - added:
export MessageContentDelta - added:
export MessageContentPartParam - added:
export MessageCreateParams - added:
export MessageDeleted - added:
export MessageDelta - added:
export MessageDeltaEvent - added:
export MessageListParams - added:
export MessageUpdateParams - added:
export RefusalContentBlock - added:
export RefusalDeltaBlock - added:
export RequiredActionFunctionToolCall - added:
export Run - added:
export RunCreateParams - added:
export RunListParams - added:
export RunStatus - added:
export RunSubmitToolOutputsParams - added:
export RunUpdateParams - added:
export Text - added:
export TextContentBlock - added:
export TextContentBlockParam - added:
export TextDelta - added:
export TextDeltaBlock
- added:
variable Annotation: TypeAlias
- added:
variable AnnotationDelta: TypeAlias
- added:
class FileCitation(BaseModel) - added:
class FileCitationAnnotation(BaseModel) - added:
field FileCitation.file_id: str - added:
field FileCitationAnnotation.end_index: int - added:
field FileCitationAnnotation.file_citation: FileCitation - added:
field FileCitationAnnotation.start_index: int - added:
field FileCitationAnnotation.text: str - added:
field FileCitationAnnotation.type: Literal['file_citation']
- added:
class FileCitation(BaseModel) - added:
class FileCitationDeltaAnnotation(BaseModel) - added:
field FileCitation.file_id: Optional[str] - added:
field FileCitation.quote: Optional[str] - added:
field FileCitationDeltaAnnotation.end_index: Optional[int] - added:
field FileCitationDeltaAnnotation.file_citation: Optional[FileCitation] - added:
field FileCitationDeltaAnnotation.index: int - added:
field FileCitationDeltaAnnotation.start_index: Optional[int] - added:
field FileCitationDeltaAnnotation.text: Optional[str] - added:
field FileCitationDeltaAnnotation.type: Literal['file_citation']
- added:
class FilePath(BaseModel) - added:
class FilePathAnnotation(BaseModel) - added:
field FilePath.file_id: str - added:
field FilePathAnnotation.end_index: int - added:
field FilePathAnnotation.file_path: FilePath - added:
field FilePathAnnotation.start_index: int - added:
field FilePathAnnotation.text: str - added:
field FilePathAnnotation.type: Literal['file_path']
- added:
class FilePath(BaseModel) - added:
class FilePathDeltaAnnotation(BaseModel) - added:
field FilePath.file_id: Optional[str] - added:
field FilePathDeltaAnnotation.end_index: Optional[int] - added:
field FilePathDeltaAnnotation.file_path: Optional[FilePath] - added:
field FilePathDeltaAnnotation.index: int - added:
field FilePathDeltaAnnotation.start_index: Optional[int] - added:
field FilePathDeltaAnnotation.text: Optional[str] - added:
field FilePathDeltaAnnotation.type: Literal['file_path']
- added:
class ImageFile(BaseModel) - added:
field ImageFile.detail: Optional[Literal['auto', 'low', 'high']] - added:
field ImageFile.file_id: str
- added:
class ImageFileContentBlock(BaseModel) - added:
field ImageFileContentBlock.image_file: ImageFile - added:
field ImageFileContentBlock.type: Literal['image_file']
- added:
class ImageFileContentBlockParam(TypedDict) - added:
field ImageFileContentBlockParam.image_file: Required[ImageFileParam] - added:
field ImageFileContentBlockParam.type: Required[Literal['image_file']]
- added:
class ImageFileDelta(BaseModel) - added:
field ImageFileDelta.detail: Optional[Literal['auto', 'low', 'high']] - added:
field ImageFileDelta.file_id: Optional[str]
- added:
class ImageFileDeltaBlock(BaseModel) - added:
field ImageFileDeltaBlock.image_file: Optional[ImageFileDelta] - added:
field ImageFileDeltaBlock.index: int - added:
field ImageFileDeltaBlock.type: Literal['image_file']
- added:
class ImageFileParam(TypedDict) - added:
field ImageFileParam.detail: Literal['auto', 'low', 'high'] - added:
field ImageFileParam.file_id: Required[str]
- added:
class ImageURL(BaseModel) - added:
field ImageURL.detail: Optional[Literal['auto', 'low', 'high']] - added:
field ImageURL.url: str
- added:
class ImageURLContentBlock(BaseModel) - added:
field ImageURLContentBlock.image_url: ImageURL - added:
field ImageURLContentBlock.type: Literal['image_url']
- added:
class ImageURLContentBlockParam(TypedDict) - added:
field ImageURLContentBlockParam.image_url: Required[ImageURLParam] - added:
field ImageURLContentBlockParam.type: Required[Literal['image_url']]
- added:
class ImageURLDelta(BaseModel) - added:
field ImageURLDelta.detail: Optional[Literal['auto', 'low', 'high']] - added:
field ImageURLDelta.url: Optional[str]
- added:
class ImageURLDeltaBlock(BaseModel) - added:
field ImageURLDeltaBlock.image_url: Optional[ImageURLDelta] - added:
field ImageURLDeltaBlock.index: int - added:
field ImageURLDeltaBlock.type: Literal['image_url']
- added:
class ImageURLParam(TypedDict) - added:
field ImageURLParam.detail: Literal['auto', 'low', 'high'] - added:
field ImageURLParam.url: Required[str]
- added:
class Attachment(BaseModel) - added:
class AttachmentToolAssistantToolsFileSearchTypeOnly(BaseModel) - added:
class IncompleteDetails(BaseModel) - added:
class Message(BaseModel) - added:
field Attachment.file_id: Optional[str] - added:
field Attachment.tools: Optional[List[AttachmentTool]] - added:
field AttachmentToolAssistantToolsFileSearchTypeOnly.type: Literal['file_search'] - added:
field IncompleteDetails.reason: Literal['content_filter', 'max_tokens', 'run_cancelled', 'run_expired', 'run_failed'] - added:
field Message.assistant_id: Optional[str] - added:
field Message.attachments: Optional[List[Attachment]] - added:
field Message.completed_at: Optional[int] - added:
field Message.content: List[MessageContent] - added:
field Message.created_at: int - added:
field Message.id: str - added:
field Message.incomplete_at: Optional[int] - added:
field Message.incomplete_details: Optional[IncompleteDetails] - added:
field Message.metadata: Optional[Metadata] - added:
field Message.object: Literal['thread.message'] - added:
field Message.role: Literal['user', 'assistant'] - added:
field Message.run_id: Optional[str] - added:
field Message.status: Literal['in_progress', 'incomplete', 'completed'] - added:
field Message.thread_id: str - added:
variable AttachmentTool: TypeAlias
- added:
variable MessageContent: TypeAlias
- added:
variable MessageContentDelta: TypeAlias
- added:
variable MessageContentPartParam: TypeAlias
- added:
class Attachment(TypedDict) - added:
class AttachmentToolFileSearch(TypedDict) - added:
class MessageCreateParams(TypedDict) - added:
field Attachment.file_id: str - added:
field Attachment.tools: Iterable[AttachmentTool] - added:
field AttachmentToolFileSearch.type: Required[Literal['file_search']] - added:
field MessageCreateParams.attachments: Optional[Iterable[Attachment]] - added:
field MessageCreateParams.content: Required[Union[str, Iterable[MessageContentPartParam]]] - added:
field MessageCreateParams.metadata: Optional[Metadata] - added:
field MessageCreateParams.role: Required[Literal['user', 'assistant']] - added:
variable AttachmentTool: TypeAlias
- added:
class MessageDeleted(BaseModel) - added:
field MessageDeleted.deleted: bool - added:
field MessageDeleted.id: str - added:
field MessageDeleted.object: Literal['thread.message.deleted']
- added:
class MessageDelta(BaseModel) - added:
field MessageDelta.content: Optional[List[MessageContentDelta]] - added:
field MessageDelta.role: Optional[Literal['user', 'assistant']]
- added:
class MessageDeltaEvent(BaseModel) - added:
field MessageDeltaEvent.delta: MessageDelta - added:
field MessageDeltaEvent.id: str - added:
field MessageDeltaEvent.object: Literal['thread.message.delta']
- added:
class MessageListParams(TypedDict) - added:
field MessageListParams.after: str - added:
field MessageListParams.before: str - added:
field MessageListParams.limit: int - added:
field MessageListParams.order: Literal['asc', 'desc'] - added:
field MessageListParams.run_id: str
- added:
class MessageUpdateParams(TypedDict) - added:
field MessageUpdateParams.metadata: Optional[Metadata] - added:
field MessageUpdateParams.thread_id: Required[str]
- added:
class RefusalContentBlock(BaseModel) - added:
field RefusalContentBlock.refusal: str - added:
field RefusalContentBlock.type: Literal['refusal']
- added:
class RefusalDeltaBlock(BaseModel) - added:
field RefusalDeltaBlock.index: int - added:
field RefusalDeltaBlock.refusal: Optional[str] - added:
field RefusalDeltaBlock.type: Literal['refusal']
- added:
class Function(BaseModel) - added:
class RequiredActionFunctionToolCall(BaseModel) - added:
field Function.arguments: str - added:
field Function.name: str - added:
field RequiredActionFunctionToolCall.function: Function - added:
field RequiredActionFunctionToolCall.id: str - added:
field RequiredActionFunctionToolCall.type: Literal['function']
- added:
class IncompleteDetails(BaseModel) - added:
class LastError(BaseModel) - added:
class RequiredAction(BaseModel) - added:
class RequiredActionSubmitToolOutputs(BaseModel) - added:
class Run(BaseModel) - added:
class TruncationStrategy(BaseModel) - added:
class Usage(BaseModel) - added:
field IncompleteDetails.reason: Optional[Literal['max_completion_tokens', 'max_prompt_tokens']] - added:
field LastError.code: Literal['server_error', 'rate_limit_exceeded', 'invalid_prompt'] - added:
field LastError.message: str - added:
field RequiredAction.submit_tool_outputs: RequiredActionSubmitToolOutputs - added:
field RequiredAction.type: Literal['submit_tool_outputs'] - added:
field RequiredActionSubmitToolOutputs.tool_calls: List[RequiredActionFunctionToolCall] - added:
field Run.assistant_id: str - added:
field Run.cancelled_at: Optional[int] - added:
field Run.completed_at: Optional[int] - added:
field Run.created_at: int - added:
field Run.expires_at: Optional[int] - added:
field Run.failed_at: Optional[int] - added:
field Run.id: str - added:
field Run.incomplete_details: Optional[IncompleteDetails] - added:
field Run.instructions: str - added:
field Run.last_error: Optional[LastError] - added:
field Run.max_completion_tokens: Optional[int] - added:
field Run.max_prompt_tokens: Optional[int] - added:
field Run.metadata: Optional[Metadata] - added:
field Run.model: str - added:
field Run.object: Literal['thread.run'] - added:
field Run.parallel_tool_calls: bool - added:
field Run.required_action: Optional[RequiredAction] - added:
field Run.response_format: Optional[AssistantResponseFormatOption] - added:
field Run.started_at: Optional[int] - added:
field Run.status: RunStatus - added:
field Run.temperature: Optional[float] - added:
field Run.thread_id: str - added:
field Run.tool_choice: Optional[AssistantToolChoiceOption] - added:
field Run.tools: List[AssistantTool] - added:
field Run.top_p: Optional[float] - added:
field Run.truncation_strategy: Optional[TruncationStrategy] - added:
field Run.usage: Optional[Usage] - added:
field TruncationStrategy.last_messages: Optional[int] - added:
field TruncationStrategy.type: Literal['auto', 'last_messages'] - added:
field Usage.completion_tokens: int - added:
field Usage.prompt_tokens: int - added:
field Usage.total_tokens: int
- added:
class AdditionalMessage(TypedDict) - added:
class AdditionalMessageAttachment(TypedDict) - added:
class AdditionalMessageAttachmentToolFileSearch(TypedDict) - added:
class RunCreateParamsBase(TypedDict) - added:
class RunCreateParamsNonStreaming(RunCreateParamsBase) - added:
class RunCreateParamsStreaming(RunCreateParamsBase) - added:
class TruncationStrategy(TypedDict) - added:
field AdditionalMessage.attachments: Optional[Iterable[AdditionalMessageAttachment]] - added:
field AdditionalMessage.content: Required[Union[str, Iterable[MessageContentPartParam]]] - added:
field AdditionalMessage.metadata: Optional[Metadata] - added:
field AdditionalMessage.role: Required[Literal['user', 'assistant']] - added:
field AdditionalMessageAttachment.file_id: str - added:
field AdditionalMessageAttachment.tools: Iterable[AdditionalMessageAttachmentTool] - added:
field AdditionalMessageAttachmentToolFileSearch.type: Required[Literal['file_search']] - added:
field RunCreateParamsBase.additional_instructions: Optional[str] - added:
field RunCreateParamsBase.additional_messages: Optional[Iterable[AdditionalMessage]] - added:
field RunCreateParamsBase.assistant_id: Required[str] - added:
field RunCreateParamsBase.include: List[RunStepInclude] - added:
field RunCreateParamsBase.instructions: Optional[str] - added:
field RunCreateParamsBase.max_completion_tokens: Optional[int] - added:
field RunCreateParamsBase.max_prompt_tokens: Optional[int] - added:
field RunCreateParamsBase.metadata: Optional[Metadata] - added:
field RunCreateParamsBase.model: Union[str, ChatModel, None] - added:
field RunCreateParamsBase.parallel_tool_calls: bool - added:
field RunCreateParamsBase.reasoning_effort: Optional[ReasoningEffort] - added:
field RunCreateParamsBase.response_format: Optional[AssistantResponseFormatOptionParam] - added:
field RunCreateParamsBase.temperature: Optional[float] - added:
field RunCreateParamsBase.tool_choice: Optional[AssistantToolChoiceOptionParam] - added:
field RunCreateParamsBase.tools: Optional[Iterable[AssistantToolParam]] - added:
field RunCreateParamsBase.top_p: Optional[float] - added:
field RunCreateParamsBase.truncation_strategy: Optional[TruncationStrategy] - added:
field RunCreateParamsNonStreaming.stream: Optional[Literal[False]] - added:
field RunCreateParamsStreaming.stream: Required[Literal[True]] - added:
field TruncationStrategy.last_messages: Optional[int] - added:
field TruncationStrategy.type: Required[Literal['auto', 'last_messages']] - added:
variable AdditionalMessageAttachmentTool: TypeAlias
- added:
class RunListParams(TypedDict) - added:
field RunListParams.after: str - added:
field RunListParams.before: str - added:
field RunListParams.limit: int - added:
field RunListParams.order: Literal['asc', 'desc']
- added:
variable RunStatus: TypeAlias
- added:
class RunSubmitToolOutputsParamsBase(TypedDict) - added:
class RunSubmitToolOutputsParamsNonStreaming(RunSubmitToolOutputsParamsBase) - added:
class RunSubmitToolOutputsParamsStreaming(RunSubmitToolOutputsParamsBase) - added:
class ToolOutput(TypedDict) - added:
field RunSubmitToolOutputsParamsBase.thread_id: Required[str] - added:
field RunSubmitToolOutputsParamsBase.tool_outputs: Required[Iterable[ToolOutput]] - added:
field RunSubmitToolOutputsParamsNonStreaming.stream: Optional[Literal[False]] - added:
field RunSubmitToolOutputsParamsStreaming.stream: Required[Literal[True]] - added:
field ToolOutput.output: str - added:
field ToolOutput.tool_call_id: str
- added:
class RunUpdateParams(TypedDict) - added:
field RunUpdateParams.metadata: Optional[Metadata] - added:
field RunUpdateParams.thread_id: Required[str]
- added:
export CodeInterpreterLogs - added:
export CodeInterpreterOutputImage - added:
export CodeInterpreterToolCall - added:
export CodeInterpreterToolCallDelta - added:
export FileSearchToolCall - added:
export FileSearchToolCallDelta - added:
export FunctionToolCall - added:
export FunctionToolCallDelta - added:
export MessageCreationStepDetails - added:
export RunStep - added:
export RunStepDelta - added:
export RunStepDeltaEvent - added:
export RunStepDeltaMessageDelta - added:
export RunStepInclude - added:
export StepListParams - added:
export StepRetrieveParams - added:
export ToolCall - added:
export ToolCallDelta - added:
export ToolCallDeltaObject - added:
export ToolCallsStepDetails
- added:
class CodeInterpreterLogs(BaseModel) - added:
field CodeInterpreterLogs.index: int - added:
field CodeInterpreterLogs.logs: Optional[str] - added:
field CodeInterpreterLogs.type: Literal['logs']
- added:
class CodeInterpreterOutputImage(BaseModel) - added:
class Image(BaseModel) - added:
field CodeInterpreterOutputImage.image: Optional[Image] - added:
field CodeInterpreterOutputImage.index: int - added:
field CodeInterpreterOutputImage.type: Literal['image'] - added:
field Image.file_id: Optional[str]
- added:
class CodeInterpreter(BaseModel) - added:
class CodeInterpreterOutputImage(BaseModel) - added:
class CodeInterpreterOutputImageImage(BaseModel) - added:
class CodeInterpreterOutputLogs(BaseModel) - added:
class CodeInterpreterToolCall(BaseModel) - added:
field CodeInterpreter.input: str - added:
field CodeInterpreter.outputs: List[CodeInterpreterOutput] - added:
field CodeInterpreterOutputImage.image: CodeInterpreterOutputImageImage - added:
field CodeInterpreterOutputImage.type: Literal['image'] - added:
field CodeInterpreterOutputImageImage.file_id: str - added:
field CodeInterpreterOutputLogs.logs: str - added:
field CodeInterpreterOutputLogs.type: Literal['logs'] - added:
field CodeInterpreterToolCall.code_interpreter: CodeInterpreter - added:
field CodeInterpreterToolCall.id: str - added:
field CodeInterpreterToolCall.type: Literal['code_interpreter'] - added:
variable CodeInterpreterOutput: TypeAlias
- added:
class CodeInterpreter(BaseModel) - added:
class CodeInterpreterToolCallDelta(BaseModel) - added:
field CodeInterpreter.input: Optional[str] - added:
field CodeInterpreter.outputs: Optional[List[CodeInterpreterOutput]] - added:
field CodeInterpreterToolCallDelta.code_interpreter: Optional[CodeInterpreter] - added:
field CodeInterpreterToolCallDelta.id: Optional[str] - added:
field CodeInterpreterToolCallDelta.index: int - added:
field CodeInterpreterToolCallDelta.type: Literal['code_interpreter'] - added:
variable CodeInterpreterOutput: TypeAlias
- added:
class FileSearch(BaseModel) - added:
class FileSearchRankingOptions(BaseModel) - added:
class FileSearchResult(BaseModel) - added:
class FileSearchResultContent(BaseModel) - added:
class FileSearchToolCall(BaseModel) - added:
field FileSearch.ranking_options: Optional[FileSearchRankingOptions] - added:
field FileSearch.results: Optional[List[FileSearchResult]] - added:
field FileSearchRankingOptions.ranker: Literal['auto', 'default_2024_08_21'] - added:
field FileSearchRankingOptions.score_threshold: float - added:
field FileSearchResult.content: Optional[List[FileSearchResultContent]] - added:
field FileSearchResult.file_id: str - added:
field FileSearchResult.file_name: str - added:
field FileSearchResult.score: float - added:
field FileSearchResultContent.text: Optional[str] - added:
field FileSearchResultContent.type: Optional[Literal['text']] - added:
field FileSearchToolCall.file_search: FileSearch - added:
field FileSearchToolCall.id: str - added:
field FileSearchToolCall.type: Literal['file_search']
- added:
class FileSearchToolCallDelta(BaseModel) - added:
field FileSearchToolCallDelta.file_search: object - added:
field FileSearchToolCallDelta.id: Optional[str] - added:
field FileSearchToolCallDelta.index: int - added:
field FileSearchToolCallDelta.type: Literal['file_search']
- added:
class Function(BaseModel) - added:
class FunctionToolCall(BaseModel) - added:
field Function.arguments: str - added:
field Function.name: str - added:
field Function.output: Optional[str] - added:
field FunctionToolCall.function: Function - added:
field FunctionToolCall.id: str - added:
field FunctionToolCall.type: Literal['function']
- added:
class Function(BaseModel) - added:
class FunctionToolCallDelta(BaseModel) - added:
field Function.arguments: Optional[str] - added:
field Function.name: Optional[str] - added:
field Function.output: Optional[str] - added:
field FunctionToolCallDelta.function: Optional[Function] - added:
field FunctionToolCallDelta.id: Optional[str] - added:
field FunctionToolCallDelta.index: int - added:
field FunctionToolCallDelta.type: Literal['function']
- added:
class MessageCreation(BaseModel) - added:
class MessageCreationStepDetails(BaseModel) - added:
field MessageCreation.message_id: str - added:
field MessageCreationStepDetails.message_creation: MessageCreation - added:
field MessageCreationStepDetails.type: Literal['message_creation']
- added:
class LastError(BaseModel) - added:
class RunStep(BaseModel) - added:
class Usage(BaseModel) - added:
field LastError.code: Literal['server_error', 'rate_limit_exceeded'] - added:
field LastError.message: str - added:
field RunStep.assistant_id: str - added:
field RunStep.cancelled_at: Optional[int] - added:
field RunStep.completed_at: Optional[int] - added:
field RunStep.created_at: int - added:
field RunStep.expired_at: Optional[int] - added:
field RunStep.failed_at: Optional[int] - added:
field RunStep.id: str - added:
field RunStep.last_error: Optional[LastError] - added:
field RunStep.metadata: Optional[Metadata] - added:
field RunStep.object: Literal['thread.run.step'] - added:
field RunStep.run_id: str - added:
field RunStep.status: Literal['in_progress', 'cancelled', 'failed', 'completed', 'expired'] - added:
field RunStep.step_details: StepDetails - added:
field RunStep.thread_id: str - added:
field RunStep.type: Literal['message_creation', 'tool_calls'] - added:
field RunStep.usage: Optional[Usage] - added:
field Usage.completion_tokens: int - added:
field Usage.prompt_tokens: int - added:
field Usage.total_tokens: int - added:
variable StepDetails: TypeAlias
- added:
class RunStepDelta(BaseModel) - added:
field RunStepDelta.step_details: Optional[StepDetails] - added:
variable StepDetails: TypeAlias
- added:
class RunStepDeltaEvent(BaseModel) - added:
field RunStepDeltaEvent.delta: RunStepDelta - added:
field RunStepDeltaEvent.id: str - added:
field RunStepDeltaEvent.object: Literal['thread.run.step.delta']
- added:
class MessageCreation(BaseModel) - added:
class RunStepDeltaMessageDelta(BaseModel) - added:
field MessageCreation.message_id: Optional[str] - added:
field RunStepDeltaMessageDelta.message_creation: Optional[MessageCreation] - added:
field RunStepDeltaMessageDelta.type: Literal['message_creation']
- added:
variable RunStepInclude: TypeAlias
- added:
class StepListParams(TypedDict) - added:
field StepListParams.after: str - added:
field StepListParams.before: str - added:
field StepListParams.include: List[RunStepInclude] - added:
field StepListParams.limit: int - added:
field StepListParams.order: Literal['asc', 'desc'] - added:
field StepListParams.thread_id: Required[str]
- added:
class StepRetrieveParams(TypedDict) - added:
field StepRetrieveParams.include: List[RunStepInclude] - added:
field StepRetrieveParams.run_id: Required[str] - added:
field StepRetrieveParams.thread_id: Required[str]
- added:
variable ToolCall: TypeAlias
- added:
variable ToolCallDelta: TypeAlias
- added:
class ToolCallDeltaObject(BaseModel) - added:
field ToolCallDeltaObject.tool_calls: Optional[List[ToolCallDelta]] - added:
field ToolCallDeltaObject.type: Literal['tool_calls']
- added:
class ToolCallsStepDetails(BaseModel) - added:
field ToolCallsStepDetails.tool_calls: List[ToolCall] - added:
field ToolCallsStepDetails.type: Literal['tool_calls']
- added:
class Text(BaseModel) - added:
field Text.annotations: List[Annotation] - added:
field Text.value: str
- added:
class TextContentBlock(BaseModel) - added:
field TextContentBlock.text: Text - added:
field TextContentBlock.type: Literal['text']
- added:
class TextContentBlockParam(TypedDict) - added:
field TextContentBlockParam.text: Required[str] - added:
field TextContentBlockParam.type: Required[Literal['text']]
- added:
class TextDelta(BaseModel) - added:
field TextDelta.annotations: Optional[List[AnnotationDelta]] - added:
field TextDelta.value: Optional[str]
- added:
class TextDeltaBlock(BaseModel) - added:
field TextDeltaBlock.index: int - added:
field TextDeltaBlock.text: Optional[TextDelta] - added:
field TextDeltaBlock.type: Literal['text']
- added:
export ChatCompletion - added:
export ChatCompletionAllowedToolChoiceParam - added:
export ChatCompletionAllowedToolsParam - added:
export ChatCompletionAssistantMessageParam - added:
export ChatCompletionAudio - added:
export ChatCompletionAudioParam - added:
export ChatCompletionChunk - added:
export ChatCompletionContentPartImage - added:
export ChatCompletionContentPartImageParam - added:
export ChatCompletionContentPartInputAudioParam - added:
export ChatCompletionContentPartParam - added:
export ChatCompletionContentPartRefusalParam - added:
export ChatCompletionContentPartText - added:
export ChatCompletionContentPartTextParam - added:
export ChatCompletionCustomToolParam - added:
export ChatCompletionDeleted - added:
export ChatCompletionDeveloperMessageParam - added:
export ChatCompletionFunctionCallOptionParam - added:
export ChatCompletionFunctionMessageParam - added:
export ChatCompletionFunctionTool - added:
export ChatCompletionFunctionToolParam - added:
export ChatCompletionMessage - added:
export ChatCompletionMessageCustomToolCall - added:
export ChatCompletionMessageCustomToolCallParam - added:
export ChatCompletionMessageFunctionToolCall - added:
export ChatCompletionMessageFunctionToolCallParam - added:
export ChatCompletionMessageParam - added:
export ChatCompletionMessageToolCall - added:
export ChatCompletionMessageToolCallParam - added:
export ChatCompletionMessageToolCallUnion - added:
export ChatCompletionMessageToolCallUnionParam - added:
export ChatCompletionModality - added:
export ChatCompletionNamedToolChoiceCustomParam - added:
export ChatCompletionNamedToolChoiceParam - added:
export ChatCompletionPredictionContentParam - added:
export ChatCompletionReasoningEffort - added:
export ChatCompletionRole - added:
export ChatCompletionStoreMessage - added:
export ChatCompletionStreamOptionsParam - added:
export ChatCompletionSystemMessageParam - added:
export ChatCompletionTokenLogprob - added:
export ChatCompletionToolChoiceOptionParam - added:
export ChatCompletionToolMessageParam - added:
export ChatCompletionToolParam - added:
export ChatCompletionToolUnionParam - added:
export ChatCompletionUserMessageParam - added:
export CompletionCreateParams - added:
export CompletionListParams - added:
export CompletionUpdateParams - added:
export ParsedChatCompletion - added:
export ParsedChatCompletionMessage - added:
export ParsedChoice - added:
export ParsedFunction - added:
export ParsedFunctionToolCall
- added:
class ChatCompletion(BaseModel) - added:
class Choice(BaseModel) - added:
class ChoiceLogprobs(BaseModel) - added:
field ChatCompletion.choices: List[Choice] - added:
field ChatCompletion.created: int - added:
field ChatCompletion.id: str - added:
field ChatCompletion.model: str - added:
field ChatCompletion.object: Literal['chat.completion'] - added:
field ChatCompletion.service_tier: Optional[Literal['auto', 'default', 'flex', 'scale', 'priority']] - added:
field ChatCompletion.system_fingerprint: Optional[str] - added:
field ChatCompletion.usage: Optional[CompletionUsage] - added:
field Choice.finish_reason: Literal['stop', 'length', 'tool_calls', 'content_filter', 'function_call'] - added:
field Choice.index: int - added:
field Choice.logprobs: Optional[ChoiceLogprobs] - added:
field Choice.message: ChatCompletionMessage - added:
field ChoiceLogprobs.content: Optional[List[ChatCompletionTokenLogprob]] - added:
field ChoiceLogprobs.refusal: Optional[List[ChatCompletionTokenLogprob]]
- added:
class ChatCompletionAllowedToolChoiceParam(TypedDict) - added:
field ChatCompletionAllowedToolChoiceParam.allowed_tools: Required[ChatCompletionAllowedToolsParam] - added:
field ChatCompletionAllowedToolChoiceParam.type: Required[Literal['allowed_tools']]
- added:
class ChatCompletionAllowedToolsParam(TypedDict) - added:
field ChatCompletionAllowedToolsParam.mode: Required[Literal['auto', 'required']] - added:
field ChatCompletionAllowedToolsParam.tools: Required[Iterable[Dict[str, object]]]
- added:
class Audio(TypedDict) - added:
class ChatCompletionAssistantMessageParam(TypedDict) - added:
class FunctionCall(TypedDict) - added:
field Audio.id: Required[str] - added:
field ChatCompletionAssistantMessageParam.audio: Optional[Audio] - added:
field ChatCompletionAssistantMessageParam.content: Union[str, Iterable[ContentArrayOfContentPart], None] - added:
field ChatCompletionAssistantMessageParam.function_call: Optional[FunctionCall] - added:
field ChatCompletionAssistantMessageParam.name: str - added:
field ChatCompletionAssistantMessageParam.refusal: Optional[str] - added:
field ChatCompletionAssistantMessageParam.role: Required[Literal['assistant']] - added:
field ChatCompletionAssistantMessageParam.tool_calls: Iterable[ChatCompletionMessageToolCallUnionParam] - added:
field FunctionCall.arguments: Required[str] - added:
field FunctionCall.name: Required[str] - added:
variable ContentArrayOfContentPart: TypeAlias
- added:
class ChatCompletionAudio(BaseModel) - added:
field ChatCompletionAudio.data: str - added:
field ChatCompletionAudio.expires_at: int - added:
field ChatCompletionAudio.id: str - added:
field ChatCompletionAudio.transcript: str
- added:
class ChatCompletionAudioParam(TypedDict) - added:
field ChatCompletionAudioParam.format: Required[Literal['wav', 'aac', 'mp3', 'flac', 'opus', 'pcm16']] - added:
field ChatCompletionAudioParam.voice: Required[Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse', 'marin', 'cedar']]]
- added:
class ChatCompletionChunk(BaseModel) - added:
class Choice(BaseModel) - added:
class ChoiceDelta(BaseModel) - added:
class ChoiceDeltaFunctionCall(BaseModel) - added:
class ChoiceDeltaToolCall(BaseModel) - added:
class ChoiceDeltaToolCallFunction(BaseModel) - added:
class ChoiceLogprobs(BaseModel) - added:
field ChatCompletionChunk.choices: List[Choice] - added:
field ChatCompletionChunk.created: int - added:
field ChatCompletionChunk.id: str - added:
field ChatCompletionChunk.model: str - added:
field ChatCompletionChunk.object: Literal['chat.completion.chunk'] - added:
field ChatCompletionChunk.service_tier: Optional[Literal['auto', 'default', 'flex', 'scale', 'priority']] - added:
field ChatCompletionChunk.system_fingerprint: Optional[str] - added:
field ChatCompletionChunk.usage: Optional[CompletionUsage] - added:
field Choice.delta: ChoiceDelta - added:
field Choice.finish_reason: Optional[Literal['stop', 'length', 'tool_calls', 'content_filter', 'function_call']] - added:
field Choice.index: int - added:
field Choice.logprobs: Optional[ChoiceLogprobs] - added:
field ChoiceDelta.content: Optional[str] - added:
field ChoiceDelta.function_call: Optional[ChoiceDeltaFunctionCall] - added:
field ChoiceDelta.refusal: Optional[str] - added:
field ChoiceDelta.role: Optional[Literal['developer', 'system', 'user', 'assistant', 'tool']] - added:
field ChoiceDelta.tool_calls: Optional[List[ChoiceDeltaToolCall]] - added:
field ChoiceDeltaFunctionCall.arguments: Optional[str] - added:
field ChoiceDeltaFunctionCall.name: Optional[str] - added:
field ChoiceDeltaToolCall.function: Optional[ChoiceDeltaToolCallFunction] - added:
field ChoiceDeltaToolCall.id: Optional[str] - added:
field ChoiceDeltaToolCall.index: int - added:
field ChoiceDeltaToolCall.type: Optional[Literal['function']] - added:
field ChoiceDeltaToolCallFunction.arguments: Optional[str] - added:
field ChoiceDeltaToolCallFunction.name: Optional[str] - added:
field ChoiceLogprobs.content: Optional[List[ChatCompletionTokenLogprob]] - added:
field ChoiceLogprobs.refusal: Optional[List[ChatCompletionTokenLogprob]]
- added:
class ChatCompletionContentPartImage(BaseModel) - added:
class ImageURL(BaseModel) - added:
field ChatCompletionContentPartImage.image_url: ImageURL - added:
field ChatCompletionContentPartImage.type: Literal['image_url'] - added:
field ImageURL.detail: Optional[Literal['auto', 'low', 'high']] - added:
field ImageURL.url: str
- added:
class ChatCompletionContentPartImageParam(TypedDict) - added:
class ImageURL(TypedDict) - added:
field ChatCompletionContentPartImageParam.image_url: Required[ImageURL] - added:
field ChatCompletionContentPartImageParam.type: Required[Literal['image_url']] - added:
field ImageURL.detail: Literal['auto', 'low', 'high'] - added:
field ImageURL.url: Required[str]
- added:
class ChatCompletionContentPartInputAudioParam(TypedDict) - added:
class InputAudio(TypedDict) - added:
field ChatCompletionContentPartInputAudioParam.input_audio: Required[InputAudio] - added:
field ChatCompletionContentPartInputAudioParam.type: Required[Literal['input_audio']] - added:
field InputAudio.data: Required[str] - added:
field InputAudio.format: Required[Literal['wav', 'mp3']]
- added:
class File(TypedDict) - added:
class FileFile(TypedDict) - added:
field File.file: Required[FileFile] - added:
field File.type: Required[Literal['file']] - added:
field FileFile.file_data: str - added:
field FileFile.file_id: str - added:
field FileFile.filename: str - added:
variable ChatCompletionContentPartParam: TypeAlias
- added:
class ChatCompletionContentPartRefusalParam(TypedDict) - added:
field ChatCompletionContentPartRefusalParam.refusal: Required[str] - added:
field ChatCompletionContentPartRefusalParam.type: Required[Literal['refusal']]
- added:
class ChatCompletionContentPartText(BaseModel) - added:
field ChatCompletionContentPartText.text: str - added:
field ChatCompletionContentPartText.type: Literal['text']
- added:
class ChatCompletionContentPartTextParam(TypedDict) - added:
field ChatCompletionContentPartTextParam.text: Required[str] - added:
field ChatCompletionContentPartTextParam.type: Required[Literal['text']]
- added:
class ChatCompletionCustomToolParam(TypedDict) - added:
class Custom(TypedDict) - added:
class CustomFormatGrammar(TypedDict) - added:
class CustomFormatGrammarGrammar(TypedDict) - added:
class CustomFormatText(TypedDict) - added:
field ChatCompletionCustomToolParam.custom: Required[Custom] - added:
field ChatCompletionCustomToolParam.type: Required[Literal['custom']] - added:
field Custom.description: str - added:
field Custom.format: CustomFormat - added:
field Custom.name: Required[str] - added:
field CustomFormatGrammar.grammar: Required[CustomFormatGrammarGrammar] - added:
field CustomFormatGrammar.type: Required[Literal['grammar']] - added:
field CustomFormatGrammarGrammar.definition: Required[str] - added:
field CustomFormatGrammarGrammar.syntax: Required[Literal['lark', 'regex']] - added:
field CustomFormatText.type: Required[Literal['text']] - added:
variable CustomFormat: TypeAlias
- added:
class ChatCompletionDeleted(BaseModel) - added:
field ChatCompletionDeleted.deleted: bool - added:
field ChatCompletionDeleted.id: str - added:
field ChatCompletionDeleted.object: Literal['chat.completion.deleted']
- added:
class ChatCompletionDeveloperMessageParam(TypedDict) - added:
field ChatCompletionDeveloperMessageParam.content: Required[Union[str, Iterable[ChatCompletionContentPartTextParam]]] - added:
field ChatCompletionDeveloperMessageParam.name: str - added:
field ChatCompletionDeveloperMessageParam.role: Required[Literal['developer']]
- added:
class ChatCompletionFunctionCallOptionParam(TypedDict) - added:
field ChatCompletionFunctionCallOptionParam.name: Required[str]
- added:
class ChatCompletionFunctionMessageParam(TypedDict) - added:
field ChatCompletionFunctionMessageParam.content: Required[Optional[str]] - added:
field ChatCompletionFunctionMessageParam.name: Required[str] - added:
field ChatCompletionFunctionMessageParam.role: Required[Literal['function']]
- added:
class ChatCompletionFunctionTool(BaseModel) - added:
field ChatCompletionFunctionTool.function: FunctionDefinition - added:
field ChatCompletionFunctionTool.type: Literal['function']
- added:
class ChatCompletionFunctionToolParam(TypedDict) - added:
field ChatCompletionFunctionToolParam.function: Required[FunctionDefinition] - added:
field ChatCompletionFunctionToolParam.type: Required[Literal['function']]
- added:
class Annotation(BaseModel) - added:
class AnnotationURLCitation(BaseModel) - added:
class ChatCompletionMessage(BaseModel) - added:
class FunctionCall(BaseModel) - added:
field Annotation.type: Literal['url_citation'] - added:
field Annotation.url_citation: AnnotationURLCitation - added:
field AnnotationURLCitation.end_index: int - added:
field AnnotationURLCitation.start_index: int - added:
field AnnotationURLCitation.title: str - added:
field AnnotationURLCitation.url: str - added:
field ChatCompletionMessage.annotations: Optional[List[Annotation]] - added:
field ChatCompletionMessage.audio: Optional[ChatCompletionAudio] - added:
field ChatCompletionMessage.content: Optional[str] - added:
field ChatCompletionMessage.function_call: Optional[FunctionCall] - added:
field ChatCompletionMessage.refusal: Optional[str] - added:
field ChatCompletionMessage.role: Literal['assistant'] - added:
field ChatCompletionMessage.tool_calls: Optional[List[ChatCompletionMessageToolCallUnion]] - added:
field FunctionCall.arguments: str - added:
field FunctionCall.name: str
- added:
class ChatCompletionMessageCustomToolCall(BaseModel) - added:
class Custom(BaseModel) - added:
field ChatCompletionMessageCustomToolCall.custom: Custom - added:
field ChatCompletionMessageCustomToolCall.id: str - added:
field ChatCompletionMessageCustomToolCall.type: Literal['custom'] - added:
field Custom.input: str - added:
field Custom.name: str
- added:
class ChatCompletionMessageCustomToolCallParam(TypedDict) - added:
class Custom(TypedDict) - added:
field ChatCompletionMessageCustomToolCallParam.custom: Required[Custom] - added:
field ChatCompletionMessageCustomToolCallParam.id: Required[str] - added:
field ChatCompletionMessageCustomToolCallParam.type: Required[Literal['custom']] - added:
field Custom.input: Required[str] - added:
field Custom.name: Required[str]
- added:
class ChatCompletionMessageFunctionToolCall(BaseModel) - added:
class Function(BaseModel) - added:
field ChatCompletionMessageFunctionToolCall.function: Function - added:
field ChatCompletionMessageFunctionToolCall.id: str - added:
field ChatCompletionMessageFunctionToolCall.type: Literal['function'] - added:
field Function.arguments: str - added:
field Function.name: str
- added:
class ChatCompletionMessageFunctionToolCallParam(TypedDict) - added:
class Function(TypedDict) - added:
field ChatCompletionMessageFunctionToolCallParam.function: Required[Function] - added:
field ChatCompletionMessageFunctionToolCallParam.id: Required[str] - added:
field ChatCompletionMessageFunctionToolCallParam.type: Required[Literal['function']] - added:
field Function.arguments: Required[str] - added:
field Function.name: Required[str]
- added:
variable ChatCompletionMessageParam: TypeAlias
- added:
export Function - added:
variable ChatCompletionMessageToolCallUnion: TypeAlias
- added:
export Function - added:
variable ChatCompletionMessageToolCallParam: TypeAlias
- added:
variable ChatCompletionMessageToolCallUnionParam: TypeAlias
- added:
variable ChatCompletionModality: TypeAlias
- added:
class ChatCompletionNamedToolChoiceCustomParam(TypedDict) - added:
class Custom(TypedDict) - added:
field ChatCompletionNamedToolChoiceCustomParam.custom: Required[Custom] - added:
field ChatCompletionNamedToolChoiceCustomParam.type: Required[Literal['custom']] - added:
field Custom.name: Required[str]
- added:
class ChatCompletionNamedToolChoiceParam(TypedDict) - added:
class Function(TypedDict) - added:
field ChatCompletionNamedToolChoiceParam.function: Required[Function] - added:
field ChatCompletionNamedToolChoiceParam.type: Required[Literal['function']] - added:
field Function.name: Required[str]
- added:
class ChatCompletionPredictionContentParam(TypedDict) - added:
field ChatCompletionPredictionContentParam.content: Required[Union[str, Iterable[ChatCompletionContentPartTextParam]]] - added:
field ChatCompletionPredictionContentParam.type: Required[Literal['content']]
- added:
variable ChatCompletionReasoningEffort
- added:
variable ChatCompletionRole: TypeAlias
- added:
class ChatCompletionStoreMessage(ChatCompletionMessage) - added:
field ChatCompletionStoreMessage.content_parts: Optional[List[ChatCompletionStoreMessageContentPart]] - added:
field ChatCompletionStoreMessage.id: str - added:
variable ChatCompletionStoreMessageContentPart: TypeAlias
- added:
class ChatCompletionStreamOptionsParam(TypedDict) - added:
field ChatCompletionStreamOptionsParam.include_obfuscation: bool - added:
field ChatCompletionStreamOptionsParam.include_usage: bool
- added:
class ChatCompletionSystemMessageParam(TypedDict) - added:
field ChatCompletionSystemMessageParam.content: Required[Union[str, Iterable[ChatCompletionContentPartTextParam]]] - added:
field ChatCompletionSystemMessageParam.name: str - added:
field ChatCompletionSystemMessageParam.role: Required[Literal['system']]
- added:
class ChatCompletionTokenLogprob(BaseModel) - added:
class TopLogprob(BaseModel) - added:
field ChatCompletionTokenLogprob.bytes: Optional[List[int]] - added:
field ChatCompletionTokenLogprob.logprob: float - added:
field ChatCompletionTokenLogprob.token: str - added:
field ChatCompletionTokenLogprob.top_logprobs: List[TopLogprob] - added:
field TopLogprob.bytes: Optional[List[int]] - added:
field TopLogprob.logprob: float - added:
field TopLogprob.token: str
- added:
variable ChatCompletionToolChoiceOptionParam: TypeAlias
- added:
class ChatCompletionToolMessageParam(TypedDict) - added:
field ChatCompletionToolMessageParam.content: Required[Union[str, Iterable[ChatCompletionContentPartTextParam]]] - added:
field ChatCompletionToolMessageParam.role: Required[Literal['tool']] - added:
field ChatCompletionToolMessageParam.tool_call_id: Required[str]
- added:
export FunctionDefinition - added:
variable ChatCompletionToolParam: TypeAlias
- added:
variable ChatCompletionToolUnionParam: TypeAlias
- added:
class ChatCompletionUserMessageParam(TypedDict) - added:
field ChatCompletionUserMessageParam.content: Required[Union[str, Iterable[ChatCompletionContentPartParam]]] - added:
field ChatCompletionUserMessageParam.name: str - added:
field ChatCompletionUserMessageParam.role: Required[Literal['user']]
- added:
class CompletionCreateParamsBase(TypedDict) - added:
class CompletionCreateParamsNonStreaming(CompletionCreateParamsBase) - added:
class CompletionCreateParamsStreaming(CompletionCreateParamsBase) - added:
class Function(TypedDict) - added:
class WebSearchOptions(TypedDict) - added:
class WebSearchOptionsUserLocation(TypedDict) - added:
class WebSearchOptionsUserLocationApproximate(TypedDict) - added:
field CompletionCreateParamsBase.audio: Optional[ChatCompletionAudioParam] - added:
field CompletionCreateParamsBase.frequency_penalty: Optional[float] - added:
field CompletionCreateParamsBase.function_call: FunctionCall - added:
field CompletionCreateParamsBase.functions: Iterable[Function] - added:
field CompletionCreateParamsBase.logit_bias: Optional[Dict[str, int]] - added:
field CompletionCreateParamsBase.logprobs: Optional[bool] - added:
field CompletionCreateParamsBase.max_completion_tokens: Optional[int] - added:
field CompletionCreateParamsBase.max_tokens: Optional[int] - added:
field CompletionCreateParamsBase.messages: Required[Iterable[ChatCompletionMessageParam]] - added:
field CompletionCreateParamsBase.metadata: Optional[Metadata] - added:
field CompletionCreateParamsBase.modalities: Optional[List[Literal['text', 'audio']]] - added:
field CompletionCreateParamsBase.model: Required[Union[str, ChatModel]] - added:
field CompletionCreateParamsBase.n: Optional[int] - added:
field CompletionCreateParamsBase.parallel_tool_calls: bool - added:
field CompletionCreateParamsBase.prediction: Optional[ChatCompletionPredictionContentParam] - added:
field CompletionCreateParamsBase.presence_penalty: Optional[float] - added:
field CompletionCreateParamsBase.prompt_cache_key: str - added:
field CompletionCreateParamsBase.reasoning_effort: Optional[ReasoningEffort] - added:
field CompletionCreateParamsBase.response_format: ResponseFormat - added:
field CompletionCreateParamsBase.safety_identifier: str - added:
field CompletionCreateParamsBase.seed: Optional[int] - added:
field CompletionCreateParamsBase.service_tier: Optional[Literal['auto', 'default', 'flex', 'scale', 'priority']] - added:
field CompletionCreateParamsBase.stop: Union[Optional[str], SequenceNotStr[str], None] - added:
field CompletionCreateParamsBase.store: Optional[bool] - added:
field CompletionCreateParamsBase.stream_options: Optional[ChatCompletionStreamOptionsParam] - added:
field CompletionCreateParamsBase.temperature: Optional[float] - added:
field CompletionCreateParamsBase.tool_choice: ChatCompletionToolChoiceOptionParam - added:
field CompletionCreateParamsBase.tools: Iterable[ChatCompletionToolUnionParam] - added:
field CompletionCreateParamsBase.top_logprobs: Optional[int] - added:
field CompletionCreateParamsBase.top_p: Optional[float] - added:
field CompletionCreateParamsBase.user: str - added:
field CompletionCreateParamsBase.verbosity: Optional[Literal['low', 'medium', 'high']] - added:
field CompletionCreateParamsBase.web_search_options: WebSearchOptions - added:
field CompletionCreateParamsNonStreaming.stream: Optional[Literal[False]] - added:
field CompletionCreateParamsStreaming.stream: Required[Literal[True]] - added:
field Function.description: str - added:
field Function.name: Required[str] - added:
field Function.parameters: FunctionParameters - added:
field WebSearchOptions.search_context_size: Literal['low', 'medium', 'high'] - added:
field WebSearchOptions.user_location: Optional[WebSearchOptionsUserLocation] - added:
field WebSearchOptionsUserLocation.approximate: Required[WebSearchOptionsUserLocationApproximate] - added:
field WebSearchOptionsUserLocation.type: Required[Literal['approximate']] - added:
field WebSearchOptionsUserLocationApproximate.city: str - added:
field WebSearchOptionsUserLocationApproximate.country: str - added:
field WebSearchOptionsUserLocationApproximate.region: str - added:
field WebSearchOptionsUserLocationApproximate.timezone: str - added:
variable FunctionCall: TypeAlias - added:
variable ResponseFormat: TypeAlias
- added:
class CompletionListParams(TypedDict) - added:
field CompletionListParams.after: str - added:
field CompletionListParams.limit: int - added:
field CompletionListParams.metadata: Optional[Metadata] - added:
field CompletionListParams.model: str - added:
field CompletionListParams.order: Literal['asc', 'desc']
- added:
class CompletionUpdateParams(TypedDict) - added:
field CompletionUpdateParams.metadata: Required[Optional[Metadata]]
- added:
export MessageListParams
- added:
class MessageListParams(TypedDict) - added:
field MessageListParams.after: str - added:
field MessageListParams.limit: int - added:
field MessageListParams.order: Literal['asc', 'desc']
- added:
class ParsedChatCompletion(ChatCompletion, GenericModel, Generic[ContentType]) - added:
class ParsedChoice(Choice, GenericModel, Generic[ContentType]) - added:
field ParsedChatCompletion.choices: List[ParsedChoice[ContentType]] - added:
field ParsedChoice.message: ParsedChatCompletionMessage[ContentType]
- added:
class ParsedFunction(Function) - added:
class ParsedFunctionToolCall(ChatCompletionMessageFunctionToolCall) - added:
field ParsedFunction.parsed_arguments: Optional[object] - added:
field ParsedFunctionToolCall.function: ParsedFunction
- added:
variable ChatModel
- added:
class Completion(BaseModel) - added:
field Completion.choices: List[CompletionChoice] - added:
field Completion.created: int - added:
field Completion.id: str - added:
field Completion.model: str - added:
field Completion.object: Literal['text_completion'] - added:
field Completion.system_fingerprint: Optional[str] - added:
field Completion.usage: Optional[CompletionUsage]
- added:
class CompletionChoice(BaseModel) - added:
class Logprobs(BaseModel) - added:
field CompletionChoice.finish_reason: Literal['stop', 'length', 'content_filter'] - added:
field CompletionChoice.index: int - added:
field CompletionChoice.logprobs: Optional[Logprobs] - added:
field CompletionChoice.text: str - added:
field Logprobs.text_offset: Optional[List[int]] - added:
field Logprobs.token_logprobs: Optional[List[float]] - added:
field Logprobs.tokens: Optional[List[str]] - added:
field Logprobs.top_logprobs: Optional[List[Dict[str, float]]]
- added:
class CompletionCreateParamsBase(TypedDict) - added:
class CompletionCreateParamsNonStreaming(CompletionCreateParamsBase) - added:
class CompletionCreateParamsStreaming(CompletionCreateParamsBase) - added:
field CompletionCreateParamsBase.best_of: Optional[int] - added:
field CompletionCreateParamsBase.echo: Optional[bool] - added:
field CompletionCreateParamsBase.frequency_penalty: Optional[float] - added:
field CompletionCreateParamsBase.logit_bias: Optional[Dict[str, int]] - added:
field CompletionCreateParamsBase.logprobs: Optional[int] - added:
field CompletionCreateParamsBase.max_tokens: Optional[int] - added:
field CompletionCreateParamsBase.model: Required[Union[str, Literal['gpt-3.5-turbo-instruct', 'davinci-002', 'babbage-002']]] - added:
field CompletionCreateParamsBase.n: Optional[int] - added:
field CompletionCreateParamsBase.presence_penalty: Optional[float] - added:
field CompletionCreateParamsBase.prompt: Required[Union[str, SequenceNotStr[str], Iterable[int], Iterable[Iterable[int]], None]] - added:
field CompletionCreateParamsBase.seed: Optional[int] - added:
field CompletionCreateParamsBase.stop: Union[Optional[str], SequenceNotStr[str], None] - added:
field CompletionCreateParamsBase.stream_options: Optional[ChatCompletionStreamOptionsParam] - added:
field CompletionCreateParamsBase.suffix: Optional[str] - added:
field CompletionCreateParamsBase.temperature: Optional[float] - added:
field CompletionCreateParamsBase.top_p: Optional[float] - added:
field CompletionCreateParamsBase.user: str - added:
field CompletionCreateParamsNonStreaming.stream: Optional[Literal[False]] - added:
field CompletionCreateParamsStreaming.stream: Required[Literal[True]]
- added:
class CompletionTokensDetails(BaseModel) - added:
class CompletionUsage(BaseModel) - added:
class PromptTokensDetails(BaseModel) - added:
field CompletionTokensDetails.accepted_prediction_tokens: Optional[int] - added:
field CompletionTokensDetails.audio_tokens: Optional[int] - added:
field CompletionTokensDetails.reasoning_tokens: Optional[int] - added:
field CompletionTokensDetails.rejected_prediction_tokens: Optional[int] - added:
field CompletionUsage.completion_tokens: int - added:
field CompletionUsage.completion_tokens_details: Optional[CompletionTokensDetails] - added:
field CompletionUsage.prompt_tokens: int - added:
field CompletionUsage.prompt_tokens_details: Optional[PromptTokensDetails] - added:
field CompletionUsage.total_tokens: int - added:
field PromptTokensDetails.audio_tokens: Optional[int] - added:
field PromptTokensDetails.cached_tokens: Optional[int]
- added:
class ContainerCreateParams(TypedDict) - added:
class ExpiresAfter(TypedDict) - added:
field ContainerCreateParams.expires_after: ExpiresAfter - added:
field ContainerCreateParams.file_ids: SequenceNotStr[str] - added:
field ContainerCreateParams.name: Required[str] - added:
field ExpiresAfter.anchor: Required[Literal['last_active_at']] - added:
field ExpiresAfter.minutes: Required[int]
- added:
class ContainerCreateResponse(BaseModel) - added:
class ExpiresAfter(BaseModel) - added:
field ContainerCreateResponse.created_at: int - added:
field ContainerCreateResponse.expires_after: Optional[ExpiresAfter] - added:
field ContainerCreateResponse.id: str - added:
field ContainerCreateResponse.name: str - added:
field ContainerCreateResponse.object: str - added:
field ContainerCreateResponse.status: str - added:
field ExpiresAfter.anchor: Optional[Literal['last_active_at']] - added:
field ExpiresAfter.minutes: Optional[int]
- added:
class ContainerListParams(TypedDict) - added:
field ContainerListParams.after: str - added:
field ContainerListParams.limit: int - added:
field ContainerListParams.order: Literal['asc', 'desc']
- added:
class ContainerListResponse(BaseModel) - added:
class ExpiresAfter(BaseModel) - added:
field ContainerListResponse.created_at: int - added:
field ContainerListResponse.expires_after: Optional[ExpiresAfter] - added:
field ContainerListResponse.id: str - added:
field ContainerListResponse.name: str - added:
field ContainerListResponse.object: str - added:
field ContainerListResponse.status: str - added:
field ExpiresAfter.anchor: Optional[Literal['last_active_at']] - added:
field ExpiresAfter.minutes: Optional[int]
- added:
class ContainerRetrieveResponse(BaseModel) - added:
class ExpiresAfter(BaseModel) - added:
field ContainerRetrieveResponse.created_at: int - added:
field ContainerRetrieveResponse.expires_after: Optional[ExpiresAfter] - added:
field ContainerRetrieveResponse.id: str - added:
field ContainerRetrieveResponse.name: str - added:
field ContainerRetrieveResponse.object: str - added:
field ContainerRetrieveResponse.status: str - added:
field ExpiresAfter.anchor: Optional[Literal['last_active_at']] - added:
field ExpiresAfter.minutes: Optional[int]
- added:
export FileCreateParams - added:
export FileCreateResponse - added:
export FileListParams - added:
export FileListResponse - added:
export FileRetrieveResponse
- added:
class FileCreateParams(TypedDict) - added:
field FileCreateParams.file: FileTypes - added:
field FileCreateParams.file_id: str
- added:
class FileCreateResponse(BaseModel) - added:
field FileCreateResponse.bytes: int - added:
field FileCreateResponse.container_id: str - added:
field FileCreateResponse.created_at: int - added:
field FileCreateResponse.id: str - added:
field FileCreateResponse.object: Literal['container.file'] - added:
field FileCreateResponse.path: str - added:
field FileCreateResponse.source: str
- added:
class FileListParams(TypedDict) - added:
field FileListParams.after: str - added:
field FileListParams.limit: int - added:
field FileListParams.order: Literal['asc', 'desc']
- added:
class FileListResponse(BaseModel) - added:
field FileListResponse.bytes: int - added:
field FileListResponse.container_id: str - added:
field FileListResponse.created_at: int - added:
field FileListResponse.id: str - added:
field FileListResponse.object: Literal['container.file'] - added:
field FileListResponse.path: str - added:
field FileListResponse.source: str
- added:
class FileRetrieveResponse(BaseModel) - added:
field FileRetrieveResponse.bytes: int - added:
field FileRetrieveResponse.container_id: str - added:
field FileRetrieveResponse.created_at: int - added:
field FileRetrieveResponse.id: str - added:
field FileRetrieveResponse.object: Literal['container.file'] - added:
field FileRetrieveResponse.path: str - added:
field FileRetrieveResponse.source: str
- added:
export ComputerScreenshotContent - added:
export Conversation - added:
export ConversationCreateParams - added:
export ConversationDeletedResource - added:
export ConversationItem - added:
export ConversationItemList - added:
export ConversationUpdateParams - added:
export InputFileContent - added:
export InputFileContentParam - added:
export InputImageContent - added:
export InputImageContentParam - added:
export InputTextContent - added:
export InputTextContentParam - added:
export ItemCreateParams - added:
export ItemListParams - added:
export ItemRetrieveParams - added:
export Message - added:
export OutputTextContent - added:
export OutputTextContentParam - added:
export RefusalContent - added:
export RefusalContentParam - added:
export SummaryTextContent - added:
export TextContent
- added:
class ComputerScreenshotContent(BaseModel) - added:
field ComputerScreenshotContent.file_id: Optional[str] - added:
field ComputerScreenshotContent.image_url: Optional[str] - added:
field ComputerScreenshotContent.type: Literal['computer_screenshot']
- added:
class Conversation(BaseModel) - added:
field Conversation.created_at: int - added:
field Conversation.id: str - added:
field Conversation.metadata: object - added:
field Conversation.object: Literal['conversation']
- added:
class ConversationCreateParams(TypedDict) - added:
field ConversationCreateParams.items: Optional[Iterable[ResponseInputItemParam]] - added:
field ConversationCreateParams.metadata: Optional[Metadata]
- added:
class ConversationDeletedResource(BaseModel) - added:
field ConversationDeletedResource.deleted: bool - added:
field ConversationDeletedResource.id: str - added:
field ConversationDeletedResource.object: Literal['conversation.deleted']
- added:
class ImageGenerationCall(BaseModel) - added:
class LocalShellCall(BaseModel) - added:
class LocalShellCallAction(BaseModel) - added:
class LocalShellCallOutput(BaseModel) - added:
class McpApprovalRequest(BaseModel) - added:
class McpApprovalResponse(BaseModel) - added:
class McpCall(BaseModel) - added:
class McpListTools(BaseModel) - added:
class McpListToolsTool(BaseModel) - added:
field ImageGenerationCall.id: str - added:
field ImageGenerationCall.result: Optional[str] - added:
field ImageGenerationCall.status: Literal['in_progress', 'completed', 'generating', 'failed'] - added:
field ImageGenerationCall.type: Literal['image_generation_call'] - added:
field LocalShellCall.action: LocalShellCallAction - added:
field LocalShellCall.call_id: str - added:
field LocalShellCall.id: str - added:
field LocalShellCall.status: Literal['in_progress', 'completed', 'incomplete'] - added:
field LocalShellCall.type: Literal['local_shell_call'] - added:
field LocalShellCallAction.command: List[str] - added:
field LocalShellCallAction.env: Dict[str, str] - added:
field LocalShellCallAction.timeout_ms: Optional[int] - added:
field LocalShellCallAction.type: Literal['exec'] - added:
field LocalShellCallAction.user: Optional[str] - added:
field LocalShellCallAction.working_directory: Optional[str] - added:
field LocalShellCallOutput.id: str - added:
field LocalShellCallOutput.output: str - added:
field LocalShellCallOutput.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field LocalShellCallOutput.type: Literal['local_shell_call_output'] - added:
field McpApprovalRequest.arguments: str - added:
field McpApprovalRequest.id: str - added:
field McpApprovalRequest.name: str - added:
field McpApprovalRequest.server_label: str - added:
field McpApprovalRequest.type: Literal['mcp_approval_request'] - added:
field McpApprovalResponse.approval_request_id: str - added:
field McpApprovalResponse.approve: bool - added:
field McpApprovalResponse.id: str - added:
field McpApprovalResponse.reason: Optional[str] - added:
field McpApprovalResponse.type: Literal['mcp_approval_response'] - added:
field McpCall.arguments: str - added:
field McpCall.error: Optional[str] - added:
field McpCall.id: str - added:
field McpCall.name: str - added:
field McpCall.output: Optional[str] - added:
field McpCall.server_label: str - added:
field McpCall.type: Literal['mcp_call'] - added:
field McpListTools.error: Optional[str] - added:
field McpListTools.id: str - added:
field McpListTools.server_label: str - added:
field McpListTools.tools: List[McpListToolsTool] - added:
field McpListTools.type: Literal['mcp_list_tools'] - added:
field McpListToolsTool.annotations: Optional[object] - added:
field McpListToolsTool.description: Optional[str] - added:
field McpListToolsTool.input_schema: object - added:
field McpListToolsTool.name: str - added:
variable ConversationItem: TypeAlias
- added:
class ConversationItemList(BaseModel) - added:
field ConversationItemList.data: List[ConversationItem] - added:
field ConversationItemList.first_id: str - added:
field ConversationItemList.has_more: bool - added:
field ConversationItemList.last_id: str - added:
field ConversationItemList.object: Literal['list']
- added:
class ConversationUpdateParams(TypedDict) - added:
field ConversationUpdateParams.metadata: Required[Optional[Metadata]]
- added:
variable InputFileContent
- added:
variable InputFileContentParam
- added:
variable InputImageContent
- added:
variable InputImageContentParam
- added:
variable InputTextContent
- added:
variable InputTextContentParam
- added:
class ItemCreateParams(TypedDict) - added:
field ItemCreateParams.include: List[ResponseIncludable] - added:
field ItemCreateParams.items: Required[Iterable[ResponseInputItemParam]]
- added:
class ItemListParams(TypedDict) - added:
field ItemListParams.after: str - added:
field ItemListParams.include: List[ResponseIncludable] - added:
field ItemListParams.limit: int - added:
field ItemListParams.order: Literal['asc', 'desc']
- added:
class ItemRetrieveParams(TypedDict) - added:
field ItemRetrieveParams.conversation_id: Required[str] - added:
field ItemRetrieveParams.include: List[ResponseIncludable]
- added:
class ContentReasoningText(BaseModel) - added:
class Message(BaseModel) - added:
field ContentReasoningText.text: str - added:
field ContentReasoningText.type: Literal['reasoning_text'] - added:
field Message.content: List[Content] - added:
field Message.id: str - added:
field Message.role: Literal['unknown', 'user', 'assistant', 'system', 'critic', 'discriminator', 'developer', 'tool'] - added:
field Message.status: Literal['in_progress', 'completed', 'incomplete'] - added:
field Message.type: Literal['message'] - added:
variable Content: TypeAlias
- added:
variable OutputTextContent
- added:
variable OutputTextContentParam
- added:
variable RefusalContent
- added:
variable RefusalContentParam
- added:
class SummaryTextContent(BaseModel) - added:
field SummaryTextContent.text: str - added:
field SummaryTextContent.type: Literal['summary_text']
- added:
class TextContent(BaseModel) - added:
field TextContent.text: str - added:
field TextContent.type: Literal['text']
- added:
class CreateEmbeddingResponse(BaseModel) - added:
class Usage(BaseModel) - added:
field CreateEmbeddingResponse.data: List[Embedding] - added:
field CreateEmbeddingResponse.model: str - added:
field CreateEmbeddingResponse.object: Literal['list'] - added:
field CreateEmbeddingResponse.usage: Usage - added:
field Usage.prompt_tokens: int - added:
field Usage.total_tokens: int
- added:
class Embedding(BaseModel) - added:
field Embedding.embedding: List[float] - added:
field Embedding.index: int - added:
field Embedding.object: Literal['embedding']
- added:
class EmbeddingCreateParams(TypedDict) - added:
field EmbeddingCreateParams.dimensions: int - added:
field EmbeddingCreateParams.encoding_format: Literal['float', 'base64'] - added:
field EmbeddingCreateParams.input: Required[Union[str, SequenceNotStr[str], Iterable[int], Iterable[Iterable[int]]]] - added:
field EmbeddingCreateParams.model: Required[Union[str, EmbeddingModel]] - added:
field EmbeddingCreateParams.user: str
- added:
variable EmbeddingModel: TypeAlias
- added:
class DataSourceConfigCustom(TypedDict) - added:
class DataSourceConfigLogs(TypedDict) - added:
class DataSourceConfigStoredCompletions(TypedDict) - added:
class EvalCreateParams(TypedDict) - added:
class TestingCriterionLabelModel(TypedDict) - added:
class TestingCriterionLabelModelInputEvalItem(TypedDict) - added:
class TestingCriterionLabelModelInputEvalItemContentInputImage(TypedDict) - added:
class TestingCriterionLabelModelInputEvalItemContentOutputText(TypedDict) - added:
class TestingCriterionLabelModelInputSimpleInputMessage(TypedDict) - added:
class TestingCriterionPython(PythonGraderParam) - added:
class TestingCriterionScoreModel(ScoreModelGraderParam) - added:
class TestingCriterionTextSimilarity(TextSimilarityGraderParam) - added:
field DataSourceConfigCustom.include_sample_schema: bool - added:
field DataSourceConfigCustom.item_schema: Required[Dict[str, object]] - added:
field DataSourceConfigCustom.type: Required[Literal['custom']] - added:
field DataSourceConfigLogs.metadata: Dict[str, object] - added:
field DataSourceConfigLogs.type: Required[Literal['logs']] - added:
field DataSourceConfigStoredCompletions.metadata: Dict[str, object] - added:
field DataSourceConfigStoredCompletions.type: Required[Literal['stored_completions']] - added:
field EvalCreateParams.data_source_config: Required[DataSourceConfig] - added:
field EvalCreateParams.metadata: Optional[Metadata] - added:
field EvalCreateParams.name: str - added:
field EvalCreateParams.testing_criteria: Required[Iterable[TestingCriterion]] - added:
field TestingCriterionLabelModel.input: Required[Iterable[TestingCriterionLabelModelInput]] - added:
field TestingCriterionLabelModel.labels: Required[SequenceNotStr[str]] - added:
field TestingCriterionLabelModel.model: Required[str] - added:
field TestingCriterionLabelModel.name: Required[str] - added:
field TestingCriterionLabelModel.passing_labels: Required[SequenceNotStr[str]] - added:
field TestingCriterionLabelModel.type: Required[Literal['label_model']] - added:
field TestingCriterionLabelModelInputEvalItem.content: Required[TestingCriterionLabelModelInputEvalItemContent] - added:
field TestingCriterionLabelModelInputEvalItem.role: Required[Literal['user', 'assistant', 'system', 'developer']] - added:
field TestingCriterionLabelModelInputEvalItem.type: Literal['message'] - added:
field TestingCriterionLabelModelInputEvalItemContentInputImage.detail: str - added:
field TestingCriterionLabelModelInputEvalItemContentInputImage.image_url: Required[str] - added:
field TestingCriterionLabelModelInputEvalItemContentInputImage.type: Required[Literal['input_image']] - added:
field TestingCriterionLabelModelInputEvalItemContentOutputText.text: Required[str] - added:
field TestingCriterionLabelModelInputEvalItemContentOutputText.type: Required[Literal['output_text']] - added:
field TestingCriterionLabelModelInputSimpleInputMessage.content: Required[str] - added:
field TestingCriterionLabelModelInputSimpleInputMessage.role: Required[str] - added:
field TestingCriterionPython.pass_threshold: float - added:
field TestingCriterionScoreModel.pass_threshold: float - added:
field TestingCriterionTextSimilarity.pass_threshold: Required[float] - added:
variable DataSourceConfig: TypeAlias - added:
variable TestingCriterion: TypeAlias - added:
variable TestingCriterionLabelModelInput: TypeAlias - added:
variable TestingCriterionLabelModelInputEvalItemContent: TypeAlias
- added:
class DataSourceConfigLogs(BaseModel) - added:
class EvalCreateResponse(BaseModel) - added:
class TestingCriterionEvalGraderPython(PythonGrader) - added:
class TestingCriterionEvalGraderScoreModel(ScoreModelGrader) - added:
class TestingCriterionEvalGraderTextSimilarity(TextSimilarityGrader) - added:
field DataSourceConfigLogs.metadata: Optional[Metadata] - added:
field DataSourceConfigLogs.schema_: Dict[str, object] - added:
field DataSourceConfigLogs.type: Literal['logs'] - added:
field EvalCreateResponse.created_at: int - added:
field EvalCreateResponse.data_source_config: DataSourceConfig - added:
field EvalCreateResponse.id: str - added:
field EvalCreateResponse.metadata: Optional[Metadata] - added:
field EvalCreateResponse.name: str - added:
field EvalCreateResponse.object: Literal['eval'] - added:
field EvalCreateResponse.testing_criteria: List[TestingCriterion] - added:
field TestingCriterionEvalGraderPython.pass_threshold: Optional[float] - added:
field TestingCriterionEvalGraderScoreModel.pass_threshold: Optional[float] - added:
field TestingCriterionEvalGraderTextSimilarity.pass_threshold: float - added:
variable DataSourceConfig: TypeAlias - added:
variable TestingCriterion: TypeAlias
- added:
class EvalCustomDataSourceConfig(BaseModel) - added:
field EvalCustomDataSourceConfig.schema_: Dict[str, object] - added:
field EvalCustomDataSourceConfig.type: Literal['custom']
- added:
class EvalDeleteResponse(BaseModel) - added:
field EvalDeleteResponse.deleted: bool - added:
field EvalDeleteResponse.eval_id: str - added:
field EvalDeleteResponse.object: str
- added:
class EvalListParams(TypedDict) - added:
field EvalListParams.after: str - added:
field EvalListParams.limit: int - added:
field EvalListParams.order: Literal['asc', 'desc'] - added:
field EvalListParams.order_by: Literal['created_at', 'updated_at']
- added:
class DataSourceConfigLogs(BaseModel) - added:
class EvalListResponse(BaseModel) - added:
class TestingCriterionEvalGraderPython(PythonGrader) - added:
class TestingCriterionEvalGraderScoreModel(ScoreModelGrader) - added:
class TestingCriterionEvalGraderTextSimilarity(TextSimilarityGrader) - added:
field DataSourceConfigLogs.metadata: Optional[Metadata] - added:
field DataSourceConfigLogs.schema_: Dict[str, object] - added:
field DataSourceConfigLogs.type: Literal['logs'] - added:
field EvalListResponse.created_at: int - added:
field EvalListResponse.data_source_config: DataSourceConfig - added:
field EvalListResponse.id: str - added:
field EvalListResponse.metadata: Optional[Metadata] - added:
field EvalListResponse.name: str - added:
field EvalListResponse.object: Literal['eval'] - added:
field EvalListResponse.testing_criteria: List[TestingCriterion] - added:
field TestingCriterionEvalGraderPython.pass_threshold: Optional[float] - added:
field TestingCriterionEvalGraderScoreModel.pass_threshold: Optional[float] - added:
field TestingCriterionEvalGraderTextSimilarity.pass_threshold: float - added:
variable DataSourceConfig: TypeAlias - added:
variable TestingCriterion: TypeAlias
- added:
class DataSourceConfigLogs(BaseModel) - added:
class EvalRetrieveResponse(BaseModel) - added:
class TestingCriterionEvalGraderPython(PythonGrader) - added:
class TestingCriterionEvalGraderScoreModel(ScoreModelGrader) - added:
class TestingCriterionEvalGraderTextSimilarity(TextSimilarityGrader) - added:
field DataSourceConfigLogs.metadata: Optional[Metadata] - added:
field DataSourceConfigLogs.schema_: Dict[str, object] - added:
field DataSourceConfigLogs.type: Literal['logs'] - added:
field EvalRetrieveResponse.created_at: int - added:
field EvalRetrieveResponse.data_source_config: DataSourceConfig - added:
field EvalRetrieveResponse.id: str - added:
field EvalRetrieveResponse.metadata: Optional[Metadata] - added:
field EvalRetrieveResponse.name: str - added:
field EvalRetrieveResponse.object: Literal['eval'] - added:
field EvalRetrieveResponse.testing_criteria: List[TestingCriterion] - added:
field TestingCriterionEvalGraderPython.pass_threshold: Optional[float] - added:
field TestingCriterionEvalGraderScoreModel.pass_threshold: Optional[float] - added:
field TestingCriterionEvalGraderTextSimilarity.pass_threshold: float - added:
variable DataSourceConfig: TypeAlias - added:
variable TestingCriterion: TypeAlias
- added:
class EvalStoredCompletionsDataSourceConfig(BaseModel) - added:
field EvalStoredCompletionsDataSourceConfig.metadata: Optional[Metadata] - added:
field EvalStoredCompletionsDataSourceConfig.schema_: Dict[str, object] - added:
field EvalStoredCompletionsDataSourceConfig.type: Literal['stored_completions']
- added:
class EvalUpdateParams(TypedDict) - added:
field EvalUpdateParams.metadata: Optional[Metadata] - added:
field EvalUpdateParams.name: str
- added:
class DataSourceConfigLogs(BaseModel) - added:
class EvalUpdateResponse(BaseModel) - added:
class TestingCriterionEvalGraderPython(PythonGrader) - added:
class TestingCriterionEvalGraderScoreModel(ScoreModelGrader) - added:
class TestingCriterionEvalGraderTextSimilarity(TextSimilarityGrader) - added:
field DataSourceConfigLogs.metadata: Optional[Metadata] - added:
field DataSourceConfigLogs.schema_: Dict[str, object] - added:
field DataSourceConfigLogs.type: Literal['logs'] - added:
field EvalUpdateResponse.created_at: int - added:
field EvalUpdateResponse.data_source_config: DataSourceConfig - added:
field EvalUpdateResponse.id: str - added:
field EvalUpdateResponse.metadata: Optional[Metadata] - added:
field EvalUpdateResponse.name: str - added:
field EvalUpdateResponse.object: Literal['eval'] - added:
field EvalUpdateResponse.testing_criteria: List[TestingCriterion] - added:
field TestingCriterionEvalGraderPython.pass_threshold: Optional[float] - added:
field TestingCriterionEvalGraderScoreModel.pass_threshold: Optional[float] - added:
field TestingCriterionEvalGraderTextSimilarity.pass_threshold: float - added:
variable DataSourceConfig: TypeAlias - added:
variable TestingCriterion: TypeAlias
- added:
export CreateEvalCompletionsRunDataSource - added:
export CreateEvalCompletionsRunDataSourceParam - added:
export CreateEvalJSONLRunDataSource - added:
export CreateEvalJSONLRunDataSourceParam - added:
export EvalAPIError - added:
export RunCancelResponse - added:
export RunCreateParams - added:
export RunCreateResponse - added:
export RunDeleteResponse - added:
export RunListParams - added:
export RunListResponse - added:
export RunRetrieveResponse
- added:
class CreateEvalCompletionsRunDataSource(BaseModel) - added:
class InputMessagesItemReference(BaseModel) - added:
class InputMessagesTemplate(BaseModel) - added:
class InputMessagesTemplateTemplateEvalItem(BaseModel) - added:
class InputMessagesTemplateTemplateEvalItemContentInputImage(BaseModel) - added:
class InputMessagesTemplateTemplateEvalItemContentOutputText(BaseModel) - added:
class SamplingParams(BaseModel) - added:
class SourceFileContent(BaseModel) - added:
class SourceFileContentContent(BaseModel) - added:
class SourceFileID(BaseModel) - added:
class SourceStoredCompletions(BaseModel) - added:
field CreateEvalCompletionsRunDataSource.input_messages: Optional[InputMessages] - added:
field CreateEvalCompletionsRunDataSource.model: Optional[str] - added:
field CreateEvalCompletionsRunDataSource.sampling_params: Optional[SamplingParams] - added:
field CreateEvalCompletionsRunDataSource.source: Source - added:
field CreateEvalCompletionsRunDataSource.type: Literal['completions'] - added:
field InputMessagesItemReference.item_reference: str - added:
field InputMessagesItemReference.type: Literal['item_reference'] - added:
field InputMessagesTemplate.template: List[InputMessagesTemplateTemplate] - added:
field InputMessagesTemplate.type: Literal['template'] - added:
field InputMessagesTemplateTemplateEvalItem.content: InputMessagesTemplateTemplateEvalItemContent - added:
field InputMessagesTemplateTemplateEvalItem.role: Literal['user', 'assistant', 'system', 'developer'] - added:
field InputMessagesTemplateTemplateEvalItem.type: Optional[Literal['message']] - added:
field InputMessagesTemplateTemplateEvalItemContentInputImage.detail: Optional[str] - added:
field InputMessagesTemplateTemplateEvalItemContentInputImage.image_url: str - added:
field InputMessagesTemplateTemplateEvalItemContentInputImage.type: Literal['input_image'] - added:
field InputMessagesTemplateTemplateEvalItemContentOutputText.text: str - added:
field InputMessagesTemplateTemplateEvalItemContentOutputText.type: Literal['output_text'] - added:
field SamplingParams.max_completion_tokens: Optional[int] - added:
field SamplingParams.reasoning_effort: Optional[ReasoningEffort] - added:
field SamplingParams.response_format: Optional[SamplingParamsResponseFormat] - added:
field SamplingParams.seed: Optional[int] - added:
field SamplingParams.temperature: Optional[float] - added:
field SamplingParams.tools: Optional[List[ChatCompletionFunctionTool]] - added:
field SamplingParams.top_p: Optional[float] - added:
field SourceFileContent.content: List[SourceFileContentContent] - added:
field SourceFileContent.type: Literal['file_content'] - added:
field SourceFileContentContent.item: Dict[str, object] - added:
field SourceFileContentContent.sample: Optional[Dict[str, object]] - added:
field SourceFileID.id: str - added:
field SourceFileID.type: Literal['file_id'] - added:
field SourceStoredCompletions.created_after: Optional[int] - added:
field SourceStoredCompletions.created_before: Optional[int] - added:
field SourceStoredCompletions.limit: Optional[int] - added:
field SourceStoredCompletions.metadata: Optional[Metadata] - added:
field SourceStoredCompletions.model: Optional[str] - added:
field SourceStoredCompletions.type: Literal['stored_completions'] - added:
variable InputMessages: TypeAlias - added:
variable InputMessagesTemplateTemplate: TypeAlias - added:
variable InputMessagesTemplateTemplateEvalItemContent: TypeAlias - added:
variable SamplingParamsResponseFormat: TypeAlias - added:
variable Source: TypeAlias
- added:
class CreateEvalCompletionsRunDataSourceParam(TypedDict) - added:
class InputMessagesItemReference(TypedDict) - added:
class InputMessagesTemplate(TypedDict) - added:
class InputMessagesTemplateTemplateEvalItem(TypedDict) - added:
class InputMessagesTemplateTemplateEvalItemContentInputImage(TypedDict) - added:
class InputMessagesTemplateTemplateEvalItemContentOutputText(TypedDict) - added:
class SamplingParams(TypedDict) - added:
class SourceFileContent(TypedDict) - added:
class SourceFileContentContent(TypedDict) - added:
class SourceFileID(TypedDict) - added:
class SourceStoredCompletions(TypedDict) - added:
field CreateEvalCompletionsRunDataSourceParam.input_messages: InputMessages - added:
field CreateEvalCompletionsRunDataSourceParam.model: str - added:
field CreateEvalCompletionsRunDataSourceParam.sampling_params: SamplingParams - added:
field CreateEvalCompletionsRunDataSourceParam.source: Required[Source] - added:
field CreateEvalCompletionsRunDataSourceParam.type: Required[Literal['completions']] - added:
field InputMessagesItemReference.item_reference: Required[str] - added:
field InputMessagesItemReference.type: Required[Literal['item_reference']] - added:
field InputMessagesTemplate.template: Required[Iterable[InputMessagesTemplateTemplate]] - added:
field InputMessagesTemplate.type: Required[Literal['template']] - added:
field InputMessagesTemplateTemplateEvalItem.content: Required[InputMessagesTemplateTemplateEvalItemContent] - added:
field InputMessagesTemplateTemplateEvalItem.role: Required[Literal['user', 'assistant', 'system', 'developer']] - added:
field InputMessagesTemplateTemplateEvalItem.type: Literal['message'] - added:
field InputMessagesTemplateTemplateEvalItemContentInputImage.detail: str - added:
field InputMessagesTemplateTemplateEvalItemContentInputImage.image_url: Required[str] - added:
field InputMessagesTemplateTemplateEvalItemContentInputImage.type: Required[Literal['input_image']] - added:
field InputMessagesTemplateTemplateEvalItemContentOutputText.text: Required[str] - added:
field InputMessagesTemplateTemplateEvalItemContentOutputText.type: Required[Literal['output_text']] - added:
field SamplingParams.max_completion_tokens: int - added:
field SamplingParams.reasoning_effort: Optional[ReasoningEffort] - added:
field SamplingParams.response_format: SamplingParamsResponseFormat - added:
field SamplingParams.seed: int - added:
field SamplingParams.temperature: float - added:
field SamplingParams.tools: Iterable[ChatCompletionFunctionToolParam] - added:
field SamplingParams.top_p: float - added:
field SourceFileContent.content: Required[Iterable[SourceFileContentContent]] - added:
field SourceFileContent.type: Required[Literal['file_content']] - added:
field SourceFileContentContent.item: Required[Dict[str, object]] - added:
field SourceFileContentContent.sample: Dict[str, object] - added:
field SourceFileID.id: Required[str] - added:
field SourceFileID.type: Required[Literal['file_id']] - added:
field SourceStoredCompletions.created_after: Optional[int] - added:
field SourceStoredCompletions.created_before: Optional[int] - added:
field SourceStoredCompletions.limit: Optional[int] - added:
field SourceStoredCompletions.metadata: Optional[Metadata] - added:
field SourceStoredCompletions.model: Optional[str] - added:
field SourceStoredCompletions.type: Required[Literal['stored_completions']] - added:
variable InputMessages: TypeAlias - added:
variable InputMessagesTemplateTemplate: TypeAlias - added:
variable InputMessagesTemplateTemplateEvalItemContent: TypeAlias - added:
variable SamplingParamsResponseFormat: TypeAlias - added:
variable Source: TypeAlias
- added:
class CreateEvalJSONLRunDataSource(BaseModel) - added:
class SourceFileContent(BaseModel) - added:
class SourceFileContentContent(BaseModel) - added:
class SourceFileID(BaseModel) - added:
field CreateEvalJSONLRunDataSource.source: Source - added:
field CreateEvalJSONLRunDataSource.type: Literal['jsonl'] - added:
field SourceFileContent.content: List[SourceFileContentContent] - added:
field SourceFileContent.type: Literal['file_content'] - added:
field SourceFileContentContent.item: Dict[str, object] - added:
field SourceFileContentContent.sample: Optional[Dict[str, object]] - added:
field SourceFileID.id: str - added:
field SourceFileID.type: Literal['file_id'] - added:
variable Source: TypeAlias
- added:
class CreateEvalJSONLRunDataSourceParam(TypedDict) - added:
class SourceFileContent(TypedDict) - added:
class SourceFileContentContent(TypedDict) - added:
class SourceFileID(TypedDict) - added:
field CreateEvalJSONLRunDataSourceParam.source: Required[Source] - added:
field CreateEvalJSONLRunDataSourceParam.type: Required[Literal['jsonl']] - added:
field SourceFileContent.content: Required[Iterable[SourceFileContentContent]] - added:
field SourceFileContent.type: Required[Literal['file_content']] - added:
field SourceFileContentContent.item: Required[Dict[str, object]] - added:
field SourceFileContentContent.sample: Dict[str, object] - added:
field SourceFileID.id: Required[str] - added:
field SourceFileID.type: Required[Literal['file_id']] - added:
variable Source: TypeAlias
- added:
class EvalAPIError(BaseModel) - added:
field EvalAPIError.code: str - added:
field EvalAPIError.message: str
- added:
class DataSourceResponses(BaseModel) - added:
class DataSourceResponsesInputMessagesItemReference(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplate(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateChatMessage(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateEvalItem(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentOutputText(BaseModel) - added:
class DataSourceResponsesSamplingParams(BaseModel) - added:
class DataSourceResponsesSamplingParamsText(BaseModel) - added:
class DataSourceResponsesSourceFileContent(BaseModel) - added:
class DataSourceResponsesSourceFileContentContent(BaseModel) - added:
class DataSourceResponsesSourceFileID(BaseModel) - added:
class DataSourceResponsesSourceResponses(BaseModel) - added:
class PerModelUsage(BaseModel) - added:
class PerTestingCriteriaResult(BaseModel) - added:
class ResultCounts(BaseModel) - added:
class RunCancelResponse(BaseModel) - added:
field DataSourceResponses.input_messages: Optional[DataSourceResponsesInputMessages] - added:
field DataSourceResponses.model: Optional[str] - added:
field DataSourceResponses.sampling_params: Optional[DataSourceResponsesSamplingParams] - added:
field DataSourceResponses.source: DataSourceResponsesSource - added:
field DataSourceResponses.type: Literal['responses'] - added:
field DataSourceResponsesInputMessagesItemReference.item_reference: str - added:
field DataSourceResponsesInputMessagesItemReference.type: Literal['item_reference'] - added:
field DataSourceResponsesInputMessagesTemplate.template: List[DataSourceResponsesInputMessagesTemplateTemplate] - added:
field DataSourceResponsesInputMessagesTemplate.type: Literal['template'] - added:
field DataSourceResponsesInputMessagesTemplateTemplateChatMessage.content: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateChatMessage.role: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItem.content: DataSourceResponsesInputMessagesTemplateTemplateEvalItemContent - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItem.role: Literal['user', 'assistant', 'system', 'developer'] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItem.type: Optional[Literal['message']] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage.detail: Optional[str] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage.image_url: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage.type: Literal['input_image'] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentOutputText.text: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentOutputText.type: Literal['output_text'] - added:
field DataSourceResponsesSamplingParams.max_completion_tokens: Optional[int] - added:
field DataSourceResponsesSamplingParams.reasoning_effort: Optional[ReasoningEffort] - added:
field DataSourceResponsesSamplingParams.seed: Optional[int] - added:
field DataSourceResponsesSamplingParams.temperature: Optional[float] - added:
field DataSourceResponsesSamplingParams.text: Optional[DataSourceResponsesSamplingParamsText] - added:
field DataSourceResponsesSamplingParams.tools: Optional[List[Tool]] - added:
field DataSourceResponsesSamplingParams.top_p: Optional[float] - added:
field DataSourceResponsesSamplingParamsText.format: Optional[ResponseFormatTextConfig] - added:
field DataSourceResponsesSourceFileContent.content: List[DataSourceResponsesSourceFileContentContent] - added:
field DataSourceResponsesSourceFileContent.type: Literal['file_content'] - added:
field DataSourceResponsesSourceFileContentContent.item: Dict[str, object] - added:
field DataSourceResponsesSourceFileContentContent.sample: Optional[Dict[str, object]] - added:
field DataSourceResponsesSourceFileID.id: str - added:
field DataSourceResponsesSourceFileID.type: Literal['file_id'] - added:
field DataSourceResponsesSourceResponses.created_after: Optional[int] - added:
field DataSourceResponsesSourceResponses.created_before: Optional[int] - added:
field DataSourceResponsesSourceResponses.instructions_search: Optional[str] - added:
field DataSourceResponsesSourceResponses.metadata: Optional[object] - added:
field DataSourceResponsesSourceResponses.model: Optional[str] - added:
field DataSourceResponsesSourceResponses.reasoning_effort: Optional[ReasoningEffort] - added:
field DataSourceResponsesSourceResponses.temperature: Optional[float] - added:
field DataSourceResponsesSourceResponses.tools: Optional[List[str]] - added:
field DataSourceResponsesSourceResponses.top_p: Optional[float] - added:
field DataSourceResponsesSourceResponses.type: Literal['responses'] - added:
field DataSourceResponsesSourceResponses.users: Optional[List[str]] - added:
field PerModelUsage.cached_tokens: int - added:
field PerModelUsage.completion_tokens: int - added:
field PerModelUsage.invocation_count: int - added:
field PerModelUsage.prompt_tokens: int - added:
field PerModelUsage.run_model_name: str - added:
field PerModelUsage.total_tokens: int - added:
field PerTestingCriteriaResult.failed: int - added:
field PerTestingCriteriaResult.passed: int - added:
field PerTestingCriteriaResult.testing_criteria: str - added:
field ResultCounts.errored: int - added:
field ResultCounts.failed: int - added:
field ResultCounts.passed: int - added:
field ResultCounts.total: int - added:
field RunCancelResponse.created_at: int - added:
field RunCancelResponse.data_source: DataSource - added:
field RunCancelResponse.error: EvalAPIError - added:
field RunCancelResponse.eval_id: str - added:
field RunCancelResponse.id: str - added:
field RunCancelResponse.metadata: Optional[Metadata] - added:
field RunCancelResponse.model: str - added:
field RunCancelResponse.name: str - added:
field RunCancelResponse.object: Literal['eval.run'] - added:
field RunCancelResponse.per_model_usage: List[PerModelUsage] - added:
field RunCancelResponse.per_testing_criteria_results: List[PerTestingCriteriaResult] - added:
field RunCancelResponse.report_url: str - added:
field RunCancelResponse.result_counts: ResultCounts - added:
field RunCancelResponse.status: str - added:
variable DataSource: TypeAlias - added:
variable DataSourceResponsesInputMessages: TypeAlias - added:
variable DataSourceResponsesInputMessagesTemplateTemplate: TypeAlias - added:
variable DataSourceResponsesInputMessagesTemplateTemplateEvalItemContent: TypeAlias - added:
variable DataSourceResponsesSource: TypeAlias
- added:
class DataSourceCreateEvalResponsesRunDataSource(TypedDict) - added:
class DataSourceCreateEvalResponsesRunDataSourceInputMessagesItemReference(TypedDict) - added:
class DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplate(TypedDict) - added:
class DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateChatMessage(TypedDict) - added:
class DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateEvalItem(TypedDict) - added:
class DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateEvalItemContentInputImage(TypedDict) - added:
class DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateEvalItemContentOutputText(TypedDict) - added:
class DataSourceCreateEvalResponsesRunDataSourceSamplingParams(TypedDict) - added:
class DataSourceCreateEvalResponsesRunDataSourceSamplingParamsText(TypedDict) - added:
class DataSourceCreateEvalResponsesRunDataSourceSourceFileContent(TypedDict) - added:
class DataSourceCreateEvalResponsesRunDataSourceSourceFileContentContent(TypedDict) - added:
class DataSourceCreateEvalResponsesRunDataSourceSourceFileID(TypedDict) - added:
class DataSourceCreateEvalResponsesRunDataSourceSourceResponses(TypedDict) - added:
class RunCreateParams(TypedDict) - added:
field DataSourceCreateEvalResponsesRunDataSource.input_messages: DataSourceCreateEvalResponsesRunDataSourceInputMessages - added:
field DataSourceCreateEvalResponsesRunDataSource.model: str - added:
field DataSourceCreateEvalResponsesRunDataSource.sampling_params: DataSourceCreateEvalResponsesRunDataSourceSamplingParams - added:
field DataSourceCreateEvalResponsesRunDataSource.source: Required[DataSourceCreateEvalResponsesRunDataSourceSource] - added:
field DataSourceCreateEvalResponsesRunDataSource.type: Required[Literal['responses']] - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesItemReference.item_reference: Required[str] - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesItemReference.type: Required[Literal['item_reference']] - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplate.template: Required[Iterable[DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplate]] - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplate.type: Required[Literal['template']] - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateChatMessage.content: Required[str] - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateChatMessage.role: Required[str] - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateEvalItem.content: Required[DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateEvalItemContent] - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateEvalItem.role: Required[Literal['user', 'assistant', 'system', 'developer']] - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateEvalItem.type: Literal['message'] - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateEvalItemContentInputImage.detail: str - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateEvalItemContentInputImage.image_url: Required[str] - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateEvalItemContentInputImage.type: Required[Literal['input_image']] - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateEvalItemContentOutputText.text: Required[str] - added:
field DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateEvalItemContentOutputText.type: Required[Literal['output_text']] - added:
field DataSourceCreateEvalResponsesRunDataSourceSamplingParams.max_completion_tokens: int - added:
field DataSourceCreateEvalResponsesRunDataSourceSamplingParams.reasoning_effort: Optional[ReasoningEffort] - added:
field DataSourceCreateEvalResponsesRunDataSourceSamplingParams.seed: int - added:
field DataSourceCreateEvalResponsesRunDataSourceSamplingParams.temperature: float - added:
field DataSourceCreateEvalResponsesRunDataSourceSamplingParams.text: DataSourceCreateEvalResponsesRunDataSourceSamplingParamsText - added:
field DataSourceCreateEvalResponsesRunDataSourceSamplingParams.tools: Iterable[ToolParam] - added:
field DataSourceCreateEvalResponsesRunDataSourceSamplingParams.top_p: float - added:
field DataSourceCreateEvalResponsesRunDataSourceSamplingParamsText.format: ResponseFormatTextConfigParam - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceFileContent.content: Required[Iterable[DataSourceCreateEvalResponsesRunDataSourceSourceFileContentContent]] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceFileContent.type: Required[Literal['file_content']] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceFileContentContent.item: Required[Dict[str, object]] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceFileContentContent.sample: Dict[str, object] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceFileID.id: Required[str] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceFileID.type: Required[Literal['file_id']] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceResponses.created_after: Optional[int] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceResponses.created_before: Optional[int] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceResponses.instructions_search: Optional[str] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceResponses.metadata: Optional[object] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceResponses.model: Optional[str] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceResponses.reasoning_effort: Optional[ReasoningEffort] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceResponses.temperature: Optional[float] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceResponses.tools: Optional[SequenceNotStr[str]] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceResponses.top_p: Optional[float] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceResponses.type: Required[Literal['responses']] - added:
field DataSourceCreateEvalResponsesRunDataSourceSourceResponses.users: Optional[SequenceNotStr[str]] - added:
field RunCreateParams.data_source: Required[DataSource] - added:
field RunCreateParams.metadata: Optional[Metadata] - added:
field RunCreateParams.name: str - added:
variable DataSource: TypeAlias - added:
variable DataSourceCreateEvalResponsesRunDataSourceInputMessages: TypeAlias - added:
variable DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplate: TypeAlias - added:
variable DataSourceCreateEvalResponsesRunDataSourceInputMessagesTemplateTemplateEvalItemContent: TypeAlias - added:
variable DataSourceCreateEvalResponsesRunDataSourceSource: TypeAlias
- added:
class DataSourceResponses(BaseModel) - added:
class DataSourceResponsesInputMessagesItemReference(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplate(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateChatMessage(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateEvalItem(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentOutputText(BaseModel) - added:
class DataSourceResponsesSamplingParams(BaseModel) - added:
class DataSourceResponsesSamplingParamsText(BaseModel) - added:
class DataSourceResponsesSourceFileContent(BaseModel) - added:
class DataSourceResponsesSourceFileContentContent(BaseModel) - added:
class DataSourceResponsesSourceFileID(BaseModel) - added:
class DataSourceResponsesSourceResponses(BaseModel) - added:
class PerModelUsage(BaseModel) - added:
class PerTestingCriteriaResult(BaseModel) - added:
class ResultCounts(BaseModel) - added:
class RunCreateResponse(BaseModel) - added:
field DataSourceResponses.input_messages: Optional[DataSourceResponsesInputMessages] - added:
field DataSourceResponses.model: Optional[str] - added:
field DataSourceResponses.sampling_params: Optional[DataSourceResponsesSamplingParams] - added:
field DataSourceResponses.source: DataSourceResponsesSource - added:
field DataSourceResponses.type: Literal['responses'] - added:
field DataSourceResponsesInputMessagesItemReference.item_reference: str - added:
field DataSourceResponsesInputMessagesItemReference.type: Literal['item_reference'] - added:
field DataSourceResponsesInputMessagesTemplate.template: List[DataSourceResponsesInputMessagesTemplateTemplate] - added:
field DataSourceResponsesInputMessagesTemplate.type: Literal['template'] - added:
field DataSourceResponsesInputMessagesTemplateTemplateChatMessage.content: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateChatMessage.role: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItem.content: DataSourceResponsesInputMessagesTemplateTemplateEvalItemContent - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItem.role: Literal['user', 'assistant', 'system', 'developer'] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItem.type: Optional[Literal['message']] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage.detail: Optional[str] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage.image_url: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage.type: Literal['input_image'] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentOutputText.text: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentOutputText.type: Literal['output_text'] - added:
field DataSourceResponsesSamplingParams.max_completion_tokens: Optional[int] - added:
field DataSourceResponsesSamplingParams.reasoning_effort: Optional[ReasoningEffort] - added:
field DataSourceResponsesSamplingParams.seed: Optional[int] - added:
field DataSourceResponsesSamplingParams.temperature: Optional[float] - added:
field DataSourceResponsesSamplingParams.text: Optional[DataSourceResponsesSamplingParamsText] - added:
field DataSourceResponsesSamplingParams.tools: Optional[List[Tool]] - added:
field DataSourceResponsesSamplingParams.top_p: Optional[float] - added:
field DataSourceResponsesSamplingParamsText.format: Optional[ResponseFormatTextConfig] - added:
field DataSourceResponsesSourceFileContent.content: List[DataSourceResponsesSourceFileContentContent] - added:
field DataSourceResponsesSourceFileContent.type: Literal['file_content'] - added:
field DataSourceResponsesSourceFileContentContent.item: Dict[str, object] - added:
field DataSourceResponsesSourceFileContentContent.sample: Optional[Dict[str, object]] - added:
field DataSourceResponsesSourceFileID.id: str - added:
field DataSourceResponsesSourceFileID.type: Literal['file_id'] - added:
field DataSourceResponsesSourceResponses.created_after: Optional[int] - added:
field DataSourceResponsesSourceResponses.created_before: Optional[int] - added:
field DataSourceResponsesSourceResponses.instructions_search: Optional[str] - added:
field DataSourceResponsesSourceResponses.metadata: Optional[object] - added:
field DataSourceResponsesSourceResponses.model: Optional[str] - added:
field DataSourceResponsesSourceResponses.reasoning_effort: Optional[ReasoningEffort] - added:
field DataSourceResponsesSourceResponses.temperature: Optional[float] - added:
field DataSourceResponsesSourceResponses.tools: Optional[List[str]] - added:
field DataSourceResponsesSourceResponses.top_p: Optional[float] - added:
field DataSourceResponsesSourceResponses.type: Literal['responses'] - added:
field DataSourceResponsesSourceResponses.users: Optional[List[str]] - added:
field PerModelUsage.cached_tokens: int - added:
field PerModelUsage.completion_tokens: int - added:
field PerModelUsage.invocation_count: int - added:
field PerModelUsage.prompt_tokens: int - added:
field PerModelUsage.run_model_name: str - added:
field PerModelUsage.total_tokens: int - added:
field PerTestingCriteriaResult.failed: int - added:
field PerTestingCriteriaResult.passed: int - added:
field PerTestingCriteriaResult.testing_criteria: str - added:
field ResultCounts.errored: int - added:
field ResultCounts.failed: int - added:
field ResultCounts.passed: int - added:
field ResultCounts.total: int - added:
field RunCreateResponse.created_at: int - added:
field RunCreateResponse.data_source: DataSource - added:
field RunCreateResponse.error: EvalAPIError - added:
field RunCreateResponse.eval_id: str - added:
field RunCreateResponse.id: str - added:
field RunCreateResponse.metadata: Optional[Metadata] - added:
field RunCreateResponse.model: str - added:
field RunCreateResponse.name: str - added:
field RunCreateResponse.object: Literal['eval.run'] - added:
field RunCreateResponse.per_model_usage: List[PerModelUsage] - added:
field RunCreateResponse.per_testing_criteria_results: List[PerTestingCriteriaResult] - added:
field RunCreateResponse.report_url: str - added:
field RunCreateResponse.result_counts: ResultCounts - added:
field RunCreateResponse.status: str - added:
variable DataSource: TypeAlias - added:
variable DataSourceResponsesInputMessages: TypeAlias - added:
variable DataSourceResponsesInputMessagesTemplateTemplate: TypeAlias - added:
variable DataSourceResponsesInputMessagesTemplateTemplateEvalItemContent: TypeAlias - added:
variable DataSourceResponsesSource: TypeAlias
- added:
class RunDeleteResponse(BaseModel) - added:
field RunDeleteResponse.deleted: Optional[bool] - added:
field RunDeleteResponse.object: Optional[str] - added:
field RunDeleteResponse.run_id: Optional[str]
- added:
class RunListParams(TypedDict) - added:
field RunListParams.after: str - added:
field RunListParams.limit: int - added:
field RunListParams.order: Literal['asc', 'desc'] - added:
field RunListParams.status: Literal['queued', 'in_progress', 'completed', 'canceled', 'failed']
- added:
class DataSourceResponses(BaseModel) - added:
class DataSourceResponsesInputMessagesItemReference(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplate(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateChatMessage(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateEvalItem(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentOutputText(BaseModel) - added:
class DataSourceResponsesSamplingParams(BaseModel) - added:
class DataSourceResponsesSamplingParamsText(BaseModel) - added:
class DataSourceResponsesSourceFileContent(BaseModel) - added:
class DataSourceResponsesSourceFileContentContent(BaseModel) - added:
class DataSourceResponsesSourceFileID(BaseModel) - added:
class DataSourceResponsesSourceResponses(BaseModel) - added:
class PerModelUsage(BaseModel) - added:
class PerTestingCriteriaResult(BaseModel) - added:
class ResultCounts(BaseModel) - added:
class RunListResponse(BaseModel) - added:
field DataSourceResponses.input_messages: Optional[DataSourceResponsesInputMessages] - added:
field DataSourceResponses.model: Optional[str] - added:
field DataSourceResponses.sampling_params: Optional[DataSourceResponsesSamplingParams] - added:
field DataSourceResponses.source: DataSourceResponsesSource - added:
field DataSourceResponses.type: Literal['responses'] - added:
field DataSourceResponsesInputMessagesItemReference.item_reference: str - added:
field DataSourceResponsesInputMessagesItemReference.type: Literal['item_reference'] - added:
field DataSourceResponsesInputMessagesTemplate.template: List[DataSourceResponsesInputMessagesTemplateTemplate] - added:
field DataSourceResponsesInputMessagesTemplate.type: Literal['template'] - added:
field DataSourceResponsesInputMessagesTemplateTemplateChatMessage.content: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateChatMessage.role: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItem.content: DataSourceResponsesInputMessagesTemplateTemplateEvalItemContent - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItem.role: Literal['user', 'assistant', 'system', 'developer'] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItem.type: Optional[Literal['message']] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage.detail: Optional[str] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage.image_url: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage.type: Literal['input_image'] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentOutputText.text: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentOutputText.type: Literal['output_text'] - added:
field DataSourceResponsesSamplingParams.max_completion_tokens: Optional[int] - added:
field DataSourceResponsesSamplingParams.reasoning_effort: Optional[ReasoningEffort] - added:
field DataSourceResponsesSamplingParams.seed: Optional[int] - added:
field DataSourceResponsesSamplingParams.temperature: Optional[float] - added:
field DataSourceResponsesSamplingParams.text: Optional[DataSourceResponsesSamplingParamsText] - added:
field DataSourceResponsesSamplingParams.tools: Optional[List[Tool]] - added:
field DataSourceResponsesSamplingParams.top_p: Optional[float] - added:
field DataSourceResponsesSamplingParamsText.format: Optional[ResponseFormatTextConfig] - added:
field DataSourceResponsesSourceFileContent.content: List[DataSourceResponsesSourceFileContentContent] - added:
field DataSourceResponsesSourceFileContent.type: Literal['file_content'] - added:
field DataSourceResponsesSourceFileContentContent.item: Dict[str, object] - added:
field DataSourceResponsesSourceFileContentContent.sample: Optional[Dict[str, object]] - added:
field DataSourceResponsesSourceFileID.id: str - added:
field DataSourceResponsesSourceFileID.type: Literal['file_id'] - added:
field DataSourceResponsesSourceResponses.created_after: Optional[int] - added:
field DataSourceResponsesSourceResponses.created_before: Optional[int] - added:
field DataSourceResponsesSourceResponses.instructions_search: Optional[str] - added:
field DataSourceResponsesSourceResponses.metadata: Optional[object] - added:
field DataSourceResponsesSourceResponses.model: Optional[str] - added:
field DataSourceResponsesSourceResponses.reasoning_effort: Optional[ReasoningEffort] - added:
field DataSourceResponsesSourceResponses.temperature: Optional[float] - added:
field DataSourceResponsesSourceResponses.tools: Optional[List[str]] - added:
field DataSourceResponsesSourceResponses.top_p: Optional[float] - added:
field DataSourceResponsesSourceResponses.type: Literal['responses'] - added:
field DataSourceResponsesSourceResponses.users: Optional[List[str]] - added:
field PerModelUsage.cached_tokens: int - added:
field PerModelUsage.completion_tokens: int - added:
field PerModelUsage.invocation_count: int - added:
field PerModelUsage.prompt_tokens: int - added:
field PerModelUsage.run_model_name: str - added:
field PerModelUsage.total_tokens: int - added:
field PerTestingCriteriaResult.failed: int - added:
field PerTestingCriteriaResult.passed: int - added:
field PerTestingCriteriaResult.testing_criteria: str - added:
field ResultCounts.errored: int - added:
field ResultCounts.failed: int - added:
field ResultCounts.passed: int - added:
field ResultCounts.total: int - added:
field RunListResponse.created_at: int - added:
field RunListResponse.data_source: DataSource - added:
field RunListResponse.error: EvalAPIError - added:
field RunListResponse.eval_id: str - added:
field RunListResponse.id: str - added:
field RunListResponse.metadata: Optional[Metadata] - added:
field RunListResponse.model: str - added:
field RunListResponse.name: str - added:
field RunListResponse.object: Literal['eval.run'] - added:
field RunListResponse.per_model_usage: List[PerModelUsage] - added:
field RunListResponse.per_testing_criteria_results: List[PerTestingCriteriaResult] - added:
field RunListResponse.report_url: str - added:
field RunListResponse.result_counts: ResultCounts - added:
field RunListResponse.status: str - added:
variable DataSource: TypeAlias - added:
variable DataSourceResponsesInputMessages: TypeAlias - added:
variable DataSourceResponsesInputMessagesTemplateTemplate: TypeAlias - added:
variable DataSourceResponsesInputMessagesTemplateTemplateEvalItemContent: TypeAlias - added:
variable DataSourceResponsesSource: TypeAlias
- added:
class DataSourceResponses(BaseModel) - added:
class DataSourceResponsesInputMessagesItemReference(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplate(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateChatMessage(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateEvalItem(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage(BaseModel) - added:
class DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentOutputText(BaseModel) - added:
class DataSourceResponsesSamplingParams(BaseModel) - added:
class DataSourceResponsesSamplingParamsText(BaseModel) - added:
class DataSourceResponsesSourceFileContent(BaseModel) - added:
class DataSourceResponsesSourceFileContentContent(BaseModel) - added:
class DataSourceResponsesSourceFileID(BaseModel) - added:
class DataSourceResponsesSourceResponses(BaseModel) - added:
class PerModelUsage(BaseModel) - added:
class PerTestingCriteriaResult(BaseModel) - added:
class ResultCounts(BaseModel) - added:
class RunRetrieveResponse(BaseModel) - added:
field DataSourceResponses.input_messages: Optional[DataSourceResponsesInputMessages] - added:
field DataSourceResponses.model: Optional[str] - added:
field DataSourceResponses.sampling_params: Optional[DataSourceResponsesSamplingParams] - added:
field DataSourceResponses.source: DataSourceResponsesSource - added:
field DataSourceResponses.type: Literal['responses'] - added:
field DataSourceResponsesInputMessagesItemReference.item_reference: str - added:
field DataSourceResponsesInputMessagesItemReference.type: Literal['item_reference'] - added:
field DataSourceResponsesInputMessagesTemplate.template: List[DataSourceResponsesInputMessagesTemplateTemplate] - added:
field DataSourceResponsesInputMessagesTemplate.type: Literal['template'] - added:
field DataSourceResponsesInputMessagesTemplateTemplateChatMessage.content: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateChatMessage.role: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItem.content: DataSourceResponsesInputMessagesTemplateTemplateEvalItemContent - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItem.role: Literal['user', 'assistant', 'system', 'developer'] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItem.type: Optional[Literal['message']] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage.detail: Optional[str] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage.image_url: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentInputImage.type: Literal['input_image'] - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentOutputText.text: str - added:
field DataSourceResponsesInputMessagesTemplateTemplateEvalItemContentOutputText.type: Literal['output_text'] - added:
field DataSourceResponsesSamplingParams.max_completion_tokens: Optional[int] - added:
field DataSourceResponsesSamplingParams.reasoning_effort: Optional[ReasoningEffort] - added:
field DataSourceResponsesSamplingParams.seed: Optional[int] - added:
field DataSourceResponsesSamplingParams.temperature: Optional[float] - added:
field DataSourceResponsesSamplingParams.text: Optional[DataSourceResponsesSamplingParamsText] - added:
field DataSourceResponsesSamplingParams.tools: Optional[List[Tool]] - added:
field DataSourceResponsesSamplingParams.top_p: Optional[float] - added:
field DataSourceResponsesSamplingParamsText.format: Optional[ResponseFormatTextConfig] - added:
field DataSourceResponsesSourceFileContent.content: List[DataSourceResponsesSourceFileContentContent] - added:
field DataSourceResponsesSourceFileContent.type: Literal['file_content'] - added:
field DataSourceResponsesSourceFileContentContent.item: Dict[str, object] - added:
field DataSourceResponsesSourceFileContentContent.sample: Optional[Dict[str, object]] - added:
field DataSourceResponsesSourceFileID.id: str - added:
field DataSourceResponsesSourceFileID.type: Literal['file_id'] - added:
field DataSourceResponsesSourceResponses.created_after: Optional[int] - added:
field DataSourceResponsesSourceResponses.created_before: Optional[int] - added:
field DataSourceResponsesSourceResponses.instructions_search: Optional[str] - added:
field DataSourceResponsesSourceResponses.metadata: Optional[object] - added:
field DataSourceResponsesSourceResponses.model: Optional[str] - added:
field DataSourceResponsesSourceResponses.reasoning_effort: Optional[ReasoningEffort] - added:
field DataSourceResponsesSourceResponses.temperature: Optional[float] - added:
field DataSourceResponsesSourceResponses.tools: Optional[List[str]] - added:
field DataSourceResponsesSourceResponses.top_p: Optional[float] - added:
field DataSourceResponsesSourceResponses.type: Literal['responses'] - added:
field DataSourceResponsesSourceResponses.users: Optional[List[str]] - added:
field PerModelUsage.cached_tokens: int - added:
field PerModelUsage.completion_tokens: int - added:
field PerModelUsage.invocation_count: int - added:
field PerModelUsage.prompt_tokens: int - added:
field PerModelUsage.run_model_name: str - added:
field PerModelUsage.total_tokens: int - added:
field PerTestingCriteriaResult.failed: int - added:
field PerTestingCriteriaResult.passed: int - added:
field PerTestingCriteriaResult.testing_criteria: str - added:
field ResultCounts.errored: int - added:
field ResultCounts.failed: int - added:
field ResultCounts.passed: int - added:
field ResultCounts.total: int - added:
field RunRetrieveResponse.created_at: int - added:
field RunRetrieveResponse.data_source: DataSource - added:
field RunRetrieveResponse.error: EvalAPIError - added:
field RunRetrieveResponse.eval_id: str - added:
field RunRetrieveResponse.id: str - added:
field RunRetrieveResponse.metadata: Optional[Metadata] - added:
field RunRetrieveResponse.model: str - added:
field RunRetrieveResponse.name: str - added:
field RunRetrieveResponse.object: Literal['eval.run'] - added:
field RunRetrieveResponse.per_model_usage: List[PerModelUsage] - added:
field RunRetrieveResponse.per_testing_criteria_results: List[PerTestingCriteriaResult] - added:
field RunRetrieveResponse.report_url: str - added:
field RunRetrieveResponse.result_counts: ResultCounts - added:
field RunRetrieveResponse.status: str - added:
variable DataSource: TypeAlias - added:
variable DataSourceResponsesInputMessages: TypeAlias - added:
variable DataSourceResponsesInputMessagesTemplateTemplate: TypeAlias - added:
variable DataSourceResponsesInputMessagesTemplateTemplateEvalItemContent: TypeAlias - added:
variable DataSourceResponsesSource: TypeAlias
- added:
export OutputItemListParams - added:
export OutputItemListResponse - added:
export OutputItemRetrieveResponse
- added:
class OutputItemListParams(TypedDict) - added:
field OutputItemListParams.after: str - added:
field OutputItemListParams.eval_id: Required[str] - added:
field OutputItemListParams.limit: int - added:
field OutputItemListParams.order: Literal['asc', 'desc'] - added:
field OutputItemListParams.status: Literal['fail', 'pass']
- added:
class OutputItemListResponse(BaseModel) - added:
class Result(BaseModel) - added:
class Sample(BaseModel) - added:
class SampleInput(BaseModel) - added:
class SampleOutput(BaseModel) - added:
class SampleUsage(BaseModel) - added:
field OutputItemListResponse.created_at: int - added:
field OutputItemListResponse.datasource_item: Dict[str, object] - added:
field OutputItemListResponse.datasource_item_id: int - added:
field OutputItemListResponse.eval_id: str - added:
field OutputItemListResponse.id: str - added:
field OutputItemListResponse.object: Literal['eval.run.output_item'] - added:
field OutputItemListResponse.results: List[Result] - added:
field OutputItemListResponse.run_id: str - added:
field OutputItemListResponse.sample: Sample - added:
field OutputItemListResponse.status: str - added:
field Result.name: str - added:
field Result.passed: bool - added:
field Result.sample: Optional[Dict[str, object]] - added:
field Result.score: float - added:
field Result.type: Optional[str] - added:
field Sample.error: EvalAPIError - added:
field Sample.finish_reason: str - added:
field Sample.input: List[SampleInput] - added:
field Sample.max_completion_tokens: int - added:
field Sample.model: str - added:
field Sample.output: List[SampleOutput] - added:
field Sample.seed: int - added:
field Sample.temperature: float - added:
field Sample.top_p: float - added:
field Sample.usage: SampleUsage - added:
field SampleInput.content: str - added:
field SampleInput.role: str - added:
field SampleOutput.content: Optional[str] - added:
field SampleOutput.role: Optional[str] - added:
field SampleUsage.cached_tokens: int - added:
field SampleUsage.completion_tokens: int - added:
field SampleUsage.prompt_tokens: int - added:
field SampleUsage.total_tokens: int
- added:
class OutputItemRetrieveResponse(BaseModel) - added:
class Result(BaseModel) - added:
class Sample(BaseModel) - added:
class SampleInput(BaseModel) - added:
class SampleOutput(BaseModel) - added:
class SampleUsage(BaseModel) - added:
field OutputItemRetrieveResponse.created_at: int - added:
field OutputItemRetrieveResponse.datasource_item: Dict[str, object] - added:
field OutputItemRetrieveResponse.datasource_item_id: int - added:
field OutputItemRetrieveResponse.eval_id: str - added:
field OutputItemRetrieveResponse.id: str - added:
field OutputItemRetrieveResponse.object: Literal['eval.run.output_item'] - added:
field OutputItemRetrieveResponse.results: List[Result] - added:
field OutputItemRetrieveResponse.run_id: str - added:
field OutputItemRetrieveResponse.sample: Sample - added:
field OutputItemRetrieveResponse.status: str - added:
field Result.name: str - added:
field Result.passed: bool - added:
field Result.sample: Optional[Dict[str, object]] - added:
field Result.score: float - added:
field Result.type: Optional[str] - added:
field Sample.error: EvalAPIError - added:
field Sample.finish_reason: str - added:
field Sample.input: List[SampleInput] - added:
field Sample.max_completion_tokens: int - added:
field Sample.model: str - added:
field Sample.output: List[SampleOutput] - added:
field Sample.seed: int - added:
field Sample.temperature: float - added:
field Sample.top_p: float - added:
field Sample.usage: SampleUsage - added:
field SampleInput.content: str - added:
field SampleInput.role: str - added:
field SampleOutput.content: Optional[str] - added:
field SampleOutput.role: Optional[str] - added:
field SampleUsage.cached_tokens: int - added:
field SampleUsage.completion_tokens: int - added:
field SampleUsage.prompt_tokens: int - added:
field SampleUsage.total_tokens: int
- added:
variable FileChunkingStrategy: TypeAlias
- added:
variable FileChunkingStrategyParam: TypeAlias
- added:
variable FileContent: TypeAlias
- added:
class ExpiresAfter(TypedDict) - added:
class FileCreateParams(TypedDict) - added:
field ExpiresAfter.anchor: Required[Literal['created_at']] - added:
field ExpiresAfter.seconds: Required[int] - added:
field FileCreateParams.expires_after: ExpiresAfter - added:
field FileCreateParams.file: Required[FileTypes] - added:
field FileCreateParams.purpose: Required[FilePurpose]
- added:
class FileDeleted(BaseModel) - added:
field FileDeleted.deleted: bool - added:
field FileDeleted.id: str - added:
field FileDeleted.object: Literal['file']
- added:
class FileListParams(TypedDict) - added:
field FileListParams.after: str - added:
field FileListParams.limit: int - added:
field FileListParams.order: Literal['asc', 'desc'] - added:
field FileListParams.purpose: str
- added:
class FileObject(BaseModel) - added:
field FileObject.bytes: int - added:
field FileObject.created_at: int - added:
field FileObject.expires_at: Optional[int] - added:
field FileObject.filename: str - added:
field FileObject.id: str - added:
field FileObject.object: Literal['file'] - added:
field FileObject.purpose: Literal['assistants', 'assistants_output', 'batch', 'batch_output', 'fine-tune', 'fine-tune-results', 'vision', 'user_data'] - added:
field FileObject.status: Literal['uploaded', 'processed', 'error'] - added:
field FileObject.status_details: Optional[str]
- added:
variable FilePurpose: TypeAlias
- added:
export DpoHyperparameters - added:
export DpoHyperparametersParam - added:
export DpoMethod - added:
export DpoMethodParam - added:
export FineTuningJob - added:
export FineTuningJobEvent - added:
export FineTuningJobIntegration - added:
export FineTuningJobWandbIntegration - added:
export FineTuningJobWandbIntegrationObject - added:
export JobCreateParams - added:
export JobListEventsParams - added:
export JobListParams - added:
export ReinforcementHyperparameters - added:
export ReinforcementHyperparametersParam - added:
export ReinforcementMethod - added:
export ReinforcementMethodParam - added:
export SupervisedHyperparameters - added:
export SupervisedHyperparametersParam - added:
export SupervisedMethod - added:
export SupervisedMethodParam
- added:
export GraderRunParams - added:
export GraderRunResponse - added:
export GraderValidateParams - added:
export GraderValidateResponse
- added:
class GraderRunParams(TypedDict) - added:
field GraderRunParams.grader: Required[Grader] - added:
field GraderRunParams.item: object - added:
field GraderRunParams.model_sample: Required[str] - added:
variable Grader: TypeAlias
- added:
class GraderRunResponse(BaseModel) - added:
class Metadata(BaseModel) - added:
class MetadataErrors(BaseModel) - added:
field GraderRunResponse.api_model_grader_token_usage_per_model: Dict[str, object] - added:
field GraderRunResponse.metadata: Metadata - added:
field GraderRunResponse.reward: float - added:
field GraderRunResponse.sub_rewards: Dict[str, object] - added:
field Metadata.errors: MetadataErrors - added:
field Metadata.execution_time: float - added:
field Metadata.name: str - added:
field Metadata.sampled_model_name: Optional[str] - added:
field Metadata.scores: Dict[str, object] - added:
field Metadata.token_usage: Optional[int] - added:
field Metadata.type: str - added:
field MetadataErrors.api_model_grader_parse_error: bool - added:
field MetadataErrors.api_model_grader_refusal_error: bool - added:
field MetadataErrors.api_model_grader_server_error: bool - added:
field MetadataErrors.api_model_grader_server_error_details: Optional[str] - added:
field MetadataErrors.formula_parse_error: bool - added:
field MetadataErrors.invalid_variable_error: bool - added:
field MetadataErrors.other_error: bool - added:
field MetadataErrors.python_grader_runtime_error: bool - added:
field MetadataErrors.python_grader_runtime_error_details: Optional[str] - added:
field MetadataErrors.python_grader_server_error: bool - added:
field MetadataErrors.python_grader_server_error_type: Optional[str] - added:
field MetadataErrors.sample_parse_error: bool - added:
field MetadataErrors.truncated_observation_error: bool - added:
field MetadataErrors.unresponsive_reward_error: bool
- added:
class GraderValidateParams(TypedDict) - added:
field GraderValidateParams.grader: Required[Grader] - added:
variable Grader: TypeAlias
- added:
class GraderValidateResponse(BaseModel) - added:
field GraderValidateResponse.grader: Optional[Grader] - added:
variable Grader: TypeAlias
- added:
export PermissionCreateParams - added:
export PermissionCreateResponse - added:
export PermissionDeleteResponse - added:
export PermissionRetrieveParams - added:
export PermissionRetrieveResponse
- added:
class PermissionCreateParams(TypedDict) - added:
field PermissionCreateParams.project_ids: Required[SequenceNotStr[str]]
- added:
class PermissionCreateResponse(BaseModel) - added:
field PermissionCreateResponse.created_at: int - added:
field PermissionCreateResponse.id: str - added:
field PermissionCreateResponse.object: Literal['checkpoint.permission'] - added:
field PermissionCreateResponse.project_id: str
- added:
class PermissionDeleteResponse(BaseModel) - added:
field PermissionDeleteResponse.deleted: bool - added:
field PermissionDeleteResponse.id: str - added:
field PermissionDeleteResponse.object: Literal['checkpoint.permission']
- added:
class PermissionRetrieveParams(TypedDict) - added:
field PermissionRetrieveParams.after: str - added:
field PermissionRetrieveParams.limit: int - added:
field PermissionRetrieveParams.order: Literal['ascending', 'descending'] - added:
field PermissionRetrieveParams.project_id: str
- added:
class Data(BaseModel) - added:
class PermissionRetrieveResponse(BaseModel) - added:
field Data.created_at: int - added:
field Data.id: str - added:
field Data.object: Literal['checkpoint.permission'] - added:
field Data.project_id: str - added:
field PermissionRetrieveResponse.data: List[Data] - added:
field PermissionRetrieveResponse.first_id: Optional[str] - added:
field PermissionRetrieveResponse.has_more: bool - added:
field PermissionRetrieveResponse.last_id: Optional[str] - added:
field PermissionRetrieveResponse.object: Literal['list']
- added:
class DpoHyperparameters(BaseModel) - added:
field DpoHyperparameters.batch_size: Union[Literal['auto'], int, None] - added:
field DpoHyperparameters.beta: Union[Literal['auto'], float, None] - added:
field DpoHyperparameters.learning_rate_multiplier: Union[Literal['auto'], float, None] - added:
field DpoHyperparameters.n_epochs: Union[Literal['auto'], int, None]
- added:
class DpoHyperparametersParam(TypedDict) - added:
field DpoHyperparametersParam.batch_size: Union[Literal['auto'], int] - added:
field DpoHyperparametersParam.beta: Union[Literal['auto'], float] - added:
field DpoHyperparametersParam.learning_rate_multiplier: Union[Literal['auto'], float] - added:
field DpoHyperparametersParam.n_epochs: Union[Literal['auto'], int]
- added:
class DpoMethod(BaseModel) - added:
field DpoMethod.hyperparameters: Optional[DpoHyperparameters]
- added:
class DpoMethodParam(TypedDict) - added:
field DpoMethodParam.hyperparameters: DpoHyperparametersParam
- added:
class Error(BaseModel) - added:
class FineTuningJob(BaseModel) - added:
class Hyperparameters(BaseModel) - added:
class Method(BaseModel) - added:
field Error.code: str - added:
field Error.message: str - added:
field Error.param: Optional[str] - added:
field FineTuningJob.created_at: int - added:
field FineTuningJob.error: Optional[Error] - added:
field FineTuningJob.estimated_finish: Optional[int] - added:
field FineTuningJob.fine_tuned_model: Optional[str] - added:
field FineTuningJob.finished_at: Optional[int] - added:
field FineTuningJob.hyperparameters: Hyperparameters - added:
field FineTuningJob.id: str - added:
field FineTuningJob.integrations: Optional[List[FineTuningJobWandbIntegrationObject]] - added:
field FineTuningJob.metadata: Optional[Metadata] - added:
field FineTuningJob.method: Optional[Method] - added:
field FineTuningJob.model: str - added:
field FineTuningJob.object: Literal['fine_tuning.job'] - added:
field FineTuningJob.organization_id: str - added:
field FineTuningJob.result_files: List[str] - added:
field FineTuningJob.seed: int - added:
field FineTuningJob.status: Literal['validating_files', 'queued', 'running', 'succeeded', 'failed', 'cancelled'] - added:
field FineTuningJob.trained_tokens: Optional[int] - added:
field FineTuningJob.training_file: str - added:
field FineTuningJob.validation_file: Optional[str] - added:
field Hyperparameters.batch_size: Union[Literal['auto'], int, None] - added:
field Hyperparameters.learning_rate_multiplier: Union[Literal['auto'], float, None] - added:
field Hyperparameters.n_epochs: Union[Literal['auto'], int, None] - added:
field Method.dpo: Optional[DpoMethod] - added:
field Method.reinforcement: Optional[ReinforcementMethod] - added:
field Method.supervised: Optional[SupervisedMethod] - added:
field Method.type: Literal['supervised', 'dpo', 'reinforcement']
- added:
class FineTuningJobEvent(BaseModel) - added:
field FineTuningJobEvent.created_at: int - added:
field FineTuningJobEvent.data: Optional[builtins.object] - added:
field FineTuningJobEvent.id: str - added:
field FineTuningJobEvent.level: Literal['info', 'warn', 'error'] - added:
field FineTuningJobEvent.message: str - added:
field FineTuningJobEvent.object: Literal['fine_tuning.job.event'] - added:
field FineTuningJobEvent.type: Optional[Literal['message', 'metrics']]
- added:
variable FineTuningJobIntegration
- added:
class FineTuningJobWandbIntegration(BaseModel) - added:
field FineTuningJobWandbIntegration.entity: Optional[str] - added:
field FineTuningJobWandbIntegration.name: Optional[str] - added:
field FineTuningJobWandbIntegration.project: str - added:
field FineTuningJobWandbIntegration.tags: Optional[List[str]]
- added:
class FineTuningJobWandbIntegrationObject(BaseModel) - added:
field FineTuningJobWandbIntegrationObject.type: Literal['wandb'] - added:
field FineTuningJobWandbIntegrationObject.wandb: FineTuningJobWandbIntegration
- added:
class Hyperparameters(TypedDict) - added:
class Integration(TypedDict) - added:
class IntegrationWandb(TypedDict) - added:
class JobCreateParams(TypedDict) - added:
class Method(TypedDict) - added:
field Hyperparameters.batch_size: Union[Literal['auto'], int] - added:
field Hyperparameters.learning_rate_multiplier: Union[Literal['auto'], float] - added:
field Hyperparameters.n_epochs: Union[Literal['auto'], int] - added:
field Integration.type: Required[Literal['wandb']] - added:
field Integration.wandb: Required[IntegrationWandb] - added:
field IntegrationWandb.entity: Optional[str] - added:
field IntegrationWandb.name: Optional[str] - added:
field IntegrationWandb.project: Required[str] - added:
field IntegrationWandb.tags: SequenceNotStr[str] - added:
field JobCreateParams.hyperparameters: Hyperparameters - added:
field JobCreateParams.integrations: Optional[Iterable[Integration]] - added:
field JobCreateParams.metadata: Optional[Metadata] - added:
field JobCreateParams.method: Method - added:
field JobCreateParams.model: Required[Union[str, Literal['babbage-002', 'davinci-002', 'gpt-3.5-turbo', 'gpt-4o-mini']]] - added:
field JobCreateParams.seed: Optional[int] - added:
field JobCreateParams.suffix: Optional[str] - added:
field JobCreateParams.training_file: Required[str] - added:
field JobCreateParams.validation_file: Optional[str] - added:
field Method.dpo: DpoMethodParam - added:
field Method.reinforcement: ReinforcementMethodParam - added:
field Method.supervised: SupervisedMethodParam - added:
field Method.type: Required[Literal['supervised', 'dpo', 'reinforcement']]
- added:
class JobListEventsParams(TypedDict) - added:
field JobListEventsParams.after: str - added:
field JobListEventsParams.limit: int
- added:
class JobListParams(TypedDict) - added:
field JobListParams.after: str - added:
field JobListParams.limit: int - added:
field JobListParams.metadata: Optional[Dict[str, str]]
- added:
export CheckpointListParams - added:
export FineTuningJobCheckpoint
- added:
class CheckpointListParams(TypedDict) - added:
field CheckpointListParams.after: str - added:
field CheckpointListParams.limit: int
- added:
class FineTuningJobCheckpoint(BaseModel) - added:
class Metrics(BaseModel) - added:
field FineTuningJobCheckpoint.created_at: int - added:
field FineTuningJobCheckpoint.fine_tuned_model_checkpoint: str - added:
field FineTuningJobCheckpoint.fine_tuning_job_id: str - added:
field FineTuningJobCheckpoint.id: str - added:
field FineTuningJobCheckpoint.metrics: Metrics - added:
field FineTuningJobCheckpoint.object: Literal['fine_tuning.job.checkpoint'] - added:
field FineTuningJobCheckpoint.step_number: int - added:
field Metrics.full_valid_loss: Optional[float] - added:
field Metrics.full_valid_mean_token_accuracy: Optional[float] - added:
field Metrics.step: Optional[float] - added:
field Metrics.train_loss: Optional[float] - added:
field Metrics.train_mean_token_accuracy: Optional[float] - added:
field Metrics.valid_loss: Optional[float] - added:
field Metrics.valid_mean_token_accuracy: Optional[float]
- added:
class ReinforcementHyperparameters(BaseModel) - added:
field ReinforcementHyperparameters.batch_size: Union[Literal['auto'], int, None] - added:
field ReinforcementHyperparameters.compute_multiplier: Union[Literal['auto'], float, None] - added:
field ReinforcementHyperparameters.eval_interval: Union[Literal['auto'], int, None] - added:
field ReinforcementHyperparameters.eval_samples: Union[Literal['auto'], int, None] - added:
field ReinforcementHyperparameters.learning_rate_multiplier: Union[Literal['auto'], float, None] - added:
field ReinforcementHyperparameters.n_epochs: Union[Literal['auto'], int, None] - added:
field ReinforcementHyperparameters.reasoning_effort: Optional[Literal['default', 'low', 'medium', 'high']]
- added:
class ReinforcementHyperparametersParam(TypedDict) - added:
field ReinforcementHyperparametersParam.batch_size: Union[Literal['auto'], int] - added:
field ReinforcementHyperparametersParam.compute_multiplier: Union[Literal['auto'], float] - added:
field ReinforcementHyperparametersParam.eval_interval: Union[Literal['auto'], int] - added:
field ReinforcementHyperparametersParam.eval_samples: Union[Literal['auto'], int] - added:
field ReinforcementHyperparametersParam.learning_rate_multiplier: Union[Literal['auto'], float] - added:
field ReinforcementHyperparametersParam.n_epochs: Union[Literal['auto'], int] - added:
field ReinforcementHyperparametersParam.reasoning_effort: Literal['default', 'low', 'medium', 'high']
- added:
class ReinforcementMethod(BaseModel) - added:
field ReinforcementMethod.grader: Grader - added:
field ReinforcementMethod.hyperparameters: Optional[ReinforcementHyperparameters] - added:
variable Grader: TypeAlias
- added:
class ReinforcementMethodParam(TypedDict) - added:
field ReinforcementMethodParam.grader: Required[Grader] - added:
field ReinforcementMethodParam.hyperparameters: ReinforcementHyperparametersParam - added:
variable Grader: TypeAlias
- added:
class SupervisedHyperparameters(BaseModel) - added:
field SupervisedHyperparameters.batch_size: Union[Literal['auto'], int, None] - added:
field SupervisedHyperparameters.learning_rate_multiplier: Union[Literal['auto'], float, None] - added:
field SupervisedHyperparameters.n_epochs: Union[Literal['auto'], int, None]
- added:
class SupervisedHyperparametersParam(TypedDict) - added:
field SupervisedHyperparametersParam.batch_size: Union[Literal['auto'], int] - added:
field SupervisedHyperparametersParam.learning_rate_multiplier: Union[Literal['auto'], float] - added:
field SupervisedHyperparametersParam.n_epochs: Union[Literal['auto'], int]
- added:
class SupervisedMethod(BaseModel) - added:
field SupervisedMethod.hyperparameters: Optional[SupervisedHyperparameters]
- added:
class SupervisedMethodParam(TypedDict) - added:
field SupervisedMethodParam.hyperparameters: SupervisedHyperparametersParam
- added:
export LabelModelGrader - added:
export LabelModelGraderParam - added:
export MultiGrader - added:
export MultiGraderParam - added:
export PythonGrader - added:
export PythonGraderParam - added:
export ScoreModelGrader - added:
export ScoreModelGraderParam - added:
export StringCheckGrader - added:
export StringCheckGraderParam - added:
export TextSimilarityGrader - added:
export TextSimilarityGraderParam
- added:
class Input(BaseModel) - added:
class InputContentInputImage(BaseModel) - added:
class InputContentOutputText(BaseModel) - added:
class LabelModelGrader(BaseModel) - added:
field Input.content: InputContent - added:
field Input.role: Literal['user', 'assistant', 'system', 'developer'] - added:
field Input.type: Optional[Literal['message']] - added:
field InputContentInputImage.detail: Optional[str] - added:
field InputContentInputImage.image_url: str - added:
field InputContentInputImage.type: Literal['input_image'] - added:
field InputContentOutputText.text: str - added:
field InputContentOutputText.type: Literal['output_text'] - added:
field LabelModelGrader.input: List[Input] - added:
field LabelModelGrader.labels: List[str] - added:
field LabelModelGrader.model: str - added:
field LabelModelGrader.name: str - added:
field LabelModelGrader.passing_labels: List[str] - added:
field LabelModelGrader.type: Literal['label_model'] - added:
variable InputContent: TypeAlias
- added:
class Input(TypedDict) - added:
class InputContentInputImage(TypedDict) - added:
class InputContentOutputText(TypedDict) - added:
class LabelModelGraderParam(TypedDict) - added:
field Input.content: Required[InputContent] - added:
field Input.role: Required[Literal['user', 'assistant', 'system', 'developer']] - added:
field Input.type: Literal['message'] - added:
field InputContentInputImage.detail: str - added:
field InputContentInputImage.image_url: Required[str] - added:
field InputContentInputImage.type: Required[Literal['input_image']] - added:
field InputContentOutputText.text: Required[str] - added:
field InputContentOutputText.type: Required[Literal['output_text']] - added:
field LabelModelGraderParam.input: Required[Iterable[Input]] - added:
field LabelModelGraderParam.labels: Required[SequenceNotStr[str]] - added:
field LabelModelGraderParam.model: Required[str] - added:
field LabelModelGraderParam.name: Required[str] - added:
field LabelModelGraderParam.passing_labels: Required[SequenceNotStr[str]] - added:
field LabelModelGraderParam.type: Required[Literal['label_model']] - added:
variable InputContent: TypeAlias
- added:
class MultiGrader(BaseModel) - added:
field MultiGrader.calculate_output: str - added:
field MultiGrader.graders: Graders - added:
field MultiGrader.name: str - added:
field MultiGrader.type: Literal['multi'] - added:
variable Graders: TypeAlias
- added:
class MultiGraderParam(TypedDict) - added:
field MultiGraderParam.calculate_output: Required[str] - added:
field MultiGraderParam.graders: Required[Graders] - added:
field MultiGraderParam.name: Required[str] - added:
field MultiGraderParam.type: Required[Literal['multi']] - added:
variable Graders: TypeAlias
- added:
class PythonGrader(BaseModel) - added:
field PythonGrader.image_tag: Optional[str] - added:
field PythonGrader.name: str - added:
field PythonGrader.source: str - added:
field PythonGrader.type: Literal['python']
- added:
class PythonGraderParam(TypedDict) - added:
field PythonGraderParam.image_tag: str - added:
field PythonGraderParam.name: Required[str] - added:
field PythonGraderParam.source: Required[str] - added:
field PythonGraderParam.type: Required[Literal['python']]
- added:
class Input(BaseModel) - added:
class InputContentInputImage(BaseModel) - added:
class InputContentOutputText(BaseModel) - added:
class SamplingParams(BaseModel) - added:
class ScoreModelGrader(BaseModel) - added:
field Input.content: InputContent - added:
field Input.role: Literal['user', 'assistant', 'system', 'developer'] - added:
field Input.type: Optional[Literal['message']] - added:
field InputContentInputImage.detail: Optional[str] - added:
field InputContentInputImage.image_url: str - added:
field InputContentInputImage.type: Literal['input_image'] - added:
field InputContentOutputText.text: str - added:
field InputContentOutputText.type: Literal['output_text'] - added:
field SamplingParams.max_completions_tokens: Optional[int] - added:
field SamplingParams.reasoning_effort: Optional[ReasoningEffort] - added:
field SamplingParams.seed: Optional[int] - added:
field SamplingParams.temperature: Optional[float] - added:
field SamplingParams.top_p: Optional[float] - added:
field ScoreModelGrader.input: List[Input] - added:
field ScoreModelGrader.model: str - added:
field ScoreModelGrader.name: str - added:
field ScoreModelGrader.range: Optional[List[float]] - added:
field ScoreModelGrader.sampling_params: Optional[SamplingParams] - added:
field ScoreModelGrader.type: Literal['score_model'] - added:
variable InputContent: TypeAlias
- added:
class Input(TypedDict) - added:
class InputContentInputImage(TypedDict) - added:
class InputContentOutputText(TypedDict) - added:
class SamplingParams(TypedDict) - added:
class ScoreModelGraderParam(TypedDict) - added:
field Input.content: Required[InputContent] - added:
field Input.role: Required[Literal['user', 'assistant', 'system', 'developer']] - added:
field Input.type: Literal['message'] - added:
field InputContentInputImage.detail: str - added:
field InputContentInputImage.image_url: Required[str] - added:
field InputContentInputImage.type: Required[Literal['input_image']] - added:
field InputContentOutputText.text: Required[str] - added:
field InputContentOutputText.type: Required[Literal['output_text']] - added:
field SamplingParams.max_completions_tokens: Optional[int] - added:
field SamplingParams.reasoning_effort: Optional[ReasoningEffort] - added:
field SamplingParams.seed: Optional[int] - added:
field SamplingParams.temperature: Optional[float] - added:
field SamplingParams.top_p: Optional[float] - added:
field ScoreModelGraderParam.input: Required[Iterable[Input]] - added:
field ScoreModelGraderParam.model: Required[str] - added:
field ScoreModelGraderParam.name: Required[str] - added:
field ScoreModelGraderParam.range: Iterable[float] - added:
field ScoreModelGraderParam.sampling_params: SamplingParams - added:
field ScoreModelGraderParam.type: Required[Literal['score_model']] - added:
variable InputContent: TypeAlias
- added:
class StringCheckGrader(BaseModel) - added:
field StringCheckGrader.input: str - added:
field StringCheckGrader.name: str - added:
field StringCheckGrader.operation: Literal['eq', 'ne', 'like', 'ilike'] - added:
field StringCheckGrader.reference: str - added:
field StringCheckGrader.type: Literal['string_check']
- added:
class StringCheckGraderParam(TypedDict) - added:
field StringCheckGraderParam.input: Required[str] - added:
field StringCheckGraderParam.name: Required[str] - added:
field StringCheckGraderParam.operation: Required[Literal['eq', 'ne', 'like', 'ilike']] - added:
field StringCheckGraderParam.reference: Required[str] - added:
field StringCheckGraderParam.type: Required[Literal['string_check']]
- added:
class TextSimilarityGrader(BaseModel) - added:
field TextSimilarityGrader.evaluation_metric: Literal['cosine', 'fuzzy_match', 'bleu', 'gleu', 'meteor', 'rouge_1', 'rouge_2', 'rouge_3', 'rouge_4', 'rouge_5', 'rouge_l'] - added:
field TextSimilarityGrader.input: str - added:
field TextSimilarityGrader.name: str - added:
field TextSimilarityGrader.reference: str - added:
field TextSimilarityGrader.type: Literal['text_similarity']
- added:
class TextSimilarityGraderParam(TypedDict) - added:
field TextSimilarityGraderParam.evaluation_metric: Required[Literal['cosine', 'fuzzy_match', 'bleu', 'gleu', 'meteor', 'rouge_1', 'rouge_2', 'rouge_3', 'rouge_4', 'rouge_5', 'rouge_l']] - added:
field TextSimilarityGraderParam.input: Required[str] - added:
field TextSimilarityGraderParam.name: Required[str] - added:
field TextSimilarityGraderParam.reference: Required[str] - added:
field TextSimilarityGraderParam.type: Required[Literal['text_similarity']]
- added:
class Image(BaseModel) - added:
field Image.b64_json: Optional[str] - added:
field Image.revised_prompt: Optional[str] - added:
field Image.url: Optional[str]
- added:
class ImageCreateVariationParams(TypedDict) - added:
field ImageCreateVariationParams.image: Required[FileTypes] - added:
field ImageCreateVariationParams.model: Union[str, ImageModel, None] - added:
field ImageCreateVariationParams.n: Optional[int] - added:
field ImageCreateVariationParams.response_format: Optional[Literal['url', 'b64_json']] - added:
field ImageCreateVariationParams.size: Optional[Literal['256x256', '512x512', '1024x1024']] - added:
field ImageCreateVariationParams.user: str
- added:
class ImageEditCompletedEvent(BaseModel) - added:
class Usage(BaseModel) - added:
class UsageInputTokensDetails(BaseModel) - added:
field ImageEditCompletedEvent.b64_json: str - added:
field ImageEditCompletedEvent.background: Literal['transparent', 'opaque', 'auto'] - added:
field ImageEditCompletedEvent.created_at: int - added:
field ImageEditCompletedEvent.output_format: Literal['png', 'webp', 'jpeg'] - added:
field ImageEditCompletedEvent.quality: Literal['low', 'medium', 'high', 'auto'] - added:
field ImageEditCompletedEvent.size: Literal['1024x1024', '1024x1536', '1536x1024', 'auto'] - added:
field ImageEditCompletedEvent.type: Literal['image_edit.completed'] - added:
field ImageEditCompletedEvent.usage: Usage - added:
field Usage.input_tokens: int - added:
field Usage.input_tokens_details: UsageInputTokensDetails - added:
field Usage.output_tokens: int - added:
field Usage.total_tokens: int - added:
field UsageInputTokensDetails.image_tokens: int - added:
field UsageInputTokensDetails.text_tokens: int
- added:
class ImageEditParamsBase(TypedDict) - added:
class ImageEditParamsNonStreaming(ImageEditParamsBase) - added:
class ImageEditParamsStreaming(ImageEditParamsBase) - added:
field ImageEditParamsBase.background: Optional[Literal['transparent', 'opaque', 'auto']] - added:
field ImageEditParamsBase.image: Required[Union[FileTypes, SequenceNotStr[FileTypes]]] - added:
field ImageEditParamsBase.input_fidelity: Optional[Literal['high', 'low']] - added:
field ImageEditParamsBase.mask: FileTypes - added:
field ImageEditParamsBase.model: Union[str, ImageModel, None] - added:
field ImageEditParamsBase.n: Optional[int] - added:
field ImageEditParamsBase.output_compression: Optional[int] - added:
field ImageEditParamsBase.output_format: Optional[Literal['png', 'jpeg', 'webp']] - added:
field ImageEditParamsBase.partial_images: Optional[int] - added:
field ImageEditParamsBase.prompt: Required[str] - added:
field ImageEditParamsBase.quality: Optional[Literal['standard', 'low', 'medium', 'high', 'auto']] - added:
field ImageEditParamsBase.response_format: Optional[Literal['url', 'b64_json']] - added:
field ImageEditParamsBase.size: Optional[Literal['256x256', '512x512', '1024x1024', '1536x1024', '1024x1536', 'auto']] - added:
field ImageEditParamsBase.user: str - added:
field ImageEditParamsNonStreaming.stream: Optional[Literal[False]] - added:
field ImageEditParamsStreaming.stream: Required[Literal[True]]
- added:
class ImageEditPartialImageEvent(BaseModel) - added:
field ImageEditPartialImageEvent.b64_json: str - added:
field ImageEditPartialImageEvent.background: Literal['transparent', 'opaque', 'auto'] - added:
field ImageEditPartialImageEvent.created_at: int - added:
field ImageEditPartialImageEvent.output_format: Literal['png', 'webp', 'jpeg'] - added:
field ImageEditPartialImageEvent.partial_image_index: int - added:
field ImageEditPartialImageEvent.quality: Literal['low', 'medium', 'high', 'auto'] - added:
field ImageEditPartialImageEvent.size: Literal['1024x1024', '1024x1536', '1536x1024', 'auto'] - added:
field ImageEditPartialImageEvent.type: Literal['image_edit.partial_image']
- added:
variable ImageEditStreamEvent: TypeAlias
- added:
class ImageGenCompletedEvent(BaseModel) - added:
class Usage(BaseModel) - added:
class UsageInputTokensDetails(BaseModel) - added:
field ImageGenCompletedEvent.b64_json: str - added:
field ImageGenCompletedEvent.background: Literal['transparent', 'opaque', 'auto'] - added:
field ImageGenCompletedEvent.created_at: int - added:
field ImageGenCompletedEvent.output_format: Literal['png', 'webp', 'jpeg'] - added:
field ImageGenCompletedEvent.quality: Literal['low', 'medium', 'high', 'auto'] - added:
field ImageGenCompletedEvent.size: Literal['1024x1024', '1024x1536', '1536x1024', 'auto'] - added:
field ImageGenCompletedEvent.type: Literal['image_generation.completed'] - added:
field ImageGenCompletedEvent.usage: Usage - added:
field Usage.input_tokens: int - added:
field Usage.input_tokens_details: UsageInputTokensDetails - added:
field Usage.output_tokens: int - added:
field Usage.total_tokens: int - added:
field UsageInputTokensDetails.image_tokens: int - added:
field UsageInputTokensDetails.text_tokens: int
- added:
class ImageGenPartialImageEvent(BaseModel) - added:
field ImageGenPartialImageEvent.b64_json: str - added:
field ImageGenPartialImageEvent.background: Literal['transparent', 'opaque', 'auto'] - added:
field ImageGenPartialImageEvent.created_at: int - added:
field ImageGenPartialImageEvent.output_format: Literal['png', 'webp', 'jpeg'] - added:
field ImageGenPartialImageEvent.partial_image_index: int - added:
field ImageGenPartialImageEvent.quality: Literal['low', 'medium', 'high', 'auto'] - added:
field ImageGenPartialImageEvent.size: Literal['1024x1024', '1024x1536', '1536x1024', 'auto'] - added:
field ImageGenPartialImageEvent.type: Literal['image_generation.partial_image']
- added:
variable ImageGenStreamEvent: TypeAlias
- added:
class ImageGenerateParamsBase(TypedDict) - added:
class ImageGenerateParamsNonStreaming(ImageGenerateParamsBase) - added:
class ImageGenerateParamsStreaming(ImageGenerateParamsBase) - added:
field ImageGenerateParamsBase.background: Optional[Literal['transparent', 'opaque', 'auto']] - added:
field ImageGenerateParamsBase.model: Union[str, ImageModel, None] - added:
field ImageGenerateParamsBase.moderation: Optional[Literal['low', 'auto']] - added:
field ImageGenerateParamsBase.n: Optional[int] - added:
field ImageGenerateParamsBase.output_compression: Optional[int] - added:
field ImageGenerateParamsBase.output_format: Optional[Literal['png', 'jpeg', 'webp']] - added:
field ImageGenerateParamsBase.partial_images: Optional[int] - added:
field ImageGenerateParamsBase.prompt: Required[str] - added:
field ImageGenerateParamsBase.quality: Optional[Literal['standard', 'hd', 'low', 'medium', 'high', 'auto']] - added:
field ImageGenerateParamsBase.response_format: Optional[Literal['url', 'b64_json']] - added:
field ImageGenerateParamsBase.size: Optional[Literal['auto', '1024x1024', '1536x1024', '1024x1536', '256x256', '512x512', '1792x1024', '1024x1792']] - added:
field ImageGenerateParamsBase.style: Optional[Literal['vivid', 'natural']] - added:
field ImageGenerateParamsBase.user: str - added:
field ImageGenerateParamsNonStreaming.stream: Optional[Literal[False]] - added:
field ImageGenerateParamsStreaming.stream: Required[Literal[True]]
- added:
variable ImageModel: TypeAlias
- added:
class ImagesResponse(BaseModel) - added:
class Usage(BaseModel) - added:
class UsageInputTokensDetails(BaseModel) - added:
field ImagesResponse.background: Optional[Literal['transparent', 'opaque']] - added:
field ImagesResponse.created: int - added:
field ImagesResponse.data: Optional[List[Image]] - added:
field ImagesResponse.output_format: Optional[Literal['png', 'webp', 'jpeg']] - added:
field ImagesResponse.quality: Optional[Literal['low', 'medium', 'high']] - added:
field ImagesResponse.size: Optional[Literal['1024x1024', '1024x1536', '1536x1024']] - added:
field ImagesResponse.usage: Optional[Usage] - added:
field Usage.input_tokens: int - added:
field Usage.input_tokens_details: UsageInputTokensDetails - added:
field Usage.output_tokens: int - added:
field Usage.total_tokens: int - added:
field UsageInputTokensDetails.image_tokens: int - added:
field UsageInputTokensDetails.text_tokens: int
- added:
class Model(BaseModel) - added:
field Model.created: int - added:
field Model.id: str - added:
field Model.object: Literal['model'] - added:
field Model.owned_by: str
- added:
class ModelDeleted(BaseModel) - added:
field ModelDeleted.deleted: bool - added:
field ModelDeleted.id: str - added:
field ModelDeleted.object: str
- added:
class Categories(BaseModel) - added:
class CategoryAppliedInputTypes(BaseModel) - added:
class CategoryScores(BaseModel) - added:
class Moderation(BaseModel) - added:
field Categories.harassment: bool - added:
field Categories.harassment_threatening: bool - added:
field Categories.hate: bool - added:
field Categories.hate_threatening: bool - added:
field Categories.illicit: Optional[bool] - added:
field Categories.illicit_violent: Optional[bool] - added:
field Categories.self_harm: bool - added:
field Categories.self_harm_instructions: bool - added:
field Categories.self_harm_intent: bool - added:
field Categories.sexual: bool - added:
field Categories.sexual_minors: bool - added:
field Categories.violence: bool - added:
field Categories.violence_graphic: bool - added:
field CategoryAppliedInputTypes.harassment: List[Literal['text']] - added:
field CategoryAppliedInputTypes.harassment_threatening: List[Literal['text']] - added:
field CategoryAppliedInputTypes.hate: List[Literal['text']] - added:
field CategoryAppliedInputTypes.hate_threatening: List[Literal['text']] - added:
field CategoryAppliedInputTypes.illicit: List[Literal['text']] - added:
field CategoryAppliedInputTypes.illicit_violent: List[Literal['text']] - added:
field CategoryAppliedInputTypes.self_harm: List[Literal['text', 'image']] - added:
field CategoryAppliedInputTypes.self_harm_instructions: List[Literal['text', 'image']] - added:
field CategoryAppliedInputTypes.self_harm_intent: List[Literal['text', 'image']] - added:
field CategoryAppliedInputTypes.sexual: List[Literal['text', 'image']] - added:
field CategoryAppliedInputTypes.sexual_minors: List[Literal['text']] - added:
field CategoryAppliedInputTypes.violence: List[Literal['text', 'image']] - added:
field CategoryAppliedInputTypes.violence_graphic: List[Literal['text', 'image']] - added:
field CategoryScores.harassment: float - added:
field CategoryScores.harassment_threatening: float - added:
field CategoryScores.hate: float - added:
field CategoryScores.hate_threatening: float - added:
field CategoryScores.illicit: float - added:
field CategoryScores.illicit_violent: float - added:
field CategoryScores.self_harm: float - added:
field CategoryScores.self_harm_instructions: float - added:
field CategoryScores.self_harm_intent: float - added:
field CategoryScores.sexual: float - added:
field CategoryScores.sexual_minors: float - added:
field CategoryScores.violence: float - added:
field CategoryScores.violence_graphic: float - added:
field Moderation.categories: Categories - added:
field Moderation.category_applied_input_types: CategoryAppliedInputTypes - added:
field Moderation.category_scores: CategoryScores - added:
field Moderation.flagged: bool
- added:
class ModerationCreateParams(TypedDict) - added:
field ModerationCreateParams.input: Required[Union[str, SequenceNotStr[str], Iterable[ModerationMultiModalInputParam]]] - added:
field ModerationCreateParams.model: Union[str, ModerationModel]
- added:
class ModerationCreateResponse(BaseModel) - added:
field ModerationCreateResponse.id: str - added:
field ModerationCreateResponse.model: str - added:
field ModerationCreateResponse.results: List[Moderation]
- added:
class ImageURL(TypedDict) - added:
class ModerationImageURLInputParam(TypedDict) - added:
field ImageURL.url: Required[str] - added:
field ModerationImageURLInputParam.image_url: Required[ImageURL] - added:
field ModerationImageURLInputParam.type: Required[Literal['image_url']]
- added:
variable ModerationModel: TypeAlias
- added:
variable ModerationMultiModalInputParam: TypeAlias
- added:
class ModerationTextInputParam(TypedDict) - added:
field ModerationTextInputParam.text: Required[str] - added:
field ModerationTextInputParam.type: Required[Literal['text']]
- added:
class OtherFileChunkingStrategyObject(BaseModel) - added:
field OtherFileChunkingStrategyObject.type: Literal['other']
- added:
export AudioTranscription - added:
export AudioTranscriptionParam - added:
export ClientSecretCreateParams - added:
export ClientSecretCreateResponse - added:
export ConversationCreatedEvent - added:
export ConversationItem - added:
export ConversationItemAdded - added:
export ConversationItemCreateEvent - added:
export ConversationItemCreateEventParam - added:
export ConversationItemCreatedEvent - added:
export ConversationItemDeleteEvent - added:
export ConversationItemDeleteEventParam - added:
export ConversationItemDeletedEvent - added:
export ConversationItemDone - added:
export ConversationItemInputAudioTranscriptionCompletedEvent - added:
export ConversationItemInputAudioTranscriptionDeltaEvent - added:
export ConversationItemInputAudioTranscriptionFailedEvent - added:
export ConversationItemInputAudioTranscriptionSegment - added:
export ConversationItemParam - added:
export ConversationItemRetrieveEvent - added:
export ConversationItemRetrieveEventParam - added:
export ConversationItemTruncateEvent - added:
export ConversationItemTruncateEventParam - added:
export ConversationItemTruncatedEvent - added:
export InputAudioBufferAppendEvent - added:
export InputAudioBufferAppendEventParam - added:
export InputAudioBufferClearEvent - added:
export InputAudioBufferClearEventParam - added:
export InputAudioBufferClearedEvent - added:
export InputAudioBufferCommitEvent - added:
export InputAudioBufferCommitEventParam - added:
export InputAudioBufferCommittedEvent - added:
export InputAudioBufferSpeechStartedEvent - added:
export InputAudioBufferSpeechStoppedEvent - added:
export InputAudioBufferTimeoutTriggered - added:
export LogProbProperties - added:
export McpListToolsCompleted - added:
export McpListToolsFailed - added:
export McpListToolsInProgress - added:
export NoiseReductionType - added:
export OutputAudioBufferClearEvent - added:
export OutputAudioBufferClearEventParam - added:
export RateLimitsUpdatedEvent - added:
export RealtimeAudioConfig - added:
export RealtimeAudioConfigInput - added:
export RealtimeAudioConfigInputParam - added:
export RealtimeAudioConfigOutput - added:
export RealtimeAudioConfigOutputParam - added:
export RealtimeAudioConfigParam - added:
export RealtimeAudioFormats - added:
export RealtimeAudioFormatsParam - added:
export RealtimeAudioInputTurnDetection - added:
export RealtimeAudioInputTurnDetectionParam - added:
export RealtimeClientEvent - added:
export RealtimeClientEventParam - added:
export RealtimeConnectParams - added:
export RealtimeConversationItemAssistantMessage - added:
export RealtimeConversationItemAssistantMessageParam - added:
export RealtimeConversationItemFunctionCall - added:
export RealtimeConversationItemFunctionCallOutput - added:
export RealtimeConversationItemFunctionCallOutputParam - added:
export RealtimeConversationItemFunctionCallParam - added:
export RealtimeConversationItemSystemMessage - added:
export RealtimeConversationItemSystemMessageParam - added:
export RealtimeConversationItemUserMessage - added:
export RealtimeConversationItemUserMessageParam - added:
export RealtimeError - added:
export RealtimeErrorEvent - added:
export RealtimeFunctionTool - added:
export RealtimeFunctionToolParam - added:
export RealtimeMcpApprovalRequest - added:
export RealtimeMcpApprovalRequestParam - added:
export RealtimeMcpApprovalResponse - added:
export RealtimeMcpApprovalResponseParam - added:
export RealtimeMcpListTools - added:
export RealtimeMcpListToolsParam - added:
export RealtimeMcpProtocolError - added:
export RealtimeMcpProtocolErrorParam - added:
export RealtimeMcpToolCall - added:
export RealtimeMcpToolCallParam - added:
export RealtimeMcpToolExecutionError - added:
export RealtimeMcpToolExecutionErrorParam - added:
export RealtimeMcphttpError - added:
export RealtimeMcphttpErrorParam - added:
export RealtimeResponse - added:
export RealtimeResponseCreateAudioOutput - added:
export RealtimeResponseCreateAudioOutputParam - added:
export RealtimeResponseCreateMcpTool - added:
export RealtimeResponseCreateMcpToolParam - added:
export RealtimeResponseCreateParams - added:
export RealtimeResponseCreateParamsParam - added:
export RealtimeResponseStatus - added:
export RealtimeResponseUsage - added:
export RealtimeResponseUsageInputTokenDetails - added:
export RealtimeResponseUsageOutputTokenDetails - added:
export RealtimeServerEvent - added:
export RealtimeSessionClientSecret - added:
export RealtimeSessionCreateRequest - added:
export RealtimeSessionCreateRequestParam - added:
export RealtimeSessionCreateResponse - added:
export RealtimeToolChoiceConfig - added:
export RealtimeToolChoiceConfigParam - added:
export RealtimeToolsConfig - added:
export RealtimeToolsConfigParam - added:
export RealtimeToolsConfigUnion - added:
export RealtimeToolsConfigUnionParam - added:
export RealtimeTracingConfig - added:
export RealtimeTracingConfigParam - added:
export RealtimeTranscriptionSessionAudio - added:
export RealtimeTranscriptionSessionAudioInput - added:
export RealtimeTranscriptionSessionAudioInputParam - added:
export RealtimeTranscriptionSessionAudioInputTurnDetection - added:
export RealtimeTranscriptionSessionAudioInputTurnDetectionParam - added:
export RealtimeTranscriptionSessionAudioParam - added:
export RealtimeTranscriptionSessionCreateRequest - added:
export RealtimeTranscriptionSessionCreateRequestParam - added:
export RealtimeTranscriptionSessionCreateResponse - added:
export RealtimeTranscriptionSessionTurnDetection - added:
export RealtimeTruncation - added:
export RealtimeTruncationParam - added:
export RealtimeTruncationRetentionRatio - added:
export RealtimeTruncationRetentionRatioParam - added:
export ResponseAudioDeltaEvent - added:
export ResponseAudioDoneEvent - added:
export ResponseAudioTranscriptDeltaEvent - added:
export ResponseAudioTranscriptDoneEvent - added:
export ResponseCancelEvent - added:
export ResponseCancelEventParam - added:
export ResponseContentPartAddedEvent - added:
export ResponseContentPartDoneEvent - added:
export ResponseCreateEvent - added:
export ResponseCreateEventParam - added:
export ResponseCreatedEvent - added:
export ResponseDoneEvent - added:
export ResponseFunctionCallArgumentsDeltaEvent - added:
export ResponseFunctionCallArgumentsDoneEvent - added:
export ResponseMcpCallArgumentsDelta - added:
export ResponseMcpCallArgumentsDone - added:
export ResponseMcpCallCompleted - added:
export ResponseMcpCallFailed - added:
export ResponseMcpCallInProgress - added:
export ResponseOutputItemAddedEvent - added:
export ResponseOutputItemDoneEvent - added:
export ResponseTextDeltaEvent - added:
export ResponseTextDoneEvent - added:
export SessionCreatedEvent - added:
export SessionUpdateEvent - added:
export SessionUpdateEventParam - added:
export SessionUpdatedEvent
- added:
class AudioTranscription(BaseModel) - added:
field AudioTranscription.language: Optional[str] - added:
field AudioTranscription.model: Optional[Literal['whisper-1', 'gpt-4o-transcribe-latest', 'gpt-4o-mini-transcribe', 'gpt-4o-transcribe']] - added:
field AudioTranscription.prompt: Optional[str]
- added:
class AudioTranscriptionParam(TypedDict) - added:
field AudioTranscriptionParam.language: str - added:
field AudioTranscriptionParam.model: Literal['whisper-1', 'gpt-4o-transcribe-latest', 'gpt-4o-mini-transcribe', 'gpt-4o-transcribe'] - added:
field AudioTranscriptionParam.prompt: str
- added:
class ClientSecretCreateParams(TypedDict) - added:
class ExpiresAfter(TypedDict) - added:
field ClientSecretCreateParams.expires_after: ExpiresAfter - added:
field ClientSecretCreateParams.session: Session - added:
field ExpiresAfter.anchor: Literal['created_at'] - added:
field ExpiresAfter.seconds: int - added:
variable Session: TypeAlias
- added:
class ClientSecretCreateResponse(BaseModel) - added:
field ClientSecretCreateResponse.expires_at: int - added:
field ClientSecretCreateResponse.session: Session - added:
field ClientSecretCreateResponse.value: str - added:
variable Session: TypeAlias
- added:
class Conversation(BaseModel) - added:
class ConversationCreatedEvent(BaseModel) - added:
field Conversation.id: Optional[str] - added:
field Conversation.object: Optional[Literal['realtime.conversation']] - added:
field ConversationCreatedEvent.conversation: Conversation - added:
field ConversationCreatedEvent.event_id: str - added:
field ConversationCreatedEvent.type: Literal['conversation.created']
- added:
variable ConversationItem: TypeAlias
- added:
class ConversationItemAdded(BaseModel) - added:
field ConversationItemAdded.event_id: str - added:
field ConversationItemAdded.item: ConversationItem - added:
field ConversationItemAdded.previous_item_id: Optional[str] - added:
field ConversationItemAdded.type: Literal['conversation.item.added']
- added:
class ConversationItemCreateEvent(BaseModel) - added:
field ConversationItemCreateEvent.event_id: Optional[str] - added:
field ConversationItemCreateEvent.item: ConversationItem - added:
field ConversationItemCreateEvent.previous_item_id: Optional[str] - added:
field ConversationItemCreateEvent.type: Literal['conversation.item.create']
- added:
class ConversationItemCreateEventParam(TypedDict) - added:
field ConversationItemCreateEventParam.event_id: str - added:
field ConversationItemCreateEventParam.item: Required[ConversationItemParam] - added:
field ConversationItemCreateEventParam.previous_item_id: str - added:
field ConversationItemCreateEventParam.type: Required[Literal['conversation.item.create']]
- added:
class ConversationItemCreatedEvent(BaseModel) - added:
field ConversationItemCreatedEvent.event_id: str - added:
field ConversationItemCreatedEvent.item: ConversationItem - added:
field ConversationItemCreatedEvent.previous_item_id: Optional[str] - added:
field ConversationItemCreatedEvent.type: Literal['conversation.item.created']
- added:
class ConversationItemDeleteEvent(BaseModel) - added:
field ConversationItemDeleteEvent.event_id: Optional[str] - added:
field ConversationItemDeleteEvent.item_id: str - added:
field ConversationItemDeleteEvent.type: Literal['conversation.item.delete']
- added:
class ConversationItemDeleteEventParam(TypedDict) - added:
field ConversationItemDeleteEventParam.event_id: str - added:
field ConversationItemDeleteEventParam.item_id: Required[str] - added:
field ConversationItemDeleteEventParam.type: Required[Literal['conversation.item.delete']]
- added:
class ConversationItemDeletedEvent(BaseModel) - added:
field ConversationItemDeletedEvent.event_id: str - added:
field ConversationItemDeletedEvent.item_id: str - added:
field ConversationItemDeletedEvent.type: Literal['conversation.item.deleted']
- added:
class ConversationItemDone(BaseModel) - added:
field ConversationItemDone.event_id: str - added:
field ConversationItemDone.item: ConversationItem - added:
field ConversationItemDone.previous_item_id: Optional[str] - added:
field ConversationItemDone.type: Literal['conversation.item.done']
- added:
class ConversationItemInputAudioTranscriptionCompletedEvent(BaseModel) - added:
class UsageTranscriptTextUsageDuration(BaseModel) - added:
class UsageTranscriptTextUsageTokens(BaseModel) - added:
class UsageTranscriptTextUsageTokensInputTokenDetails(BaseModel) - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.content_index: int - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.event_id: str - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.item_id: str - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.logprobs: Optional[List[LogProbProperties]] - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.transcript: str - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.type: Literal['conversation.item.input_audio_transcription.completed'] - added:
field ConversationItemInputAudioTranscriptionCompletedEvent.usage: Usage - added:
field UsageTranscriptTextUsageDuration.seconds: float - added:
field UsageTranscriptTextUsageDuration.type: Literal['duration'] - added:
field UsageTranscriptTextUsageTokens.input_token_details: Optional[UsageTranscriptTextUsageTokensInputTokenDetails] - added:
field UsageTranscriptTextUsageTokens.input_tokens: int - added:
field UsageTranscriptTextUsageTokens.output_tokens: int - added:
field UsageTranscriptTextUsageTokens.total_tokens: int - added:
field UsageTranscriptTextUsageTokens.type: Literal['tokens'] - added:
field UsageTranscriptTextUsageTokensInputTokenDetails.audio_tokens: Optional[int] - added:
field UsageTranscriptTextUsageTokensInputTokenDetails.text_tokens: Optional[int] - added:
variable Usage: TypeAlias
- added:
class ConversationItemInputAudioTranscriptionDeltaEvent(BaseModel) - added:
field ConversationItemInputAudioTranscriptionDeltaEvent.content_index: Optional[int] - added:
field ConversationItemInputAudioTranscriptionDeltaEvent.delta: Optional[str] - added:
field ConversationItemInputAudioTranscriptionDeltaEvent.event_id: str - added:
field ConversationItemInputAudioTranscriptionDeltaEvent.item_id: str - added:
field ConversationItemInputAudioTranscriptionDeltaEvent.logprobs: Optional[List[LogProbProperties]] - added:
field ConversationItemInputAudioTranscriptionDeltaEvent.type: Literal['conversation.item.input_audio_transcription.delta']
- added:
class ConversationItemInputAudioTranscriptionFailedEvent(BaseModel) - added:
class Error(BaseModel) - added:
field ConversationItemInputAudioTranscriptionFailedEvent.content_index: int - added:
field ConversationItemInputAudioTranscriptionFailedEvent.error: Error - added:
field ConversationItemInputAudioTranscriptionFailedEvent.event_id: str - added:
field ConversationItemInputAudioTranscriptionFailedEvent.item_id: str - added:
field ConversationItemInputAudioTranscriptionFailedEvent.type: Literal['conversation.item.input_audio_transcription.failed'] - added:
field Error.code: Optional[str] - added:
field Error.message: Optional[str] - added:
field Error.param: Optional[str] - added:
field Error.type: Optional[str]
- added:
class ConversationItemInputAudioTranscriptionSegment(BaseModel) - added:
field ConversationItemInputAudioTranscriptionSegment.content_index: int - added:
field ConversationItemInputAudioTranscriptionSegment.end: float - added:
field ConversationItemInputAudioTranscriptionSegment.event_id: str - added:
field ConversationItemInputAudioTranscriptionSegment.id: str - added:
field ConversationItemInputAudioTranscriptionSegment.item_id: str - added:
field ConversationItemInputAudioTranscriptionSegment.speaker: str - added:
field ConversationItemInputAudioTranscriptionSegment.start: float - added:
field ConversationItemInputAudioTranscriptionSegment.text: str - added:
field ConversationItemInputAudioTranscriptionSegment.type: Literal['conversation.item.input_audio_transcription.segment']
- added:
variable ConversationItemParam: TypeAlias
- added:
class ConversationItemRetrieveEvent(BaseModel) - added:
field ConversationItemRetrieveEvent.event_id: Optional[str] - added:
field ConversationItemRetrieveEvent.item_id: str - added:
field ConversationItemRetrieveEvent.type: Literal['conversation.item.retrieve']
- added:
class ConversationItemRetrieveEventParam(TypedDict) - added:
field ConversationItemRetrieveEventParam.event_id: str - added:
field ConversationItemRetrieveEventParam.item_id: Required[str] - added:
field ConversationItemRetrieveEventParam.type: Required[Literal['conversation.item.retrieve']]
- added:
class ConversationItemTruncateEvent(BaseModel) - added:
field ConversationItemTruncateEvent.audio_end_ms: int - added:
field ConversationItemTruncateEvent.content_index: int - added:
field ConversationItemTruncateEvent.event_id: Optional[str] - added:
field ConversationItemTruncateEvent.item_id: str - added:
field ConversationItemTruncateEvent.type: Literal['conversation.item.truncate']
- added:
class ConversationItemTruncateEventParam(TypedDict) - added:
field ConversationItemTruncateEventParam.audio_end_ms: Required[int] - added:
field ConversationItemTruncateEventParam.content_index: Required[int] - added:
field ConversationItemTruncateEventParam.event_id: str - added:
field ConversationItemTruncateEventParam.item_id: Required[str] - added:
field ConversationItemTruncateEventParam.type: Required[Literal['conversation.item.truncate']]
- added:
class ConversationItemTruncatedEvent(BaseModel) - added:
field ConversationItemTruncatedEvent.audio_end_ms: int - added:
field ConversationItemTruncatedEvent.content_index: int - added:
field ConversationItemTruncatedEvent.event_id: str - added:
field ConversationItemTruncatedEvent.item_id: str - added:
field ConversationItemTruncatedEvent.type: Literal['conversation.item.truncated']
- added:
class InputAudioBufferAppendEvent(BaseModel) - added:
field InputAudioBufferAppendEvent.audio: str - added:
field InputAudioBufferAppendEvent.event_id: Optional[str] - added:
field InputAudioBufferAppendEvent.type: Literal['input_audio_buffer.append']
- added:
class InputAudioBufferAppendEventParam(TypedDict) - added:
field InputAudioBufferAppendEventParam.audio: Required[str] - added:
field InputAudioBufferAppendEventParam.event_id: str - added:
field InputAudioBufferAppendEventParam.type: Required[Literal['input_audio_buffer.append']]
- added:
class InputAudioBufferClearEvent(BaseModel) - added:
field InputAudioBufferClearEvent.event_id: Optional[str] - added:
field InputAudioBufferClearEvent.type: Literal['input_audio_buffer.clear']
- added:
class InputAudioBufferClearEventParam(TypedDict) - added:
field InputAudioBufferClearEventParam.event_id: str - added:
field InputAudioBufferClearEventParam.type: Required[Literal['input_audio_buffer.clear']]
- added:
class InputAudioBufferClearedEvent(BaseModel) - added:
field InputAudioBufferClearedEvent.event_id: str - added:
field InputAudioBufferClearedEvent.type: Literal['input_audio_buffer.cleared']
- added:
class InputAudioBufferCommitEvent(BaseModel) - added:
field InputAudioBufferCommitEvent.event_id: Optional[str] - added:
field InputAudioBufferCommitEvent.type: Literal['input_audio_buffer.commit']
- added:
class InputAudioBufferCommitEventParam(TypedDict) - added:
field InputAudioBufferCommitEventParam.event_id: str - added:
field InputAudioBufferCommitEventParam.type: Required[Literal['input_audio_buffer.commit']]
- added:
class InputAudioBufferCommittedEvent(BaseModel) - added:
field InputAudioBufferCommittedEvent.event_id: str - added:
field InputAudioBufferCommittedEvent.item_id: str - added:
field InputAudioBufferCommittedEvent.previous_item_id: Optional[str] - added:
field InputAudioBufferCommittedEvent.type: Literal['input_audio_buffer.committed']
- added:
class InputAudioBufferSpeechStartedEvent(BaseModel) - added:
field InputAudioBufferSpeechStartedEvent.audio_start_ms: int - added:
field InputAudioBufferSpeechStartedEvent.event_id: str - added:
field InputAudioBufferSpeechStartedEvent.item_id: str - added:
field InputAudioBufferSpeechStartedEvent.type: Literal['input_audio_buffer.speech_started']
- added:
class InputAudioBufferSpeechStoppedEvent(BaseModel) - added:
field InputAudioBufferSpeechStoppedEvent.audio_end_ms: int - added:
field InputAudioBufferSpeechStoppedEvent.event_id: str - added:
field InputAudioBufferSpeechStoppedEvent.item_id: str - added:
field InputAudioBufferSpeechStoppedEvent.type: Literal['input_audio_buffer.speech_stopped']
- added:
class InputAudioBufferTimeoutTriggered(BaseModel) - added:
field InputAudioBufferTimeoutTriggered.audio_end_ms: int - added:
field InputAudioBufferTimeoutTriggered.audio_start_ms: int - added:
field InputAudioBufferTimeoutTriggered.event_id: str - added:
field InputAudioBufferTimeoutTriggered.item_id: str - added:
field InputAudioBufferTimeoutTriggered.type: Literal['input_audio_buffer.timeout_triggered']
- added:
class LogProbProperties(BaseModel) - added:
field LogProbProperties.bytes: List[int] - added:
field LogProbProperties.logprob: float - added:
field LogProbProperties.token: str
- added:
class McpListToolsCompleted(BaseModel) - added:
field McpListToolsCompleted.event_id: str - added:
field McpListToolsCompleted.item_id: str - added:
field McpListToolsCompleted.type: Literal['mcp_list_tools.completed']
- added:
class McpListToolsFailed(BaseModel) - added:
field McpListToolsFailed.event_id: str - added:
field McpListToolsFailed.item_id: str - added:
field McpListToolsFailed.type: Literal['mcp_list_tools.failed']
- added:
class McpListToolsInProgress(BaseModel) - added:
field McpListToolsInProgress.event_id: str - added:
field McpListToolsInProgress.item_id: str - added:
field McpListToolsInProgress.type: Literal['mcp_list_tools.in_progress']
- added:
variable NoiseReductionType: TypeAlias
- added:
class OutputAudioBufferClearEvent(BaseModel) - added:
field OutputAudioBufferClearEvent.event_id: Optional[str] - added:
field OutputAudioBufferClearEvent.type: Literal['output_audio_buffer.clear']
- added:
class OutputAudioBufferClearEventParam(TypedDict) - added:
field OutputAudioBufferClearEventParam.event_id: str - added:
field OutputAudioBufferClearEventParam.type: Required[Literal['output_audio_buffer.clear']]
- added:
class RateLimit(BaseModel) - added:
class RateLimitsUpdatedEvent(BaseModel) - added:
field RateLimit.limit: Optional[int] - added:
field RateLimit.name: Optional[Literal['requests', 'tokens']] - added:
field RateLimit.remaining: Optional[int] - added:
field RateLimit.reset_seconds: Optional[float] - added:
field RateLimitsUpdatedEvent.event_id: str - added:
field RateLimitsUpdatedEvent.rate_limits: List[RateLimit] - added:
field RateLimitsUpdatedEvent.type: Literal['rate_limits.updated']
- added:
class RealtimeAudioConfig(BaseModel) - added:
field RealtimeAudioConfig.input: Optional[RealtimeAudioConfigInput] - added:
field RealtimeAudioConfig.output: Optional[RealtimeAudioConfigOutput]
- added:
class NoiseReduction(BaseModel) - added:
class RealtimeAudioConfigInput(BaseModel) - added:
field NoiseReduction.type: Optional[NoiseReductionType] - added:
field RealtimeAudioConfigInput.format: Optional[RealtimeAudioFormats] - added:
field RealtimeAudioConfigInput.noise_reduction: Optional[NoiseReduction] - added:
field RealtimeAudioConfigInput.transcription: Optional[AudioTranscription] - added:
field RealtimeAudioConfigInput.turn_detection: Optional[RealtimeAudioInputTurnDetection]
- added:
class NoiseReduction(TypedDict) - added:
class RealtimeAudioConfigInputParam(TypedDict) - added:
field NoiseReduction.type: NoiseReductionType - added:
field RealtimeAudioConfigInputParam.format: RealtimeAudioFormatsParam - added:
field RealtimeAudioConfigInputParam.noise_reduction: NoiseReduction - added:
field RealtimeAudioConfigInputParam.transcription: AudioTranscriptionParam - added:
field RealtimeAudioConfigInputParam.turn_detection: Optional[RealtimeAudioInputTurnDetectionParam]
- added:
class RealtimeAudioConfigOutput(BaseModel) - added:
field RealtimeAudioConfigOutput.format: Optional[RealtimeAudioFormats] - added:
field RealtimeAudioConfigOutput.speed: Optional[float] - added:
field RealtimeAudioConfigOutput.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse', 'marin', 'cedar'], None]
- added:
class RealtimeAudioConfigOutputParam(TypedDict) - added:
field RealtimeAudioConfigOutputParam.format: RealtimeAudioFormatsParam - added:
field RealtimeAudioConfigOutputParam.speed: float - added:
field RealtimeAudioConfigOutputParam.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse', 'marin', 'cedar']]
- added:
class RealtimeAudioConfigParam(TypedDict) - added:
field RealtimeAudioConfigParam.input: RealtimeAudioConfigInputParam - added:
field RealtimeAudioConfigParam.output: RealtimeAudioConfigOutputParam
- added:
class AudioPCM(BaseModel) - added:
class AudioPCMA(BaseModel) - added:
class AudioPCMU(BaseModel) - added:
field AudioPCM.rate: Optional[Literal[24000]] - added:
field AudioPCM.type: Optional[Literal['audio/pcm']] - added:
field AudioPCMA.type: Optional[Literal['audio/pcma']] - added:
field AudioPCMU.type: Optional[Literal['audio/pcmu']] - added:
variable RealtimeAudioFormats: TypeAlias
- added:
class AudioPCM(TypedDict) - added:
class AudioPCMA(TypedDict) - added:
class AudioPCMU(TypedDict) - added:
field AudioPCM.rate: Literal[24000] - added:
field AudioPCM.type: Literal['audio/pcm'] - added:
field AudioPCMA.type: Literal['audio/pcma'] - added:
field AudioPCMU.type: Literal['audio/pcmu'] - added:
variable RealtimeAudioFormatsParam: TypeAlias
- added:
class SemanticVad(BaseModel) - added:
class ServerVad(BaseModel) - added:
field SemanticVad.create_response: Optional[bool] - added:
field SemanticVad.eagerness: Optional[Literal['low', 'medium', 'high', 'auto']] - added:
field SemanticVad.interrupt_response: Optional[bool] - added:
field SemanticVad.type: Literal['semantic_vad'] - added:
field ServerVad.create_response: Optional[bool] - added:
field ServerVad.idle_timeout_ms: Optional[int] - added:
field ServerVad.interrupt_response: Optional[bool] - added:
field ServerVad.prefix_padding_ms: Optional[int] - added:
field ServerVad.silence_duration_ms: Optional[int] - added:
field ServerVad.threshold: Optional[float] - added:
field ServerVad.type: Literal['server_vad'] - added:
variable RealtimeAudioInputTurnDetection: TypeAlias
- added:
class SemanticVad(TypedDict) - added:
class ServerVad(TypedDict) - added:
field SemanticVad.create_response: bool - added:
field SemanticVad.eagerness: Literal['low', 'medium', 'high', 'auto'] - added:
field SemanticVad.interrupt_response: bool - added:
field SemanticVad.type: Required[Literal['semantic_vad']] - added:
field ServerVad.create_response: bool - added:
field ServerVad.idle_timeout_ms: Optional[int] - added:
field ServerVad.interrupt_response: bool - added:
field ServerVad.prefix_padding_ms: int - added:
field ServerVad.silence_duration_ms: int - added:
field ServerVad.threshold: float - added:
field ServerVad.type: Required[Literal['server_vad']] - added:
variable RealtimeAudioInputTurnDetectionParam: TypeAlias
- added:
variable RealtimeClientEvent: TypeAlias
- added:
variable RealtimeClientEventParam: TypeAlias
- added:
class RealtimeConnectParams(TypedDict) - added:
field RealtimeConnectParams.model: Required[str]
- added:
class Content(BaseModel) - added:
class RealtimeConversationItemAssistantMessage(BaseModel) - added:
field Content.audio: Optional[str] - added:
field Content.text: Optional[str] - added:
field Content.transcript: Optional[str] - added:
field Content.type: Optional[Literal['output_text', 'output_audio']] - added:
field RealtimeConversationItemAssistantMessage.content: List[Content] - added:
field RealtimeConversationItemAssistantMessage.id: Optional[str] - added:
field RealtimeConversationItemAssistantMessage.object: Optional[Literal['realtime.item']] - added:
field RealtimeConversationItemAssistantMessage.role: Literal['assistant'] - added:
field RealtimeConversationItemAssistantMessage.status: Optional[Literal['completed', 'incomplete', 'in_progress']] - added:
field RealtimeConversationItemAssistantMessage.type: Literal['message']
- added:
class Content(TypedDict) - added:
class RealtimeConversationItemAssistantMessageParam(TypedDict) - added:
field Content.audio: str - added:
field Content.text: str - added:
field Content.transcript: str - added:
field Content.type: Literal['output_text', 'output_audio'] - added:
field RealtimeConversationItemAssistantMessageParam.content: Required[Iterable[Content]] - added:
field RealtimeConversationItemAssistantMessageParam.id: str - added:
field RealtimeConversationItemAssistantMessageParam.object: Literal['realtime.item'] - added:
field RealtimeConversationItemAssistantMessageParam.role: Required[Literal['assistant']] - added:
field RealtimeConversationItemAssistantMessageParam.status: Literal['completed', 'incomplete', 'in_progress'] - added:
field RealtimeConversationItemAssistantMessageParam.type: Required[Literal['message']]
- added:
class RealtimeConversationItemFunctionCall(BaseModel) - added:
field RealtimeConversationItemFunctionCall.arguments: str - added:
field RealtimeConversationItemFunctionCall.call_id: Optional[str] - added:
field RealtimeConversationItemFunctionCall.id: Optional[str] - added:
field RealtimeConversationItemFunctionCall.name: str - added:
field RealtimeConversationItemFunctionCall.object: Optional[Literal['realtime.item']] - added:
field RealtimeConversationItemFunctionCall.status: Optional[Literal['completed', 'incomplete', 'in_progress']] - added:
field RealtimeConversationItemFunctionCall.type: Literal['function_call']
- added:
class RealtimeConversationItemFunctionCallOutput(BaseModel) - added:
field RealtimeConversationItemFunctionCallOutput.call_id: str - added:
field RealtimeConversationItemFunctionCallOutput.id: Optional[str] - added:
field RealtimeConversationItemFunctionCallOutput.object: Optional[Literal['realtime.item']] - added:
field RealtimeConversationItemFunctionCallOutput.output: str - added:
field RealtimeConversationItemFunctionCallOutput.status: Optional[Literal['completed', 'incomplete', 'in_progress']] - added:
field RealtimeConversationItemFunctionCallOutput.type: Literal['function_call_output']
- added:
class RealtimeConversationItemFunctionCallOutputParam(TypedDict) - added:
field RealtimeConversationItemFunctionCallOutputParam.call_id: Required[str] - added:
field RealtimeConversationItemFunctionCallOutputParam.id: str - added:
field RealtimeConversationItemFunctionCallOutputParam.object: Literal['realtime.item'] - added:
field RealtimeConversationItemFunctionCallOutputParam.output: Required[str] - added:
field RealtimeConversationItemFunctionCallOutputParam.status: Literal['completed', 'incomplete', 'in_progress'] - added:
field RealtimeConversationItemFunctionCallOutputParam.type: Required[Literal['function_call_output']]
- added:
class RealtimeConversationItemFunctionCallParam(TypedDict) - added:
field RealtimeConversationItemFunctionCallParam.arguments: Required[str] - added:
field RealtimeConversationItemFunctionCallParam.call_id: str - added:
field RealtimeConversationItemFunctionCallParam.id: str - added:
field RealtimeConversationItemFunctionCallParam.name: Required[str] - added:
field RealtimeConversationItemFunctionCallParam.object: Literal['realtime.item'] - added:
field RealtimeConversationItemFunctionCallParam.status: Literal['completed', 'incomplete', 'in_progress'] - added:
field RealtimeConversationItemFunctionCallParam.type: Required[Literal['function_call']]
- added:
class Content(BaseModel) - added:
class RealtimeConversationItemSystemMessage(BaseModel) - added:
field Content.text: Optional[str] - added:
field Content.type: Optional[Literal['input_text']] - added:
field RealtimeConversationItemSystemMessage.content: List[Content] - added:
field RealtimeConversationItemSystemMessage.id: Optional[str] - added:
field RealtimeConversationItemSystemMessage.object: Optional[Literal['realtime.item']] - added:
field RealtimeConversationItemSystemMessage.role: Literal['system'] - added:
field RealtimeConversationItemSystemMessage.status: Optional[Literal['completed', 'incomplete', 'in_progress']] - added:
field RealtimeConversationItemSystemMessage.type: Literal['message']
- added:
class Content(TypedDict) - added:
class RealtimeConversationItemSystemMessageParam(TypedDict) - added:
field Content.text: str - added:
field Content.type: Literal['input_text'] - added:
field RealtimeConversationItemSystemMessageParam.content: Required[Iterable[Content]] - added:
field RealtimeConversationItemSystemMessageParam.id: str - added:
field RealtimeConversationItemSystemMessageParam.object: Literal['realtime.item'] - added:
field RealtimeConversationItemSystemMessageParam.role: Required[Literal['system']] - added:
field RealtimeConversationItemSystemMessageParam.status: Literal['completed', 'incomplete', 'in_progress'] - added:
field RealtimeConversationItemSystemMessageParam.type: Required[Literal['message']]
- added:
class Content(BaseModel) - added:
class RealtimeConversationItemUserMessage(BaseModel) - added:
field Content.audio: Optional[str] - added:
field Content.detail: Optional[Literal['auto', 'low', 'high']] - added:
field Content.image_url: Optional[str] - added:
field Content.text: Optional[str] - added:
field Content.transcript: Optional[str] - added:
field Content.type: Optional[Literal['input_text', 'input_audio', 'input_image']] - added:
field RealtimeConversationItemUserMessage.content: List[Content] - added:
field RealtimeConversationItemUserMessage.id: Optional[str] - added:
field RealtimeConversationItemUserMessage.object: Optional[Literal['realtime.item']] - added:
field RealtimeConversationItemUserMessage.role: Literal['user'] - added:
field RealtimeConversationItemUserMessage.status: Optional[Literal['completed', 'incomplete', 'in_progress']] - added:
field RealtimeConversationItemUserMessage.type: Literal['message']
- added:
class Content(TypedDict) - added:
class RealtimeConversationItemUserMessageParam(TypedDict) - added:
field Content.audio: str - added:
field Content.detail: Literal['auto', 'low', 'high'] - added:
field Content.image_url: str - added:
field Content.text: str - added:
field Content.transcript: str - added:
field Content.type: Literal['input_text', 'input_audio', 'input_image'] - added:
field RealtimeConversationItemUserMessageParam.content: Required[Iterable[Content]] - added:
field RealtimeConversationItemUserMessageParam.id: str - added:
field RealtimeConversationItemUserMessageParam.object: Literal['realtime.item'] - added:
field RealtimeConversationItemUserMessageParam.role: Required[Literal['user']] - added:
field RealtimeConversationItemUserMessageParam.status: Literal['completed', 'incomplete', 'in_progress'] - added:
field RealtimeConversationItemUserMessageParam.type: Required[Literal['message']]
- added:
class RealtimeError(BaseModel) - added:
field RealtimeError.code: Optional[str] - added:
field RealtimeError.event_id: Optional[str] - added:
field RealtimeError.message: str - added:
field RealtimeError.param: Optional[str] - added:
field RealtimeError.type: str
- added:
class RealtimeErrorEvent(BaseModel) - added:
field RealtimeErrorEvent.error: RealtimeError - added:
field RealtimeErrorEvent.event_id: str - added:
field RealtimeErrorEvent.type: Literal['error']
- added:
class RealtimeFunctionTool(BaseModel) - added:
field RealtimeFunctionTool.description: Optional[str] - added:
field RealtimeFunctionTool.name: Optional[str] - added:
field RealtimeFunctionTool.parameters: Optional[object] - added:
field RealtimeFunctionTool.type: Optional[Literal['function']]
- added:
class RealtimeFunctionToolParam(TypedDict) - added:
field RealtimeFunctionToolParam.description: str - added:
field RealtimeFunctionToolParam.name: str - added:
field RealtimeFunctionToolParam.parameters: object - added:
field RealtimeFunctionToolParam.type: Literal['function']
- added:
class RealtimeMcpApprovalRequest(BaseModel) - added:
field RealtimeMcpApprovalRequest.arguments: str - added:
field RealtimeMcpApprovalRequest.id: str - added:
field RealtimeMcpApprovalRequest.name: str - added:
field RealtimeMcpApprovalRequest.server_label: str - added:
field RealtimeMcpApprovalRequest.type: Literal['mcp_approval_request']
- added:
class RealtimeMcpApprovalRequestParam(TypedDict) - added:
field RealtimeMcpApprovalRequestParam.arguments: Required[str] - added:
field RealtimeMcpApprovalRequestParam.id: Required[str] - added:
field RealtimeMcpApprovalRequestParam.name: Required[str] - added:
field RealtimeMcpApprovalRequestParam.server_label: Required[str] - added:
field RealtimeMcpApprovalRequestParam.type: Required[Literal['mcp_approval_request']]
- added:
class RealtimeMcpApprovalResponse(BaseModel) - added:
field RealtimeMcpApprovalResponse.approval_request_id: str - added:
field RealtimeMcpApprovalResponse.approve: bool - added:
field RealtimeMcpApprovalResponse.id: str - added:
field RealtimeMcpApprovalResponse.reason: Optional[str] - added:
field RealtimeMcpApprovalResponse.type: Literal['mcp_approval_response']
- added:
class RealtimeMcpApprovalResponseParam(TypedDict) - added:
field RealtimeMcpApprovalResponseParam.approval_request_id: Required[str] - added:
field RealtimeMcpApprovalResponseParam.approve: Required[bool] - added:
field RealtimeMcpApprovalResponseParam.id: Required[str] - added:
field RealtimeMcpApprovalResponseParam.reason: Optional[str] - added:
field RealtimeMcpApprovalResponseParam.type: Required[Literal['mcp_approval_response']]
- added:
class RealtimeMcpListTools(BaseModel) - added:
class Tool(BaseModel) - added:
field RealtimeMcpListTools.id: Optional[str] - added:
field RealtimeMcpListTools.server_label: str - added:
field RealtimeMcpListTools.tools: List[Tool] - added:
field RealtimeMcpListTools.type: Literal['mcp_list_tools'] - added:
field Tool.annotations: Optional[object] - added:
field Tool.description: Optional[str] - added:
field Tool.input_schema: object - added:
field Tool.name: str
- added:
class RealtimeMcpListToolsParam(TypedDict) - added:
class Tool(TypedDict) - added:
field RealtimeMcpListToolsParam.id: str - added:
field RealtimeMcpListToolsParam.server_label: Required[str] - added:
field RealtimeMcpListToolsParam.tools: Required[Iterable[Tool]] - added:
field RealtimeMcpListToolsParam.type: Required[Literal['mcp_list_tools']] - added:
field Tool.annotations: Optional[object] - added:
field Tool.description: Optional[str] - added:
field Tool.input_schema: Required[object] - added:
field Tool.name: Required[str]
- added:
class RealtimeMcpProtocolError(BaseModel) - added:
field RealtimeMcpProtocolError.code: int - added:
field RealtimeMcpProtocolError.message: str - added:
field RealtimeMcpProtocolError.type: Literal['protocol_error']
- added:
class RealtimeMcpProtocolErrorParam(TypedDict) - added:
field RealtimeMcpProtocolErrorParam.code: Required[int] - added:
field RealtimeMcpProtocolErrorParam.message: Required[str] - added:
field RealtimeMcpProtocolErrorParam.type: Required[Literal['protocol_error']]
- added:
class RealtimeMcpToolCall(BaseModel) - added:
field RealtimeMcpToolCall.approval_request_id: Optional[str] - added:
field RealtimeMcpToolCall.arguments: str - added:
field RealtimeMcpToolCall.error: Optional[Error] - added:
field RealtimeMcpToolCall.id: str - added:
field RealtimeMcpToolCall.name: str - added:
field RealtimeMcpToolCall.output: Optional[str] - added:
field RealtimeMcpToolCall.server_label: str - added:
field RealtimeMcpToolCall.type: Literal['mcp_call'] - added:
variable Error: TypeAlias
- added:
class RealtimeMcpToolCallParam(TypedDict) - added:
field RealtimeMcpToolCallParam.approval_request_id: Optional[str] - added:
field RealtimeMcpToolCallParam.arguments: Required[str] - added:
field RealtimeMcpToolCallParam.error: Optional[Error] - added:
field RealtimeMcpToolCallParam.id: Required[str] - added:
field RealtimeMcpToolCallParam.name: Required[str] - added:
field RealtimeMcpToolCallParam.output: Optional[str] - added:
field RealtimeMcpToolCallParam.server_label: Required[str] - added:
field RealtimeMcpToolCallParam.type: Required[Literal['mcp_call']] - added:
variable Error: TypeAlias
- added:
class RealtimeMcpToolExecutionError(BaseModel) - added:
field RealtimeMcpToolExecutionError.message: str - added:
field RealtimeMcpToolExecutionError.type: Literal['tool_execution_error']
- added:
class RealtimeMcpToolExecutionErrorParam(TypedDict) - added:
field RealtimeMcpToolExecutionErrorParam.message: Required[str] - added:
field RealtimeMcpToolExecutionErrorParam.type: Required[Literal['tool_execution_error']]
- added:
class RealtimeMcphttpError(BaseModel) - added:
field RealtimeMcphttpError.code: int - added:
field RealtimeMcphttpError.message: str - added:
field RealtimeMcphttpError.type: Literal['http_error']
- added:
class RealtimeMcphttpErrorParam(TypedDict) - added:
field RealtimeMcphttpErrorParam.code: Required[int] - added:
field RealtimeMcphttpErrorParam.message: Required[str] - added:
field RealtimeMcphttpErrorParam.type: Required[Literal['http_error']]
- added:
class Audio(BaseModel) - added:
class AudioOutput(BaseModel) - added:
class RealtimeResponse(BaseModel) - added:
field Audio.output: Optional[AudioOutput] - added:
field AudioOutput.format: Optional[RealtimeAudioFormats] - added:
field AudioOutput.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse', 'marin', 'cedar'], None] - added:
field RealtimeResponse.audio: Optional[Audio] - added:
field RealtimeResponse.conversation_id: Optional[str] - added:
field RealtimeResponse.id: Optional[str] - added:
field RealtimeResponse.max_output_tokens: Union[int, Literal['inf'], None] - added:
field RealtimeResponse.metadata: Optional[Metadata] - added:
field RealtimeResponse.object: Optional[Literal['realtime.response']] - added:
field RealtimeResponse.output: Optional[List[ConversationItem]] - added:
field RealtimeResponse.output_modalities: Optional[List[Literal['text', 'audio']]] - added:
field RealtimeResponse.status: Optional[Literal['completed', 'cancelled', 'failed', 'incomplete', 'in_progress']] - added:
field RealtimeResponse.status_details: Optional[RealtimeResponseStatus] - added:
field RealtimeResponse.usage: Optional[RealtimeResponseUsage]
- added:
class Output(BaseModel) - added:
class RealtimeResponseCreateAudioOutput(BaseModel) - added:
field Output.format: Optional[RealtimeAudioFormats] - added:
field Output.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse', 'marin', 'cedar'], None] - added:
field RealtimeResponseCreateAudioOutput.output: Optional[Output]
- added:
class Output(TypedDict) - added:
class RealtimeResponseCreateAudioOutputParam(TypedDict) - added:
field Output.format: RealtimeAudioFormatsParam - added:
field Output.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse', 'marin', 'cedar']] - added:
field RealtimeResponseCreateAudioOutputParam.output: Output
- added:
class AllowedToolsMcpToolFilter(BaseModel) - added:
class RealtimeResponseCreateMcpTool(BaseModel) - added:
class RequireApprovalMcpToolApprovalFilter(BaseModel) - added:
class RequireApprovalMcpToolApprovalFilterAlways(BaseModel) - added:
class RequireApprovalMcpToolApprovalFilterNever(BaseModel) - added:
field AllowedToolsMcpToolFilter.read_only: Optional[bool] - added:
field AllowedToolsMcpToolFilter.tool_names: Optional[List[str]] - added:
field RealtimeResponseCreateMcpTool.allowed_tools: Optional[AllowedTools] - added:
field RealtimeResponseCreateMcpTool.authorization: Optional[str] - added:
field RealtimeResponseCreateMcpTool.connector_id: Optional[Literal['connector_dropbox', 'connector_gmail', 'connector_googlecalendar', 'connector_googledrive', 'connector_microsoftteams', 'connector_outlookcalendar', 'connector_outlookemail', 'connector_sharepoint']] - added:
field RealtimeResponseCreateMcpTool.headers: Optional[Dict[str, str]] - added:
field RealtimeResponseCreateMcpTool.require_approval: Optional[RequireApproval] - added:
field RealtimeResponseCreateMcpTool.server_description: Optional[str] - added:
field RealtimeResponseCreateMcpTool.server_label: str - added:
field RealtimeResponseCreateMcpTool.server_url: Optional[str] - added:
field RealtimeResponseCreateMcpTool.type: Literal['mcp'] - added:
field RequireApprovalMcpToolApprovalFilter.always: Optional[RequireApprovalMcpToolApprovalFilterAlways] - added:
field RequireApprovalMcpToolApprovalFilter.never: Optional[RequireApprovalMcpToolApprovalFilterNever] - added:
field RequireApprovalMcpToolApprovalFilterAlways.read_only: Optional[bool] - added:
field RequireApprovalMcpToolApprovalFilterAlways.tool_names: Optional[List[str]] - added:
field RequireApprovalMcpToolApprovalFilterNever.read_only: Optional[bool] - added:
field RequireApprovalMcpToolApprovalFilterNever.tool_names: Optional[List[str]] - added:
variable AllowedTools: TypeAlias - added:
variable RequireApproval: TypeAlias
- added:
class AllowedToolsMcpToolFilter(TypedDict) - added:
class RealtimeResponseCreateMcpToolParam(TypedDict) - added:
class RequireApprovalMcpToolApprovalFilter(TypedDict) - added:
class RequireApprovalMcpToolApprovalFilterAlways(TypedDict) - added:
class RequireApprovalMcpToolApprovalFilterNever(TypedDict) - added:
field AllowedToolsMcpToolFilter.read_only: bool - added:
field AllowedToolsMcpToolFilter.tool_names: SequenceNotStr[str] - added:
field RealtimeResponseCreateMcpToolParam.allowed_tools: Optional[AllowedTools] - added:
field RealtimeResponseCreateMcpToolParam.authorization: str - added:
field RealtimeResponseCreateMcpToolParam.connector_id: Literal['connector_dropbox', 'connector_gmail', 'connector_googlecalendar', 'connector_googledrive', 'connector_microsoftteams', 'connector_outlookcalendar', 'connector_outlookemail', 'connector_sharepoint'] - added:
field RealtimeResponseCreateMcpToolParam.headers: Optional[Dict[str, str]] - added:
field RealtimeResponseCreateMcpToolParam.require_approval: Optional[RequireApproval] - added:
field RealtimeResponseCreateMcpToolParam.server_description: str - added:
field RealtimeResponseCreateMcpToolParam.server_label: Required[str] - added:
field RealtimeResponseCreateMcpToolParam.server_url: str - added:
field RealtimeResponseCreateMcpToolParam.type: Required[Literal['mcp']] - added:
field RequireApprovalMcpToolApprovalFilter.always: RequireApprovalMcpToolApprovalFilterAlways - added:
field RequireApprovalMcpToolApprovalFilter.never: RequireApprovalMcpToolApprovalFilterNever - added:
field RequireApprovalMcpToolApprovalFilterAlways.read_only: bool - added:
field RequireApprovalMcpToolApprovalFilterAlways.tool_names: SequenceNotStr[str] - added:
field RequireApprovalMcpToolApprovalFilterNever.read_only: bool - added:
field RequireApprovalMcpToolApprovalFilterNever.tool_names: SequenceNotStr[str] - added:
variable AllowedTools: TypeAlias - added:
variable RequireApproval: TypeAlias
- added:
class RealtimeResponseCreateParams(BaseModel) - added:
field RealtimeResponseCreateParams.audio: Optional[RealtimeResponseCreateAudioOutput] - added:
field RealtimeResponseCreateParams.conversation: Union[str, Literal['auto', 'none'], None] - added:
field RealtimeResponseCreateParams.input: Optional[List[ConversationItem]] - added:
field RealtimeResponseCreateParams.instructions: Optional[str] - added:
field RealtimeResponseCreateParams.max_output_tokens: Union[int, Literal['inf'], None] - added:
field RealtimeResponseCreateParams.metadata: Optional[Metadata] - added:
field RealtimeResponseCreateParams.output_modalities: Optional[List[Literal['text', 'audio']]] - added:
field RealtimeResponseCreateParams.prompt: Optional[ResponsePrompt] - added:
field RealtimeResponseCreateParams.tool_choice: Optional[ToolChoice] - added:
field RealtimeResponseCreateParams.tools: Optional[List[Tool]] - added:
variable Tool: TypeAlias - added:
variable ToolChoice: TypeAlias
- added:
class RealtimeResponseCreateParamsParam(TypedDict) - added:
field RealtimeResponseCreateParamsParam.audio: RealtimeResponseCreateAudioOutputParam - added:
field RealtimeResponseCreateParamsParam.conversation: Union[str, Literal['auto', 'none']] - added:
field RealtimeResponseCreateParamsParam.input: Iterable[ConversationItemParam] - added:
field RealtimeResponseCreateParamsParam.instructions: str - added:
field RealtimeResponseCreateParamsParam.max_output_tokens: Union[int, Literal['inf']] - added:
field RealtimeResponseCreateParamsParam.metadata: Optional[Metadata] - added:
field RealtimeResponseCreateParamsParam.output_modalities: List[Literal['text', 'audio']] - added:
field RealtimeResponseCreateParamsParam.prompt: Optional[ResponsePromptParam] - added:
field RealtimeResponseCreateParamsParam.tool_choice: ToolChoice - added:
field RealtimeResponseCreateParamsParam.tools: Iterable[Tool] - added:
variable Tool: TypeAlias - added:
variable ToolChoice: TypeAlias
- added:
class Error(BaseModel) - added:
class RealtimeResponseStatus(BaseModel) - added:
field Error.code: Optional[str] - added:
field Error.type: Optional[str] - added:
field RealtimeResponseStatus.error: Optional[Error] - added:
field RealtimeResponseStatus.reason: Optional[Literal['turn_detected', 'client_cancelled', 'max_output_tokens', 'content_filter']] - added:
field RealtimeResponseStatus.type: Optional[Literal['completed', 'cancelled', 'incomplete', 'failed']]
- added:
class RealtimeResponseUsage(BaseModel) - added:
field RealtimeResponseUsage.input_token_details: Optional[RealtimeResponseUsageInputTokenDetails] - added:
field RealtimeResponseUsage.input_tokens: Optional[int] - added:
field RealtimeResponseUsage.output_token_details: Optional[RealtimeResponseUsageOutputTokenDetails] - added:
field RealtimeResponseUsage.output_tokens: Optional[int] - added:
field RealtimeResponseUsage.total_tokens: Optional[int]
- added:
class CachedTokensDetails(BaseModel) - added:
class RealtimeResponseUsageInputTokenDetails(BaseModel) - added:
field CachedTokensDetails.audio_tokens: Optional[int] - added:
field CachedTokensDetails.image_tokens: Optional[int] - added:
field CachedTokensDetails.text_tokens: Optional[int] - added:
field RealtimeResponseUsageInputTokenDetails.audio_tokens: Optional[int] - added:
field RealtimeResponseUsageInputTokenDetails.cached_tokens: Optional[int] - added:
field RealtimeResponseUsageInputTokenDetails.cached_tokens_details: Optional[CachedTokensDetails] - added:
field RealtimeResponseUsageInputTokenDetails.image_tokens: Optional[int] - added:
field RealtimeResponseUsageInputTokenDetails.text_tokens: Optional[int]
- added:
class RealtimeResponseUsageOutputTokenDetails(BaseModel) - added:
field RealtimeResponseUsageOutputTokenDetails.audio_tokens: Optional[int] - added:
field RealtimeResponseUsageOutputTokenDetails.text_tokens: Optional[int]
- added:
class ConversationItemRetrieved(BaseModel) - added:
class OutputAudioBufferCleared(BaseModel) - added:
class OutputAudioBufferStarted(BaseModel) - added:
class OutputAudioBufferStopped(BaseModel) - added:
field ConversationItemRetrieved.event_id: str - added:
field ConversationItemRetrieved.item: ConversationItem - added:
field ConversationItemRetrieved.type: Literal['conversation.item.retrieved'] - added:
field OutputAudioBufferCleared.event_id: str - added:
field OutputAudioBufferCleared.response_id: str - added:
field OutputAudioBufferCleared.type: Literal['output_audio_buffer.cleared'] - added:
field OutputAudioBufferStarted.event_id: str - added:
field OutputAudioBufferStarted.response_id: str - added:
field OutputAudioBufferStarted.type: Literal['output_audio_buffer.started'] - added:
field OutputAudioBufferStopped.event_id: str - added:
field OutputAudioBufferStopped.response_id: str - added:
field OutputAudioBufferStopped.type: Literal['output_audio_buffer.stopped'] - added:
variable RealtimeServerEvent: TypeAlias
- added:
class RealtimeSessionClientSecret(BaseModel) - added:
field RealtimeSessionClientSecret.expires_at: int - added:
field RealtimeSessionClientSecret.value: str
- added:
class RealtimeSessionCreateRequest(BaseModel) - added:
field RealtimeSessionCreateRequest.audio: Optional[RealtimeAudioConfig] - added:
field RealtimeSessionCreateRequest.include: Optional[List[Literal['item.input_audio_transcription.logprobs']]] - added:
field RealtimeSessionCreateRequest.instructions: Optional[str] - added:
field RealtimeSessionCreateRequest.max_output_tokens: Union[int, Literal['inf'], None] - added:
field RealtimeSessionCreateRequest.model: Union[str, Literal['gpt-realtime', 'gpt-realtime-2025-08-28', 'gpt-4o-realtime-preview', 'gpt-4o-realtime-preview-2024-10-01', 'gpt-4o-realtime-preview-2024-12-17', 'gpt-4o-realtime-preview-2025-06-03', 'gpt-4o-mini-realtime-preview', 'gpt-4o-mini-realtime-preview-2024-12-17'], None] - added:
field RealtimeSessionCreateRequest.output_modalities: Optional[List[Literal['text', 'audio']]] - added:
field RealtimeSessionCreateRequest.prompt: Optional[ResponsePrompt] - added:
field RealtimeSessionCreateRequest.tool_choice: Optional[RealtimeToolChoiceConfig] - added:
field RealtimeSessionCreateRequest.tools: Optional[RealtimeToolsConfig] - added:
field RealtimeSessionCreateRequest.tracing: Optional[RealtimeTracingConfig] - added:
field RealtimeSessionCreateRequest.truncation: Optional[RealtimeTruncation] - added:
field RealtimeSessionCreateRequest.type: Literal['realtime']
- added:
class RealtimeSessionCreateRequestParam(TypedDict) - added:
field RealtimeSessionCreateRequestParam.audio: RealtimeAudioConfigParam - added:
field RealtimeSessionCreateRequestParam.include: List[Literal['item.input_audio_transcription.logprobs']] - added:
field RealtimeSessionCreateRequestParam.instructions: str - added:
field RealtimeSessionCreateRequestParam.max_output_tokens: Union[int, Literal['inf']] - added:
field RealtimeSessionCreateRequestParam.model: Union[str, Literal['gpt-realtime', 'gpt-realtime-2025-08-28', 'gpt-4o-realtime-preview', 'gpt-4o-realtime-preview-2024-10-01', 'gpt-4o-realtime-preview-2024-12-17', 'gpt-4o-realtime-preview-2025-06-03', 'gpt-4o-mini-realtime-preview', 'gpt-4o-mini-realtime-preview-2024-12-17']] - added:
field RealtimeSessionCreateRequestParam.output_modalities: List[Literal['text', 'audio']] - added:
field RealtimeSessionCreateRequestParam.prompt: Optional[ResponsePromptParam] - added:
field RealtimeSessionCreateRequestParam.tool_choice: RealtimeToolChoiceConfigParam - added:
field RealtimeSessionCreateRequestParam.tools: RealtimeToolsConfigParam - added:
field RealtimeSessionCreateRequestParam.tracing: Optional[RealtimeTracingConfigParam] - added:
field RealtimeSessionCreateRequestParam.truncation: RealtimeTruncationParam - added:
field RealtimeSessionCreateRequestParam.type: Required[Literal['realtime']]
- added:
class Audio(BaseModel) - added:
class AudioInput(BaseModel) - added:
class AudioInputNoiseReduction(BaseModel) - added:
class AudioInputTurnDetectionSemanticVad(BaseModel) - added:
class AudioInputTurnDetectionServerVad(BaseModel) - added:
class AudioOutput(BaseModel) - added:
class RealtimeSessionCreateResponse(BaseModel) - added:
class ToolMcpTool(BaseModel) - added:
class ToolMcpToolAllowedToolsMcpToolFilter(BaseModel) - added:
class ToolMcpToolRequireApprovalMcpToolApprovalFilter(BaseModel) - added:
class ToolMcpToolRequireApprovalMcpToolApprovalFilterAlways(BaseModel) - added:
class ToolMcpToolRequireApprovalMcpToolApprovalFilterNever(BaseModel) - added:
class TracingTracingConfiguration(BaseModel) - added:
field Audio.input: Optional[AudioInput] - added:
field Audio.output: Optional[AudioOutput] - added:
field AudioInput.format: Optional[RealtimeAudioFormats] - added:
field AudioInput.noise_reduction: Optional[AudioInputNoiseReduction] - added:
field AudioInput.transcription: Optional[AudioTranscription] - added:
field AudioInput.turn_detection: Optional[AudioInputTurnDetection] - added:
field AudioInputNoiseReduction.type: Optional[NoiseReductionType] - added:
field AudioInputTurnDetectionSemanticVad.create_response: Optional[bool] - added:
field AudioInputTurnDetectionSemanticVad.eagerness: Optional[Literal['low', 'medium', 'high', 'auto']] - added:
field AudioInputTurnDetectionSemanticVad.interrupt_response: Optional[bool] - added:
field AudioInputTurnDetectionSemanticVad.type: Literal['semantic_vad'] - added:
field AudioInputTurnDetectionServerVad.create_response: Optional[bool] - added:
field AudioInputTurnDetectionServerVad.idle_timeout_ms: Optional[int] - added:
field AudioInputTurnDetectionServerVad.interrupt_response: Optional[bool] - added:
field AudioInputTurnDetectionServerVad.prefix_padding_ms: Optional[int] - added:
field AudioInputTurnDetectionServerVad.silence_duration_ms: Optional[int] - added:
field AudioInputTurnDetectionServerVad.threshold: Optional[float] - added:
field AudioInputTurnDetectionServerVad.type: Literal['server_vad'] - added:
field AudioOutput.format: Optional[RealtimeAudioFormats] - added:
field AudioOutput.speed: Optional[float] - added:
field AudioOutput.voice: Union[str, Literal['alloy', 'ash', 'ballad', 'coral', 'echo', 'sage', 'shimmer', 'verse', 'marin', 'cedar'], None] - added:
field RealtimeSessionCreateResponse.audio: Optional[Audio] - added:
field RealtimeSessionCreateResponse.client_secret: RealtimeSessionClientSecret - added:
field RealtimeSessionCreateResponse.include: Optional[List[Literal['item.input_audio_transcription.logprobs']]] - added:
field RealtimeSessionCreateResponse.instructions: Optional[str] - added:
field RealtimeSessionCreateResponse.max_output_tokens: Union[int, Literal['inf'], None] - added:
field RealtimeSessionCreateResponse.model: Union[str, Literal['gpt-realtime', 'gpt-realtime-2025-08-28', 'gpt-4o-realtime-preview', 'gpt-4o-realtime-preview-2024-10-01', 'gpt-4o-realtime-preview-2024-12-17', 'gpt-4o-realtime-preview-2025-06-03', 'gpt-4o-mini-realtime-preview', 'gpt-4o-mini-realtime-preview-2024-12-17'], None] - added:
field RealtimeSessionCreateResponse.output_modalities: Optional[List[Literal['text', 'audio']]] - added:
field RealtimeSessionCreateResponse.prompt: Optional[ResponsePrompt] - added:
field RealtimeSessionCreateResponse.tool_choice: Optional[ToolChoice] - added:
field RealtimeSessionCreateResponse.tools: Optional[List[Tool]] - added:
field RealtimeSessionCreateResponse.tracing: Optional[Tracing] - added:
field RealtimeSessionCreateResponse.truncation: Optional[RealtimeTruncation] - added:
field RealtimeSessionCreateResponse.type: Literal['realtime'] - added:
field ToolMcpTool.allowed_tools: Optional[ToolMcpToolAllowedTools] - added:
field ToolMcpTool.authorization: Optional[str] - added:
field ToolMcpTool.connector_id: Optional[Literal['connector_dropbox', 'connector_gmail', 'connector_googlecalendar', 'connector_googledrive', 'connector_microsoftteams', 'connector_outlookcalendar', 'connector_outlookemail', 'connector_sharepoint']] - added:
field ToolMcpTool.headers: Optional[Dict[str, str]] - added:
field ToolMcpTool.require_approval: Optional[ToolMcpToolRequireApproval] - added:
field ToolMcpTool.server_description: Optional[str] - added:
field ToolMcpTool.server_label: str - added:
field ToolMcpTool.server_url: Optional[str] - added:
field ToolMcpTool.type: Literal['mcp'] - added:
field ToolMcpToolAllowedToolsMcpToolFilter.read_only: Optional[bool] - added:
field ToolMcpToolAllowedToolsMcpToolFilter.tool_names: Optional[List[str]] - added:
field ToolMcpToolRequireApprovalMcpToolApprovalFilter.always: Optional[ToolMcpToolRequireApprovalMcpToolApprovalFilterAlways] - added:
field ToolMcpToolRequireApprovalMcpToolApprovalFilter.never: Optional[ToolMcpToolRequireApprovalMcpToolApprovalFilterNever] - added:
field ToolMcpToolRequireApprovalMcpToolApprovalFilterAlways.read_only: Optional[bool] - added:
field ToolMcpToolRequireApprovalMcpToolApprovalFilterAlways.tool_names: Optional[List[str]] - added:
field ToolMcpToolRequireApprovalMcpToolApprovalFilterNever.read_only: Optional[bool] - added:
field ToolMcpToolRequireApprovalMcpToolApprovalFilterNever.tool_names: Optional[List[str]] - added:
field TracingTracingConfiguration.group_id: Optional[str] - added:
field TracingTracingConfiguration.metadata: Optional[object] - added:
field TracingTracingConfiguration.workflow_name: Optional[str] - added:
variable AudioInputTurnDetection: TypeAlias - added:
variable Tool: TypeAlias - added:
variable ToolChoice: TypeAlias - added:
variable ToolMcpToolAllowedTools: TypeAlias - added:
variable ToolMcpToolRequireApproval: TypeAlias - added:
variable Tracing: TypeAlias
- added:
variable RealtimeToolChoiceConfig: TypeAlias
- added:
variable RealtimeToolChoiceConfigParam: TypeAlias
- added:
variable RealtimeToolsConfig: TypeAlias
- added:
class Mcp(TypedDict) - added:
class McpAllowedToolsMcpToolFilter(TypedDict) - added:
class McpRequireApprovalMcpToolApprovalFilter(TypedDict) - added:
class McpRequireApprovalMcpToolApprovalFilterAlways(TypedDict) - added:
class McpRequireApprovalMcpToolApprovalFilterNever(TypedDict) - added:
field Mcp.allowed_tools: Optional[McpAllowedTools] - added:
field Mcp.authorization: str - added:
field Mcp.connector_id: Literal['connector_dropbox', 'connector_gmail', 'connector_googlecalendar', 'connector_googledrive', 'connector_microsoftteams', 'connector_outlookcalendar', 'connector_outlookemail', 'connector_sharepoint'] - added:
field Mcp.headers: Optional[Dict[str, str]] - added:
field Mcp.require_approval: Optional[McpRequireApproval] - added:
field Mcp.server_description: str - added:
field Mcp.server_label: Required[str] - added:
field Mcp.server_url: str - added:
field Mcp.type: Required[Literal['mcp']] - added:
field McpAllowedToolsMcpToolFilter.read_only: bool - added:
field McpAllowedToolsMcpToolFilter.tool_names: SequenceNotStr[str] - added:
field McpRequireApprovalMcpToolApprovalFilter.always: McpRequireApprovalMcpToolApprovalFilterAlways - added:
field McpRequireApprovalMcpToolApprovalFilter.never: McpRequireApprovalMcpToolApprovalFilterNever - added:
field McpRequireApprovalMcpToolApprovalFilterAlways.read_only: bool - added:
field McpRequireApprovalMcpToolApprovalFilterAlways.tool_names: SequenceNotStr[str] - added:
field McpRequireApprovalMcpToolApprovalFilterNever.read_only: bool - added:
field McpRequireApprovalMcpToolApprovalFilterNever.tool_names: SequenceNotStr[str] - added:
variable McpAllowedTools: TypeAlias - added:
variable McpRequireApproval: TypeAlias - added:
variable RealtimeToolsConfigParam: TypeAlias - added:
variable RealtimeToolsConfigUnionParam: TypeAlias
- added:
class Mcp(BaseModel) - added:
class McpAllowedToolsMcpToolFilter(BaseModel) - added:
class McpRequireApprovalMcpToolApprovalFilter(BaseModel) - added:
class McpRequireApprovalMcpToolApprovalFilterAlways(BaseModel) - added:
class McpRequireApprovalMcpToolApprovalFilterNever(BaseModel) - added:
field Mcp.allowed_tools: Optional[McpAllowedTools] - added:
field Mcp.authorization: Optional[str] - added:
field Mcp.connector_id: Optional[Literal['connector_dropbox', 'connector_gmail', 'connector_googlecalendar', 'connector_googledrive', 'connector_microsoftteams', 'connector_outlookcalendar', 'connector_outlookemail', 'connector_sharepoint']] - added:
field Mcp.headers: Optional[Dict[str, str]] - added:
field Mcp.require_approval: Optional[McpRequireApproval] - added:
field Mcp.server_description: Optional[str] - added:
field Mcp.server_label: str - added:
field Mcp.server_url: Optional[str] - added:
field Mcp.type: Literal['mcp'] - added:
field McpAllowedToolsMcpToolFilter.read_only: Optional[bool] - added:
field McpAllowedToolsMcpToolFilter.tool_names: Optional[List[str]] - added:
field McpRequireApprovalMcpToolApprovalFilter.always: Optional[McpRequireApprovalMcpToolApprovalFilterAlways] - added:
field McpRequireApprovalMcpToolApprovalFilter.never: Optional[McpRequireApprovalMcpToolApprovalFilterNever] - added:
field McpRequireApprovalMcpToolApprovalFilterAlways.read_only: Optional[bool] - added:
field McpRequireApprovalMcpToolApprovalFilterAlways.tool_names: Optional[List[str]] - added:
field McpRequireApprovalMcpToolApprovalFilterNever.read_only: Optional[bool] - added:
field McpRequireApprovalMcpToolApprovalFilterNever.tool_names: Optional[List[str]] - added:
variable McpAllowedTools: TypeAlias - added:
variable McpRequireApproval: TypeAlias - added:
variable RealtimeToolsConfigUnion: TypeAlias
- added:
class Mcp(TypedDict) - added:
class McpAllowedToolsMcpToolFilter(TypedDict) - added:
class McpRequireApprovalMcpToolApprovalFilter(TypedDict) - added:
class McpRequireApprovalMcpToolApprovalFilterAlways(TypedDict) - added:
class McpRequireApprovalMcpToolApprovalFilterNever(TypedDict) - added:
field Mcp.allowed_tools: Optional[McpAllowedTools] - added:
field Mcp.authorization: str - added:
field Mcp.connector_id: Literal['connector_dropbox', 'connector_gmail', 'connector_googlecalendar', 'connector_googledrive', 'connector_microsoftteams', 'connector_outlookcalendar', 'connector_outlookemail', 'connector_sharepoint'] - added:
field Mcp.headers: Optional[Dict[str, str]] - added:
field Mcp.require_approval: Optional[McpRequireApproval] - added:
field Mcp.server_description: str - added:
field Mcp.server_label: Required[str] - added:
field Mcp.server_url: str - added:
field Mcp.type: Required[Literal['mcp']] - added:
field McpAllowedToolsMcpToolFilter.read_only: bool - added:
field McpAllowedToolsMcpToolFilter.tool_names: SequenceNotStr[str] - added:
field McpRequireApprovalMcpToolApprovalFilter.always: McpRequireApprovalMcpToolApprovalFilterAlways - added:
field McpRequireApprovalMcpToolApprovalFilter.never: McpRequireApprovalMcpToolApprovalFilterNever - added:
field McpRequireApprovalMcpToolApprovalFilterAlways.read_only: bool - added:
field McpRequireApprovalMcpToolApprovalFilterAlways.tool_names: SequenceNotStr[str] - added:
field McpRequireApprovalMcpToolApprovalFilterNever.read_only: bool - added:
field McpRequireApprovalMcpToolApprovalFilterNever.tool_names: SequenceNotStr[str] - added:
variable McpAllowedTools: TypeAlias - added:
variable McpRequireApproval: TypeAlias - added:
variable RealtimeToolsConfigUnionParam: TypeAlias
- added:
class TracingConfiguration(BaseModel) - added:
field TracingConfiguration.group_id: Optional[str] - added:
field TracingConfiguration.metadata: Optional[object] - added:
field TracingConfiguration.workflow_name: Optional[str] - added:
variable RealtimeTracingConfig: TypeAlias
- added:
class TracingConfiguration(TypedDict) - added:
field TracingConfiguration.group_id: str - added:
field TracingConfiguration.metadata: object - added:
field TracingConfiguration.workflow_name: str - added:
variable RealtimeTracingConfigParam: TypeAlias
- added:
class RealtimeTranscriptionSessionAudio(BaseModel) - added:
field RealtimeTranscriptionSessionAudio.input: Optional[RealtimeTranscriptionSessionAudioInput]
- added:
class NoiseReduction(BaseModel) - added:
class RealtimeTranscriptionSessionAudioInput(BaseModel) - added:
field NoiseReduction.type: Optional[NoiseReductionType] - added:
field RealtimeTranscriptionSessionAudioInput.format: Optional[RealtimeAudioFormats] - added:
field RealtimeTranscriptionSessionAudioInput.noise_reduction: Optional[NoiseReduction] - added:
field RealtimeTranscriptionSessionAudioInput.transcription: Optional[AudioTranscription] - added:
field RealtimeTranscriptionSessionAudioInput.turn_detection: Optional[RealtimeTranscriptionSessionAudioInputTurnDetection]
- added:
class NoiseReduction(TypedDict) - added:
class RealtimeTranscriptionSessionAudioInputParam(TypedDict) - added:
field NoiseReduction.type: NoiseReductionType - added:
field RealtimeTranscriptionSessionAudioInputParam.format: RealtimeAudioFormatsParam - added:
field RealtimeTranscriptionSessionAudioInputParam.noise_reduction: NoiseReduction - added:
field RealtimeTranscriptionSessionAudioInputParam.transcription: AudioTranscriptionParam - added:
field RealtimeTranscriptionSessionAudioInputParam.turn_detection: Optional[RealtimeTranscriptionSessionAudioInputTurnDetectionParam]
- added:
class SemanticVad(BaseModel) - added:
class ServerVad(BaseModel) - added:
field SemanticVad.create_response: Optional[bool] - added:
field SemanticVad.eagerness: Optional[Literal['low', 'medium', 'high', 'auto']] - added:
field SemanticVad.interrupt_response: Optional[bool] - added:
field SemanticVad.type: Literal['semantic_vad'] - added:
field ServerVad.create_response: Optional[bool] - added:
field ServerVad.idle_timeout_ms: Optional[int] - added:
field ServerVad.interrupt_response: Optional[bool] - added:
field ServerVad.prefix_padding_ms: Optional[int] - added:
field ServerVad.silence_duration_ms: Optional[int] - added:
field ServerVad.threshold: Optional[float] - added:
field ServerVad.type: Literal['server_vad'] - added:
variable RealtimeTranscriptionSessionAudioInputTurnDetection: TypeAlias
- added:
class SemanticVad(TypedDict) - added:
class ServerVad(TypedDict) - added:
field SemanticVad.create_response: bool - added:
field SemanticVad.eagerness: Literal['low', 'medium', 'high', 'auto'] - added:
field SemanticVad.interrupt_response: bool - added:
field SemanticVad.type: Required[Literal['semantic_vad']] - added:
field ServerVad.create_response: bool - added:
field ServerVad.idle_timeout_ms: Optional[int] - added:
field ServerVad.interrupt_response: bool - added:
field ServerVad.prefix_padding_ms: int - added:
field ServerVad.silence_duration_ms: int - added:
field ServerVad.threshold: float - added:
field ServerVad.type: Required[Literal['server_vad']] - added:
variable RealtimeTranscriptionSessionAudioInputTurnDetectionParam: TypeAlias
- added:
class RealtimeTranscriptionSessionAudioParam(TypedDict) - added:
field RealtimeTranscriptionSessionAudioParam.input: RealtimeTranscriptionSessionAudioInputParam
- added:
class RealtimeTranscriptionSessionCreateRequest(BaseModel) - added:
field RealtimeTranscriptionSessionCreateRequest.audio: Optional[RealtimeTranscriptionSessionAudio] - added:
field RealtimeTranscriptionSessionCreateRequest.include: Optional[List[Literal['item.input_audio_transcription.logprobs']]] - added:
field RealtimeTranscriptionSessionCreateRequest.type: Literal['transcription']
- added:
class RealtimeTranscriptionSessionCreateRequestParam(TypedDict) - added:
field RealtimeTranscriptionSessionCreateRequestParam.audio: RealtimeTranscriptionSessionAudioParam - added:
field RealtimeTranscriptionSessionCreateRequestParam.include: List[Literal['item.input_audio_transcription.logprobs']] - added:
field RealtimeTranscriptionSessionCreateRequestParam.type: Required[Literal['transcription']]
- added:
class Audio(BaseModel) - added:
class AudioInput(BaseModel) - added:
class AudioInputNoiseReduction(BaseModel) - added:
class RealtimeTranscriptionSessionCreateResponse(BaseModel) - added:
field Audio.input: Optional[AudioInput] - added:
field AudioInput.format: Optional[RealtimeAudioFormats] - added:
field AudioInput.noise_reduction: Optional[AudioInputNoiseReduction] - added:
field AudioInput.transcription: Optional[AudioTranscription] - added:
field AudioInput.turn_detection: Optional[RealtimeTranscriptionSessionTurnDetection] - added:
field AudioInputNoiseReduction.type: Optional[NoiseReductionType] - added:
field RealtimeTranscriptionSessionCreateResponse.audio: Optional[Audio] - added:
field RealtimeTranscriptionSessionCreateResponse.expires_at: Optional[int] - added:
field RealtimeTranscriptionSessionCreateResponse.id: str - added:
field RealtimeTranscriptionSessionCreateResponse.include: Optional[List[Literal['item.input_audio_transcription.logprobs']]] - added:
field RealtimeTranscriptionSessionCreateResponse.object: str - added:
field RealtimeTranscriptionSessionCreateResponse.type: Literal['transcription']
- added:
class RealtimeTranscriptionSessionTurnDetection(BaseModel) - added:
field RealtimeTranscriptionSessionTurnDetection.prefix_padding_ms: Optional[int] - added:
field RealtimeTranscriptionSessionTurnDetection.silence_duration_ms: Optional[int] - added:
field RealtimeTranscriptionSessionTurnDetection.threshold: Optional[float] - added:
field RealtimeTranscriptionSessionTurnDetection.type: Optional[str]
- added:
variable RealtimeTruncation: TypeAlias
- added:
variable RealtimeTruncationParam: TypeAlias
- added:
class RealtimeTruncationRetentionRatio(BaseModel) - added:
field RealtimeTruncationRetentionRatio.retention_ratio: float - added:
field RealtimeTruncationRetentionRatio.type: Literal['retention_ratio']
- added:
class RealtimeTruncationRetentionRatioParam(TypedDict) - added:
field RealtimeTruncationRetentionRatioParam.retention_ratio: Required[float] - added:
field RealtimeTruncationRetentionRatioParam.type: Required[Literal['retention_ratio']]
- added:
class ResponseAudioDeltaEvent(BaseModel) - added:
field ResponseAudioDeltaEvent.content_index: int - added:
field ResponseAudioDeltaEvent.delta: str - added:
field ResponseAudioDeltaEvent.event_id: str - added:
field ResponseAudioDeltaEvent.item_id: str - added:
field ResponseAudioDeltaEvent.output_index: int - added:
field ResponseAudioDeltaEvent.response_id: str - added:
field ResponseAudioDeltaEvent.type: Literal['response.output_audio.delta']
- added:
class ResponseAudioDoneEvent(BaseModel) - added:
field ResponseAudioDoneEvent.content_index: int - added:
field ResponseAudioDoneEvent.event_id: str - added:
field ResponseAudioDoneEvent.item_id: str - added:
field ResponseAudioDoneEvent.output_index: int - added:
field ResponseAudioDoneEvent.response_id: str - added:
field ResponseAudioDoneEvent.type: Literal['response.output_audio.done']
- added:
class ResponseAudioTranscriptDeltaEvent(BaseModel) - added:
field ResponseAudioTranscriptDeltaEvent.content_index: int - added:
field ResponseAudioTranscriptDeltaEvent.delta: str - added:
field ResponseAudioTranscriptDeltaEvent.event_id: str - added:
field ResponseAudioTranscriptDeltaEvent.item_id: str - added:
field ResponseAudioTranscriptDeltaEvent.output_index: int - added:
field ResponseAudioTranscriptDeltaEvent.response_id: str - added:
field ResponseAudioTranscriptDeltaEvent.type: Literal['response.output_audio_transcript.delta']
- added:
class ResponseAudioTranscriptDoneEvent(BaseModel) - added:
field ResponseAudioTranscriptDoneEvent.content_index: int - added:
field ResponseAudioTranscriptDoneEvent.event_id: str - added:
field ResponseAudioTranscriptDoneEvent.item_id: str - added:
field ResponseAudioTranscriptDoneEvent.output_index: int - added:
field ResponseAudioTranscriptDoneEvent.response_id: str - added:
field ResponseAudioTranscriptDoneEvent.transcript: str - added:
field ResponseAudioTranscriptDoneEvent.type: Literal['response.output_audio_transcript.done']
- added:
class ResponseCancelEvent(BaseModel) - added:
field ResponseCancelEvent.event_id: Optional[str] - added:
field ResponseCancelEvent.response_id: Optional[str] - added:
field ResponseCancelEvent.type: Literal['response.cancel']
- added:
class ResponseCancelEventParam(TypedDict) - added:
field ResponseCancelEventParam.event_id: str - added:
field ResponseCancelEventParam.response_id: str - added:
field ResponseCancelEventParam.type: Required[Literal['response.cancel']]
- added:
class Part(BaseModel) - added:
class ResponseContentPartAddedEvent(BaseModel) - added:
field Part.audio: Optional[str] - added:
field Part.text: Optional[str] - added:
field Part.transcript: Optional[str] - added:
field Part.type: Optional[Literal['text', 'audio']] - added:
field ResponseContentPartAddedEvent.content_index: int - added:
field ResponseContentPartAddedEvent.event_id: str - added:
field ResponseContentPartAddedEvent.item_id: str - added:
field ResponseContentPartAddedEvent.output_index: int - added:
field ResponseContentPartAddedEvent.part: Part - added:
field ResponseContentPartAddedEvent.response_id: str - added:
field ResponseContentPartAddedEvent.type: Literal['response.content_part.added']
- added:
class Part(BaseModel) - added:
class ResponseContentPartDoneEvent(BaseModel) - added:
field Part.audio: Optional[str] - added:
field Part.text: Optional[str] - added:
field Part.transcript: Optional[str] - added:
field Part.type: Optional[Literal['text', 'audio']] - added:
field ResponseContentPartDoneEvent.content_index: int - added:
field ResponseContentPartDoneEvent.event_id: str - added:
field ResponseContentPartDoneEvent.item_id: str - added:
field ResponseContentPartDoneEvent.output_index: int - added:
field ResponseContentPartDoneEvent.part: Part - added:
field ResponseContentPartDoneEvent.response_id: str - added:
field ResponseContentPartDoneEvent.type: Literal['response.content_part.done']
- added:
class ResponseCreateEvent(BaseModel) - added:
field ResponseCreateEvent.event_id: Optional[str] - added:
field ResponseCreateEvent.response: Optional[RealtimeResponseCreateParams] - added:
field ResponseCreateEvent.type: Literal['response.create']
- added:
class ResponseCreateEventParam(TypedDict) - added:
field ResponseCreateEventParam.event_id: str - added:
field ResponseCreateEventParam.response: RealtimeResponseCreateParamsParam - added:
field ResponseCreateEventParam.type: Required[Literal['response.create']]
- added:
class ResponseCreatedEvent(BaseModel) - added:
field ResponseCreatedEvent.event_id: str - added:
field ResponseCreatedEvent.response: RealtimeResponse - added:
field ResponseCreatedEvent.type: Literal['response.created']
- added:
class ResponseDoneEvent(BaseModel) - added:
field ResponseDoneEvent.event_id: str - added:
field ResponseDoneEvent.response: RealtimeResponse - added:
field ResponseDoneEvent.type: Literal['response.done']
- added:
class ResponseFunctionCallArgumentsDeltaEvent(BaseModel) - added:
field ResponseFunctionCallArgumentsDeltaEvent.call_id: str - added:
field ResponseFunctionCallArgumentsDeltaEvent.delta: str - added:
field ResponseFunctionCallArgumentsDeltaEvent.event_id: str - added:
field ResponseFunctionCallArgumentsDeltaEvent.item_id: str - added:
field ResponseFunctionCallArgumentsDeltaEvent.output_index: int - added:
field ResponseFunctionCallArgumentsDeltaEvent.response_id: str - added:
field ResponseFunctionCallArgumentsDeltaEvent.type: Literal['response.function_call_arguments.delta']
- added:
class ResponseFunctionCallArgumentsDoneEvent(BaseModel) - added:
field ResponseFunctionCallArgumentsDoneEvent.arguments: str - added:
field ResponseFunctionCallArgumentsDoneEvent.call_id: str - added:
field ResponseFunctionCallArgumentsDoneEvent.event_id: str - added:
field ResponseFunctionCallArgumentsDoneEvent.item_id: str - added:
field ResponseFunctionCallArgumentsDoneEvent.output_index: int - added:
field ResponseFunctionCallArgumentsDoneEvent.response_id: str - added:
field ResponseFunctionCallArgumentsDoneEvent.type: Literal['response.function_call_arguments.done']
- added:
class ResponseMcpCallArgumentsDelta(BaseModel) - added:
field ResponseMcpCallArgumentsDelta.delta: str - added:
field ResponseMcpCallArgumentsDelta.event_id: str - added:
field ResponseMcpCallArgumentsDelta.item_id: str - added:
field ResponseMcpCallArgumentsDelta.obfuscation: Optional[str] - added:
field ResponseMcpCallArgumentsDelta.output_index: int - added:
field ResponseMcpCallArgumentsDelta.response_id: str - added:
field ResponseMcpCallArgumentsDelta.type: Literal['response.mcp_call_arguments.delta']
- added:
class ResponseMcpCallArgumentsDone(BaseModel) - added:
field ResponseMcpCallArgumentsDone.arguments: str - added:
field ResponseMcpCallArgumentsDone.event_id: str - added:
field ResponseMcpCallArgumentsDone.item_id: str - added:
field ResponseMcpCallArgumentsDone.output_index: int - added:
field ResponseMcpCallArgumentsDone.response_id: str - added:
field ResponseMcpCallArgumentsDone.type: Literal['response.mcp_call_arguments.done']
- added:
class ResponseMcpCallCompleted(BaseModel) - added:
field ResponseMcpCallCompleted.event_id: str - added:
field ResponseMcpCallCompleted.item_id: str - added:
field ResponseMcpCallCompleted.output_index: int - added:
field ResponseMcpCallCompleted.type: Literal['response.mcp_call.completed']
- added:
class ResponseMcpCallFailed(BaseModel) - added:
field ResponseMcpCallFailed.event_id: str - added:
field ResponseMcpCallFailed.item_id: str - added:
field ResponseMcpCallFailed.output_index: int - added:
field ResponseMcpCallFailed.type: Literal['response.mcp_call.failed']
- added:
class ResponseMcpCallInProgress(BaseModel) - added:
field ResponseMcpCallInProgress.event_id: str - added:
field ResponseMcpCallInProgress.item_id: str - added:
field ResponseMcpCallInProgress.output_index: int - added:
field ResponseMcpCallInProgress.type: Literal['response.mcp_call.in_progress']
- added:
class ResponseOutputItemAddedEvent(BaseModel) - added:
field ResponseOutputItemAddedEvent.event_id: str - added:
field ResponseOutputItemAddedEvent.item: ConversationItem - added:
field ResponseOutputItemAddedEvent.output_index: int - added:
field ResponseOutputItemAddedEvent.response_id: str - added:
field ResponseOutputItemAddedEvent.type: Literal['response.output_item.added']
- added:
class ResponseOutputItemDoneEvent(BaseModel) - added:
field ResponseOutputItemDoneEvent.event_id: str - added:
field ResponseOutputItemDoneEvent.item: ConversationItem - added:
field ResponseOutputItemDoneEvent.output_index: int - added:
field ResponseOutputItemDoneEvent.response_id: str - added:
field ResponseOutputItemDoneEvent.type: Literal['response.output_item.done']
- added:
class ResponseTextDeltaEvent(BaseModel) - added:
field ResponseTextDeltaEvent.content_index: int - added:
field ResponseTextDeltaEvent.delta: str - added:
field ResponseTextDeltaEvent.event_id: str - added:
field ResponseTextDeltaEvent.item_id: str - added:
field ResponseTextDeltaEvent.output_index: int - added:
field ResponseTextDeltaEvent.response_id: str - added:
field ResponseTextDeltaEvent.type: Literal['response.output_text.delta']
- added:
class ResponseTextDoneEvent(BaseModel) - added:
field ResponseTextDoneEvent.content_index: int - added:
field ResponseTextDoneEvent.event_id: str - added:
field ResponseTextDoneEvent.item_id: str - added:
field ResponseTextDoneEvent.output_index: int - added:
field ResponseTextDoneEvent.response_id: str - added:
field ResponseTextDoneEvent.text: str - added:
field ResponseTextDoneEvent.type: Literal['response.output_text.done']
- added:
class SessionCreatedEvent(BaseModel) - added:
field SessionCreatedEvent.event_id: str - added:
field SessionCreatedEvent.session: Session - added:
field SessionCreatedEvent.type: Literal['session.created'] - added:
variable Session: TypeAlias
- added:
class SessionUpdateEvent(BaseModel) - added:
field SessionUpdateEvent.event_id: Optional[str] - added:
field SessionUpdateEvent.session: Session - added:
field SessionUpdateEvent.type: Literal['session.update'] - added:
variable Session: TypeAlias
- added:
class SessionUpdateEventParam(TypedDict) - added:
field SessionUpdateEventParam.event_id: str - added:
field SessionUpdateEventParam.session: Required[Session] - added:
field SessionUpdateEventParam.type: Required[Literal['session.update']] - added:
variable Session: TypeAlias
- added:
class SessionUpdatedEvent(BaseModel) - added:
field SessionUpdatedEvent.event_id: str - added:
field SessionUpdatedEvent.session: Session - added:
field SessionUpdatedEvent.type: Literal['session.updated'] - added:
variable Session: TypeAlias
- added:
export ComputerTool - added:
export ComputerToolParam - added:
export CustomTool - added:
export CustomToolParam - added:
export EasyInputMessage - added:
export EasyInputMessageParam - added:
export FileSearchTool - added:
export FileSearchToolParam - added:
export FunctionTool - added:
export FunctionToolParam - added:
export InputItemListParams - added:
export ParsedContent - added:
export ParsedResponse - added:
export ParsedResponseFunctionToolCall - added:
export ParsedResponseOutputItem - added:
export ParsedResponseOutputMessage - added:
export ParsedResponseOutputText - added:
export Response - added:
export ResponseAudioDeltaEvent - added:
export ResponseAudioDoneEvent - added:
export ResponseAudioTranscriptDeltaEvent - added:
export ResponseAudioTranscriptDoneEvent - added:
export ResponseCodeInterpreterCallCodeDeltaEvent - added:
export ResponseCodeInterpreterCallCodeDoneEvent - added:
export ResponseCodeInterpreterCallCompletedEvent - added:
export ResponseCodeInterpreterCallInProgressEvent - added:
export ResponseCodeInterpreterCallInterpretingEvent - added:
export ResponseCodeInterpreterToolCall - added:
export ResponseCodeInterpreterToolCallParam - added:
export ResponseCompletedEvent - added:
export ResponseComputerToolCall - added:
export ResponseComputerToolCallOutputItem - added:
export ResponseComputerToolCallOutputScreenshot - added:
export ResponseComputerToolCallOutputScreenshotParam - added:
export ResponseComputerToolCallParam - added:
export ResponseContentPartAddedEvent - added:
export ResponseContentPartDoneEvent - added:
export ResponseConversationParam - added:
export ResponseCreateParams - added:
export ResponseCreatedEvent - added:
export ResponseCustomToolCall - added:
export ResponseCustomToolCallInputDeltaEvent - added:
export ResponseCustomToolCallInputDoneEvent - added:
export ResponseCustomToolCallOutput - added:
export ResponseCustomToolCallOutputParam - added:
export ResponseCustomToolCallParam - added:
export ResponseError - added:
export ResponseErrorEvent - added:
export ResponseFailedEvent - added:
export ResponseFileSearchCallCompletedEvent - added:
export ResponseFileSearchCallInProgressEvent - added:
export ResponseFileSearchCallSearchingEvent - added:
export ResponseFileSearchToolCall - added:
export ResponseFileSearchToolCallParam - added:
export ResponseFormatTextConfig - added:
export ResponseFormatTextConfigParam - added:
export ResponseFormatTextJSONSchemaConfig - added:
export ResponseFormatTextJSONSchemaConfigParam - added:
export ResponseFunctionCallArgumentsDeltaEvent - added:
export ResponseFunctionCallArgumentsDoneEvent - added:
export ResponseFunctionToolCall - added:
export ResponseFunctionToolCallItem - added:
export ResponseFunctionToolCallOutputItem - added:
export ResponseFunctionToolCallParam - added:
export ResponseFunctionWebSearch - added:
export ResponseFunctionWebSearchParam - added:
export ResponseImageGenCallCompletedEvent - added:
export ResponseImageGenCallGeneratingEvent - added:
export ResponseImageGenCallInProgressEvent - added:
export ResponseImageGenCallPartialImageEvent - added:
export ResponseInProgressEvent - added:
export ResponseIncludable - added:
export ResponseIncompleteEvent - added:
export ResponseInputAudio - added:
export ResponseInputAudioParam - added:
export ResponseInputContent - added:
export ResponseInputContentParam - added:
export ResponseInputFile - added:
export ResponseInputFileParam - added:
export ResponseInputImage - added:
export ResponseInputImageParam - added:
export ResponseInputItem - added:
export ResponseInputItemParam - added:
export ResponseInputMessageContentList - added:
export ResponseInputMessageContentListParam - added:
export ResponseInputMessageItem - added:
export ResponseInputParam - added:
export ResponseInputText - added:
export ResponseInputTextParam - added:
export ResponseItem - added:
export ResponseItemList - added:
export ResponseMcpCallArgumentsDeltaEvent - added:
export ResponseMcpCallArgumentsDoneEvent - added:
export ResponseMcpCallCompletedEvent - added:
export ResponseMcpCallFailedEvent - added:
export ResponseMcpCallInProgressEvent - added:
export ResponseMcpListToolsCompletedEvent - added:
export ResponseMcpListToolsFailedEvent - added:
export ResponseMcpListToolsInProgressEvent - added:
export ResponseOutputItem - added:
export ResponseOutputItemAddedEvent - added:
export ResponseOutputItemDoneEvent - added:
export ResponseOutputMessage - added:
export ResponseOutputMessageParam - added:
export ResponseOutputRefusal - added:
export ResponseOutputRefusalParam - added:
export ResponseOutputText - added:
export ResponseOutputTextAnnotationAddedEvent - added:
export ResponseOutputTextParam - added:
export ResponsePrompt - added:
export ResponsePromptParam - added:
export ResponseQueuedEvent - added:
export ResponseReasoningItem - added:
export ResponseReasoningItemParam - added:
export ResponseReasoningSummaryPartAddedEvent - added:
export ResponseReasoningSummaryPartDoneEvent - added:
export ResponseReasoningSummaryTextDeltaEvent - added:
export ResponseReasoningSummaryTextDoneEvent - added:
export ResponseReasoningTextDeltaEvent - added:
export ResponseReasoningTextDoneEvent - added:
export ResponseRefusalDeltaEvent - added:
export ResponseRefusalDoneEvent - added:
export ResponseRetrieveParams - added:
export ResponseStatus - added:
export ResponseStreamEvent - added:
export ResponseTextConfig - added:
export ResponseTextConfigParam - added:
export ResponseTextDeltaEvent - added:
export ResponseTextDoneEvent - added:
export ResponseUsage - added:
export ResponseWebSearchCallCompletedEvent - added:
export ResponseWebSearchCallInProgressEvent - added:
export ResponseWebSearchCallSearchingEvent - added:
export Tool - added:
export ToolChoiceAllowed - added:
export ToolChoiceAllowedParam - added:
export ToolChoiceCustom - added:
export ToolChoiceCustomParam - added:
export ToolChoiceFunction - added:
export ToolChoiceFunctionParam - added:
export ToolChoiceMcp - added:
export ToolChoiceMcpParam - added:
export ToolChoiceOptions - added:
export ToolChoiceTypes - added:
export ToolChoiceTypesParam - added:
export ToolParam - added:
export WebSearchPreviewTool - added:
export WebSearchPreviewToolParam - added:
export WebSearchTool - added:
export WebSearchToolParam
- added:
class ComputerTool(BaseModel) - added:
field ComputerTool.display_height: int - added:
field ComputerTool.display_width: int - added:
field ComputerTool.environment: Literal['windows', 'mac', 'linux', 'ubuntu', 'browser'] - added:
field ComputerTool.type: Literal['computer_use_preview']
- added:
class ComputerToolParam(TypedDict) - added:
field ComputerToolParam.display_height: Required[int] - added:
field ComputerToolParam.display_width: Required[int] - added:
field ComputerToolParam.environment: Required[Literal['windows', 'mac', 'linux', 'ubuntu', 'browser']] - added:
field ComputerToolParam.type: Required[Literal['computer_use_preview']]
- added:
class CustomTool(BaseModel) - added:
field CustomTool.description: Optional[str] - added:
field CustomTool.format: Optional[CustomToolInputFormat] - added:
field CustomTool.name: str - added:
field CustomTool.type: Literal['custom']
- added:
class CustomToolParam(TypedDict) - added:
field CustomToolParam.description: str - added:
field CustomToolParam.format: CustomToolInputFormat - added:
field CustomToolParam.name: Required[str] - added:
field CustomToolParam.type: Required[Literal['custom']]
- added:
class EasyInputMessage(BaseModel) - added:
field EasyInputMessage.content: Union[str, ResponseInputMessageContentList] - added:
field EasyInputMessage.role: Literal['user', 'assistant', 'system', 'developer'] - added:
field EasyInputMessage.type: Optional[Literal['message']]
- added:
class EasyInputMessageParam(TypedDict) - added:
field EasyInputMessageParam.content: Required[Union[str, ResponseInputMessageContentListParam]] - added:
field EasyInputMessageParam.role: Required[Literal['user', 'assistant', 'system', 'developer']] - added:
field EasyInputMessageParam.type: Literal['message']
- added:
class FileSearchTool(BaseModel) - added:
class RankingOptions(BaseModel) - added:
field FileSearchTool.filters: Optional[Filters] - added:
field FileSearchTool.max_num_results: Optional[int] - added:
field FileSearchTool.ranking_options: Optional[RankingOptions] - added:
field FileSearchTool.type: Literal['file_search'] - added:
field FileSearchTool.vector_store_ids: List[str] - added:
field RankingOptions.ranker: Optional[Literal['auto', 'default-2024-11-15']] - added:
field RankingOptions.score_threshold: Optional[float] - added:
variable Filters: TypeAlias
- added:
class FileSearchToolParam(TypedDict) - added:
class RankingOptions(TypedDict) - added:
field FileSearchToolParam.filters: Optional[Filters] - added:
field FileSearchToolParam.max_num_results: int - added:
field FileSearchToolParam.ranking_options: RankingOptions - added:
field FileSearchToolParam.type: Required[Literal['file_search']] - added:
field FileSearchToolParam.vector_store_ids: Required[SequenceNotStr[str]] - added:
field RankingOptions.ranker: Literal['auto', 'default-2024-11-15'] - added:
field RankingOptions.score_threshold: float - added:
variable Filters: TypeAlias
- added:
class FunctionTool(BaseModel) - added:
field FunctionTool.description: Optional[str] - added:
field FunctionTool.name: str - added:
field FunctionTool.parameters: Optional[Dict[str, object]] - added:
field FunctionTool.strict: Optional[bool] - added:
field FunctionTool.type: Literal['function']
- added:
class FunctionToolParam(TypedDict) - added:
field FunctionToolParam.description: Optional[str] - added:
field FunctionToolParam.name: Required[str] - added:
field FunctionToolParam.parameters: Required[Optional[Dict[str, object]]] - added:
field FunctionToolParam.strict: Required[Optional[bool]] - added:
field FunctionToolParam.type: Required[Literal['function']]
- added:
class InputItemListParams(TypedDict) - added:
field InputItemListParams.after: str - added:
field InputItemListParams.include: List[ResponseIncludable] - added:
field InputItemListParams.limit: int - added:
field InputItemListParams.order: Literal['asc', 'desc']
- added:
class ParsedResponse(Response, GenericModel, Generic[ContentType]) - added:
class ParsedResponseOutputMessage(ResponseOutputMessage, GenericModel, Generic[ContentType]) - added:
class ParsedResponseOutputText(ResponseOutputText, GenericModel, Generic[ContentType]) - added:
field ParsedResponse.output: List[ParsedResponseOutputItem[ContentType]] - added:
field ParsedResponse.output: List[ParsedResponseOutputItem] - added:
field ParsedResponseOutputMessage.content: List[ParsedContent[ContentType]] - added:
field ParsedResponseOutputMessage.content: List[ParsedContent] - added:
field ParsedResponseOutputText.parsed: Optional[ContentType] - added:
property ParsedResponse.output_parsed -> Optional[ContentType]
- added:
class Conversation(BaseModel) - added:
class IncompleteDetails(BaseModel) - added:
class Response(BaseModel) - added:
field Conversation.id: str - added:
field IncompleteDetails.reason: Optional[Literal['max_output_tokens', 'content_filter']] - added:
field Response.background: Optional[bool] - added:
field Response.conversation: Optional[Conversation] - added:
field Response.created_at: float - added:
field Response.error: Optional[ResponseError] - added:
field Response.id: str - added:
field Response.incomplete_details: Optional[IncompleteDetails] - added:
field Response.instructions: Union[str, List[ResponseInputItem], None] - added:
field Response.max_output_tokens: Optional[int] - added:
field Response.max_tool_calls: Optional[int] - added:
field Response.metadata: Optional[Metadata] - added:
field Response.model: ResponsesModel - added:
field Response.object: Literal['response'] - added:
field Response.output: List[ResponseOutputItem] - added:
field Response.parallel_tool_calls: bool - added:
field Response.previous_response_id: Optional[str] - added:
field Response.prompt: Optional[ResponsePrompt] - added:
field Response.prompt_cache_key: Optional[str] - added:
field Response.reasoning: Optional[Reasoning] - added:
field Response.safety_identifier: Optional[str] - added:
field Response.service_tier: Optional[Literal['auto', 'default', 'flex', 'scale', 'priority']] - added:
field Response.status: Optional[ResponseStatus] - added:
field Response.temperature: Optional[float] - added:
field Response.text: Optional[ResponseTextConfig] - added:
field Response.tool_choice: ToolChoice - added:
field Response.tools: List[Tool] - added:
field Response.top_logprobs: Optional[int] - added:
field Response.top_p: Optional[float] - added:
field Response.truncation: Optional[Literal['auto', 'disabled']] - added:
field Response.usage: Optional[ResponseUsage] - added:
field Response.user: Optional[str] - added:
property Response.output_text -> str - added:
variable ToolChoice: TypeAlias
- added:
class ResponseAudioDeltaEvent(BaseModel) - added:
field ResponseAudioDeltaEvent.delta: str - added:
field ResponseAudioDeltaEvent.sequence_number: int - added:
field ResponseAudioDeltaEvent.type: Literal['response.audio.delta']
- added:
class ResponseAudioDoneEvent(BaseModel) - added:
field ResponseAudioDoneEvent.sequence_number: int - added:
field ResponseAudioDoneEvent.type: Literal['response.audio.done']
- added:
class ResponseAudioTranscriptDeltaEvent(BaseModel) - added:
field ResponseAudioTranscriptDeltaEvent.delta: str - added:
field ResponseAudioTranscriptDeltaEvent.sequence_number: int - added:
field ResponseAudioTranscriptDeltaEvent.type: Literal['response.audio.transcript.delta']
- added:
class ResponseAudioTranscriptDoneEvent(BaseModel) - added:
field ResponseAudioTranscriptDoneEvent.sequence_number: int - added:
field ResponseAudioTranscriptDoneEvent.type: Literal['response.audio.transcript.done']
- added:
class ResponseCodeInterpreterCallCodeDeltaEvent(BaseModel) - added:
field ResponseCodeInterpreterCallCodeDeltaEvent.delta: str - added:
field ResponseCodeInterpreterCallCodeDeltaEvent.item_id: str - added:
field ResponseCodeInterpreterCallCodeDeltaEvent.output_index: int - added:
field ResponseCodeInterpreterCallCodeDeltaEvent.sequence_number: int - added:
field ResponseCodeInterpreterCallCodeDeltaEvent.type: Literal['response.code_interpreter_call_code.delta']
- added:
class ResponseCodeInterpreterCallCodeDoneEvent(BaseModel) - added:
field ResponseCodeInterpreterCallCodeDoneEvent.code: str - added:
field ResponseCodeInterpreterCallCodeDoneEvent.item_id: str - added:
field ResponseCodeInterpreterCallCodeDoneEvent.output_index: int - added:
field ResponseCodeInterpreterCallCodeDoneEvent.sequence_number: int - added:
field ResponseCodeInterpreterCallCodeDoneEvent.type: Literal['response.code_interpreter_call_code.done']
- added:
class ResponseCodeInterpreterCallCompletedEvent(BaseModel) - added:
field ResponseCodeInterpreterCallCompletedEvent.item_id: str - added:
field ResponseCodeInterpreterCallCompletedEvent.output_index: int - added:
field ResponseCodeInterpreterCallCompletedEvent.sequence_number: int - added:
field ResponseCodeInterpreterCallCompletedEvent.type: Literal['response.code_interpreter_call.completed']
- added:
class ResponseCodeInterpreterCallInProgressEvent(BaseModel) - added:
field ResponseCodeInterpreterCallInProgressEvent.item_id: str - added:
field ResponseCodeInterpreterCallInProgressEvent.output_index: int - added:
field ResponseCodeInterpreterCallInProgressEvent.sequence_number: int - added:
field ResponseCodeInterpreterCallInProgressEvent.type: Literal['response.code_interpreter_call.in_progress']
- added:
class ResponseCodeInterpreterCallInterpretingEvent(BaseModel) - added:
field ResponseCodeInterpreterCallInterpretingEvent.item_id: str - added:
field ResponseCodeInterpreterCallInterpretingEvent.output_index: int - added:
field ResponseCodeInterpreterCallInterpretingEvent.sequence_number: int - added:
field ResponseCodeInterpreterCallInterpretingEvent.type: Literal['response.code_interpreter_call.interpreting']
- added:
class OutputImage(BaseModel) - added:
class OutputLogs(BaseModel) - added:
class ResponseCodeInterpreterToolCall(BaseModel) - added:
field OutputImage.type: Literal['image'] - added:
field OutputImage.url: str - added:
field OutputLogs.logs: str - added:
field OutputLogs.type: Literal['logs'] - added:
field ResponseCodeInterpreterToolCall.code: Optional[str] - added:
field ResponseCodeInterpreterToolCall.container_id: str - added:
field ResponseCodeInterpreterToolCall.id: str - added:
field ResponseCodeInterpreterToolCall.outputs: Optional[List[Output]] - added:
field ResponseCodeInterpreterToolCall.status: Literal['in_progress', 'completed', 'incomplete', 'interpreting', 'failed'] - added:
field ResponseCodeInterpreterToolCall.type: Literal['code_interpreter_call'] - added:
variable Output: TypeAlias
- added:
class OutputImage(TypedDict) - added:
class OutputLogs(TypedDict) - added:
class ResponseCodeInterpreterToolCallParam(TypedDict) - added:
field OutputImage.type: Required[Literal['image']] - added:
field OutputImage.url: Required[str] - added:
field OutputLogs.logs: Required[str] - added:
field OutputLogs.type: Required[Literal['logs']] - added:
field ResponseCodeInterpreterToolCallParam.code: Required[Optional[str]] - added:
field ResponseCodeInterpreterToolCallParam.container_id: Required[str] - added:
field ResponseCodeInterpreterToolCallParam.id: Required[str] - added:
field ResponseCodeInterpreterToolCallParam.outputs: Required[Optional[Iterable[Output]]] - added:
field ResponseCodeInterpreterToolCallParam.status: Required[Literal['in_progress', 'completed', 'incomplete', 'interpreting', 'failed']] - added:
field ResponseCodeInterpreterToolCallParam.type: Required[Literal['code_interpreter_call']] - added:
variable Output: TypeAlias
- added:
class ResponseCompletedEvent(BaseModel) - added:
field ResponseCompletedEvent.response: Response - added:
field ResponseCompletedEvent.sequence_number: int - added:
field ResponseCompletedEvent.type: Literal['response.completed']
- added:
class ActionClick(BaseModel) - added:
class ActionDoubleClick(BaseModel) - added:
class ActionDrag(BaseModel) - added:
class ActionDragPath(BaseModel) - added:
class ActionKeypress(BaseModel) - added:
class ActionMove(BaseModel) - added:
class ActionScreenshot(BaseModel) - added:
class ActionScroll(BaseModel) - added:
class ActionType(BaseModel) - added:
class ActionWait(BaseModel) - added:
class PendingSafetyCheck(BaseModel) - added:
class ResponseComputerToolCall(BaseModel) - added:
field ActionClick.button: Literal['left', 'right', 'wheel', 'back', 'forward'] - added:
field ActionClick.type: Literal['click'] - added:
field ActionClick.x: int - added:
field ActionClick.y: int - added:
field ActionDoubleClick.type: Literal['double_click'] - added:
field ActionDoubleClick.x: int - added:
field ActionDoubleClick.y: int - added:
field ActionDrag.path: List[ActionDragPath] - added:
field ActionDrag.type: Literal['drag'] - added:
field ActionDragPath.x: int - added:
field ActionDragPath.y: int - added:
field ActionKeypress.keys: List[str] - added:
field ActionKeypress.type: Literal['keypress'] - added:
field ActionMove.type: Literal['move'] - added:
field ActionMove.x: int - added:
field ActionMove.y: int - added:
field ActionScreenshot.type: Literal['screenshot'] - added:
field ActionScroll.scroll_x: int - added:
field ActionScroll.scroll_y: int - added:
field ActionScroll.type: Literal['scroll'] - added:
field ActionScroll.x: int - added:
field ActionScroll.y: int - added:
field ActionType.text: str - added:
field ActionType.type: Literal['type'] - added:
field ActionWait.type: Literal['wait'] - added:
field PendingSafetyCheck.code: str - added:
field PendingSafetyCheck.id: str - added:
field PendingSafetyCheck.message: str - added:
field ResponseComputerToolCall.action: Action - added:
field ResponseComputerToolCall.call_id: str - added:
field ResponseComputerToolCall.id: str - added:
field ResponseComputerToolCall.pending_safety_checks: List[PendingSafetyCheck] - added:
field ResponseComputerToolCall.status: Literal['in_progress', 'completed', 'incomplete'] - added:
field ResponseComputerToolCall.type: Literal['computer_call'] - added:
variable Action: TypeAlias
- added:
class AcknowledgedSafetyCheck(BaseModel) - added:
class ResponseComputerToolCallOutputItem(BaseModel) - added:
field AcknowledgedSafetyCheck.code: str - added:
field AcknowledgedSafetyCheck.id: str - added:
field AcknowledgedSafetyCheck.message: str - added:
field ResponseComputerToolCallOutputItem.acknowledged_safety_checks: Optional[List[AcknowledgedSafetyCheck]] - added:
field ResponseComputerToolCallOutputItem.call_id: str - added:
field ResponseComputerToolCallOutputItem.id: str - added:
field ResponseComputerToolCallOutputItem.output: ResponseComputerToolCallOutputScreenshot - added:
field ResponseComputerToolCallOutputItem.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field ResponseComputerToolCallOutputItem.type: Literal['computer_call_output']
- added:
class ResponseComputerToolCallOutputScreenshot(BaseModel) - added:
field ResponseComputerToolCallOutputScreenshot.file_id: Optional[str] - added:
field ResponseComputerToolCallOutputScreenshot.image_url: Optional[str] - added:
field ResponseComputerToolCallOutputScreenshot.type: Literal['computer_screenshot']
- added:
class ResponseComputerToolCallOutputScreenshotParam(TypedDict) - added:
field ResponseComputerToolCallOutputScreenshotParam.file_id: str - added:
field ResponseComputerToolCallOutputScreenshotParam.image_url: str - added:
field ResponseComputerToolCallOutputScreenshotParam.type: Required[Literal['computer_screenshot']]
- added:
class ActionClick(TypedDict) - added:
class ActionDoubleClick(TypedDict) - added:
class ActionDrag(TypedDict) - added:
class ActionDragPath(TypedDict) - added:
class ActionKeypress(TypedDict) - added:
class ActionMove(TypedDict) - added:
class ActionScreenshot(TypedDict) - added:
class ActionScroll(TypedDict) - added:
class ActionType(TypedDict) - added:
class ActionWait(TypedDict) - added:
class PendingSafetyCheck(TypedDict) - added:
class ResponseComputerToolCallParam(TypedDict) - added:
field ActionClick.button: Required[Literal['left', 'right', 'wheel', 'back', 'forward']] - added:
field ActionClick.type: Required[Literal['click']] - added:
field ActionClick.x: Required[int] - added:
field ActionClick.y: Required[int] - added:
field ActionDoubleClick.type: Required[Literal['double_click']] - added:
field ActionDoubleClick.x: Required[int] - added:
field ActionDoubleClick.y: Required[int] - added:
field ActionDrag.path: Required[Iterable[ActionDragPath]] - added:
field ActionDrag.type: Required[Literal['drag']] - added:
field ActionDragPath.x: Required[int] - added:
field ActionDragPath.y: Required[int] - added:
field ActionKeypress.keys: Required[SequenceNotStr[str]] - added:
field ActionKeypress.type: Required[Literal['keypress']] - added:
field ActionMove.type: Required[Literal['move']] - added:
field ActionMove.x: Required[int] - added:
field ActionMove.y: Required[int] - added:
field ActionScreenshot.type: Required[Literal['screenshot']] - added:
field ActionScroll.scroll_x: Required[int] - added:
field ActionScroll.scroll_y: Required[int] - added:
field ActionScroll.type: Required[Literal['scroll']] - added:
field ActionScroll.x: Required[int] - added:
field ActionScroll.y: Required[int] - added:
field ActionType.text: Required[str] - added:
field ActionType.type: Required[Literal['type']] - added:
field ActionWait.type: Required[Literal['wait']] - added:
field PendingSafetyCheck.code: Required[str] - added:
field PendingSafetyCheck.id: Required[str] - added:
field PendingSafetyCheck.message: Required[str] - added:
field ResponseComputerToolCallParam.action: Required[Action] - added:
field ResponseComputerToolCallParam.call_id: Required[str] - added:
field ResponseComputerToolCallParam.id: Required[str] - added:
field ResponseComputerToolCallParam.pending_safety_checks: Required[Iterable[PendingSafetyCheck]] - added:
field ResponseComputerToolCallParam.status: Required[Literal['in_progress', 'completed', 'incomplete']] - added:
field ResponseComputerToolCallParam.type: Required[Literal['computer_call']] - added:
variable Action: TypeAlias
- added:
class PartReasoningText(BaseModel) - added:
class ResponseContentPartAddedEvent(BaseModel) - added:
field PartReasoningText.text: str - added:
field PartReasoningText.type: Literal['reasoning_text'] - added:
field ResponseContentPartAddedEvent.content_index: int - added:
field ResponseContentPartAddedEvent.item_id: str - added:
field ResponseContentPartAddedEvent.output_index: int - added:
field ResponseContentPartAddedEvent.part: Part - added:
field ResponseContentPartAddedEvent.sequence_number: int - added:
field ResponseContentPartAddedEvent.type: Literal['response.content_part.added'] - added:
variable Part: TypeAlias
- added:
class PartReasoningText(BaseModel) - added:
class ResponseContentPartDoneEvent(BaseModel) - added:
field PartReasoningText.text: str - added:
field PartReasoningText.type: Literal['reasoning_text'] - added:
field ResponseContentPartDoneEvent.content_index: int - added:
field ResponseContentPartDoneEvent.item_id: str - added:
field ResponseContentPartDoneEvent.output_index: int - added:
field ResponseContentPartDoneEvent.part: Part - added:
field ResponseContentPartDoneEvent.sequence_number: int - added:
field ResponseContentPartDoneEvent.type: Literal['response.content_part.done'] - added:
variable Part: TypeAlias
- added:
class ResponseConversationParam(TypedDict) - added:
field ResponseConversationParam.id: Required[str]
- added:
class ResponseCreateParamsBase(TypedDict) - added:
class ResponseCreateParamsNonStreaming(ResponseCreateParamsBase) - added:
class ResponseCreateParamsStreaming(ResponseCreateParamsBase) - added:
class StreamOptions(TypedDict) - added:
field ResponseCreateParamsBase.background: Optional[bool] - added:
field ResponseCreateParamsBase.conversation: Optional[Conversation] - added:
field ResponseCreateParamsBase.include: Optional[List[ResponseIncludable]] - added:
field ResponseCreateParamsBase.input: Union[str, ResponseInputParam] - added:
field ResponseCreateParamsBase.instructions: Optional[str] - added:
field ResponseCreateParamsBase.max_output_tokens: Optional[int] - added:
field ResponseCreateParamsBase.max_tool_calls: Optional[int] - added:
field ResponseCreateParamsBase.metadata: Optional[Metadata] - added:
field ResponseCreateParamsBase.model: ResponsesModel - added:
field ResponseCreateParamsBase.parallel_tool_calls: Optional[bool] - added:
field ResponseCreateParamsBase.previous_response_id: Optional[str] - added:
field ResponseCreateParamsBase.prompt: Optional[ResponsePromptParam] - added:
field ResponseCreateParamsBase.prompt_cache_key: str - added:
field ResponseCreateParamsBase.reasoning: Optional[Reasoning] - added:
field ResponseCreateParamsBase.safety_identifier: str - added:
field ResponseCreateParamsBase.service_tier: Optional[Literal['auto', 'default', 'flex', 'scale', 'priority']] - added:
field ResponseCreateParamsBase.store: Optional[bool] - added:
field ResponseCreateParamsBase.stream_options: Optional[StreamOptions] - added:
field ResponseCreateParamsBase.temperature: Optional[float] - added:
field ResponseCreateParamsBase.text: ResponseTextConfigParam - added:
field ResponseCreateParamsBase.tool_choice: ToolChoice - added:
field ResponseCreateParamsBase.tools: Iterable[ToolParam] - added:
field ResponseCreateParamsBase.top_logprobs: Optional[int] - added:
field ResponseCreateParamsBase.top_p: Optional[float] - added:
field ResponseCreateParamsBase.truncation: Optional[Literal['auto', 'disabled']] - added:
field ResponseCreateParamsBase.user: str - added:
field ResponseCreateParamsNonStreaming.stream: Optional[Literal[False]] - added:
field ResponseCreateParamsStreaming.stream: Required[Literal[True]] - added:
field StreamOptions.include_obfuscation: bool - added:
variable Conversation: TypeAlias - added:
variable ToolChoice: TypeAlias
- added:
class ResponseCreatedEvent(BaseModel) - added:
field ResponseCreatedEvent.response: Response - added:
field ResponseCreatedEvent.sequence_number: int - added:
field ResponseCreatedEvent.type: Literal['response.created']
- added:
class ResponseCustomToolCall(BaseModel) - added:
field ResponseCustomToolCall.call_id: str - added:
field ResponseCustomToolCall.id: Optional[str] - added:
field ResponseCustomToolCall.input: str - added:
field ResponseCustomToolCall.name: str - added:
field ResponseCustomToolCall.type: Literal['custom_tool_call']
- added:
class ResponseCustomToolCallInputDeltaEvent(BaseModel) - added:
field ResponseCustomToolCallInputDeltaEvent.delta: str - added:
field ResponseCustomToolCallInputDeltaEvent.item_id: str - added:
field ResponseCustomToolCallInputDeltaEvent.output_index: int - added:
field ResponseCustomToolCallInputDeltaEvent.sequence_number: int - added:
field ResponseCustomToolCallInputDeltaEvent.type: Literal['response.custom_tool_call_input.delta']
- added:
class ResponseCustomToolCallInputDoneEvent(BaseModel) - added:
field ResponseCustomToolCallInputDoneEvent.input: str - added:
field ResponseCustomToolCallInputDoneEvent.item_id: str - added:
field ResponseCustomToolCallInputDoneEvent.output_index: int - added:
field ResponseCustomToolCallInputDoneEvent.sequence_number: int - added:
field ResponseCustomToolCallInputDoneEvent.type: Literal['response.custom_tool_call_input.done']
- added:
class ResponseCustomToolCallOutput(BaseModel) - added:
field ResponseCustomToolCallOutput.call_id: str - added:
field ResponseCustomToolCallOutput.id: Optional[str] - added:
field ResponseCustomToolCallOutput.output: str - added:
field ResponseCustomToolCallOutput.type: Literal['custom_tool_call_output']
- added:
class ResponseCustomToolCallOutputParam(TypedDict) - added:
field ResponseCustomToolCallOutputParam.call_id: Required[str] - added:
field ResponseCustomToolCallOutputParam.id: str - added:
field ResponseCustomToolCallOutputParam.output: Required[str] - added:
field ResponseCustomToolCallOutputParam.type: Required[Literal['custom_tool_call_output']]
- added:
class ResponseCustomToolCallParam(TypedDict) - added:
field ResponseCustomToolCallParam.call_id: Required[str] - added:
field ResponseCustomToolCallParam.id: str - added:
field ResponseCustomToolCallParam.input: Required[str] - added:
field ResponseCustomToolCallParam.name: Required[str] - added:
field ResponseCustomToolCallParam.type: Required[Literal['custom_tool_call']]
- added:
class ResponseError(BaseModel) - added:
field ResponseError.code: Literal['server_error', 'rate_limit_exceeded', 'invalid_prompt', 'vector_store_timeout', 'invalid_image', 'invalid_image_format', 'invalid_base64_image', 'invalid_image_url', 'image_too_large', 'image_too_small', 'image_parse_error', 'image_content_policy_violation', 'invalid_image_mode', 'image_file_too_large', 'unsupported_image_media_type', 'empty_image_file', 'failed… - added:
field ResponseError.message: str
- added:
class ResponseErrorEvent(BaseModel) - added:
field ResponseErrorEvent.code: Optional[str] - added:
field ResponseErrorEvent.message: str - added:
field ResponseErrorEvent.param: Optional[str] - added:
field ResponseErrorEvent.sequence_number: int - added:
field ResponseErrorEvent.type: Literal['error']
- added:
class ResponseFailedEvent(BaseModel) - added:
field ResponseFailedEvent.response: Response - added:
field ResponseFailedEvent.sequence_number: int - added:
field ResponseFailedEvent.type: Literal['response.failed']
- added:
class ResponseFileSearchCallCompletedEvent(BaseModel) - added:
field ResponseFileSearchCallCompletedEvent.item_id: str - added:
field ResponseFileSearchCallCompletedEvent.output_index: int - added:
field ResponseFileSearchCallCompletedEvent.sequence_number: int - added:
field ResponseFileSearchCallCompletedEvent.type: Literal['response.file_search_call.completed']
- added:
class ResponseFileSearchCallInProgressEvent(BaseModel) - added:
field ResponseFileSearchCallInProgressEvent.item_id: str - added:
field ResponseFileSearchCallInProgressEvent.output_index: int - added:
field ResponseFileSearchCallInProgressEvent.sequence_number: int - added:
field ResponseFileSearchCallInProgressEvent.type: Literal['response.file_search_call.in_progress']
- added:
class ResponseFileSearchCallSearchingEvent(BaseModel) - added:
field ResponseFileSearchCallSearchingEvent.item_id: str - added:
field ResponseFileSearchCallSearchingEvent.output_index: int - added:
field ResponseFileSearchCallSearchingEvent.sequence_number: int - added:
field ResponseFileSearchCallSearchingEvent.type: Literal['response.file_search_call.searching']
- added:
class ResponseFileSearchToolCall(BaseModel) - added:
class Result(BaseModel) - added:
field ResponseFileSearchToolCall.id: str - added:
field ResponseFileSearchToolCall.queries: List[str] - added:
field ResponseFileSearchToolCall.results: Optional[List[Result]] - added:
field ResponseFileSearchToolCall.status: Literal['in_progress', 'searching', 'completed', 'incomplete', 'failed'] - added:
field ResponseFileSearchToolCall.type: Literal['file_search_call'] - added:
field Result.attributes: Optional[Dict[str, Union[str, float, bool]]] - added:
field Result.file_id: Optional[str] - added:
field Result.filename: Optional[str] - added:
field Result.score: Optional[float] - added:
field Result.text: Optional[str]
- added:
class ResponseFileSearchToolCallParam(TypedDict) - added:
class Result(TypedDict) - added:
field ResponseFileSearchToolCallParam.id: Required[str] - added:
field ResponseFileSearchToolCallParam.queries: Required[SequenceNotStr[str]] - added:
field ResponseFileSearchToolCallParam.results: Optional[Iterable[Result]] - added:
field ResponseFileSearchToolCallParam.status: Required[Literal['in_progress', 'searching', 'completed', 'incomplete', 'failed']] - added:
field ResponseFileSearchToolCallParam.type: Required[Literal['file_search_call']] - added:
field Result.attributes: Optional[Dict[str, Union[str, float, bool]]] - added:
field Result.file_id: str - added:
field Result.filename: str - added:
field Result.score: float - added:
field Result.text: str
- added:
variable ResponseFormatTextConfig: TypeAlias
- added:
variable ResponseFormatTextConfigParam: TypeAlias
- added:
class ResponseFormatTextJSONSchemaConfig(BaseModel) - added:
field ResponseFormatTextJSONSchemaConfig.description: Optional[str] - added:
field ResponseFormatTextJSONSchemaConfig.name: str - added:
field ResponseFormatTextJSONSchemaConfig.schema_: Dict[str, object] - added:
field ResponseFormatTextJSONSchemaConfig.strict: Optional[bool] - added:
field ResponseFormatTextJSONSchemaConfig.type: Literal['json_schema']
- added:
class ResponseFormatTextJSONSchemaConfigParam(TypedDict) - added:
field ResponseFormatTextJSONSchemaConfigParam.description: str - added:
field ResponseFormatTextJSONSchemaConfigParam.name: Required[str] - added:
field ResponseFormatTextJSONSchemaConfigParam.schema: Required[Dict[str, object]] - added:
field ResponseFormatTextJSONSchemaConfigParam.strict: Optional[bool] - added:
field ResponseFormatTextJSONSchemaConfigParam.type: Required[Literal['json_schema']]
- added:
class ResponseFunctionCallArgumentsDeltaEvent(BaseModel) - added:
field ResponseFunctionCallArgumentsDeltaEvent.delta: str - added:
field ResponseFunctionCallArgumentsDeltaEvent.item_id: str - added:
field ResponseFunctionCallArgumentsDeltaEvent.output_index: int - added:
field ResponseFunctionCallArgumentsDeltaEvent.sequence_number: int - added:
field ResponseFunctionCallArgumentsDeltaEvent.type: Literal['response.function_call_arguments.delta']
- added:
class ResponseFunctionCallArgumentsDoneEvent(BaseModel) - added:
field ResponseFunctionCallArgumentsDoneEvent.arguments: str - added:
field ResponseFunctionCallArgumentsDoneEvent.item_id: str - added:
field ResponseFunctionCallArgumentsDoneEvent.output_index: int - added:
field ResponseFunctionCallArgumentsDoneEvent.sequence_number: int - added:
field ResponseFunctionCallArgumentsDoneEvent.type: Literal['response.function_call_arguments.done']
- added:
class ResponseFunctionToolCall(BaseModel) - added:
field ResponseFunctionToolCall.arguments: str - added:
field ResponseFunctionToolCall.call_id: str - added:
field ResponseFunctionToolCall.id: Optional[str] - added:
field ResponseFunctionToolCall.name: str - added:
field ResponseFunctionToolCall.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field ResponseFunctionToolCall.type: Literal['function_call']
- added:
class ResponseFunctionToolCallItem(ResponseFunctionToolCall) - added:
field ResponseFunctionToolCallItem.id: str
- added:
class ResponseFunctionToolCallOutputItem(BaseModel) - added:
field ResponseFunctionToolCallOutputItem.call_id: str - added:
field ResponseFunctionToolCallOutputItem.id: str - added:
field ResponseFunctionToolCallOutputItem.output: str - added:
field ResponseFunctionToolCallOutputItem.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field ResponseFunctionToolCallOutputItem.type: Literal['function_call_output']
- added:
class ResponseFunctionToolCallParam(TypedDict) - added:
field ResponseFunctionToolCallParam.arguments: Required[str] - added:
field ResponseFunctionToolCallParam.call_id: Required[str] - added:
field ResponseFunctionToolCallParam.id: str - added:
field ResponseFunctionToolCallParam.name: Required[str] - added:
field ResponseFunctionToolCallParam.status: Literal['in_progress', 'completed', 'incomplete'] - added:
field ResponseFunctionToolCallParam.type: Required[Literal['function_call']]
- added:
class ActionFind(BaseModel) - added:
class ActionOpenPage(BaseModel) - added:
class ActionSearch(BaseModel) - added:
class ActionSearchSource(BaseModel) - added:
class ResponseFunctionWebSearch(BaseModel) - added:
field ActionFind.pattern: str - added:
field ActionFind.type: Literal['find'] - added:
field ActionFind.url: str - added:
field ActionOpenPage.type: Literal['open_page'] - added:
field ActionOpenPage.url: str - added:
field ActionSearch.query: str - added:
field ActionSearch.sources: Optional[List[ActionSearchSource]] - added:
field ActionSearch.type: Literal['search'] - added:
field ActionSearchSource.type: Literal['url'] - added:
field ActionSearchSource.url: str - added:
field ResponseFunctionWebSearch.action: Action - added:
field ResponseFunctionWebSearch.id: str - added:
field ResponseFunctionWebSearch.status: Literal['in_progress', 'searching', 'completed', 'failed'] - added:
field ResponseFunctionWebSearch.type: Literal['web_search_call'] - added:
variable Action: TypeAlias
- added:
class ActionFind(TypedDict) - added:
class ActionOpenPage(TypedDict) - added:
class ActionSearch(TypedDict) - added:
class ActionSearchSource(TypedDict) - added:
class ResponseFunctionWebSearchParam(TypedDict) - added:
field ActionFind.pattern: Required[str] - added:
field ActionFind.type: Required[Literal['find']] - added:
field ActionFind.url: Required[str] - added:
field ActionOpenPage.type: Required[Literal['open_page']] - added:
field ActionOpenPage.url: Required[str] - added:
field ActionSearch.query: Required[str] - added:
field ActionSearch.sources: Iterable[ActionSearchSource] - added:
field ActionSearch.type: Required[Literal['search']] - added:
field ActionSearchSource.type: Required[Literal['url']] - added:
field ActionSearchSource.url: Required[str] - added:
field ResponseFunctionWebSearchParam.action: Required[Action] - added:
field ResponseFunctionWebSearchParam.id: Required[str] - added:
field ResponseFunctionWebSearchParam.status: Required[Literal['in_progress', 'searching', 'completed', 'failed']] - added:
field ResponseFunctionWebSearchParam.type: Required[Literal['web_search_call']] - added:
variable Action: TypeAlias
- added:
class ResponseImageGenCallCompletedEvent(BaseModel) - added:
field ResponseImageGenCallCompletedEvent.item_id: str - added:
field ResponseImageGenCallCompletedEvent.output_index: int - added:
field ResponseImageGenCallCompletedEvent.sequence_number: int - added:
field ResponseImageGenCallCompletedEvent.type: Literal['response.image_generation_call.completed']
- added:
class ResponseImageGenCallGeneratingEvent(BaseModel) - added:
field ResponseImageGenCallGeneratingEvent.item_id: str - added:
field ResponseImageGenCallGeneratingEvent.output_index: int - added:
field ResponseImageGenCallGeneratingEvent.sequence_number: int - added:
field ResponseImageGenCallGeneratingEvent.type: Literal['response.image_generation_call.generating']
- added:
class ResponseImageGenCallInProgressEvent(BaseModel) - added:
field ResponseImageGenCallInProgressEvent.item_id: str - added:
field ResponseImageGenCallInProgressEvent.output_index: int - added:
field ResponseImageGenCallInProgressEvent.sequence_number: int - added:
field ResponseImageGenCallInProgressEvent.type: Literal['response.image_generation_call.in_progress']
- added:
class ResponseImageGenCallPartialImageEvent(BaseModel) - added:
field ResponseImageGenCallPartialImageEvent.item_id: str - added:
field ResponseImageGenCallPartialImageEvent.output_index: int - added:
field ResponseImageGenCallPartialImageEvent.partial_image_b64: str - added:
field ResponseImageGenCallPartialImageEvent.partial_image_index: int - added:
field ResponseImageGenCallPartialImageEvent.sequence_number: int - added:
field ResponseImageGenCallPartialImageEvent.type: Literal['response.image_generation_call.partial_image']
- added:
class ResponseInProgressEvent(BaseModel) - added:
field ResponseInProgressEvent.response: Response - added:
field ResponseInProgressEvent.sequence_number: int - added:
field ResponseInProgressEvent.type: Literal['response.in_progress']
- added:
variable ResponseIncludable: TypeAlias
- added:
class ResponseIncompleteEvent(BaseModel) - added:
field ResponseIncompleteEvent.response: Response - added:
field ResponseIncompleteEvent.sequence_number: int - added:
field ResponseIncompleteEvent.type: Literal['response.incomplete']
- added:
class InputAudio(BaseModel) - added:
class ResponseInputAudio(BaseModel) - added:
field InputAudio.data: str - added:
field InputAudio.format: Literal['mp3', 'wav'] - added:
field ResponseInputAudio.input_audio: InputAudio - added:
field ResponseInputAudio.type: Literal['input_audio']
- added:
class InputAudio(TypedDict) - added:
class ResponseInputAudioParam(TypedDict) - added:
field InputAudio.data: Required[str] - added:
field InputAudio.format: Required[Literal['mp3', 'wav']] - added:
field ResponseInputAudioParam.input_audio: Required[InputAudio] - added:
field ResponseInputAudioParam.type: Required[Literal['input_audio']]
- added:
variable ResponseInputContent: TypeAlias
- added:
variable ResponseInputContentParam: TypeAlias
- added:
class ResponseInputFile(BaseModel) - added:
field ResponseInputFile.file_data: Optional[str] - added:
field ResponseInputFile.file_id: Optional[str] - added:
field ResponseInputFile.file_url: Optional[str] - added:
field ResponseInputFile.filename: Optional[str] - added:
field ResponseInputFile.type: Literal['input_file']
- added:
class ResponseInputFileParam(TypedDict) - added:
field ResponseInputFileParam.file_data: str - added:
field ResponseInputFileParam.file_id: Optional[str] - added:
field ResponseInputFileParam.file_url: str - added:
field ResponseInputFileParam.filename: str - added:
field ResponseInputFileParam.type: Required[Literal['input_file']]
- added:
class ResponseInputImage(BaseModel) - added:
field ResponseInputImage.detail: Literal['low', 'high', 'auto'] - added:
field ResponseInputImage.file_id: Optional[str] - added:
field ResponseInputImage.image_url: Optional[str] - added:
field ResponseInputImage.type: Literal['input_image']
- added:
class ResponseInputImageParam(TypedDict) - added:
field ResponseInputImageParam.detail: Required[Literal['low', 'high', 'auto']] - added:
field ResponseInputImageParam.file_id: Optional[str] - added:
field ResponseInputImageParam.image_url: Optional[str] - added:
field ResponseInputImageParam.type: Required[Literal['input_image']]
- added:
class ComputerCallOutput(BaseModel) - added:
class ComputerCallOutputAcknowledgedSafetyCheck(BaseModel) - added:
class FunctionCallOutput(BaseModel) - added:
class ImageGenerationCall(BaseModel) - added:
class ItemReference(BaseModel) - added:
class LocalShellCall(BaseModel) - added:
class LocalShellCallAction(BaseModel) - added:
class LocalShellCallOutput(BaseModel) - added:
class McpApprovalRequest(BaseModel) - added:
class McpApprovalResponse(BaseModel) - added:
class McpCall(BaseModel) - added:
class McpListTools(BaseModel) - added:
class McpListToolsTool(BaseModel) - added:
class Message(BaseModel) - added:
field ComputerCallOutput.acknowledged_safety_checks: Optional[List[ComputerCallOutputAcknowledgedSafetyCheck]] - added:
field ComputerCallOutput.call_id: str - added:
field ComputerCallOutput.id: Optional[str] - added:
field ComputerCallOutput.output: ResponseComputerToolCallOutputScreenshot - added:
field ComputerCallOutput.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field ComputerCallOutput.type: Literal['computer_call_output'] - added:
field ComputerCallOutputAcknowledgedSafetyCheck.code: Optional[str] - added:
field ComputerCallOutputAcknowledgedSafetyCheck.id: str - added:
field ComputerCallOutputAcknowledgedSafetyCheck.message: Optional[str] - added:
field FunctionCallOutput.call_id: str - added:
field FunctionCallOutput.id: Optional[str] - added:
field FunctionCallOutput.output: str - added:
field FunctionCallOutput.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field FunctionCallOutput.type: Literal['function_call_output'] - added:
field ImageGenerationCall.id: str - added:
field ImageGenerationCall.result: Optional[str] - added:
field ImageGenerationCall.status: Literal['in_progress', 'completed', 'generating', 'failed'] - added:
field ImageGenerationCall.type: Literal['image_generation_call'] - added:
field ItemReference.id: str - added:
field ItemReference.type: Optional[Literal['item_reference']] - added:
field LocalShellCall.action: LocalShellCallAction - added:
field LocalShellCall.call_id: str - added:
field LocalShellCall.id: str - added:
field LocalShellCall.status: Literal['in_progress', 'completed', 'incomplete'] - added:
field LocalShellCall.type: Literal['local_shell_call'] - added:
field LocalShellCallAction.command: List[str] - added:
field LocalShellCallAction.env: Dict[str, str] - added:
field LocalShellCallAction.timeout_ms: Optional[int] - added:
field LocalShellCallAction.type: Literal['exec'] - added:
field LocalShellCallAction.user: Optional[str] - added:
field LocalShellCallAction.working_directory: Optional[str] - added:
field LocalShellCallOutput.id: str - added:
field LocalShellCallOutput.output: str - added:
field LocalShellCallOutput.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field LocalShellCallOutput.type: Literal['local_shell_call_output'] - added:
field McpApprovalRequest.arguments: str - added:
field McpApprovalRequest.id: str - added:
field McpApprovalRequest.name: str - added:
field McpApprovalRequest.server_label: str - added:
field McpApprovalRequest.type: Literal['mcp_approval_request'] - added:
field McpApprovalResponse.approval_request_id: str - added:
field McpApprovalResponse.approve: bool - added:
field McpApprovalResponse.id: Optional[str] - added:
field McpApprovalResponse.reason: Optional[str] - added:
field McpApprovalResponse.type: Literal['mcp_approval_response'] - added:
field McpCall.arguments: str - added:
field McpCall.error: Optional[str] - added:
field McpCall.id: str - added:
field McpCall.name: str - added:
field McpCall.output: Optional[str] - added:
field McpCall.server_label: str - added:
field McpCall.type: Literal['mcp_call'] - added:
field McpListTools.error: Optional[str] - added:
field McpListTools.id: str - added:
field McpListTools.server_label: str - added:
field McpListTools.tools: List[McpListToolsTool] - added:
field McpListTools.type: Literal['mcp_list_tools'] - added:
field McpListToolsTool.annotations: Optional[object] - added:
field McpListToolsTool.description: Optional[str] - added:
field McpListToolsTool.input_schema: object - added:
field McpListToolsTool.name: str - added:
field Message.content: ResponseInputMessageContentList - added:
field Message.role: Literal['user', 'system', 'developer'] - added:
field Message.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field Message.type: Optional[Literal['message']] - added:
variable ResponseInputItem: TypeAlias
- added:
class ComputerCallOutput(TypedDict) - added:
class ComputerCallOutputAcknowledgedSafetyCheck(TypedDict) - added:
class FunctionCallOutput(TypedDict) - added:
class ImageGenerationCall(TypedDict) - added:
class ItemReference(TypedDict) - added:
class LocalShellCall(TypedDict) - added:
class LocalShellCallAction(TypedDict) - added:
class LocalShellCallOutput(TypedDict) - added:
class McpApprovalRequest(TypedDict) - added:
class McpApprovalResponse(TypedDict) - added:
class McpCall(TypedDict) - added:
class McpListTools(TypedDict) - added:
class McpListToolsTool(TypedDict) - added:
class Message(TypedDict) - added:
field ComputerCallOutput.acknowledged_safety_checks: Optional[Iterable[ComputerCallOutputAcknowledgedSafetyCheck]] - added:
field ComputerCallOutput.call_id: Required[str] - added:
field ComputerCallOutput.id: Optional[str] - added:
field ComputerCallOutput.output: Required[ResponseComputerToolCallOutputScreenshotParam] - added:
field ComputerCallOutput.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field ComputerCallOutput.type: Required[Literal['computer_call_output']] - added:
field ComputerCallOutputAcknowledgedSafetyCheck.code: Optional[str] - added:
field ComputerCallOutputAcknowledgedSafetyCheck.id: Required[str] - added:
field ComputerCallOutputAcknowledgedSafetyCheck.message: Optional[str] - added:
field FunctionCallOutput.call_id: Required[str] - added:
field FunctionCallOutput.id: Optional[str] - added:
field FunctionCallOutput.output: Required[str] - added:
field FunctionCallOutput.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field FunctionCallOutput.type: Required[Literal['function_call_output']] - added:
field ImageGenerationCall.id: Required[str] - added:
field ImageGenerationCall.result: Required[Optional[str]] - added:
field ImageGenerationCall.status: Required[Literal['in_progress', 'completed', 'generating', 'failed']] - added:
field ImageGenerationCall.type: Required[Literal['image_generation_call']] - added:
field ItemReference.id: Required[str] - added:
field ItemReference.type: Optional[Literal['item_reference']] - added:
field LocalShellCall.action: Required[LocalShellCallAction] - added:
field LocalShellCall.call_id: Required[str] - added:
field LocalShellCall.id: Required[str] - added:
field LocalShellCall.status: Required[Literal['in_progress', 'completed', 'incomplete']] - added:
field LocalShellCall.type: Required[Literal['local_shell_call']] - added:
field LocalShellCallAction.command: Required[SequenceNotStr[str]] - added:
field LocalShellCallAction.env: Required[Dict[str, str]] - added:
field LocalShellCallAction.timeout_ms: Optional[int] - added:
field LocalShellCallAction.type: Required[Literal['exec']] - added:
field LocalShellCallAction.user: Optional[str] - added:
field LocalShellCallAction.working_directory: Optional[str] - added:
field LocalShellCallOutput.id: Required[str] - added:
field LocalShellCallOutput.output: Required[str] - added:
field LocalShellCallOutput.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field LocalShellCallOutput.type: Required[Literal['local_shell_call_output']] - added:
field McpApprovalRequest.arguments: Required[str] - added:
field McpApprovalRequest.id: Required[str] - added:
field McpApprovalRequest.name: Required[str] - added:
field McpApprovalRequest.server_label: Required[str] - added:
field McpApprovalRequest.type: Required[Literal['mcp_approval_request']] - added:
field McpApprovalResponse.approval_request_id: Required[str] - added:
field McpApprovalResponse.approve: Required[bool] - added:
field McpApprovalResponse.id: Optional[str] - added:
field McpApprovalResponse.reason: Optional[str] - added:
field McpApprovalResponse.type: Required[Literal['mcp_approval_response']] - added:
field McpCall.arguments: Required[str] - added:
field McpCall.error: Optional[str] - added:
field McpCall.id: Required[str] - added:
field McpCall.name: Required[str] - added:
field McpCall.output: Optional[str] - added:
field McpCall.server_label: Required[str] - added:
field McpCall.type: Required[Literal['mcp_call']] - added:
field McpListTools.error: Optional[str] - added:
field McpListTools.id: Required[str] - added:
field McpListTools.server_label: Required[str] - added:
field McpListTools.tools: Required[Iterable[McpListToolsTool]] - added:
field McpListTools.type: Required[Literal['mcp_list_tools']] - added:
field McpListToolsTool.annotations: Optional[object] - added:
field McpListToolsTool.description: Optional[str] - added:
field McpListToolsTool.input_schema: Required[object] - added:
field McpListToolsTool.name: Required[str] - added:
field Message.content: Required[ResponseInputMessageContentListParam] - added:
field Message.role: Required[Literal['user', 'system', 'developer']] - added:
field Message.status: Literal['in_progress', 'completed', 'incomplete'] - added:
field Message.type: Literal['message'] - added:
variable ResponseInputItemParam: TypeAlias
- added:
variable ResponseInputMessageContentList: TypeAlias
- added:
variable ResponseInputContentParam: TypeAlias - added:
variable ResponseInputMessageContentListParam: TypeAlias
- added:
class ResponseInputMessageItem(BaseModel) - added:
field ResponseInputMessageItem.content: ResponseInputMessageContentList - added:
field ResponseInputMessageItem.id: str - added:
field ResponseInputMessageItem.role: Literal['user', 'system', 'developer'] - added:
field ResponseInputMessageItem.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field ResponseInputMessageItem.type: Optional[Literal['message']]
- added:
class ComputerCallOutput(TypedDict) - added:
class ComputerCallOutputAcknowledgedSafetyCheck(TypedDict) - added:
class FunctionCallOutput(TypedDict) - added:
class ImageGenerationCall(TypedDict) - added:
class ItemReference(TypedDict) - added:
class LocalShellCall(TypedDict) - added:
class LocalShellCallAction(TypedDict) - added:
class LocalShellCallOutput(TypedDict) - added:
class McpApprovalRequest(TypedDict) - added:
class McpApprovalResponse(TypedDict) - added:
class McpCall(TypedDict) - added:
class McpListTools(TypedDict) - added:
class McpListToolsTool(TypedDict) - added:
class Message(TypedDict) - added:
field ComputerCallOutput.acknowledged_safety_checks: Optional[Iterable[ComputerCallOutputAcknowledgedSafetyCheck]] - added:
field ComputerCallOutput.call_id: Required[str] - added:
field ComputerCallOutput.id: Optional[str] - added:
field ComputerCallOutput.output: Required[ResponseComputerToolCallOutputScreenshotParam] - added:
field ComputerCallOutput.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field ComputerCallOutput.type: Required[Literal['computer_call_output']] - added:
field ComputerCallOutputAcknowledgedSafetyCheck.code: Optional[str] - added:
field ComputerCallOutputAcknowledgedSafetyCheck.id: Required[str] - added:
field ComputerCallOutputAcknowledgedSafetyCheck.message: Optional[str] - added:
field FunctionCallOutput.call_id: Required[str] - added:
field FunctionCallOutput.id: Optional[str] - added:
field FunctionCallOutput.output: Required[str] - added:
field FunctionCallOutput.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field FunctionCallOutput.type: Required[Literal['function_call_output']] - added:
field ImageGenerationCall.id: Required[str] - added:
field ImageGenerationCall.result: Required[Optional[str]] - added:
field ImageGenerationCall.status: Required[Literal['in_progress', 'completed', 'generating', 'failed']] - added:
field ImageGenerationCall.type: Required[Literal['image_generation_call']] - added:
field ItemReference.id: Required[str] - added:
field ItemReference.type: Optional[Literal['item_reference']] - added:
field LocalShellCall.action: Required[LocalShellCallAction] - added:
field LocalShellCall.call_id: Required[str] - added:
field LocalShellCall.id: Required[str] - added:
field LocalShellCall.status: Required[Literal['in_progress', 'completed', 'incomplete']] - added:
field LocalShellCall.type: Required[Literal['local_shell_call']] - added:
field LocalShellCallAction.command: Required[SequenceNotStr[str]] - added:
field LocalShellCallAction.env: Required[Dict[str, str]] - added:
field LocalShellCallAction.timeout_ms: Optional[int] - added:
field LocalShellCallAction.type: Required[Literal['exec']] - added:
field LocalShellCallAction.user: Optional[str] - added:
field LocalShellCallAction.working_directory: Optional[str] - added:
field LocalShellCallOutput.id: Required[str] - added:
field LocalShellCallOutput.output: Required[str] - added:
field LocalShellCallOutput.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field LocalShellCallOutput.type: Required[Literal['local_shell_call_output']] - added:
field McpApprovalRequest.arguments: Required[str] - added:
field McpApprovalRequest.id: Required[str] - added:
field McpApprovalRequest.name: Required[str] - added:
field McpApprovalRequest.server_label: Required[str] - added:
field McpApprovalRequest.type: Required[Literal['mcp_approval_request']] - added:
field McpApprovalResponse.approval_request_id: Required[str] - added:
field McpApprovalResponse.approve: Required[bool] - added:
field McpApprovalResponse.id: Optional[str] - added:
field McpApprovalResponse.reason: Optional[str] - added:
field McpApprovalResponse.type: Required[Literal['mcp_approval_response']] - added:
field McpCall.arguments: Required[str] - added:
field McpCall.error: Optional[str] - added:
field McpCall.id: Required[str] - added:
field McpCall.name: Required[str] - added:
field McpCall.output: Optional[str] - added:
field McpCall.server_label: Required[str] - added:
field McpCall.type: Required[Literal['mcp_call']] - added:
field McpListTools.error: Optional[str] - added:
field McpListTools.id: Required[str] - added:
field McpListTools.server_label: Required[str] - added:
field McpListTools.tools: Required[Iterable[McpListToolsTool]] - added:
field McpListTools.type: Required[Literal['mcp_list_tools']] - added:
field McpListToolsTool.annotations: Optional[object] - added:
field McpListToolsTool.description: Optional[str] - added:
field McpListToolsTool.input_schema: Required[object] - added:
field McpListToolsTool.name: Required[str] - added:
field Message.content: Required[ResponseInputMessageContentListParam] - added:
field Message.role: Required[Literal['user', 'system', 'developer']] - added:
field Message.status: Literal['in_progress', 'completed', 'incomplete'] - added:
field Message.type: Literal['message'] - added:
variable ResponseInputItemParam: TypeAlias - added:
variable ResponseInputParam: TypeAlias
- added:
class ResponseInputText(BaseModel) - added:
field ResponseInputText.text: str - added:
field ResponseInputText.type: Literal['input_text']
- added:
class ResponseInputTextParam(TypedDict) - added:
field ResponseInputTextParam.text: Required[str] - added:
field ResponseInputTextParam.type: Required[Literal['input_text']]
- added:
class ImageGenerationCall(BaseModel) - added:
class LocalShellCall(BaseModel) - added:
class LocalShellCallAction(BaseModel) - added:
class LocalShellCallOutput(BaseModel) - added:
class McpApprovalRequest(BaseModel) - added:
class McpApprovalResponse(BaseModel) - added:
class McpCall(BaseModel) - added:
class McpListTools(BaseModel) - added:
class McpListToolsTool(BaseModel) - added:
field ImageGenerationCall.id: str - added:
field ImageGenerationCall.result: Optional[str] - added:
field ImageGenerationCall.status: Literal['in_progress', 'completed', 'generating', 'failed'] - added:
field ImageGenerationCall.type: Literal['image_generation_call'] - added:
field LocalShellCall.action: LocalShellCallAction - added:
field LocalShellCall.call_id: str - added:
field LocalShellCall.id: str - added:
field LocalShellCall.status: Literal['in_progress', 'completed', 'incomplete'] - added:
field LocalShellCall.type: Literal['local_shell_call'] - added:
field LocalShellCallAction.command: List[str] - added:
field LocalShellCallAction.env: Dict[str, str] - added:
field LocalShellCallAction.timeout_ms: Optional[int] - added:
field LocalShellCallAction.type: Literal['exec'] - added:
field LocalShellCallAction.user: Optional[str] - added:
field LocalShellCallAction.working_directory: Optional[str] - added:
field LocalShellCallOutput.id: str - added:
field LocalShellCallOutput.output: str - added:
field LocalShellCallOutput.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field LocalShellCallOutput.type: Literal['local_shell_call_output'] - added:
field McpApprovalRequest.arguments: str - added:
field McpApprovalRequest.id: str - added:
field McpApprovalRequest.name: str - added:
field McpApprovalRequest.server_label: str - added:
field McpApprovalRequest.type: Literal['mcp_approval_request'] - added:
field McpApprovalResponse.approval_request_id: str - added:
field McpApprovalResponse.approve: bool - added:
field McpApprovalResponse.id: str - added:
field McpApprovalResponse.reason: Optional[str] - added:
field McpApprovalResponse.type: Literal['mcp_approval_response'] - added:
field McpCall.arguments: str - added:
field McpCall.error: Optional[str] - added:
field McpCall.id: str - added:
field McpCall.name: str - added:
field McpCall.output: Optional[str] - added:
field McpCall.server_label: str - added:
field McpCall.type: Literal['mcp_call'] - added:
field McpListTools.error: Optional[str] - added:
field McpListTools.id: str - added:
field McpListTools.server_label: str - added:
field McpListTools.tools: List[McpListToolsTool] - added:
field McpListTools.type: Literal['mcp_list_tools'] - added:
field McpListToolsTool.annotations: Optional[object] - added:
field McpListToolsTool.description: Optional[str] - added:
field McpListToolsTool.input_schema: object - added:
field McpListToolsTool.name: str - added:
variable ResponseItem: TypeAlias
- added:
class ResponseItemList(BaseModel) - added:
field ResponseItemList.data: List[ResponseItem] - added:
field ResponseItemList.first_id: str - added:
field ResponseItemList.has_more: bool - added:
field ResponseItemList.last_id: str - added:
field ResponseItemList.object: Literal['list']
- added:
class ResponseMcpCallArgumentsDeltaEvent(BaseModel) - added:
field ResponseMcpCallArgumentsDeltaEvent.delta: str - added:
field ResponseMcpCallArgumentsDeltaEvent.item_id: str - added:
field ResponseMcpCallArgumentsDeltaEvent.output_index: int - added:
field ResponseMcpCallArgumentsDeltaEvent.sequence_number: int - added:
field ResponseMcpCallArgumentsDeltaEvent.type: Literal['response.mcp_call_arguments.delta']
- added:
class ResponseMcpCallArgumentsDoneEvent(BaseModel) - added:
field ResponseMcpCallArgumentsDoneEvent.arguments: str - added:
field ResponseMcpCallArgumentsDoneEvent.item_id: str - added:
field ResponseMcpCallArgumentsDoneEvent.output_index: int - added:
field ResponseMcpCallArgumentsDoneEvent.sequence_number: int - added:
field ResponseMcpCallArgumentsDoneEvent.type: Literal['response.mcp_call_arguments.done']
- added:
class ResponseMcpCallCompletedEvent(BaseModel) - added:
field ResponseMcpCallCompletedEvent.item_id: str - added:
field ResponseMcpCallCompletedEvent.output_index: int - added:
field ResponseMcpCallCompletedEvent.sequence_number: int - added:
field ResponseMcpCallCompletedEvent.type: Literal['response.mcp_call.completed']
- added:
class ResponseMcpCallFailedEvent(BaseModel) - added:
field ResponseMcpCallFailedEvent.item_id: str - added:
field ResponseMcpCallFailedEvent.output_index: int - added:
field ResponseMcpCallFailedEvent.sequence_number: int - added:
field ResponseMcpCallFailedEvent.type: Literal['response.mcp_call.failed']
- added:
class ResponseMcpCallInProgressEvent(BaseModel) - added:
field ResponseMcpCallInProgressEvent.item_id: str - added:
field ResponseMcpCallInProgressEvent.output_index: int - added:
field ResponseMcpCallInProgressEvent.sequence_number: int - added:
field ResponseMcpCallInProgressEvent.type: Literal['response.mcp_call.in_progress']
- added:
class ResponseMcpListToolsCompletedEvent(BaseModel) - added:
field ResponseMcpListToolsCompletedEvent.item_id: str - added:
field ResponseMcpListToolsCompletedEvent.output_index: int - added:
field ResponseMcpListToolsCompletedEvent.sequence_number: int - added:
field ResponseMcpListToolsCompletedEvent.type: Literal['response.mcp_list_tools.completed']
- added:
class ResponseMcpListToolsFailedEvent(BaseModel) - added:
field ResponseMcpListToolsFailedEvent.item_id: str - added:
field ResponseMcpListToolsFailedEvent.output_index: int - added:
field ResponseMcpListToolsFailedEvent.sequence_number: int - added:
field ResponseMcpListToolsFailedEvent.type: Literal['response.mcp_list_tools.failed']
- added:
class ResponseMcpListToolsInProgressEvent(BaseModel) - added:
field ResponseMcpListToolsInProgressEvent.item_id: str - added:
field ResponseMcpListToolsInProgressEvent.output_index: int - added:
field ResponseMcpListToolsInProgressEvent.sequence_number: int - added:
field ResponseMcpListToolsInProgressEvent.type: Literal['response.mcp_list_tools.in_progress']
- added:
class ImageGenerationCall(BaseModel) - added:
class LocalShellCall(BaseModel) - added:
class LocalShellCallAction(BaseModel) - added:
class McpApprovalRequest(BaseModel) - added:
class McpCall(BaseModel) - added:
class McpListTools(BaseModel) - added:
class McpListToolsTool(BaseModel) - added:
field ImageGenerationCall.id: str - added:
field ImageGenerationCall.result: Optional[str] - added:
field ImageGenerationCall.status: Literal['in_progress', 'completed', 'generating', 'failed'] - added:
field ImageGenerationCall.type: Literal['image_generation_call'] - added:
field LocalShellCall.action: LocalShellCallAction - added:
field LocalShellCall.call_id: str - added:
field LocalShellCall.id: str - added:
field LocalShellCall.status: Literal['in_progress', 'completed', 'incomplete'] - added:
field LocalShellCall.type: Literal['local_shell_call'] - added:
field LocalShellCallAction.command: List[str] - added:
field LocalShellCallAction.env: Dict[str, str] - added:
field LocalShellCallAction.timeout_ms: Optional[int] - added:
field LocalShellCallAction.type: Literal['exec'] - added:
field LocalShellCallAction.user: Optional[str] - added:
field LocalShellCallAction.working_directory: Optional[str] - added:
field McpApprovalRequest.arguments: str - added:
field McpApprovalRequest.id: str - added:
field McpApprovalRequest.name: str - added:
field McpApprovalRequest.server_label: str - added:
field McpApprovalRequest.type: Literal['mcp_approval_request'] - added:
field McpCall.arguments: str - added:
field McpCall.error: Optional[str] - added:
field McpCall.id: str - added:
field McpCall.name: str - added:
field McpCall.output: Optional[str] - added:
field McpCall.server_label: str - added:
field McpCall.type: Literal['mcp_call'] - added:
field McpListTools.error: Optional[str] - added:
field McpListTools.id: str - added:
field McpListTools.server_label: str - added:
field McpListTools.tools: List[McpListToolsTool] - added:
field McpListTools.type: Literal['mcp_list_tools'] - added:
field McpListToolsTool.annotations: Optional[object] - added:
field McpListToolsTool.description: Optional[str] - added:
field McpListToolsTool.input_schema: object - added:
field McpListToolsTool.name: str - added:
variable ResponseOutputItem: TypeAlias
- added:
class ResponseOutputItemAddedEvent(BaseModel) - added:
field ResponseOutputItemAddedEvent.item: ResponseOutputItem - added:
field ResponseOutputItemAddedEvent.output_index: int - added:
field ResponseOutputItemAddedEvent.sequence_number: int - added:
field ResponseOutputItemAddedEvent.type: Literal['response.output_item.added']
- added:
class ResponseOutputItemDoneEvent(BaseModel) - added:
field ResponseOutputItemDoneEvent.item: ResponseOutputItem - added:
field ResponseOutputItemDoneEvent.output_index: int - added:
field ResponseOutputItemDoneEvent.sequence_number: int - added:
field ResponseOutputItemDoneEvent.type: Literal['response.output_item.done']
- added:
class ResponseOutputMessage(BaseModel) - added:
field ResponseOutputMessage.content: List[Content] - added:
field ResponseOutputMessage.id: str - added:
field ResponseOutputMessage.role: Literal['assistant'] - added:
field ResponseOutputMessage.status: Literal['in_progress', 'completed', 'incomplete'] - added:
field ResponseOutputMessage.type: Literal['message'] - added:
variable Content: TypeAlias
- added:
class ResponseOutputMessageParam(TypedDict) - added:
field ResponseOutputMessageParam.content: Required[Iterable[Content]] - added:
field ResponseOutputMessageParam.id: Required[str] - added:
field ResponseOutputMessageParam.role: Required[Literal['assistant']] - added:
field ResponseOutputMessageParam.status: Required[Literal['in_progress', 'completed', 'incomplete']] - added:
field ResponseOutputMessageParam.type: Required[Literal['message']] - added:
variable Content: TypeAlias
- added:
class ResponseOutputRefusal(BaseModel) - added:
field ResponseOutputRefusal.refusal: str - added:
field ResponseOutputRefusal.type: Literal['refusal']
- added:
class ResponseOutputRefusalParam(TypedDict) - added:
field ResponseOutputRefusalParam.refusal: Required[str] - added:
field ResponseOutputRefusalParam.type: Required[Literal['refusal']]
- added:
class AnnotationContainerFileCitation(BaseModel) - added:
class AnnotationFileCitation(BaseModel) - added:
class AnnotationFilePath(BaseModel) - added:
class AnnotationURLCitation(BaseModel) - added:
class Logprob(BaseModel) - added:
class LogprobTopLogprob(BaseModel) - added:
class ResponseOutputText(BaseModel) - added:
field AnnotationContainerFileCitation.container_id: str - added:
field AnnotationContainerFileCitation.end_index: int - added:
field AnnotationContainerFileCitation.file_id: str - added:
field AnnotationContainerFileCitation.filename: str - added:
field AnnotationContainerFileCitation.start_index: int - added:
field AnnotationContainerFileCitation.type: Literal['container_file_citation'] - added:
field AnnotationFileCitation.file_id: str - added:
field AnnotationFileCitation.filename: str - added:
field AnnotationFileCitation.index: int - added:
field AnnotationFileCitation.type: Literal['file_citation'] - added:
field AnnotationFilePath.file_id: str - added:
field AnnotationFilePath.index: int - added:
field AnnotationFilePath.type: Literal['file_path'] - added:
field AnnotationURLCitation.end_index: int - added:
field AnnotationURLCitation.start_index: int - added:
field AnnotationURLCitation.title: str - added:
field AnnotationURLCitation.type: Literal['url_citation'] - added:
field AnnotationURLCitation.url: str - added:
field Logprob.bytes: List[int] - added:
field Logprob.logprob: float - added:
field Logprob.token: str - added:
field Logprob.top_logprobs: List[LogprobTopLogprob] - added:
field LogprobTopLogprob.bytes: List[int] - added:
field LogprobTopLogprob.logprob: float - added:
field LogprobTopLogprob.token: str - added:
field ResponseOutputText.annotations: List[Annotation] - added:
field ResponseOutputText.logprobs: Optional[List[Logprob]] - added:
field ResponseOutputText.text: str - added:
field ResponseOutputText.type: Literal['output_text'] - added:
variable Annotation: TypeAlias
- added:
class ResponseOutputTextAnnotationAddedEvent(BaseModel) - added:
field ResponseOutputTextAnnotationAddedEvent.annotation: object - added:
field ResponseOutputTextAnnotationAddedEvent.annotation_index: int - added:
field ResponseOutputTextAnnotationAddedEvent.content_index: int - added:
field ResponseOutputTextAnnotationAddedEvent.item_id: str - added:
field ResponseOutputTextAnnotationAddedEvent.output_index: int - added:
field ResponseOutputTextAnnotationAddedEvent.sequence_number: int - added:
field ResponseOutputTextAnnotationAddedEvent.type: Literal['response.output_text.annotation.added']
- added:
class AnnotationContainerFileCitation(TypedDict) - added:
class AnnotationFileCitation(TypedDict) - added:
class AnnotationFilePath(TypedDict) - added:
class AnnotationURLCitation(TypedDict) - added:
class Logprob(TypedDict) - added:
class LogprobTopLogprob(TypedDict) - added:
class ResponseOutputTextParam(TypedDict) - added:
field AnnotationContainerFileCitation.container_id: Required[str] - added:
field AnnotationContainerFileCitation.end_index: Required[int] - added:
field AnnotationContainerFileCitation.file_id: Required[str] - added:
field AnnotationContainerFileCitation.filename: Required[str] - added:
field AnnotationContainerFileCitation.start_index: Required[int] - added:
field AnnotationContainerFileCitation.type: Required[Literal['container_file_citation']] - added:
field AnnotationFileCitation.file_id: Required[str] - added:
field AnnotationFileCitation.filename: Required[str] - added:
field AnnotationFileCitation.index: Required[int] - added:
field AnnotationFileCitation.type: Required[Literal['file_citation']] - added:
field AnnotationFilePath.file_id: Required[str] - added:
field AnnotationFilePath.index: Required[int] - added:
field AnnotationFilePath.type: Required[Literal['file_path']] - added:
field AnnotationURLCitation.end_index: Required[int] - added:
field AnnotationURLCitation.start_index: Required[int] - added:
field AnnotationURLCitation.title: Required[str] - added:
field AnnotationURLCitation.type: Required[Literal['url_citation']] - added:
field AnnotationURLCitation.url: Required[str] - added:
field Logprob.bytes: Required[Iterable[int]] - added:
field Logprob.logprob: Required[float] - added:
field Logprob.token: Required[str] - added:
field Logprob.top_logprobs: Required[Iterable[LogprobTopLogprob]] - added:
field LogprobTopLogprob.bytes: Required[Iterable[int]] - added:
field LogprobTopLogprob.logprob: Required[float] - added:
field LogprobTopLogprob.token: Required[str] - added:
field ResponseOutputTextParam.annotations: Required[Iterable[Annotation]] - added:
field ResponseOutputTextParam.logprobs: Iterable[Logprob] - added:
field ResponseOutputTextParam.text: Required[str] - added:
field ResponseOutputTextParam.type: Required[Literal['output_text']] - added:
variable Annotation: TypeAlias
- added:
class ResponsePrompt(BaseModel) - added:
field ResponsePrompt.id: str - added:
field ResponsePrompt.variables: Optional[Dict[str, Variables]] - added:
field ResponsePrompt.version: Optional[str] - added:
variable Variables: TypeAlias
- added:
class ResponsePromptParam(TypedDict) - added:
field ResponsePromptParam.id: Required[str] - added:
field ResponsePromptParam.variables: Optional[Dict[str, Variables]] - added:
field ResponsePromptParam.version: Optional[str] - added:
variable Variables: TypeAlias
- added:
class ResponseQueuedEvent(BaseModel) - added:
field ResponseQueuedEvent.response: Response - added:
field ResponseQueuedEvent.sequence_number: int - added:
field ResponseQueuedEvent.type: Literal['response.queued']
- added:
class Content(BaseModel) - added:
class ResponseReasoningItem(BaseModel) - added:
class Summary(BaseModel) - added:
field Content.text: str - added:
field Content.type: Literal['reasoning_text'] - added:
field ResponseReasoningItem.content: Optional[List[Content]] - added:
field ResponseReasoningItem.encrypted_content: Optional[str] - added:
field ResponseReasoningItem.id: str - added:
field ResponseReasoningItem.status: Optional[Literal['in_progress', 'completed', 'incomplete']] - added:
field ResponseReasoningItem.summary: List[Summary] - added:
field ResponseReasoningItem.type: Literal['reasoning'] - added:
field Summary.text: str - added:
field Summary.type: Literal['summary_text']
- added:
class Content(TypedDict) - added:
class ResponseReasoningItemParam(TypedDict) - added:
class Summary(TypedDict) - added:
field Content.text: Required[str] - added:
field Content.type: Required[Literal['reasoning_text']] - added:
field ResponseReasoningItemParam.content: Iterable[Content] - added:
field ResponseReasoningItemParam.encrypted_content: Optional[str] - added:
field ResponseReasoningItemParam.id: Required[str] - added:
field ResponseReasoningItemParam.status: Literal['in_progress', 'completed', 'incomplete'] - added:
field ResponseReasoningItemParam.summary: Required[Iterable[Summary]] - added:
field ResponseReasoningItemParam.type: Required[Literal['reasoning']] - added:
field Summary.text: Required[str] - added:
field Summary.type: Required[Literal['summary_text']]
- added:
class Part(BaseModel) - added:
class ResponseReasoningSummaryPartAddedEvent(BaseModel) - added:
field Part.text: str - added:
field Part.type: Literal['summary_text'] - added:
field ResponseReasoningSummaryPartAddedEvent.item_id: str - added:
field ResponseReasoningSummaryPartAddedEvent.output_index: int - added:
field ResponseReasoningSummaryPartAddedEvent.part: Part - added:
field ResponseReasoningSummaryPartAddedEvent.sequence_number: int - added:
field ResponseReasoningSummaryPartAddedEvent.summary_index: int - added:
field ResponseReasoningSummaryPartAddedEvent.type: Literal['response.reasoning_summary_part.added']
- added:
class Part(BaseModel) - added:
class ResponseReasoningSummaryPartDoneEvent(BaseModel) - added:
field Part.text: str - added:
field Part.type: Literal['summary_text'] - added:
field ResponseReasoningSummaryPartDoneEvent.item_id: str - added:
field ResponseReasoningSummaryPartDoneEvent.output_index: int - added:
field ResponseReasoningSummaryPartDoneEvent.part: Part - added:
field ResponseReasoningSummaryPartDoneEvent.sequence_number: int - added:
field ResponseReasoningSummaryPartDoneEvent.summary_index: int - added:
field ResponseReasoningSummaryPartDoneEvent.type: Literal['response.reasoning_summary_part.done']
- added:
class ResponseReasoningSummaryTextDeltaEvent(BaseModel) - added:
field ResponseReasoningSummaryTextDeltaEvent.delta: str - added:
field ResponseReasoningSummaryTextDeltaEvent.item_id: str - added:
field ResponseReasoningSummaryTextDeltaEvent.output_index: int - added:
field ResponseReasoningSummaryTextDeltaEvent.sequence_number: int - added:
field ResponseReasoningSummaryTextDeltaEvent.summary_index: int - added:
field ResponseReasoningSummaryTextDeltaEvent.type: Literal['response.reasoning_summary_text.delta']
- added:
class ResponseReasoningSummaryTextDoneEvent(BaseModel) - added:
field ResponseReasoningSummaryTextDoneEvent.item_id: str - added:
field ResponseReasoningSummaryTextDoneEvent.output_index: int - added:
field ResponseReasoningSummaryTextDoneEvent.sequence_number: int - added:
field ResponseReasoningSummaryTextDoneEvent.summary_index: int - added:
field ResponseReasoningSummaryTextDoneEvent.text: str - added:
field ResponseReasoningSummaryTextDoneEvent.type: Literal['response.reasoning_summary_text.done']
- added:
class ResponseReasoningTextDeltaEvent(BaseModel) - added:
field ResponseReasoningTextDeltaEvent.content_index: int - added:
field ResponseReasoningTextDeltaEvent.delta: str - added:
field ResponseReasoningTextDeltaEvent.item_id: str - added:
field ResponseReasoningTextDeltaEvent.output_index: int - added:
field ResponseReasoningTextDeltaEvent.sequence_number: int - added:
field ResponseReasoningTextDeltaEvent.type: Literal['response.reasoning_text.delta']
- added:
class ResponseReasoningTextDoneEvent(BaseModel) - added:
field ResponseReasoningTextDoneEvent.content_index: int - added:
field ResponseReasoningTextDoneEvent.item_id: str - added:
field ResponseReasoningTextDoneEvent.output_index: int - added:
field ResponseReasoningTextDoneEvent.sequence_number: int - added:
field ResponseReasoningTextDoneEvent.text: str - added:
field ResponseReasoningTextDoneEvent.type: Literal['response.reasoning_text.done']
- added:
class ResponseRefusalDeltaEvent(BaseModel) - added:
field ResponseRefusalDeltaEvent.content_index: int - added:
field ResponseRefusalDeltaEvent.delta: str - added:
field ResponseRefusalDeltaEvent.item_id: str - added:
field ResponseRefusalDeltaEvent.output_index: int - added:
field ResponseRefusalDeltaEvent.sequence_number: int - added:
field ResponseRefusalDeltaEvent.type: Literal['response.refusal.delta']
- added:
class ResponseRefusalDoneEvent(BaseModel) - added:
field ResponseRefusalDoneEvent.content_index: int - added:
field ResponseRefusalDoneEvent.item_id: str - added:
field ResponseRefusalDoneEvent.output_index: int - added:
field ResponseRefusalDoneEvent.refusal: str - added:
field ResponseRefusalDoneEvent.sequence_number: int - added:
field ResponseRefusalDoneEvent.type: Literal['response.refusal.done']
- added:
class ResponseRetrieveParamsBase(TypedDict) - added:
class ResponseRetrieveParamsNonStreaming(ResponseRetrieveParamsBase) - added:
class ResponseRetrieveParamsStreaming(ResponseRetrieveParamsBase) - added:
field ResponseRetrieveParamsBase.include: List[ResponseIncludable] - added:
field ResponseRetrieveParamsBase.include_obfuscation: bool - added:
field ResponseRetrieveParamsBase.starting_after: int - added:
field ResponseRetrieveParamsNonStreaming.stream: Literal[False] - added:
field ResponseRetrieveParamsStreaming.stream: Required[Literal[True]]
- added:
variable ResponseStatus: TypeAlias
- added:
variable ResponseStreamEvent: TypeAlias
- added:
class ResponseTextConfig(BaseModel) - added:
field ResponseTextConfig.format: Optional[ResponseFormatTextConfig] - added:
field ResponseTextConfig.verbosity: Optional[Literal['low', 'medium', 'high']]
- added:
class ResponseTextConfigParam(TypedDict) - added:
field ResponseTextConfigParam.format: ResponseFormatTextConfigParam - added:
field ResponseTextConfigParam.verbosity: Optional[Literal['low', 'medium', 'high']]
- added:
class Logprob(BaseModel) - added:
class LogprobTopLogprob(BaseModel) - added:
class ResponseTextDeltaEvent(BaseModel) - added:
field Logprob.logprob: float - added:
field Logprob.token: str - added:
field Logprob.top_logprobs: Optional[List[LogprobTopLogprob]] - added:
field LogprobTopLogprob.logprob: Optional[float] - added:
field LogprobTopLogprob.token: Optional[str] - added:
field ResponseTextDeltaEvent.content_index: int - added:
field ResponseTextDeltaEvent.delta: str - added:
field ResponseTextDeltaEvent.item_id: str - added:
field ResponseTextDeltaEvent.logprobs: List[Logprob] - added:
field ResponseTextDeltaEvent.output_index: int - added:
field ResponseTextDeltaEvent.sequence_number: int - added:
field ResponseTextDeltaEvent.type: Literal['response.output_text.delta']
- added:
class Logprob(BaseModel) - added:
class LogprobTopLogprob(BaseModel) - added:
class ResponseTextDoneEvent(BaseModel) - added:
field Logprob.logprob: float - added:
field Logprob.token: str - added:
field Logprob.top_logprobs: Optional[List[LogprobTopLogprob]] - added:
field LogprobTopLogprob.logprob: Optional[float] - added:
field LogprobTopLogprob.token: Optional[str] - added:
field ResponseTextDoneEvent.content_index: int - added:
field ResponseTextDoneEvent.item_id: str - added:
field ResponseTextDoneEvent.logprobs: List[Logprob] - added:
field ResponseTextDoneEvent.output_index: int - added:
field ResponseTextDoneEvent.sequence_number: int - added:
field ResponseTextDoneEvent.text: str - added:
field ResponseTextDoneEvent.type: Literal['response.output_text.done']
- added:
class InputTokensDetails(BaseModel) - added:
class OutputTokensDetails(BaseModel) - added:
class ResponseUsage(BaseModel) - added:
field InputTokensDetails.cached_tokens: int - added:
field OutputTokensDetails.reasoning_tokens: int - added:
field ResponseUsage.input_tokens: int - added:
field ResponseUsage.input_tokens_details: InputTokensDetails - added:
field ResponseUsage.output_tokens: int - added:
field ResponseUsage.output_tokens_details: OutputTokensDetails - added:
field ResponseUsage.total_tokens: int
- added:
class ResponseWebSearchCallCompletedEvent(BaseModel) - added:
field ResponseWebSearchCallCompletedEvent.item_id: str - added:
field ResponseWebSearchCallCompletedEvent.output_index: int - added:
field ResponseWebSearchCallCompletedEvent.sequence_number: int - added:
field ResponseWebSearchCallCompletedEvent.type: Literal['response.web_search_call.completed']
- added:
class ResponseWebSearchCallInProgressEvent(BaseModel) - added:
field ResponseWebSearchCallInProgressEvent.item_id: str - added:
field ResponseWebSearchCallInProgressEvent.output_index: int - added:
field ResponseWebSearchCallInProgressEvent.sequence_number: int - added:
field ResponseWebSearchCallInProgressEvent.type: Literal['response.web_search_call.in_progress']
- added:
class ResponseWebSearchCallSearchingEvent(BaseModel) - added:
field ResponseWebSearchCallSearchingEvent.item_id: str - added:
field ResponseWebSearchCallSearchingEvent.output_index: int - added:
field ResponseWebSearchCallSearchingEvent.sequence_number: int - added:
field ResponseWebSearchCallSearchingEvent.type: Literal['response.web_search_call.searching']
- added:
class CodeInterpreter(BaseModel) - added:
class CodeInterpreterContainerCodeInterpreterToolAuto(BaseModel) - added:
class ImageGeneration(BaseModel) - added:
class ImageGenerationInputImageMask(BaseModel) - added:
class LocalShell(BaseModel) - added:
class Mcp(BaseModel) - added:
class McpAllowedToolsMcpToolFilter(BaseModel) - added:
class McpRequireApprovalMcpToolApprovalFilter(BaseModel) - added:
class McpRequireApprovalMcpToolApprovalFilterAlways(BaseModel) - added:
class McpRequireApprovalMcpToolApprovalFilterNever(BaseModel) - added:
export WebSearchTool - added:
field CodeInterpreter.container: CodeInterpreterContainer - added:
field CodeInterpreter.type: Literal['code_interpreter'] - added:
field CodeInterpreterContainerCodeInterpreterToolAuto.file_ids: Optional[List[str]] - added:
field CodeInterpreterContainerCodeInterpreterToolAuto.type: Literal['auto'] - added:
field ImageGeneration.background: Optional[Literal['transparent', 'opaque', 'auto']] - added:
field ImageGeneration.input_fidelity: Optional[Literal['high', 'low']] - added:
field ImageGeneration.input_image_mask: Optional[ImageGenerationInputImageMask] - added:
field ImageGeneration.model: Optional[Literal['gpt-image-1']] - added:
field ImageGeneration.moderation: Optional[Literal['auto', 'low']] - added:
field ImageGeneration.output_compression: Optional[int] - added:
field ImageGeneration.output_format: Optional[Literal['png', 'webp', 'jpeg']] - added:
field ImageGeneration.partial_images: Optional[int] - added:
field ImageGeneration.quality: Optional[Literal['low', 'medium', 'high', 'auto']] - added:
field ImageGeneration.size: Optional[Literal['1024x1024', '1024x1536', '1536x1024', 'auto']] - added:
field ImageGeneration.type: Literal['image_generation'] - added:
field ImageGenerationInputImageMask.file_id: Optional[str] - added:
field ImageGenerationInputImageMask.image_url: Optional[str] - added:
field LocalShell.type: Literal['local_shell'] - added:
field Mcp.allowed_tools: Optional[McpAllowedTools] - added:
field Mcp.authorization: Optional[str] - added:
field Mcp.connector_id: Optional[Literal['connector_dropbox', 'connector_gmail', 'connector_googlecalendar', 'connector_googledrive', 'connector_microsoftteams', 'connector_outlookcalendar', 'connector_outlookemail', 'connector_sharepoint']] - added:
field Mcp.headers: Optional[Dict[str, str]] - added:
field Mcp.require_approval: Optional[McpRequireApproval] - added:
field Mcp.server_description: Optional[str] - added:
field Mcp.server_label: str - added:
field Mcp.server_url: Optional[str] - added:
field Mcp.type: Literal['mcp'] - added:
field McpAllowedToolsMcpToolFilter.read_only: Optional[bool] - added:
field McpAllowedToolsMcpToolFilter.tool_names: Optional[List[str]] - added:
field McpRequireApprovalMcpToolApprovalFilter.always: Optional[McpRequireApprovalMcpToolApprovalFilterAlways] - added:
field McpRequireApprovalMcpToolApprovalFilter.never: Optional[McpRequireApprovalMcpToolApprovalFilterNever] - added:
field McpRequireApprovalMcpToolApprovalFilterAlways.read_only: Optional[bool] - added:
field McpRequireApprovalMcpToolApprovalFilterAlways.tool_names: Optional[List[str]] - added:
field McpRequireApprovalMcpToolApprovalFilterNever.read_only: Optional[bool] - added:
field McpRequireApprovalMcpToolApprovalFilterNever.tool_names: Optional[List[str]] - added:
variable CodeInterpreterContainer: TypeAlias - added:
variable McpAllowedTools: TypeAlias - added:
variable McpRequireApproval: TypeAlias - added:
variable Tool: TypeAlias
- added:
class ToolChoiceAllowed(BaseModel) - added:
field ToolChoiceAllowed.mode: Literal['auto', 'required'] - added:
field ToolChoiceAllowed.tools: List[Dict[str, object]] - added:
field ToolChoiceAllowed.type: Literal['allowed_tools']
- added:
class ToolChoiceAllowedParam(TypedDict) - added:
field ToolChoiceAllowedParam.mode: Required[Literal['auto', 'required']] - added:
field ToolChoiceAllowedParam.tools: Required[Iterable[Dict[str, object]]] - added:
field ToolChoiceAllowedParam.type: Required[Literal['allowed_tools']]
- added:
class ToolChoiceCustom(BaseModel) - added:
field ToolChoiceCustom.name: str - added:
field ToolChoiceCustom.type: Literal['custom']
- added:
class ToolChoiceCustomParam(TypedDict) - added:
field ToolChoiceCustomParam.name: Required[str] - added:
field ToolChoiceCustomParam.type: Required[Literal['custom']]
- added:
class ToolChoiceFunction(BaseModel) - added:
field ToolChoiceFunction.name: str - added:
field ToolChoiceFunction.type: Literal['function']
- added:
class ToolChoiceFunctionParam(TypedDict) - added:
field ToolChoiceFunctionParam.name: Required[str] - added:
field ToolChoiceFunctionParam.type: Required[Literal['function']]
- added:
class ToolChoiceMcp(BaseModel) - added:
field ToolChoiceMcp.name: Optional[str] - added:
field ToolChoiceMcp.server_label: str - added:
field ToolChoiceMcp.type: Literal['mcp']
- added:
class ToolChoiceMcpParam(TypedDict) - added:
field ToolChoiceMcpParam.name: Optional[str] - added:
field ToolChoiceMcpParam.server_label: Required[str] - added:
field ToolChoiceMcpParam.type: Required[Literal['mcp']]
- added:
variable ToolChoiceOptions: TypeAlias
- added:
class ToolChoiceTypes(BaseModel) - added:
field ToolChoiceTypes.type: Literal['file_search', 'web_search_preview', 'computer_use_preview', 'web_search_preview_2025_03_11', 'image_generation', 'code_interpreter']
- added:
class ToolChoiceTypesParam(TypedDict) - added:
field ToolChoiceTypesParam.type: Required[Literal['file_search', 'web_search_preview', 'computer_use_preview', 'web_search_preview_2025_03_11', 'image_generation', 'code_interpreter']]
- added:
class CodeInterpreter(TypedDict) - added:
class CodeInterpreterContainerCodeInterpreterToolAuto(TypedDict) - added:
class ImageGeneration(TypedDict) - added:
class ImageGenerationInputImageMask(TypedDict) - added:
class LocalShell(TypedDict) - added:
class Mcp(TypedDict) - added:
class McpAllowedToolsMcpToolFilter(TypedDict) - added:
class McpRequireApprovalMcpToolApprovalFilter(TypedDict) - added:
class McpRequireApprovalMcpToolApprovalFilterAlways(TypedDict) - added:
class McpRequireApprovalMcpToolApprovalFilterNever(TypedDict) - added:
field CodeInterpreter.container: Required[CodeInterpreterContainer] - added:
field CodeInterpreter.type: Required[Literal['code_interpreter']] - added:
field CodeInterpreterContainerCodeInterpreterToolAuto.file_ids: SequenceNotStr[str] - added:
field CodeInterpreterContainerCodeInterpreterToolAuto.type: Required[Literal['auto']] - added:
field ImageGeneration.background: Literal['transparent', 'opaque', 'auto'] - added:
field ImageGeneration.input_fidelity: Optional[Literal['high', 'low']] - added:
field ImageGeneration.input_image_mask: ImageGenerationInputImageMask - added:
field ImageGeneration.model: Literal['gpt-image-1'] - added:
field ImageGeneration.moderation: Literal['auto', 'low'] - added:
field ImageGeneration.output_compression: int - added:
field ImageGeneration.output_format: Literal['png', 'webp', 'jpeg'] - added:
field ImageGeneration.partial_images: int - added:
field ImageGeneration.quality: Literal['low', 'medium', 'high', 'auto'] - added:
field ImageGeneration.size: Literal['1024x1024', '1024x1536', '1536x1024', 'auto'] - added:
field ImageGeneration.type: Required[Literal['image_generation']] - added:
field ImageGenerationInputImageMask.file_id: str - added:
field ImageGenerationInputImageMask.image_url: str - added:
field LocalShell.type: Required[Literal['local_shell']] - added:
field Mcp.allowed_tools: Optional[McpAllowedTools] - added:
field Mcp.authorization: str - added:
field Mcp.connector_id: Literal['connector_dropbox', 'connector_gmail', 'connector_googlecalendar', 'connector_googledrive', 'connector_microsoftteams', 'connector_outlookcalendar', 'connector_outlookemail', 'connector_sharepoint'] - added:
field Mcp.headers: Optional[Dict[str, str]] - added:
field Mcp.require_approval: Optional[McpRequireApproval] - added:
field Mcp.server_description: str - added:
field Mcp.server_label: Required[str] - added:
field Mcp.server_url: str - added:
field Mcp.type: Required[Literal['mcp']] - added:
field McpAllowedToolsMcpToolFilter.read_only: bool - added:
field McpAllowedToolsMcpToolFilter.tool_names: SequenceNotStr[str] - added:
field McpRequireApprovalMcpToolApprovalFilter.always: McpRequireApprovalMcpToolApprovalFilterAlways - added:
field McpRequireApprovalMcpToolApprovalFilter.never: McpRequireApprovalMcpToolApprovalFilterNever - added:
field McpRequireApprovalMcpToolApprovalFilterAlways.read_only: bool - added:
field McpRequireApprovalMcpToolApprovalFilterAlways.tool_names: SequenceNotStr[str] - added:
field McpRequireApprovalMcpToolApprovalFilterNever.read_only: bool - added:
field McpRequireApprovalMcpToolApprovalFilterNever.tool_names: SequenceNotStr[str] - added:
variable CodeInterpreterContainer: TypeAlias - added:
variable McpAllowedTools: TypeAlias - added:
variable McpRequireApproval: TypeAlias - added:
variable ToolParam: TypeAlias
- added:
class UserLocation(BaseModel) - added:
class WebSearchPreviewTool(BaseModel) - added:
field UserLocation.city: Optional[str] - added:
field UserLocation.country: Optional[str] - added:
field UserLocation.region: Optional[str] - added:
field UserLocation.timezone: Optional[str] - added:
field UserLocation.type: Literal['approximate'] - added:
field WebSearchPreviewTool.search_context_size: Optional[Literal['low', 'medium', 'high']] - added:
field WebSearchPreviewTool.type: Literal['web_search_preview', 'web_search_preview_2025_03_11'] - added:
field WebSearchPreviewTool.user_location: Optional[UserLocation]
- added:
class UserLocation(TypedDict) - added:
class WebSearchPreviewToolParam(TypedDict) - added:
field UserLocation.city: Optional[str] - added:
field UserLocation.country: Optional[str] - added:
field UserLocation.region: Optional[str] - added:
field UserLocation.timezone: Optional[str] - added:
field UserLocation.type: Required[Literal['approximate']] - added:
field WebSearchPreviewToolParam.search_context_size: Literal['low', 'medium', 'high'] - added:
field WebSearchPreviewToolParam.type: Required[Literal['web_search_preview', 'web_search_preview_2025_03_11']] - added:
field WebSearchPreviewToolParam.user_location: Optional[UserLocation]
- added:
class Filters(BaseModel) - added:
class UserLocation(BaseModel) - added:
class WebSearchTool(BaseModel) - added:
field Filters.allowed_domains: Optional[List[str]] - added:
field UserLocation.city: Optional[str] - added:
field UserLocation.country: Optional[str] - added:
field UserLocation.region: Optional[str] - added:
field UserLocation.timezone: Optional[str] - added:
field UserLocation.type: Optional[Literal['approximate']] - added:
field WebSearchTool.filters: Optional[Filters] - added:
field WebSearchTool.search_context_size: Optional[Literal['low', 'medium', 'high']] - added:
field WebSearchTool.type: Literal['web_search', 'web_search_2025_08_26'] - added:
field WebSearchTool.user_location: Optional[UserLocation]
- added:
class Filters(TypedDict) - added:
class UserLocation(TypedDict) - added:
class WebSearchToolParam(TypedDict) - added:
field Filters.allowed_domains: Optional[SequenceNotStr[str]] - added:
field UserLocation.city: Optional[str] - added:
field UserLocation.country: Optional[str] - added:
field UserLocation.region: Optional[str] - added:
field UserLocation.timezone: Optional[str] - added:
field UserLocation.type: Literal['approximate'] - added:
field WebSearchToolParam.filters: Optional[Filters] - added:
field WebSearchToolParam.search_context_size: Literal['low', 'medium', 'high'] - added:
field WebSearchToolParam.type: Required[Literal['web_search', 'web_search_2025_08_26']] - added:
field WebSearchToolParam.user_location: Optional[UserLocation]
- added:
export AllModels - added:
export ChatModel - added:
export ComparisonFilter - added:
export CompoundFilter - added:
export CustomToolInputFormat - added:
export ErrorObject - added:
export FunctionDefinition - added:
export FunctionParameters - added:
export Metadata - added:
export Reasoning - added:
export ReasoningEffort - added:
export ResponseFormatJSONObject - added:
export ResponseFormatJSONSchema - added:
export ResponseFormatText - added:
export ResponseFormatTextGrammar - added:
export ResponseFormatTextPython - added:
export ResponsesModel
- added:
variable AllModels: TypeAlias
- added:
variable ChatModel: TypeAlias
- added:
class ComparisonFilter(BaseModel) - added:
field ComparisonFilter.key: str - added:
field ComparisonFilter.type: Literal['eq', 'ne', 'gt', 'gte', 'lt', 'lte'] - added:
field ComparisonFilter.value: Union[str, float, bool]
- added:
class CompoundFilter(BaseModel) - added:
field CompoundFilter.filters: List[Filter] - added:
field CompoundFilter.type: Literal['and', 'or'] - added:
variable Filter: TypeAlias
- added:
class Grammar(BaseModel) - added:
class Text(BaseModel) - added:
field Grammar.definition: str - added:
field Grammar.syntax: Literal['lark', 'regex'] - added:
field Grammar.type: Literal['grammar'] - added:
field Text.type: Literal['text'] - added:
variable CustomToolInputFormat: TypeAlias
- added:
class ErrorObject(BaseModel) - added:
field ErrorObject.code: Optional[str] - added:
field ErrorObject.message: str - added:
field ErrorObject.param: Optional[str] - added:
field ErrorObject.type: str
- added:
class FunctionDefinition(BaseModel) - added:
field FunctionDefinition.description: Optional[str] - added:
field FunctionDefinition.name: str - added:
field FunctionDefinition.parameters: Optional[FunctionParameters] - added:
field FunctionDefinition.strict: Optional[bool]
- added:
variable FunctionParameters: TypeAlias
- added:
variable Metadata: TypeAlias
- added:
class Reasoning(BaseModel) - added:
field Reasoning.effort: Optional[ReasoningEffort] - added:
field Reasoning.generate_summary: Optional[Literal['auto', 'concise', 'detailed']] - added:
field Reasoning.summary: Optional[Literal['auto', 'concise', 'detailed']]
- added:
variable ReasoningEffort: TypeAlias
- added:
class ResponseFormatJSONObject(BaseModel) - added:
field ResponseFormatJSONObject.type: Literal['json_object']
- added:
class JSONSchema(BaseModel) - added:
class ResponseFormatJSONSchema(BaseModel) - added:
field JSONSchema.description: Optional[str] - added:
field JSONSchema.name: str - added:
field JSONSchema.schema_: Optional[Dict[str, object]] - added:
field JSONSchema.strict: Optional[bool] - added:
field ResponseFormatJSONSchema.json_schema: JSONSchema - added:
field ResponseFormatJSONSchema.type: Literal['json_schema']
- added:
class ResponseFormatText(BaseModel) - added:
field ResponseFormatText.type: Literal['text']
- added:
class ResponseFormatTextGrammar(BaseModel) - added:
field ResponseFormatTextGrammar.grammar: str - added:
field ResponseFormatTextGrammar.type: Literal['grammar']
- added:
class ResponseFormatTextPython(BaseModel) - added:
field ResponseFormatTextPython.type: Literal['python']
- added:
variable ResponsesModel: TypeAlias
- added:
export ChatModel - added:
export ComparisonFilter - added:
export CompoundFilter - added:
export CustomToolInputFormat - added:
export FunctionDefinition - added:
export FunctionParameters - added:
export Metadata - added:
export Reasoning - added:
export ReasoningEffort - added:
export ResponseFormatJSONObject - added:
export ResponseFormatJSONSchema - added:
export ResponseFormatText - added:
export ResponsesModel
- added:
variable ChatModel: TypeAlias
- added:
class ComparisonFilter(TypedDict) - added:
field ComparisonFilter.key: Required[str] - added:
field ComparisonFilter.type: Required[Literal['eq', 'ne', 'gt', 'gte', 'lt', 'lte']] - added:
field ComparisonFilter.value: Required[Union[str, float, bool]]
- added:
class CompoundFilter(TypedDict) - added:
field CompoundFilter.filters: Required[Iterable[Filter]] - added:
field CompoundFilter.type: Required[Literal['and', 'or']] - added:
variable Filter: TypeAlias
- added:
class Grammar(TypedDict) - added:
class Text(TypedDict) - added:
field Grammar.definition: Required[str] - added:
field Grammar.syntax: Required[Literal['lark', 'regex']] - added:
field Grammar.type: Required[Literal['grammar']] - added:
field Text.type: Required[Literal['text']] - added:
variable CustomToolInputFormat: TypeAlias
- added:
class FunctionDefinition(TypedDict) - added:
field FunctionDefinition.description: str - added:
field FunctionDefinition.name: Required[str] - added:
field FunctionDefinition.parameters: FunctionParameters - added:
field FunctionDefinition.strict: Optional[bool]
- added:
variable FunctionParameters: TypeAlias
- added:
variable Metadata: TypeAlias
- added:
class Reasoning(TypedDict) - added:
field Reasoning.effort: Optional[ReasoningEffort] - added:
field Reasoning.generate_summary: Optional[Literal['auto', 'concise', 'detailed']] - added:
field Reasoning.summary: Optional[Literal['auto', 'concise', 'detailed']]
- added:
variable ReasoningEffort: TypeAlias
- added:
class ResponseFormatJSONObject(TypedDict) - added:
field ResponseFormatJSONObject.type: Required[Literal['json_object']]
- added:
class JSONSchema(TypedDict) - added:
class ResponseFormatJSONSchema(TypedDict) - added:
field JSONSchema.description: str - added:
field JSONSchema.name: Required[str] - added:
field JSONSchema.schema: Dict[str, object] - added:
field JSONSchema.strict: Optional[bool] - added:
field ResponseFormatJSONSchema.json_schema: Required[JSONSchema] - added:
field ResponseFormatJSONSchema.type: Required[Literal['json_schema']]
- added:
class ResponseFormatText(TypedDict) - added:
field ResponseFormatText.type: Required[Literal['text']]
- added:
variable ResponsesModel: TypeAlias
- added:
class StaticFileChunkingStrategy(BaseModel) - added:
field StaticFileChunkingStrategy.chunk_overlap_tokens: int - added:
field StaticFileChunkingStrategy.max_chunk_size_tokens: int
- added:
class StaticFileChunkingStrategyObject(BaseModel) - added:
field StaticFileChunkingStrategyObject.static: StaticFileChunkingStrategy - added:
field StaticFileChunkingStrategyObject.type: Literal['static']
- added:
class StaticFileChunkingStrategyObjectParam(TypedDict) - added:
field StaticFileChunkingStrategyObjectParam.static: Required[StaticFileChunkingStrategyParam] - added:
field StaticFileChunkingStrategyObjectParam.type: Required[Literal['static']]
- added:
class StaticFileChunkingStrategyParam(TypedDict) - added:
field StaticFileChunkingStrategyParam.chunk_overlap_tokens: Required[int] - added:
field StaticFileChunkingStrategyParam.max_chunk_size_tokens: Required[int]
- added:
class Upload(BaseModel) - added:
field Upload.bytes: int - added:
field Upload.created_at: int - added:
field Upload.expires_at: int - added:
field Upload.file: Optional[FileObject] - added:
field Upload.filename: str - added:
field Upload.id: str - added:
field Upload.object: Literal['upload'] - added:
field Upload.purpose: str - added:
field Upload.status: Literal['pending', 'completed', 'cancelled', 'expired']
- added:
class UploadCompleteParams(TypedDict) - added:
field UploadCompleteParams.md5: str - added:
field UploadCompleteParams.part_ids: Required[SequenceNotStr[str]]
- added:
class ExpiresAfter(TypedDict) - added:
class UploadCreateParams(TypedDict) - added:
field ExpiresAfter.anchor: Required[Literal['created_at']] - added:
field ExpiresAfter.seconds: Required[int] - added:
field UploadCreateParams.bytes: Required[int] - added:
field UploadCreateParams.expires_after: ExpiresAfter - added:
field UploadCreateParams.filename: Required[str] - added:
field UploadCreateParams.mime_type: Required[str] - added:
field UploadCreateParams.purpose: Required[FilePurpose]
- added:
export PartCreateParams - added:
export UploadPart
- added:
class PartCreateParams(TypedDict) - added:
field PartCreateParams.data: Required[FileTypes]
- added:
class UploadPart(BaseModel) - added:
field UploadPart.created_at: int - added:
field UploadPart.id: str - added:
field UploadPart.object: Literal['upload.part'] - added:
field UploadPart.upload_id: str
- added:
class ExpiresAfter(BaseModel) - added:
class FileCounts(BaseModel) - added:
class VectorStore(BaseModel) - added:
field ExpiresAfter.anchor: Literal['last_active_at'] - added:
field ExpiresAfter.days: int - added:
field FileCounts.cancelled: int - added:
field FileCounts.completed: int - added:
field FileCounts.failed: int - added:
field FileCounts.in_progress: int - added:
field FileCounts.total: int - added:
field VectorStore.created_at: int - added:
field VectorStore.expires_after: Optional[ExpiresAfter] - added:
field VectorStore.expires_at: Optional[int] - added:
field VectorStore.file_counts: FileCounts - added:
field VectorStore.id: str - added:
field VectorStore.last_active_at: Optional[int] - added:
field VectorStore.metadata: Optional[Metadata] - added:
field VectorStore.name: str - added:
field VectorStore.object: Literal['vector_store'] - added:
field VectorStore.status: Literal['expired', 'in_progress', 'completed'] - added:
field VectorStore.usage_bytes: int
- added:
class ExpiresAfter(TypedDict) - added:
class VectorStoreCreateParams(TypedDict) - added:
field ExpiresAfter.anchor: Required[Literal['last_active_at']] - added:
field ExpiresAfter.days: Required[int] - added:
field VectorStoreCreateParams.chunking_strategy: FileChunkingStrategyParam - added:
field VectorStoreCreateParams.expires_after: ExpiresAfter - added:
field VectorStoreCreateParams.file_ids: SequenceNotStr[str] - added:
field VectorStoreCreateParams.metadata: Optional[Metadata] - added:
field VectorStoreCreateParams.name: str
- added:
class VectorStoreDeleted(BaseModel) - added:
field VectorStoreDeleted.deleted: bool - added:
field VectorStoreDeleted.id: str - added:
field VectorStoreDeleted.object: Literal['vector_store.deleted']
- added:
class VectorStoreListParams(TypedDict) - added:
field VectorStoreListParams.after: str - added:
field VectorStoreListParams.before: str - added:
field VectorStoreListParams.limit: int - added:
field VectorStoreListParams.order: Literal['asc', 'desc']
- added:
class RankingOptions(TypedDict) - added:
class VectorStoreSearchParams(TypedDict) - added:
field RankingOptions.ranker: Literal['none', 'auto', 'default-2024-11-15'] - added:
field RankingOptions.score_threshold: float - added:
field VectorStoreSearchParams.filters: Filters - added:
field VectorStoreSearchParams.max_num_results: int - added:
field VectorStoreSearchParams.query: Required[Union[str, SequenceNotStr[str]]] - added:
field VectorStoreSearchParams.ranking_options: RankingOptions - added:
field VectorStoreSearchParams.rewrite_query: bool - added:
variable Filters: TypeAlias
- added:
class Content(BaseModel) - added:
class VectorStoreSearchResponse(BaseModel) - added:
field Content.text: str - added:
field Content.type: Literal['text'] - added:
field VectorStoreSearchResponse.attributes: Optional[Dict[str, Union[str, float, bool]]] - added:
field VectorStoreSearchResponse.content: List[Content] - added:
field VectorStoreSearchResponse.file_id: str - added:
field VectorStoreSearchResponse.filename: str - added:
field VectorStoreSearchResponse.score: float
- added:
class ExpiresAfter(TypedDict) - added:
class VectorStoreUpdateParams(TypedDict) - added:
field ExpiresAfter.anchor: Required[Literal['last_active_at']] - added:
field ExpiresAfter.days: Required[int] - added:
field VectorStoreUpdateParams.expires_after: Optional[ExpiresAfter] - added:
field VectorStoreUpdateParams.metadata: Optional[Metadata] - added:
field VectorStoreUpdateParams.name: Optional[str]
- added:
export FileBatchCreateParams - added:
export FileBatchListFilesParams - added:
export FileContentResponse - added:
export FileCreateParams - added:
export FileListParams - added:
export FileUpdateParams - added:
export VectorStoreFile - added:
export VectorStoreFileBatch - added:
export VectorStoreFileDeleted
- added:
class FileBatchCreateParams(TypedDict) - added:
field FileBatchCreateParams.attributes: Optional[Dict[str, Union[str, float, bool]]] - added:
field FileBatchCreateParams.chunking_strategy: FileChunkingStrategyParam - added:
field FileBatchCreateParams.file_ids: Required[SequenceNotStr[str]]
- added:
class FileBatchListFilesParams(TypedDict) - added:
field FileBatchListFilesParams.after: str - added:
field FileBatchListFilesParams.before: str - added:
field FileBatchListFilesParams.filter: Literal['in_progress', 'completed', 'failed', 'cancelled'] - added:
field FileBatchListFilesParams.limit: int - added:
field FileBatchListFilesParams.order: Literal['asc', 'desc'] - added:
field FileBatchListFilesParams.vector_store_id: Required[str]
- added:
class FileContentResponse(BaseModel) - added:
field FileContentResponse.text: Optional[str] - added:
field FileContentResponse.type: Optional[str]
- added:
class FileCreateParams(TypedDict) - added:
field FileCreateParams.attributes: Optional[Dict[str, Union[str, float, bool]]] - added:
field FileCreateParams.chunking_strategy: FileChunkingStrategyParam - added:
field FileCreateParams.file_id: Required[str]
- added:
class FileListParams(TypedDict) - added:
field FileListParams.after: str - added:
field FileListParams.before: str - added:
field FileListParams.filter: Literal['in_progress', 'completed', 'failed', 'cancelled'] - added:
field FileListParams.limit: int - added:
field FileListParams.order: Literal['asc', 'desc']
- added:
class FileUpdateParams(TypedDict) - added:
field FileUpdateParams.attributes: Required[Optional[Dict[str, Union[str, float, bool]]]] - added:
field FileUpdateParams.vector_store_id: Required[str]
- added:
class LastError(BaseModel) - added:
class VectorStoreFile(BaseModel) - added:
field LastError.code: Literal['server_error', 'unsupported_file', 'invalid_file'] - added:
field LastError.message: str - added:
field VectorStoreFile.attributes: Optional[Dict[str, Union[str, float, bool]]] - added:
field VectorStoreFile.chunking_strategy: Optional[FileChunkingStrategy] - added:
field VectorStoreFile.created_at: int - added:
field VectorStoreFile.id: str - added:
field VectorStoreFile.last_error: Optional[LastError] - added:
field VectorStoreFile.object: Literal['vector_store.file'] - added:
field VectorStoreFile.status: Literal['in_progress', 'completed', 'cancelled', 'failed'] - added:
field VectorStoreFile.usage_bytes: int - added:
field VectorStoreFile.vector_store_id: str
- added:
class FileCounts(BaseModel) - added:
class VectorStoreFileBatch(BaseModel) - added:
field FileCounts.cancelled: int - added:
field FileCounts.completed: int - added:
field FileCounts.failed: int - added:
field FileCounts.in_progress: int - added:
field FileCounts.total: int - added:
field VectorStoreFileBatch.created_at: int - added:
field VectorStoreFileBatch.file_counts: FileCounts - added:
field VectorStoreFileBatch.id: str - added:
field VectorStoreFileBatch.object: Literal['vector_store.files_batch'] - added:
field VectorStoreFileBatch.status: Literal['in_progress', 'completed', 'cancelled', 'failed'] - added:
field VectorStoreFileBatch.vector_store_id: str
- added:
class VectorStoreFileDeleted(BaseModel) - added:
field VectorStoreFileDeleted.deleted: bool - added:
field VectorStoreFileDeleted.id: str - added:
field VectorStoreFileDeleted.object: Literal['vector_store.file.deleted']
- added:
export BatchCancelledWebhookEvent - added:
export BatchCompletedWebhookEvent - added:
export BatchExpiredWebhookEvent - added:
export BatchFailedWebhookEvent - added:
export EvalRunCanceledWebhookEvent - added:
export EvalRunFailedWebhookEvent - added:
export EvalRunSucceededWebhookEvent - added:
export FineTuningJobCancelledWebhookEvent - added:
export FineTuningJobFailedWebhookEvent - added:
export FineTuningJobSucceededWebhookEvent - added:
export RealtimeCallIncomingWebhookEvent - added:
export ResponseCancelledWebhookEvent - added:
export ResponseCompletedWebhookEvent - added:
export ResponseFailedWebhookEvent - added:
export ResponseIncompleteWebhookEvent - added:
export UnwrapWebhookEvent
- added:
class BatchCancelledWebhookEvent(BaseModel) - added:
class Data(BaseModel) - added:
field BatchCancelledWebhookEvent.created_at: int - added:
field BatchCancelledWebhookEvent.data: Data - added:
field BatchCancelledWebhookEvent.id: str - added:
field BatchCancelledWebhookEvent.object: Optional[Literal['event']] - added:
field BatchCancelledWebhookEvent.type: Literal['batch.cancelled'] - added:
field Data.id: str
- added:
class BatchCompletedWebhookEvent(BaseModel) - added:
class Data(BaseModel) - added:
field BatchCompletedWebhookEvent.created_at: int - added:
field BatchCompletedWebhookEvent.data: Data - added:
field BatchCompletedWebhookEvent.id: str - added:
field BatchCompletedWebhookEvent.object: Optional[Literal['event']] - added:
field BatchCompletedWebhookEvent.type: Literal['batch.completed'] - added:
field Data.id: str
- added:
class BatchExpiredWebhookEvent(BaseModel) - added:
class Data(BaseModel) - added:
field BatchExpiredWebhookEvent.created_at: int - added:
field BatchExpiredWebhookEvent.data: Data - added:
field BatchExpiredWebhookEvent.id: str - added:
field BatchExpiredWebhookEvent.object: Optional[Literal['event']] - added:
field BatchExpiredWebhookEvent.type: Literal['batch.expired'] - added:
field Data.id: str
- added:
class BatchFailedWebhookEvent(BaseModel) - added:
class Data(BaseModel) - added:
field BatchFailedWebhookEvent.created_at: int - added:
field BatchFailedWebhookEvent.data: Data - added:
field BatchFailedWebhookEvent.id: str - added:
field BatchFailedWebhookEvent.object: Optional[Literal['event']] - added:
field BatchFailedWebhookEvent.type: Literal['batch.failed'] - added:
field Data.id: str
- added:
class Data(BaseModel) - added:
class EvalRunCanceledWebhookEvent(BaseModel) - added:
field Data.id: str - added:
field EvalRunCanceledWebhookEvent.created_at: int - added:
field EvalRunCanceledWebhookEvent.data: Data - added:
field EvalRunCanceledWebhookEvent.id: str - added:
field EvalRunCanceledWebhookEvent.object: Optional[Literal['event']] - added:
field EvalRunCanceledWebhookEvent.type: Literal['eval.run.canceled']
- added:
class Data(BaseModel) - added:
class EvalRunFailedWebhookEvent(BaseModel) - added:
field Data.id: str - added:
field EvalRunFailedWebhookEvent.created_at: int - added:
field EvalRunFailedWebhookEvent.data: Data - added:
field EvalRunFailedWebhookEvent.id: str - added:
field EvalRunFailedWebhookEvent.object: Optional[Literal['event']] - added:
field EvalRunFailedWebhookEvent.type: Literal['eval.run.failed']
- added:
class Data(BaseModel) - added:
class EvalRunSucceededWebhookEvent(BaseModel) - added:
field Data.id: str - added:
field EvalRunSucceededWebhookEvent.created_at: int - added:
field EvalRunSucceededWebhookEvent.data: Data - added:
field EvalRunSucceededWebhookEvent.id: str - added:
field EvalRunSucceededWebhookEvent.object: Optional[Literal['event']] - added:
field EvalRunSucceededWebhookEvent.type: Literal['eval.run.succeeded']
- added:
class Data(BaseModel) - added:
class FineTuningJobCancelledWebhookEvent(BaseModel) - added:
field Data.id: str - added:
field FineTuningJobCancelledWebhookEvent.created_at: int - added:
field FineTuningJobCancelledWebhookEvent.data: Data - added:
field FineTuningJobCancelledWebhookEvent.id: str - added:
field FineTuningJobCancelledWebhookEvent.object: Optional[Literal['event']] - added:
field FineTuningJobCancelledWebhookEvent.type: Literal['fine_tuning.job.cancelled']
- added:
class Data(BaseModel) - added:
class FineTuningJobFailedWebhookEvent(BaseModel) - added:
field Data.id: str - added:
field FineTuningJobFailedWebhookEvent.created_at: int - added:
field FineTuningJobFailedWebhookEvent.data: Data - added:
field FineTuningJobFailedWebhookEvent.id: str - added:
field FineTuningJobFailedWebhookEvent.object: Optional[Literal['event']] - added:
field FineTuningJobFailedWebhookEvent.type: Literal['fine_tuning.job.failed']
- added:
class Data(BaseModel) - added:
class FineTuningJobSucceededWebhookEvent(BaseModel) - added:
field Data.id: str - added:
field FineTuningJobSucceededWebhookEvent.created_at: int - added:
field FineTuningJobSucceededWebhookEvent.data: Data - added:
field FineTuningJobSucceededWebhookEvent.id: str - added:
field FineTuningJobSucceededWebhookEvent.object: Optional[Literal['event']] - added:
field FineTuningJobSucceededWebhookEvent.type: Literal['fine_tuning.job.succeeded']
- added:
class Data(BaseModel) - added:
class DataSipHeader(BaseModel) - added:
class RealtimeCallIncomingWebhookEvent(BaseModel) - added:
field Data.call_id: str - added:
field Data.sip_headers: List[DataSipHeader] - added:
field DataSipHeader.name: str - added:
field DataSipHeader.value: str - added:
field RealtimeCallIncomingWebhookEvent.created_at: int - added:
field RealtimeCallIncomingWebhookEvent.data: Data - added:
field RealtimeCallIncomingWebhookEvent.id: str - added:
field RealtimeCallIncomingWebhookEvent.object: Optional[Literal['event']] - added:
field RealtimeCallIncomingWebhookEvent.type: Literal['realtime.call.incoming']
- added:
class Data(BaseModel) - added:
class ResponseCancelledWebhookEvent(BaseModel) - added:
field Data.id: str - added:
field ResponseCancelledWebhookEvent.created_at: int - added:
field ResponseCancelledWebhookEvent.data: Data - added:
field ResponseCancelledWebhookEvent.id: str - added:
field ResponseCancelledWebhookEvent.object: Optional[Literal['event']] - added:
field ResponseCancelledWebhookEvent.type: Literal['response.cancelled']
- added:
class Data(BaseModel) - added:
class ResponseCompletedWebhookEvent(BaseModel) - added:
field Data.id: str - added:
field ResponseCompletedWebhookEvent.created_at: int - added:
field ResponseCompletedWebhookEvent.data: Data - added:
field ResponseCompletedWebhookEvent.id: str - added:
field ResponseCompletedWebhookEvent.object: Optional[Literal['event']] - added:
field ResponseCompletedWebhookEvent.type: Literal['response.completed']
- added:
class Data(BaseModel) - added:
class ResponseFailedWebhookEvent(BaseModel) - added:
field Data.id: str - added:
field ResponseFailedWebhookEvent.created_at: int - added:
field ResponseFailedWebhookEvent.data: Data - added:
field ResponseFailedWebhookEvent.id: str - added:
field ResponseFailedWebhookEvent.object: Optional[Literal['event']] - added:
field ResponseFailedWebhookEvent.type: Literal['response.failed']
- added:
class Data(BaseModel) - added:
class ResponseIncompleteWebhookEvent(BaseModel) - added:
field Data.id: str - added:
field ResponseIncompleteWebhookEvent.created_at: int - added:
field ResponseIncompleteWebhookEvent.data: Data - added:
field ResponseIncompleteWebhookEvent.id: str - added:
field ResponseIncompleteWebhookEvent.object: Optional[Literal['event']] - added:
field ResponseIncompleteWebhookEvent.type: Literal['response.incomplete']
- added:
variable UnwrapWebhookEvent: TypeAlias
- added:
class WebsocketConnectionOptions(TypedDict) - added:
field WebsocketConnectionOptions.compression: str | None - added:
field WebsocketConnectionOptions.extensions: Sequence[ClientExtensionFactory] | None - added:
field WebsocketConnectionOptions.max_queue: int | None | tuple[int | None, int | None] - added:
field WebsocketConnectionOptions.max_size: int | None - added:
field WebsocketConnectionOptions.subprotocols: Sequence[Subprotocol] | None - added:
field WebsocketConnectionOptions.write_limit: int | tuple[int, int | None]
- removed:
class BufferReader(io.BytesIO) - removed:
class CancelledError(Exception) - removed:
constructor BufferReader(buf=…, desc=…) - removed:
constructor CancelledError(msg) - removed:
function MB(i) - removed:
function progress(total, desc) - removed:
method BufferReader.read(n=…)
- removed:
function log_debug(message, **params) - removed:
function log_info(message, **params) - removed:
function log_warn(message, **params) - removed:
function logfmt(props)
- removed:
class Remediation(NamedTuple) - removed:
field Remediation.error_msg: Optional[str] - removed:
field Remediation.immediate_msg: Optional[str] - removed:
field Remediation.name: str - removed:
field Remediation.necessary_fn: Optional[Callable[[Any], Any]] - removed:
field Remediation.necessary_msg: Optional[str] - removed:
field Remediation.optional_fn: Optional[Callable[[Any], Any]] - removed:
field Remediation.optional_msg: Optional[str] - removed:
function accept_suggestion(input_text, auto_accept) - removed:
function additional_column_validator(df, fields=…) - removed:
function apply_necessary_remediation(df, remediation) - removed:
function apply_optional_remediation(df, remediation, auto_accept) - removed:
function apply_validators(df, fname, remediation, validators, auto_accept, write_out_file_func) - removed:
function common_completion_prefix_validator(df) - removed:
function common_completion_suffix_validator(df) - removed:
function common_prompt_prefix_validator(df) - removed:
function common_prompt_suffix_validator(df) - removed:
function completions_space_start_validator(df) - removed:
function duplicated_rows_validator(df, fields=…) - removed:
function estimate_fine_tuning_time(df) - removed:
function format_inferrer_validator(df) - removed:
function get_classification_hyperparams(df) - removed:
function get_common_xfix(series, xfix=…) - removed:
function get_outfnames(fname, split) - removed:
function get_validators() - removed:
function infer_task_type(df) - removed:
function long_examples_validator(df) - removed:
function lower_case_validator(df, column) - removed:
function necessary_column_validator(df, necessary_column) - removed:
function non_empty_field_validator(df, field=…) - removed:
function num_examples_validator(df) - removed:
function read_any_format(fname, fields=…) - removed:
function write_out_file(df, fname, any_remediations, auto_accept)
- changed:
variable VERSION → variable VERSION: str
- removed:
class WandbLogger - removed:
static method WandbLogger.sync(id=…, n_fine_tunes=…, project=…, entity=…, force=…, legacy=…, **kwargs_wandb_init) - removed:
variable WANDB_AVAILABLE