phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-12-03 01:48:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docs

Browse source
This commit is contained in:
Shabana Baig 2025-11-30 12:02:51 -05:00
parent 7d6c0aaf11
commit 937464252c
5 changed files with 635 additions and 153 deletions
Download patch file Download diff file Expand all files Collapse all files

171
client-sdks/stainless/openapi.yml
View file

@ -4456,15 +4456,15 @@ components:
type: number type: number
title: Logprob title: Logprob
top_logprobs: top_logprobs:
items: anyOf:
$ref: '#/components/schemas/OpenAITopLogProb' - items:
type: array $ref: '#/components/schemas/OpenAITopLogProb'
title: Top Logprobs type: array
- type: 'null'
type: object type: object
required: required:
- token - token
- logprob - logprob
- top_logprobs
title: OpenAITokenLogProb title: OpenAITokenLogProb
description: |- description: |-
The log probability for a token from an OpenAI-compatible chat completion response. The log probability for a token from an OpenAI-compatible chat completion response.
@ -5552,15 +5552,22 @@ components:
OpenAIResponseOutputMessageContentOutputText: OpenAIResponseOutputMessageContentOutputText:
properties: properties:
text: text:
type: string
title: Text title: Text
type:
type: string type: string
type:
const: output_text const: output_text
title: Type
default: output_text default: output_text
title: Type
type: string
annotations: annotations:
items: items:
discriminator:
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
propertyName: type
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation title: OpenAIResponseAnnotationFileCitation
@ -5570,20 +5577,20 @@ components:
title: OpenAIResponseAnnotationContainerFileCitation title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants) title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations title: Annotations
type: object type: array
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
nullable: true
required: required:
- text - text
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText
type: object
OpenAIResponseOutputMessageFileSearchToolCall: OpenAIResponseOutputMessageFileSearchToolCall:
properties: properties:
id: id:
@ -7199,7 +7206,7 @@ components:
include: include:
anyOf: anyOf:
- items: - items:
type: string $ref: '#/components/schemas/ResponseItemInclude'
type: array type: array
- type: 'null' - type: 'null'
max_infer_iters: max_infer_iters:
@ -7398,8 +7405,7 @@ components:
logprobs: logprobs:
anyOf: anyOf:
- items: - items:
additionalProperties: true $ref: '#/components/schemas/OpenAITokenLogProb'
type: object
type: array type: array
- type: 'null' - type: 'null'
nullable: true nullable: true
@ -8161,6 +8167,13 @@ components:
item_id: item_id:
title: Item Id title: Item Id
type: string type: string
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
nullable: true
output_index: output_index:
title: Output Index title: Output Index
type: integer type: integer
@ -11827,19 +11840,19 @@ components:
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
- items: - items:
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input'
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText-Input
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseContentPartRefusal title: OpenAIResponseContentPartRefusal
discriminator: discriminator:
propertyName: type propertyName: type
mapping: mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal
type: array type: array
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal]
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal]
role: role:
title: Role title: Role
type: string type: string
@ -11896,19 +11909,19 @@ components:
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
- items: - items:
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText-Output
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseContentPartRefusal title: OpenAIResponseContentPartRefusal
discriminator: discriminator:
propertyName: type propertyName: type
mapping: mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal
type: array type: array
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
role: role:
title: Role title: Role
type: string type: string
@ -11941,6 +11954,88 @@ components:
They are all under one type because the Responses API gives them all They are all under one type because the Responses API gives them all
the same "type" value, and there is no way to tell them apart in certain the same "type" value, and there is no way to tell them apart in certain
scenarios. scenarios.
OpenAIResponseOutputMessageContentOutputText-Input:
properties:
text:
type: string
title: Text
type:
type: string
const: output_text
title: Type
default: output_text
annotations:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
type: object
required:
- text
title: OpenAIResponseOutputMessageContentOutputText
OpenAIResponseOutputMessageContentOutputText-Output:
properties:
text:
type: string
title: Text
type:
type: string
const: output_text
title: Type
default: output_text
annotations:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
type: object
required:
- text
title: OpenAIResponseOutputMessageContentOutputText
OpenAIResponseOutputMessageFileSearchToolCallResults: OpenAIResponseOutputMessageFileSearchToolCallResults:
properties: properties:
attributes: attributes:
@ -12100,6 +12195,18 @@ components:
required: required:
- reasoning_tokens - reasoning_tokens
title: OutputTokensDetails title: OutputTokensDetails
ResponseItemInclude:
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: ResponseItemInclude
description: Specify additional output data to include in the model response.
SearchRankingOptions: SearchRankingOptions:
properties: properties:
ranker: ranker:

171
docs/static/deprecated-llama-stack-spec.yaml vendored
View file

@ -1450,15 +1450,15 @@ components:
type: number type: number
title: Logprob title: Logprob
top_logprobs: top_logprobs:
items: anyOf:
$ref: '#/components/schemas/OpenAITopLogProb' - items:
type: array $ref: '#/components/schemas/OpenAITopLogProb'
title: Top Logprobs type: array
- type: 'null'
type: object type: object
required: required:
- token - token
- logprob - logprob
- top_logprobs
title: OpenAITokenLogProb title: OpenAITokenLogProb
description: |- description: |-
The log probability for a token from an OpenAI-compatible chat completion response. The log probability for a token from an OpenAI-compatible chat completion response.
@ -2546,15 +2546,22 @@ components:
OpenAIResponseOutputMessageContentOutputText: OpenAIResponseOutputMessageContentOutputText:
properties: properties:
text: text:
type: string
title: Text title: Text
type:
type: string type: string
type:
const: output_text const: output_text
title: Type
default: output_text default: output_text
title: Type
type: string
annotations: annotations:
items: items:
discriminator:
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
propertyName: type
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation title: OpenAIResponseAnnotationFileCitation
@ -2564,20 +2571,20 @@ components:
title: OpenAIResponseAnnotationContainerFileCitation title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants) title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations title: Annotations
type: object type: array
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
nullable: true
required: required:
- text - text
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText
type: object
OpenAIResponseOutputMessageFileSearchToolCall: OpenAIResponseOutputMessageFileSearchToolCall:
properties: properties:
id: id:
@ -4193,7 +4200,7 @@ components:
include: include:
anyOf: anyOf:
- items: - items:
type: string $ref: '#/components/schemas/ResponseItemInclude'
type: array type: array
- type: 'null' - type: 'null'
max_infer_iters: max_infer_iters:
@ -4392,8 +4399,7 @@ components:
logprobs: logprobs:
anyOf: anyOf:
- items: - items:
additionalProperties: true $ref: '#/components/schemas/OpenAITokenLogProb'
type: object
type: array type: array
- type: 'null' - type: 'null'
nullable: true nullable: true
@ -5155,6 +5161,13 @@ components:
item_id: item_id:
title: Item Id title: Item Id
type: string type: string
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
nullable: true
output_index: output_index:
title: Output Index title: Output Index
type: integer type: integer
@ -8821,19 +8834,19 @@ components:
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
- items: - items:
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input'
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText-Input
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseContentPartRefusal title: OpenAIResponseContentPartRefusal
discriminator: discriminator:
propertyName: type propertyName: type
mapping: mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal
type: array type: array
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal]
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal]
role: role:
title: Role title: Role
type: string type: string
@ -8890,19 +8903,19 @@ components:
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
- items: - items:
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText-Output
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseContentPartRefusal title: OpenAIResponseContentPartRefusal
discriminator: discriminator:
propertyName: type propertyName: type
mapping: mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal
type: array type: array
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
role: role:
title: Role title: Role
type: string type: string
@ -8935,6 +8948,88 @@ components:
They are all under one type because the Responses API gives them all They are all under one type because the Responses API gives them all
the same "type" value, and there is no way to tell them apart in certain the same "type" value, and there is no way to tell them apart in certain
scenarios. scenarios.
OpenAIResponseOutputMessageContentOutputText-Input:
properties:
text:
type: string
title: Text
type:
type: string
const: output_text
title: Type
default: output_text
annotations:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
type: object
required:
- text
title: OpenAIResponseOutputMessageContentOutputText
OpenAIResponseOutputMessageContentOutputText-Output:
properties:
text:
type: string
title: Text
type:
type: string
const: output_text
title: Type
default: output_text
annotations:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
type: object
required:
- text
title: OpenAIResponseOutputMessageContentOutputText
OpenAIResponseOutputMessageFileSearchToolCallResults: OpenAIResponseOutputMessageFileSearchToolCallResults:
properties: properties:
attributes: attributes:
@ -9094,6 +9189,18 @@ components:
required: required:
- reasoning_tokens - reasoning_tokens
title: OutputTokensDetails title: OutputTokensDetails
ResponseItemInclude:
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: ResponseItemInclude
description: Specify additional output data to include in the model response.
SearchRankingOptions: SearchRankingOptions:
properties: properties:
ranker: ranker:

