Skip to content

Commit 6f5c564

Browse files
s-akhtar-baigs-akhtar-baig
committed
Update docs
1 parent bcb540e commit 6f5c564

File tree

5 files changed

+635
-153
lines changed

5 files changed

+635
-153
lines changed

‎client-sdks/stainless/openapi.yml‎

Lines changed: 139 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4450,15 +4450,15 @@ components:
44504450
type: number
44514451
title: Logprob
44524452
top_logprobs:
4453-
items:
4454-
$ref: '#/components/schemas/OpenAITopLogProb'
4455-
type: array
4456-
title: Top Logprobs
4453+
anyOf:
4454+
- items:
4455+
$ref: '#/components/schemas/OpenAITopLogProb'
4456+
type: array
4457+
- type: 'null'
44574458
type: object
44584459
required:
44594460
- token
44604461
- logprob
4461-
- top_logprobs
44624462
title: OpenAITokenLogProb
44634463
description: |-
44644464
The log probability for a token from an OpenAI-compatible chat completion response.
@@ -5546,15 +5546,22 @@ components:
55465546
OpenAIResponseOutputMessageContentOutputText:
55475547
properties:
55485548
text:
5549-
type: string
55505549
title: Text
5551-
type:
55525550
type: string
5551+
type:
55535552
const: output_text
5554-
title: Type
55555553
default: output_text
5554+
title: Type
5555+
type: string
55565556
annotations:
55575557
items:
5558+
discriminator:
5559+
mapping:
5560+
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
5561+
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
5562+
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
5563+
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
5564+
propertyName: type
55585565
oneOf:
55595566
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
55605567
title: OpenAIResponseAnnotationFileCitation
@@ -5564,20 +5571,20 @@ components:
55645571
title: OpenAIResponseAnnotationContainerFileCitation
55655572
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
55665573
title: OpenAIResponseAnnotationFilePath
5567-
discriminator:
5568-
propertyName: type
5569-
mapping:
5570-
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
5571-
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
5572-
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
5573-
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
55745574
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
5575-
type: array
55765575
title: Annotations
5577-
type: object
5576+
type: array
5577+
logprobs:
5578+
anyOf:
5579+
- items:
5580+
$ref: '#/components/schemas/OpenAITokenLogProb'
5581+
type: array
5582+
- type: 'null'
5583+
nullable: true
55785584
required:
55795585
- text
55805586
title: OpenAIResponseOutputMessageContentOutputText
5587+
type: object
55815588
OpenAIResponseOutputMessageFileSearchToolCall:
55825589
properties:
55835590
id:
@@ -7187,7 +7194,7 @@ components:
71877194
include:
71887195
anyOf:
71897196
- items:
7190-
type: string
7197+
$ref: '#/components/schemas/ResponseItemInclude'
71917198
type: array
71927199
- type: 'null'
71937200
max_infer_iters:
@@ -7374,8 +7381,7 @@ components:
73747381
logprobs:
73757382
anyOf:
73767383
- items:
7377-
additionalProperties: true
7378-
type: object
7384+
$ref: '#/components/schemas/OpenAITokenLogProb'
73797385
type: array
73807386
- type: 'null'
73817387
nullable: true
@@ -8137,6 +8143,13 @@ components:
81378143
item_id:
81388144
title: Item Id
81398145
type: string
8146+
logprobs:
8147+
anyOf:
8148+
- items:
8149+
$ref: '#/components/schemas/OpenAITokenLogProb'
8150+
type: array
8151+
- type: 'null'
8152+
nullable: true
81408153
output_index:
81418154
title: Output Index
81428155
type: integer
@@ -11803,19 +11816,19 @@ components:
1180311816
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
1180411817
- items:
1180511818
oneOf:
11806-
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
11807-
title: OpenAIResponseOutputMessageContentOutputText
11819+
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input'
11820+
title: OpenAIResponseOutputMessageContentOutputText-Input
1180811821
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
1180911822
title: OpenAIResponseContentPartRefusal
1181011823
discriminator:
1181111824
propertyName: type
1181211825
mapping:
11813-
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
11826+
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input'
1181411827
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
11815-
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal
11828+
title: OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal
1181611829
type: array
11817-
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
11818-
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
11830+
title: list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal]
11831+
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal]
1181911832
role:
1182011833
title: Role
1182111834
type: string
@@ -11872,19 +11885,19 @@ components:
1187211885
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
1187311886
- items:
1187411887
oneOf:
11875-
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
11876-
title: OpenAIResponseOutputMessageContentOutputText
11888+
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
11889+
title: OpenAIResponseOutputMessageContentOutputText-Output
1187711890
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
1187811891
title: OpenAIResponseContentPartRefusal
1187911892
discriminator:
1188011893
propertyName: type
1188111894
mapping:
11882-
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
11895+
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
1188311896
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
11884-
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal
11897+
title: OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal
1188511898
type: array
11886-
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
11887-
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal]
11899+
title: list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
11900+
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
1188811901
role:
1188911902
title: Role
1189011903
type: string
@@ -11917,6 +11930,88 @@ components:
1191711930
They are all under one type because the Responses API gives them all
1191811931
the same "type" value, and there is no way to tell them apart in certain
1191911932
scenarios.
11933+
OpenAIResponseOutputMessageContentOutputText-Input:
11934+
properties:
11935+
text:
11936+
type: string
11937+
title: Text
11938+
type:
11939+
type: string
11940+
const: output_text
11941+
title: Type
11942+
default: output_text
11943+
annotations:
11944+
items:
11945+
oneOf:
11946+
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
11947+
title: OpenAIResponseAnnotationFileCitation
11948+
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
11949+
title: OpenAIResponseAnnotationCitation
11950+
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
11951+
title: OpenAIResponseAnnotationContainerFileCitation
11952+
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
11953+
title: OpenAIResponseAnnotationFilePath
11954+
discriminator:
11955+
propertyName: type
11956+
mapping:
11957+
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
11958+
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
11959+
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
11960+
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
11961+
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
11962+
type: array
11963+
title: Annotations
11964+
logprobs:
11965+
anyOf:
11966+
- items:
11967+
$ref: '#/components/schemas/OpenAITokenLogProb'
11968+
type: array
11969+
- type: 'null'
11970+
type: object
11971+
required:
11972+
- text
11973+
title: OpenAIResponseOutputMessageContentOutputText
11974+
OpenAIResponseOutputMessageContentOutputText-Output:
11975+
properties:
11976+
text:
11977+
type: string
11978+
title: Text
11979+
type:
11980+
type: string
11981+
const: output_text
11982+
title: Type
11983+
default: output_text
11984+
annotations:
11985+
items:
11986+
oneOf:
11987+
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
11988+
title: OpenAIResponseAnnotationFileCitation
11989+
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
11990+
title: OpenAIResponseAnnotationCitation
11991+
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
11992+
title: OpenAIResponseAnnotationContainerFileCitation
11993+
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
11994+
title: OpenAIResponseAnnotationFilePath
11995+
discriminator:
11996+
propertyName: type
11997+
mapping:
11998+
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
11999+
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
12000+
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
12001+
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
12002+
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
12003+
type: array
12004+
title: Annotations
12005+
logprobs:
12006+
anyOf:
12007+
- items:
12008+
$ref: '#/components/schemas/OpenAITokenLogProb'
12009+
type: array
12010+
- type: 'null'
12011+
type: object
12012+
required:
12013+
- text
12014+
title: OpenAIResponseOutputMessageContentOutputText
1192012015
OpenAIResponseOutputMessageFileSearchToolCallResults:
1192112016
properties:
1192212017
attributes:
@@ -12076,6 +12171,18 @@ components:
1207612171
required:
1207712172
- reasoning_tokens
1207812173
title: OutputTokensDetails
12174+
ResponseItemInclude:
12175+
type: string
12176+
enum:
12177+
- web_search_call.action.sources
12178+
- code_interpreter_call.outputs
12179+
- computer_call_output.output.image_url
12180+
- file_search_call.results
12181+
- message.input_image.image_url
12182+
- message.output_text.logprobs
12183+
- reasoning.encrypted_content
12184+
title: ResponseItemInclude
12185+
description: Specify additional output data to include in the model response.
1207912186
SearchRankingOptions:
1208012187
properties:
1208112188
ranker:

0 commit comments

Comments
 (0)