Compared with 4.104.0: `OpenAI.ChatCompletionFunctionMessageParam`, `OpenAI.EvalStoredCompletionsDataSourceConfig`, `OpenAI.images.createVariation`, `OpenAI.Beta.Realtime`, `OpenAI.Beta.Threads`, and 49 more. 15 newly deprecated.
openai 4.104.0 → 7.42.0: deprecates 54 API(s): from its source to your code
OpenAI.EvalStoredCompletionsDataSourceConfig: Deprecated in favor of LogsDataSourceConfig.
OpenAI.images.createVariation: This endpoint is retired and no longer available. Use the image edits endpoint with a GPT Image model and a prompt to create a variation of an image. The request and response schemas below describe the legacy contract.
OpenAI.Beta.Realtime: Realtime has now launched and is generally available. The old beta API is now deprecated.
OpenAI.Beta.Threads: Build Assistants that can call models and use tools. The Assistants API is deprecated in favor of the Responses API
OpenAI.Beta.Assistant: Represents an `assistant` that can call the model and use tools.
OpenAI.ChatCompletion.system_fingerprint: This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.
OpenAI.ChatCompletionAssistantMessageParam.function_call: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.
OpenAI.ChatCompletionAssistantMessageParam.FunctionCall: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.
OpenAI.ChatCompletionChunk.system_fingerprint: This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.
OpenAI.ChatCompletionMessage.function_call: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.
OpenAI.ChatCompletionMessage.FunctionCall: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.
OpenAI.ChatCompletionCreateParamsNonStreaming.function_call: Deprecated in favor of `tool_choice`. Controls which (if any) function is called by the model. `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function. Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. `none` is the default when no functions are present. `auto` is the default if functions are present.
OpenAI.ChatCompletionCreateParamsNonStreaming.functions: Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for.
OpenAI.ChatCompletionCreateParamsNonStreaming.max_tokens: The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the chat completion. This value can be used to control [costs](https://openai.com/api/pricing/) for text generated via API. This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with [o-series models](https://developers.openai.com/api/docs/guides/reasoning).
OpenAI.ChatCompletionCreateParamsNonStreaming.seed: This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.
OpenAI.ChatCompletionCreateParamsNonStreaming.user: This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
OpenAI.FileObject.status: Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`.
OpenAI.FileObject.status_details: Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`.
OpenAI.EvalCreateParams.StoredCompletions: Deprecated in favor of LogsDataSourceConfig.
OpenAI.Reasoning.generate_summary: **Deprecated:** use `summary` instead. A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of `auto`, `concise`, or `detailed`.
OpenAI.beta.assistants.create: Create an assistant with a model and instructions.
OpenAI.beta.assistants.retrieve: Retrieves an assistant.
OpenAI.beta.assistants.update: Modifies an assistant.
OpenAI.beta.assistants.list: Returns a list of assistants.
OpenAI.beta.threads.create: Create a thread. The Assistants API is deprecated in favor of the Responses API
OpenAI.beta.threads.retrieve: Retrieves a thread. The Assistants API is deprecated in favor of the Responses API
OpenAI.beta.threads.update: Modifies a thread. The Assistants API is deprecated in favor of the Responses API
OpenAI.beta.threads.createAndRun: Create a thread and run it in one request. The Assistants API is deprecated in favor of the Responses API
OpenAI.FineTuning.JobCreateParams.hyperparameters: The hyperparameters used for the fine-tuning job. This value is now deprecated in favor of `method`, and should be passed in under the `method` parameter.
OpenAI.FineTuning.JobCreateParams.Hyperparameters: The hyperparameters used for the fine-tuning job. This value is now deprecated in favor of `method`, and should be passed in under the `method` parameter.
OpenAI.Beta.Threads.Runs: Build Assistants that can call models and use tools. The Assistants API is deprecated in favor of the Responses API
OpenAI.Beta.Threads.Messages: Build Assistants that can call models and use tools. The Assistants API is deprecated in favor of the Responses API
OpenAI.Responses.Response.user: This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
OpenAI.Responses.ResponseCreateParamsNonStreaming.truncation: The truncation strategy to use for the model response. - `auto`: If the input to this Response exceeds the model's context window size, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation. - `disabled` (default): If the input size will exceed the context window size for a model, the request will fail with a 400 error.
OpenAI.Responses.ResponseCreateParamsNonStreaming.user: This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
OpenAI.fineTuning.checkpoints.permissions.retrieve: **NOTE:** This endpoint requires an [admin API key](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/admin_api_keys). Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint. Retrieve is deprecated. Please swap to the paginated list method instead.
OpenAI.beta.threads.runs.create: Create a run. The Assistants API is deprecated in favor of the Responses API
OpenAI.beta.threads.runs.retrieve: Retrieves a run. The Assistants API is deprecated in favor of the Responses API
OpenAI.beta.threads.runs.update: Modifies a run. The Assistants API is deprecated in favor of the Responses API
OpenAI.beta.threads.runs.list: Returns a list of runs belonging to a thread. The Assistants API is deprecated in favor of the Responses API
OpenAI.beta.threads.runs.cancel: Cancels a run that is `in_progress`. The Assistants API is deprecated in favor of the Responses API
OpenAI.beta.threads.runs.createAndStream: Create a Run stream use `stream` instead
OpenAI.beta.threads.runs.submitToolOutputs: When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. The Assistants API is deprecated in favor of the Responses API
OpenAI.beta.threads.messages.create: Create a message. The Assistants API is deprecated in favor of the Responses API
OpenAI.beta.threads.messages.retrieve: Retrieve a message. The Assistants API is deprecated in favor of the Responses API
OpenAI.beta.threads.messages.update: Modifies a message. The Assistants API is deprecated in favor of the Responses API
OpenAI.beta.threads.messages.list: Returns a list of messages for a given thread. The Assistants API is deprecated in favor of the Responses API
OpenAI.Beta.Threads.Runs.Steps: Build Assistants that can call models and use tools. The Assistants API is deprecated in favor of the Responses API
OpenAI.ChatCompletionChunk.Choice.delta.function_call: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.
OpenAI.ChatCompletionChunk.Choice.Delta.FunctionCall: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.