104
docs/static/experimental-llama-stack-spec.yaml vendored
View file

@ -1158,15 +1158,15 @@ components:
type: number type: number
title: Logprob title: Logprob
top_logprobs: top_logprobs:
items: anyOf:
$ref: '#/components/schemas/OpenAITopLogProb' - items:
type: array $ref: '#/components/schemas/OpenAITopLogProb'
title: Top Logprobs type: array
- type: 'null'
type: object type: object
required: required:
- token - token
- logprob - logprob
- top_logprobs
title: OpenAITokenLogProb title: OpenAITokenLogProb
description: |- description: |-
The log probability for a token from an OpenAI-compatible chat completion response. The log probability for a token from an OpenAI-compatible chat completion response.
@ -2254,15 +2254,22 @@ components:
OpenAIResponseOutputMessageContentOutputText: OpenAIResponseOutputMessageContentOutputText:
properties: properties:
text: text:
type: string
title: Text title: Text
type:
type: string type: string
type:
const: output_text const: output_text
title: Type
default: output_text default: output_text
title: Type
type: string
annotations: annotations:
items: items:
discriminator:
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
propertyName: type
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation title: OpenAIResponseAnnotationFileCitation
@ -2272,20 +2279,20 @@ components:
title: OpenAIResponseAnnotationContainerFileCitation title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants) title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations title: Annotations
type: object type: array
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
nullable: true
required: required:
- text - text
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText
type: object
OpenAIResponseOutputMessageFileSearchToolCall: OpenAIResponseOutputMessageFileSearchToolCall:
properties: properties:
id: id:
@ -3792,8 +3799,7 @@ components:
logprobs: logprobs:
anyOf: anyOf:
- items: - items:
additionalProperties: true $ref: '#/components/schemas/OpenAITokenLogProb'
type: object
type: array type: array
- type: 'null' - type: 'null'
nullable: true nullable: true
@ -4555,6 +4561,13 @@ components:
item_id: item_id:
title: Item Id title: Item Id
type: string type: string
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
nullable: true
output_index: output_index:
title: Output Index title: Output Index
type: integer type: integer
@ -7656,19 +7669,19 @@ components:
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
- items: - items:
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText-Output
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseContentPartRefusal title: OpenAIResponseContentPartRefusal
discriminator: discriminator:
propertyName: type propertyName: type
mapping: mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal
type: array type: array
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
role: role:
title: Role title: Role
type: string type: string
@ -7701,6 +7714,47 @@ components:
They are all under one type because the Responses API gives them all They are all under one type because the Responses API gives them all
the same "type" value, and there is no way to tell them apart in certain the same "type" value, and there is no way to tell them apart in certain
scenarios. scenarios.
OpenAIResponseOutputMessageContentOutputText-Output:
properties:
text:
type: string
title: Text
type:
type: string
const: output_text
title: Type
default: output_text
annotations:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
type: object
required:
- text
title: OpenAIResponseOutputMessageContentOutputText
OpenAIResponseOutputMessageFileSearchToolCallResults: OpenAIResponseOutputMessageFileSearchToolCallResults:
properties: properties:
attributes: attributes:

171
docs/static/llama-stack-spec.yaml vendored
View file

@ -3261,15 +3261,15 @@ components:
type: number type: number
title: Logprob title: Logprob
top_logprobs: top_logprobs:
items: anyOf:
$ref: '#/components/schemas/OpenAITopLogProb' - items:
type: array $ref: '#/components/schemas/OpenAITopLogProb'
title: Top Logprobs type: array
- type: 'null'
type: object type: object
required: required:
- token - token
- logprob - logprob
- top_logprobs
title: OpenAITokenLogProb title: OpenAITokenLogProb
description: |- description: |-
The log probability for a token from an OpenAI-compatible chat completion response. The log probability for a token from an OpenAI-compatible chat completion response.
@ -4357,15 +4357,22 @@ components:
OpenAIResponseOutputMessageContentOutputText: OpenAIResponseOutputMessageContentOutputText:
properties: properties:
text: text:
type: string
title: Text title: Text
type:
type: string type: string
type:
const: output_text const: output_text
title: Type
default: output_text default: output_text
title: Type
type: string
annotations: annotations:
items: items:
discriminator:
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
propertyName: type
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation title: OpenAIResponseAnnotationFileCitation
@ -4375,20 +4382,20 @@ components:
title: OpenAIResponseAnnotationContainerFileCitation title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants) title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations title: Annotations
type: object type: array
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
nullable: true
required: required:
- text - text
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText
type: object
OpenAIResponseOutputMessageFileSearchToolCall: OpenAIResponseOutputMessageFileSearchToolCall:
properties: properties:
id: id:
@ -6004,7 +6011,7 @@ components:
include: include:
anyOf: anyOf:
- items: - items:
type: string $ref: '#/components/schemas/ResponseItemInclude'
type: array type: array
- type: 'null' - type: 'null'
max_infer_iters: max_infer_iters:
@ -6203,8 +6210,7 @@ components:
logprobs: logprobs:
anyOf: anyOf:
- items: - items:
additionalProperties: true $ref: '#/components/schemas/OpenAITokenLogProb'
type: object
type: array type: array
- type: 'null' - type: 'null'
nullable: true nullable: true
@ -6966,6 +6972,13 @@ components:
item_id: item_id:
title: Item Id title: Item Id
type: string type: string
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
nullable: true
output_index: output_index:
title: Output Index title: Output Index
type: integer type: integer
@ -10263,19 +10276,19 @@ components:
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
- items: - items:
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input'
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText-Input
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseContentPartRefusal title: OpenAIResponseContentPartRefusal
discriminator: discriminator:
propertyName: type propertyName: type
mapping: mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal
type: array type: array
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal]
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal]
role: role:
title: Role title: Role
type: string type: string
@ -10332,19 +10345,19 @@ components:
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
- items: - items:
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText-Output
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseContentPartRefusal title: OpenAIResponseContentPartRefusal
discriminator: discriminator:
propertyName: type propertyName: type
mapping: mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal
type: array type: array
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
role: role:
title: Role title: Role
type: string type: string
@ -10377,6 +10390,88 @@ components:
They are all under one type because the Responses API gives them all They are all under one type because the Responses API gives them all
the same "type" value, and there is no way to tell them apart in certain the same "type" value, and there is no way to tell them apart in certain
scenarios. scenarios.
OpenAIResponseOutputMessageContentOutputText-Input:
properties:
text:
type: string
title: Text
type:
type: string
const: output_text
title: Type
default: output_text
annotations:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
type: object
required:
- text
title: OpenAIResponseOutputMessageContentOutputText
OpenAIResponseOutputMessageContentOutputText-Output:
properties:
text:
type: string
title: Text
type:
type: string
const: output_text
title: Type
default: output_text
annotations:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
type: object
required:
- text
title: OpenAIResponseOutputMessageContentOutputText
OpenAIResponseOutputMessageFileSearchToolCallResults: OpenAIResponseOutputMessageFileSearchToolCallResults:
properties: properties:
attributes: attributes:
@ -10536,6 +10631,18 @@ components:
required: required:
- reasoning_tokens - reasoning_tokens
title: OutputTokensDetails title: OutputTokensDetails
ResponseItemInclude:
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: ResponseItemInclude
description: Specify additional output data to include in the model response.
SearchRankingOptions: SearchRankingOptions:
properties: properties:
ranker: ranker:

171
docs/static/stainless-llama-stack-spec.yaml vendored
View file

@ -4456,15 +4456,15 @@ components:
type: number type: number
title: Logprob title: Logprob
top_logprobs: top_logprobs:
items: anyOf:
$ref: '#/components/schemas/OpenAITopLogProb' - items:
type: array $ref: '#/components/schemas/OpenAITopLogProb'
title: Top Logprobs type: array
- type: 'null'
type: object type: object
required: required:
- token - token
- logprob - logprob
- top_logprobs
title: OpenAITokenLogProb title: OpenAITokenLogProb
description: |- description: |-
The log probability for a token from an OpenAI-compatible chat completion response. The log probability for a token from an OpenAI-compatible chat completion response.
@ -5552,15 +5552,22 @@ components:
OpenAIResponseOutputMessageContentOutputText: OpenAIResponseOutputMessageContentOutputText:
properties: properties:
text: text:
type: string
title: Text title: Text
type:
type: string type: string
type:
const: output_text const: output_text
title: Type
default: output_text default: output_text
title: Type
type: string
annotations: annotations:
items: items:
discriminator:
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
propertyName: type
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation title: OpenAIResponseAnnotationFileCitation
@ -5570,20 +5577,20 @@ components:
title: OpenAIResponseAnnotationContainerFileCitation title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants) title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations title: Annotations
type: object type: array
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
nullable: true
required: required:
- text - text
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText
type: object
OpenAIResponseOutputMessageFileSearchToolCall: OpenAIResponseOutputMessageFileSearchToolCall:
properties: properties:
id: id:
@ -7199,7 +7206,7 @@ components:
include: include:
anyOf: anyOf:
- items: - items:
type: string $ref: '#/components/schemas/ResponseItemInclude'
type: array type: array
- type: 'null' - type: 'null'
max_infer_iters: max_infer_iters:
@ -7398,8 +7405,7 @@ components:
logprobs: logprobs:
anyOf: anyOf:
- items: - items:
additionalProperties: true $ref: '#/components/schemas/OpenAITokenLogProb'
type: object
type: array type: array
- type: 'null' - type: 'null'
nullable: true nullable: true
@ -8161,6 +8167,13 @@ components:
item_id: item_id:
title: Item Id title: Item Id
type: string type: string
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
nullable: true
output_index: output_index:
title: Output Index title: Output Index
type: integer type: integer
@ -11827,19 +11840,19 @@ components:
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
- items: - items:
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input'
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText-Input
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseContentPartRefusal title: OpenAIResponseContentPartRefusal
discriminator: discriminator:
propertyName: type propertyName: type
mapping: mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal
type: array type: array
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal]
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal]
role: role:
title: Role title: Role
type: string type: string
@ -11896,19 +11909,19 @@ components:
title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile]
- items: - items:
oneOf: oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
title: OpenAIResponseOutputMessageContentOutputText title: OpenAIResponseOutputMessageContentOutputText-Output
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseContentPartRefusal title: OpenAIResponseContentPartRefusal
discriminator: discriminator:
propertyName: type propertyName: type
mapping: mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal
type: array type: array
title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal]
role: role:
title: Role title: Role
type: string type: string
@ -11941,6 +11954,88 @@ components:
They are all under one type because the Responses API gives them all They are all under one type because the Responses API gives them all
the same "type" value, and there is no way to tell them apart in certain the same "type" value, and there is no way to tell them apart in certain
scenarios. scenarios.
OpenAIResponseOutputMessageContentOutputText-Input:
properties:
text:
type: string
title: Text
type:
type: string
const: output_text
title: Type
default: output_text
annotations:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
type: object
required:
- text
title: OpenAIResponseOutputMessageContentOutputText
OpenAIResponseOutputMessageContentOutputText-Output:
properties:
text:
type: string
title: Text
type:
type: string
const: output_text
title: Type
default: output_text
annotations:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
title: OpenAIResponseAnnotationFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
title: OpenAIResponseAnnotationContainerFileCitation
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: OpenAIResponseAnnotationFilePath
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
title: OpenAIResponseAnnotationFileCitation | ... (4 variants)
type: array
title: Annotations
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
type: object
required:
- text
title: OpenAIResponseOutputMessageContentOutputText
OpenAIResponseOutputMessageFileSearchToolCallResults: OpenAIResponseOutputMessageFileSearchToolCallResults:
properties: properties:
attributes: attributes:
@ -12100,6 +12195,18 @@ components:
required: required:
- reasoning_tokens - reasoning_tokens
title: OutputTokensDetails title: OutputTokensDetails
ResponseItemInclude:
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: ResponseItemInclude
description: Specify additional output data to include in the model response.
SearchRankingOptions: SearchRankingOptions:
properties: properties:
ranker: ranker: