update conversations API stubs

This commit is contained in:
Ashwin Bharambe 2025-10-22 11:07:06 -07:00
parent 5da1b4f81e
commit cc4009603b
6 changed files with 141 additions and 387 deletions

View file

@ -483,86 +483,42 @@
"name": "after",
"in": "query",
"description": "An item ID to list items after, used in pagination.",
"required": true,
"required": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"title": "NotGiven",
"description": "For parameters with a meaningful None value, we need to distinguish between the user explicitly passing None, and the user not passing the parameter at all.\nUser code shouldn't need to use not_given directly.\n\nFor example:\n\n```py\ndef create(timeout: Timeout | None | NotGiven = not_given): ...\n\n\ncreate(timeout=1) # 1s timeout\ncreate(timeout=None) # No timeout\ncreate() # Default timeout behavior\n```"
}
]
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "Specify additional output data to include in the response.",
"required": true,
"required": false,
"schema": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"code_interpreter_call.outputs",
"computer_call_output.output.image_url",
"file_search_call.results",
"message.input_image.image_url",
"message.output_text.logprobs",
"reasoning.encrypted_content"
]
}
},
{
"type": "object",
"title": "NotGiven",
"description": "For parameters with a meaningful None value, we need to distinguish between the user explicitly passing None, and the user not passing the parameter at all.\nUser code shouldn't need to use not_given directly.\n\nFor example:\n\n```py\ndef create(timeout: Timeout | None | NotGiven = not_given): ...\n\n\ncreate(timeout=1) # 1s timeout\ncreate(timeout=None) # No timeout\ncreate() # Default timeout behavior\n```"
}
]
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationItemInclude"
}
}
},
{
"name": "limit",
"in": "query",
"description": "A limit on the number of objects to be returned (1-100, default 20).",
"required": true,
"required": false,
"schema": {
"oneOf": [
{
"type": "integer"
},
{
"type": "object",
"title": "NotGiven",
"description": "For parameters with a meaningful None value, we need to distinguish between the user explicitly passing None, and the user not passing the parameter at all.\nUser code shouldn't need to use not_given directly.\n\nFor example:\n\n```py\ndef create(timeout: Timeout | None | NotGiven = not_given): ...\n\n\ncreate(timeout=1) # 1s timeout\ncreate(timeout=None) # No timeout\ncreate() # Default timeout behavior\n```"
}
]
"type": "integer"
}
},
{
"name": "order",
"in": "query",
"description": "The order to return items in (asc or desc, default desc).",
"required": true,
"required": false,
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"asc",
"desc"
]
},
{
"type": "object",
"title": "NotGiven",
"description": "For parameters with a meaningful None value, we need to distinguish between the user explicitly passing None, and the user not passing the parameter at all.\nUser code shouldn't need to use not_given directly.\n\nFor example:\n\n```py\ndef create(timeout: Timeout | None | NotGiven = not_given): ...\n\n\ncreate(timeout=1) # 1s timeout\ncreate(timeout=None) # No timeout\ncreate() # Default timeout behavior\n```"
}
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
@ -6355,6 +6311,20 @@
"title": "ConversationDeletedResource",
"description": "Response for deleted conversation."
},
"ConversationItemInclude": {
"type": "string",
"enum": [
"web_search_call.action.sources",
"code_interpreter_call.outputs",
"computer_call_output.output.image_url",
"file_search_call.results",
"message.input_image.image_url",
"message.output_text.logprobs",
"reasoning.encrypted_content"
],
"title": "ConversationItemInclude",
"description": "Specify additional output data to include in the model response."
},
"ConversationItemList": {
"type": "object",
"properties": {

View file

@ -347,150 +347,35 @@ paths:
in: query
description: >-
An item ID to list items after, used in pagination.
required: true
required: false
schema:
oneOf:
- type: string
- type: object
title: NotGiven
description: >-
For parameters with a meaningful None value, we need to distinguish
between the user explicitly passing None, and the user not passing
the parameter at all.
User code shouldn't need to use not_given directly.
For example:
```py
def create(timeout: Timeout | None | NotGiven = not_given): ...
create(timeout=1) # 1s timeout
create(timeout=None) # No timeout
create() # Default timeout behavior
```
type: string
- name: include
in: query
description: >-
Specify additional output data to include in the response.
required: true
required: false
schema:
oneOf:
- type: array
items:
type: string
enum:
- code_interpreter_call.outputs
- computer_call_output.output.image_url
- file_search_call.results
- message.input_image.image_url
- message.output_text.logprobs
- reasoning.encrypted_content
- type: object
title: NotGiven
description: >-
For parameters with a meaningful None value, we need to distinguish
between the user explicitly passing None, and the user not passing
the parameter at all.
User code shouldn't need to use not_given directly.
For example:
```py
def create(timeout: Timeout | None | NotGiven = not_given): ...
create(timeout=1) # 1s timeout
create(timeout=None) # No timeout
create() # Default timeout behavior
```
type: array
items:
$ref: '#/components/schemas/ConversationItemInclude'
- name: limit
in: query
description: >-
A limit on the number of objects to be returned (1-100, default 20).
required: true
required: false
schema:
oneOf:
- type: integer
- type: object
title: NotGiven
description: >-
For parameters with a meaningful None value, we need to distinguish
between the user explicitly passing None, and the user not passing
the parameter at all.
User code shouldn't need to use not_given directly.
For example:
```py
def create(timeout: Timeout | None | NotGiven = not_given): ...
create(timeout=1) # 1s timeout
create(timeout=None) # No timeout
create() # Default timeout behavior
```
type: integer
- name: order
in: query
description: >-
The order to return items in (asc or desc, default desc).
required: true
required: false
schema:
oneOf:
- type: string
enum:
- asc
- desc
- type: object
title: NotGiven
description: >-
For parameters with a meaningful None value, we need to distinguish
between the user explicitly passing None, and the user not passing
the parameter at all.
User code shouldn't need to use not_given directly.
For example:
```py
def create(timeout: Timeout | None | NotGiven = not_given): ...
create(timeout=1) # 1s timeout
create(timeout=None) # No timeout
create() # Default timeout behavior
```
type: string
enum:
- asc
- desc
deprecated: false
post:
responses:
@ -4853,6 +4738,19 @@ components:
- deleted
title: ConversationDeletedResource
description: Response for deleted conversation.
ConversationItemInclude:
type: string
enum:
- web_search_call.action.sources
- code_interpreter_call.outputs
- computer_call_output.output.image_url
- file_search_call.results
- message.input_image.image_url
- message.output_text.logprobs
- reasoning.encrypted_content
title: ConversationItemInclude
description: >-
Specify additional output data to include in the model response.
ConversationItemList:
type: object
properties:

View file

@ -483,86 +483,42 @@
"name": "after",
"in": "query",
"description": "An item ID to list items after, used in pagination.",
"required": true,
"required": false,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"title": "NotGiven",
"description": "For parameters with a meaningful None value, we need to distinguish between the user explicitly passing None, and the user not passing the parameter at all.\nUser code shouldn't need to use not_given directly.\n\nFor example:\n\n```py\ndef create(timeout: Timeout | None | NotGiven = not_given): ...\n\n\ncreate(timeout=1) # 1s timeout\ncreate(timeout=None) # No timeout\ncreate() # Default timeout behavior\n```"
}
]
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "Specify additional output data to include in the response.",
"required": true,
"required": false,
"schema": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"code_interpreter_call.outputs",
"computer_call_output.output.image_url",
"file_search_call.results",
"message.input_image.image_url",
"message.output_text.logprobs",
"reasoning.encrypted_content"
]
}
},
{
"type": "object",
"title": "NotGiven",
"description": "For parameters with a meaningful None value, we need to distinguish between the user explicitly passing None, and the user not passing the parameter at all.\nUser code shouldn't need to use not_given directly.\n\nFor example:\n\n```py\ndef create(timeout: Timeout | None | NotGiven = not_given): ...\n\n\ncreate(timeout=1) # 1s timeout\ncreate(timeout=None) # No timeout\ncreate() # Default timeout behavior\n```"
}
]
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationItemInclude"
}
}
},
{
"name": "limit",
"in": "query",
"description": "A limit on the number of objects to be returned (1-100, default 20).",
"required": true,
"required": false,
"schema": {
"oneOf": [
{
"type": "integer"
},
{
"type": "object",
"title": "NotGiven",
"description": "For parameters with a meaningful None value, we need to distinguish between the user explicitly passing None, and the user not passing the parameter at all.\nUser code shouldn't need to use not_given directly.\n\nFor example:\n\n```py\ndef create(timeout: Timeout | None | NotGiven = not_given): ...\n\n\ncreate(timeout=1) # 1s timeout\ncreate(timeout=None) # No timeout\ncreate() # Default timeout behavior\n```"
}
]
"type": "integer"
}
},
{
"name": "order",
"in": "query",
"description": "The order to return items in (asc or desc, default desc).",
"required": true,
"required": false,
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"asc",
"desc"
]
},
{
"type": "object",
"title": "NotGiven",
"description": "For parameters with a meaningful None value, we need to distinguish between the user explicitly passing None, and the user not passing the parameter at all.\nUser code shouldn't need to use not_given directly.\n\nFor example:\n\n```py\ndef create(timeout: Timeout | None | NotGiven = not_given): ...\n\n\ncreate(timeout=1) # 1s timeout\ncreate(timeout=None) # No timeout\ncreate() # Default timeout behavior\n```"
}
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
@ -8027,6 +7983,20 @@
"title": "ConversationDeletedResource",
"description": "Response for deleted conversation."
},
"ConversationItemInclude": {
"type": "string",
"enum": [
"web_search_call.action.sources",
"code_interpreter_call.outputs",
"computer_call_output.output.image_url",
"file_search_call.results",
"message.input_image.image_url",
"message.output_text.logprobs",
"reasoning.encrypted_content"
],
"title": "ConversationItemInclude",
"description": "Specify additional output data to include in the model response."
},
"ConversationItemList": {
"type": "object",
"properties": {

View file

@ -350,150 +350,35 @@ paths:
in: query
description: >-
An item ID to list items after, used in pagination.
required: true
required: false
schema:
oneOf:
- type: string
- type: object
title: NotGiven
description: >-
For parameters with a meaningful None value, we need to distinguish
between the user explicitly passing None, and the user not passing
the parameter at all.
User code shouldn't need to use not_given directly.
For example:
```py
def create(timeout: Timeout | None | NotGiven = not_given): ...
create(timeout=1) # 1s timeout
create(timeout=None) # No timeout
create() # Default timeout behavior
```
type: string
- name: include
in: query
description: >-
Specify additional output data to include in the response.
required: true
required: false
schema:
oneOf:
- type: array
items:
type: string
enum:
- code_interpreter_call.outputs
- computer_call_output.output.image_url
- file_search_call.results
- message.input_image.image_url
- message.output_text.logprobs
- reasoning.encrypted_content
- type: object
title: NotGiven
description: >-
For parameters with a meaningful None value, we need to distinguish
between the user explicitly passing None, and the user not passing
the parameter at all.
User code shouldn't need to use not_given directly.
For example:
```py
def create(timeout: Timeout | None | NotGiven = not_given): ...
create(timeout=1) # 1s timeout
create(timeout=None) # No timeout
create() # Default timeout behavior
```
type: array
items:
$ref: '#/components/schemas/ConversationItemInclude'
- name: limit
in: query
description: >-
A limit on the number of objects to be returned (1-100, default 20).
required: true
required: false
schema:
oneOf:
- type: integer
- type: object
title: NotGiven
description: >-
For parameters with a meaningful None value, we need to distinguish
between the user explicitly passing None, and the user not passing
the parameter at all.
User code shouldn't need to use not_given directly.
For example:
```py
def create(timeout: Timeout | None | NotGiven = not_given): ...
create(timeout=1) # 1s timeout
create(timeout=None) # No timeout
create() # Default timeout behavior
```
type: integer
- name: order
in: query
description: >-
The order to return items in (asc or desc, default desc).
required: true
required: false
schema:
oneOf:
- type: string
enum:
- asc
- desc
- type: object
title: NotGiven
description: >-
For parameters with a meaningful None value, we need to distinguish
between the user explicitly passing None, and the user not passing
the parameter at all.
User code shouldn't need to use not_given directly.
For example:
```py
def create(timeout: Timeout | None | NotGiven = not_given): ...
create(timeout=1) # 1s timeout
create(timeout=None) # No timeout
create() # Default timeout behavior
```
type: string
enum:
- asc
- desc
deprecated: false
post:
responses:
@ -6066,6 +5951,19 @@ components:
- deleted
title: ConversationDeletedResource
description: Response for deleted conversation.
ConversationItemInclude:
type: string
enum:
- web_search_call.action.sources
- code_interpreter_call.outputs
- computer_call_output.output.image_url
- file_search_call.results
- message.input_image.image_url
- message.output_text.logprobs
- reasoning.encrypted_content
title: ConversationItemInclude
description: >-
Specify additional output data to include in the model response.
ConversationItemList:
type: object
properties: