mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-11 13:44:38 +00:00
feat(responses)!: add in_progress, failed, content part events (#3765)
## Summary - add schema + runtime support for response.in_progress / response.failed / response.incomplete - stream content parts with proper indexes and reasoning slots - align tests + docs with the richer event payloads ## Testing - uv run pytest tests/unit/providers/agents/meta_reference/test_openai_responses.py::test_create_openai_response_with_string_input - uv run pytest tests/unit/providers/agents/meta_reference/test_response_conversion_utils.py
This commit is contained in:
parent
a548169b99
commit
e039b61d26
12 changed files with 1431 additions and 221 deletions
206
docs/static/deprecated-llama-stack-spec.html
vendored
206
docs/static/deprecated-llama-stack-spec.html
vendored
|
@ -10125,10 +10125,71 @@
|
|||
"type": {
|
||||
"type": "string",
|
||||
"const": "output_text",
|
||||
"default": "output_text"
|
||||
"default": "output_text",
|
||||
"description": "Content part type identifier, always \"output_text\""
|
||||
},
|
||||
"text": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "Text emitted for this content part"
|
||||
},
|
||||
"annotations": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseAnnotations"
|
||||
},
|
||||
"description": "Structured annotations associated with the text"
|
||||
},
|
||||
"logprobs": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "null"
|
||||
},
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "object"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"description": "(Optional) Token log probability details"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"type",
|
||||
"text",
|
||||
"annotations"
|
||||
],
|
||||
"title": "OpenAIResponseContentPartOutputText",
|
||||
"description": "Text content within a streamed response part."
|
||||
},
|
||||
"OpenAIResponseContentPartReasoningText": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "reasoning_text",
|
||||
"default": "reasoning_text",
|
||||
"description": "Content part type identifier, always \"reasoning_text\""
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Reasoning text supplied by the model"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
|
@ -10136,7 +10197,8 @@
|
|||
"type",
|
||||
"text"
|
||||
],
|
||||
"title": "OpenAIResponseContentPartOutputText"
|
||||
"title": "OpenAIResponseContentPartReasoningText",
|
||||
"description": "Reasoning text emitted as part of a streamed response."
|
||||
},
|
||||
"OpenAIResponseContentPartRefusal": {
|
||||
"type": "object",
|
||||
|
@ -10144,10 +10206,12 @@
|
|||
"type": {
|
||||
"type": "string",
|
||||
"const": "refusal",
|
||||
"default": "refusal"
|
||||
"default": "refusal",
|
||||
"description": "Content part type identifier, always \"refusal\""
|
||||
},
|
||||
"refusal": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "Refusal text supplied by the model"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
|
@ -10155,13 +10219,17 @@
|
|||
"type",
|
||||
"refusal"
|
||||
],
|
||||
"title": "OpenAIResponseContentPartRefusal"
|
||||
"title": "OpenAIResponseContentPartRefusal",
|
||||
"description": "Refusal content within a streamed response part."
|
||||
},
|
||||
"OpenAIResponseObjectStream": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseCreated"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseInProgress"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded"
|
||||
},
|
||||
|
@ -10219,6 +10287,12 @@
|
|||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseFailed"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseCompleted"
|
||||
}
|
||||
|
@ -10227,6 +10301,7 @@
|
|||
"propertyName": "type",
|
||||
"mapping": {
|
||||
"response.created": "#/components/schemas/OpenAIResponseObjectStreamResponseCreated",
|
||||
"response.in_progress": "#/components/schemas/OpenAIResponseObjectStreamResponseInProgress",
|
||||
"response.output_item.added": "#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded",
|
||||
"response.output_item.done": "#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone",
|
||||
"response.output_text.delta": "#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta",
|
||||
|
@ -10246,6 +10321,8 @@
|
|||
"response.mcp_call.completed": "#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted",
|
||||
"response.content_part.added": "#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded",
|
||||
"response.content_part.done": "#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone",
|
||||
"response.incomplete": "#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete",
|
||||
"response.failed": "#/components/schemas/OpenAIResponseObjectStreamResponseFailed",
|
||||
"response.completed": "#/components/schemas/OpenAIResponseObjectStreamResponseCompleted"
|
||||
}
|
||||
}
|
||||
|
@ -10255,7 +10332,7 @@
|
|||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "The completed response object"
|
||||
"description": "Completed response object"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
|
@ -10275,6 +10352,10 @@
|
|||
"OpenAIResponseObjectStreamResponseContentPartAdded": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"content_index": {
|
||||
"type": "integer",
|
||||
"description": "Index position of the part within the content array"
|
||||
},
|
||||
"response_id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier of the response containing this content"
|
||||
|
@ -10283,6 +10364,10 @@
|
|||
"type": "string",
|
||||
"description": "Unique identifier of the output item containing this content part"
|
||||
},
|
||||
"output_index": {
|
||||
"type": "integer",
|
||||
"description": "Index position of the output item in the response"
|
||||
},
|
||||
"part": {
|
||||
"oneOf": [
|
||||
{
|
||||
|
@ -10290,13 +10375,17 @@
|
|||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
||||
}
|
||||
],
|
||||
"discriminator": {
|
||||
"propertyName": "type",
|
||||
"mapping": {
|
||||
"output_text": "#/components/schemas/OpenAIResponseContentPartOutputText",
|
||||
"refusal": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
||||
"refusal": "#/components/schemas/OpenAIResponseContentPartRefusal",
|
||||
"reasoning_text": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
||||
}
|
||||
},
|
||||
"description": "The content part that was added"
|
||||
|
@ -10314,8 +10403,10 @@
|
|||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"content_index",
|
||||
"response_id",
|
||||
"item_id",
|
||||
"output_index",
|
||||
"part",
|
||||
"sequence_number",
|
||||
"type"
|
||||
|
@ -10326,6 +10417,10 @@
|
|||
"OpenAIResponseObjectStreamResponseContentPartDone": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"content_index": {
|
||||
"type": "integer",
|
||||
"description": "Index position of the part within the content array"
|
||||
},
|
||||
"response_id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier of the response containing this content"
|
||||
|
@ -10334,6 +10429,10 @@
|
|||
"type": "string",
|
||||
"description": "Unique identifier of the output item containing this content part"
|
||||
},
|
||||
"output_index": {
|
||||
"type": "integer",
|
||||
"description": "Index position of the output item in the response"
|
||||
},
|
||||
"part": {
|
||||
"oneOf": [
|
||||
{
|
||||
|
@ -10341,13 +10440,17 @@
|
|||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
||||
}
|
||||
],
|
||||
"discriminator": {
|
||||
"propertyName": "type",
|
||||
"mapping": {
|
||||
"output_text": "#/components/schemas/OpenAIResponseContentPartOutputText",
|
||||
"refusal": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
||||
"refusal": "#/components/schemas/OpenAIResponseContentPartRefusal",
|
||||
"reasoning_text": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
||||
}
|
||||
},
|
||||
"description": "The completed content part"
|
||||
|
@ -10365,8 +10468,10 @@
|
|||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"content_index",
|
||||
"response_id",
|
||||
"item_id",
|
||||
"output_index",
|
||||
"part",
|
||||
"sequence_number",
|
||||
"type"
|
||||
|
@ -10379,7 +10484,7 @@
|
|||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "The newly created response object"
|
||||
"description": "The response object that was created"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
|
@ -10396,6 +10501,33 @@
|
|||
"title": "OpenAIResponseObjectStreamResponseCreated",
|
||||
"description": "Streaming event indicating a new response has been created."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseFailed": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "Response object describing the failure"
|
||||
},
|
||||
"sequence_number": {
|
||||
"type": "integer",
|
||||
"description": "Sequential number for ordering streaming events"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "response.failed",
|
||||
"default": "response.failed",
|
||||
"description": "Event type identifier, always \"response.failed\""
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"response",
|
||||
"sequence_number",
|
||||
"type"
|
||||
],
|
||||
"title": "OpenAIResponseObjectStreamResponseFailed",
|
||||
"description": "Streaming event emitted when a response fails."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
@ -10470,6 +10602,60 @@
|
|||
"title": "OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone",
|
||||
"description": "Streaming event for when function call arguments are completed."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseInProgress": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "Current response state while in progress"
|
||||
},
|
||||
"sequence_number": {
|
||||
"type": "integer",
|
||||
"description": "Sequential number for ordering streaming events"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "response.in_progress",
|
||||
"default": "response.in_progress",
|
||||
"description": "Event type identifier, always \"response.in_progress\""
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"response",
|
||||
"sequence_number",
|
||||
"type"
|
||||
],
|
||||
"title": "OpenAIResponseObjectStreamResponseInProgress",
|
||||
"description": "Streaming event indicating the response remains in progress."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseIncomplete": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "Response object describing the incomplete state"
|
||||
},
|
||||
"sequence_number": {
|
||||
"type": "integer",
|
||||
"description": "Sequential number for ordering streaming events"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "response.incomplete",
|
||||
"default": "response.incomplete",
|
||||
"description": "Event type identifier, always \"response.incomplete\""
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"response",
|
||||
"sequence_number",
|
||||
"type"
|
||||
],
|
||||
"title": "OpenAIResponseObjectStreamResponseIncomplete",
|
||||
"description": "Streaming event emitted when a response ends in an incomplete state."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
158
docs/static/deprecated-llama-stack-spec.yaml
vendored
158
docs/static/deprecated-llama-stack-spec.yaml
vendored
|
@ -7544,13 +7544,57 @@ components:
|
|||
type: string
|
||||
const: output_text
|
||||
default: output_text
|
||||
description: >-
|
||||
Content part type identifier, always "output_text"
|
||||
text:
|
||||
type: string
|
||||
description: Text emitted for this content part
|
||||
annotations:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/OpenAIResponseAnnotations'
|
||||
description: >-
|
||||
Structured annotations associated with the text
|
||||
logprobs:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
additionalProperties:
|
||||
oneOf:
|
||||
- type: 'null'
|
||||
- type: boolean
|
||||
- type: number
|
||||
- type: string
|
||||
- type: array
|
||||
- type: object
|
||||
description: (Optional) Token log probability details
|
||||
additionalProperties: false
|
||||
required:
|
||||
- type
|
||||
- text
|
||||
- annotations
|
||||
title: OpenAIResponseContentPartOutputText
|
||||
description: >-
|
||||
Text content within a streamed response part.
|
||||
OpenAIResponseContentPartReasoningText:
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
const: reasoning_text
|
||||
default: reasoning_text
|
||||
description: >-
|
||||
Content part type identifier, always "reasoning_text"
|
||||
text:
|
||||
type: string
|
||||
description: Reasoning text supplied by the model
|
||||
additionalProperties: false
|
||||
required:
|
||||
- type
|
||||
- text
|
||||
title: OpenAIResponseContentPartReasoningText
|
||||
description: >-
|
||||
Reasoning text emitted as part of a streamed response.
|
||||
OpenAIResponseContentPartRefusal:
|
||||
type: object
|
||||
properties:
|
||||
|
@ -7558,16 +7602,22 @@ components:
|
|||
type: string
|
||||
const: refusal
|
||||
default: refusal
|
||||
description: >-
|
||||
Content part type identifier, always "refusal"
|
||||
refusal:
|
||||
type: string
|
||||
description: Refusal text supplied by the model
|
||||
additionalProperties: false
|
||||
required:
|
||||
- type
|
||||
- refusal
|
||||
title: OpenAIResponseContentPartRefusal
|
||||
description: >-
|
||||
Refusal content within a streamed response part.
|
||||
OpenAIResponseObjectStream:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta'
|
||||
|
@ -7587,11 +7637,14 @@ components:
|
|||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted'
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
response.created: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated'
|
||||
response.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress'
|
||||
response.output_item.added: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded'
|
||||
response.output_item.done: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone'
|
||||
response.output_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta'
|
||||
|
@ -7611,13 +7664,15 @@ components:
|
|||
response.mcp_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted'
|
||||
response.content_part.added: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded'
|
||||
response.content_part.done: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone'
|
||||
response.incomplete: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete'
|
||||
response.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed'
|
||||
response.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted'
|
||||
"OpenAIResponseObjectStreamResponseCompleted":
|
||||
type: object
|
||||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: The completed response object
|
||||
description: Completed response object
|
||||
type:
|
||||
type: string
|
||||
const: response.completed
|
||||
|
@ -7635,6 +7690,10 @@ components:
|
|||
"OpenAIResponseObjectStreamResponseContentPartAdded":
|
||||
type: object
|
||||
properties:
|
||||
content_index:
|
||||
type: integer
|
||||
description: >-
|
||||
Index position of the part within the content array
|
||||
response_id:
|
||||
type: string
|
||||
description: >-
|
||||
|
@ -7643,15 +7702,21 @@ components:
|
|||
type: string
|
||||
description: >-
|
||||
Unique identifier of the output item containing this content part
|
||||
output_index:
|
||||
type: integer
|
||||
description: >-
|
||||
Index position of the output item in the response
|
||||
part:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
||||
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
||||
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
||||
description: The content part that was added
|
||||
sequence_number:
|
||||
type: integer
|
||||
|
@ -7665,8 +7730,10 @@ components:
|
|||
Event type identifier, always "response.content_part.added"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- content_index
|
||||
- response_id
|
||||
- item_id
|
||||
- output_index
|
||||
- part
|
||||
- sequence_number
|
||||
- type
|
||||
|
@ -7677,6 +7744,10 @@ components:
|
|||
"OpenAIResponseObjectStreamResponseContentPartDone":
|
||||
type: object
|
||||
properties:
|
||||
content_index:
|
||||
type: integer
|
||||
description: >-
|
||||
Index position of the part within the content array
|
||||
response_id:
|
||||
type: string
|
||||
description: >-
|
||||
|
@ -7685,15 +7756,21 @@ components:
|
|||
type: string
|
||||
description: >-
|
||||
Unique identifier of the output item containing this content part
|
||||
output_index:
|
||||
type: integer
|
||||
description: >-
|
||||
Index position of the output item in the response
|
||||
part:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
||||
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
||||
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
||||
description: The completed content part
|
||||
sequence_number:
|
||||
type: integer
|
||||
|
@ -7707,8 +7784,10 @@ components:
|
|||
Event type identifier, always "response.content_part.done"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- content_index
|
||||
- response_id
|
||||
- item_id
|
||||
- output_index
|
||||
- part
|
||||
- sequence_number
|
||||
- type
|
||||
|
@ -7721,7 +7800,7 @@ components:
|
|||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: The newly created response object
|
||||
description: The response object that was created
|
||||
type:
|
||||
type: string
|
||||
const: response.created
|
||||
|
@ -7736,6 +7815,30 @@ components:
|
|||
OpenAIResponseObjectStreamResponseCreated
|
||||
description: >-
|
||||
Streaming event indicating a new response has been created.
|
||||
OpenAIResponseObjectStreamResponseFailed:
|
||||
type: object
|
||||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: Response object describing the failure
|
||||
sequence_number:
|
||||
type: integer
|
||||
description: >-
|
||||
Sequential number for ordering streaming events
|
||||
type:
|
||||
type: string
|
||||
const: response.failed
|
||||
default: response.failed
|
||||
description: >-
|
||||
Event type identifier, always "response.failed"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- response
|
||||
- sequence_number
|
||||
- type
|
||||
title: OpenAIResponseObjectStreamResponseFailed
|
||||
description: >-
|
||||
Streaming event emitted when a response fails.
|
||||
"OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta":
|
||||
type: object
|
||||
properties:
|
||||
|
@ -7808,6 +7911,57 @@ components:
|
|||
OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone
|
||||
description: >-
|
||||
Streaming event for when function call arguments are completed.
|
||||
"OpenAIResponseObjectStreamResponseInProgress":
|
||||
type: object
|
||||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: Current response state while in progress
|
||||
sequence_number:
|
||||
type: integer
|
||||
description: >-
|
||||
Sequential number for ordering streaming events
|
||||
type:
|
||||
type: string
|
||||
const: response.in_progress
|
||||
default: response.in_progress
|
||||
description: >-
|
||||
Event type identifier, always "response.in_progress"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- response
|
||||
- sequence_number
|
||||
- type
|
||||
title: >-
|
||||
OpenAIResponseObjectStreamResponseInProgress
|
||||
description: >-
|
||||
Streaming event indicating the response remains in progress.
|
||||
"OpenAIResponseObjectStreamResponseIncomplete":
|
||||
type: object
|
||||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: >-
|
||||
Response object describing the incomplete state
|
||||
sequence_number:
|
||||
type: integer
|
||||
description: >-
|
||||
Sequential number for ordering streaming events
|
||||
type:
|
||||
type: string
|
||||
const: response.incomplete
|
||||
default: response.incomplete
|
||||
description: >-
|
||||
Event type identifier, always "response.incomplete"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- response
|
||||
- sequence_number
|
||||
- type
|
||||
title: >-
|
||||
OpenAIResponseObjectStreamResponseIncomplete
|
||||
description: >-
|
||||
Streaming event emitted when a response ends in an incomplete state.
|
||||
"OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta":
|
||||
type: object
|
||||
properties:
|
||||
|
|
206
docs/static/llama-stack-spec.html
vendored
206
docs/static/llama-stack-spec.html
vendored
|
@ -8220,10 +8220,71 @@
|
|||
"type": {
|
||||
"type": "string",
|
||||
"const": "output_text",
|
||||
"default": "output_text"
|
||||
"default": "output_text",
|
||||
"description": "Content part type identifier, always \"output_text\""
|
||||
},
|
||||
"text": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "Text emitted for this content part"
|
||||
},
|
||||
"annotations": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseAnnotations"
|
||||
},
|
||||
"description": "Structured annotations associated with the text"
|
||||
},
|
||||
"logprobs": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "null"
|
||||
},
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "object"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"description": "(Optional) Token log probability details"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"type",
|
||||
"text",
|
||||
"annotations"
|
||||
],
|
||||
"title": "OpenAIResponseContentPartOutputText",
|
||||
"description": "Text content within a streamed response part."
|
||||
},
|
||||
"OpenAIResponseContentPartReasoningText": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "reasoning_text",
|
||||
"default": "reasoning_text",
|
||||
"description": "Content part type identifier, always \"reasoning_text\""
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Reasoning text supplied by the model"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
|
@ -8231,7 +8292,8 @@
|
|||
"type",
|
||||
"text"
|
||||
],
|
||||
"title": "OpenAIResponseContentPartOutputText"
|
||||
"title": "OpenAIResponseContentPartReasoningText",
|
||||
"description": "Reasoning text emitted as part of a streamed response."
|
||||
},
|
||||
"OpenAIResponseContentPartRefusal": {
|
||||
"type": "object",
|
||||
|
@ -8239,10 +8301,12 @@
|
|||
"type": {
|
||||
"type": "string",
|
||||
"const": "refusal",
|
||||
"default": "refusal"
|
||||
"default": "refusal",
|
||||
"description": "Content part type identifier, always \"refusal\""
|
||||
},
|
||||
"refusal": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "Refusal text supplied by the model"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
|
@ -8250,13 +8314,17 @@
|
|||
"type",
|
||||
"refusal"
|
||||
],
|
||||
"title": "OpenAIResponseContentPartRefusal"
|
||||
"title": "OpenAIResponseContentPartRefusal",
|
||||
"description": "Refusal content within a streamed response part."
|
||||
},
|
||||
"OpenAIResponseObjectStream": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseCreated"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseInProgress"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded"
|
||||
},
|
||||
|
@ -8314,6 +8382,12 @@
|
|||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseFailed"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseCompleted"
|
||||
}
|
||||
|
@ -8322,6 +8396,7 @@
|
|||
"propertyName": "type",
|
||||
"mapping": {
|
||||
"response.created": "#/components/schemas/OpenAIResponseObjectStreamResponseCreated",
|
||||
"response.in_progress": "#/components/schemas/OpenAIResponseObjectStreamResponseInProgress",
|
||||
"response.output_item.added": "#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded",
|
||||
"response.output_item.done": "#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone",
|
||||
"response.output_text.delta": "#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta",
|
||||
|
@ -8341,6 +8416,8 @@
|
|||
"response.mcp_call.completed": "#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted",
|
||||
"response.content_part.added": "#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded",
|
||||
"response.content_part.done": "#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone",
|
||||
"response.incomplete": "#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete",
|
||||
"response.failed": "#/components/schemas/OpenAIResponseObjectStreamResponseFailed",
|
||||
"response.completed": "#/components/schemas/OpenAIResponseObjectStreamResponseCompleted"
|
||||
}
|
||||
}
|
||||
|
@ -8350,7 +8427,7 @@
|
|||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "The completed response object"
|
||||
"description": "Completed response object"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
|
@ -8370,6 +8447,10 @@
|
|||
"OpenAIResponseObjectStreamResponseContentPartAdded": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"content_index": {
|
||||
"type": "integer",
|
||||
"description": "Index position of the part within the content array"
|
||||
},
|
||||
"response_id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier of the response containing this content"
|
||||
|
@ -8378,6 +8459,10 @@
|
|||
"type": "string",
|
||||
"description": "Unique identifier of the output item containing this content part"
|
||||
},
|
||||
"output_index": {
|
||||
"type": "integer",
|
||||
"description": "Index position of the output item in the response"
|
||||
},
|
||||
"part": {
|
||||
"oneOf": [
|
||||
{
|
||||
|
@ -8385,13 +8470,17 @@
|
|||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
||||
}
|
||||
],
|
||||
"discriminator": {
|
||||
"propertyName": "type",
|
||||
"mapping": {
|
||||
"output_text": "#/components/schemas/OpenAIResponseContentPartOutputText",
|
||||
"refusal": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
||||
"refusal": "#/components/schemas/OpenAIResponseContentPartRefusal",
|
||||
"reasoning_text": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
||||
}
|
||||
},
|
||||
"description": "The content part that was added"
|
||||
|
@ -8409,8 +8498,10 @@
|
|||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"content_index",
|
||||
"response_id",
|
||||
"item_id",
|
||||
"output_index",
|
||||
"part",
|
||||
"sequence_number",
|
||||
"type"
|
||||
|
@ -8421,6 +8512,10 @@
|
|||
"OpenAIResponseObjectStreamResponseContentPartDone": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"content_index": {
|
||||
"type": "integer",
|
||||
"description": "Index position of the part within the content array"
|
||||
},
|
||||
"response_id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier of the response containing this content"
|
||||
|
@ -8429,6 +8524,10 @@
|
|||
"type": "string",
|
||||
"description": "Unique identifier of the output item containing this content part"
|
||||
},
|
||||
"output_index": {
|
||||
"type": "integer",
|
||||
"description": "Index position of the output item in the response"
|
||||
},
|
||||
"part": {
|
||||
"oneOf": [
|
||||
{
|
||||
|
@ -8436,13 +8535,17 @@
|
|||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
||||
}
|
||||
],
|
||||
"discriminator": {
|
||||
"propertyName": "type",
|
||||
"mapping": {
|
||||
"output_text": "#/components/schemas/OpenAIResponseContentPartOutputText",
|
||||
"refusal": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
||||
"refusal": "#/components/schemas/OpenAIResponseContentPartRefusal",
|
||||
"reasoning_text": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
||||
}
|
||||
},
|
||||
"description": "The completed content part"
|
||||
|
@ -8460,8 +8563,10 @@
|
|||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"content_index",
|
||||
"response_id",
|
||||
"item_id",
|
||||
"output_index",
|
||||
"part",
|
||||
"sequence_number",
|
||||
"type"
|
||||
|
@ -8474,7 +8579,7 @@
|
|||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "The newly created response object"
|
||||
"description": "The response object that was created"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
|
@ -8491,6 +8596,33 @@
|
|||
"title": "OpenAIResponseObjectStreamResponseCreated",
|
||||
"description": "Streaming event indicating a new response has been created."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseFailed": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "Response object describing the failure"
|
||||
},
|
||||
"sequence_number": {
|
||||
"type": "integer",
|
||||
"description": "Sequential number for ordering streaming events"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "response.failed",
|
||||
"default": "response.failed",
|
||||
"description": "Event type identifier, always \"response.failed\""
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"response",
|
||||
"sequence_number",
|
||||
"type"
|
||||
],
|
||||
"title": "OpenAIResponseObjectStreamResponseFailed",
|
||||
"description": "Streaming event emitted when a response fails."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
@ -8565,6 +8697,60 @@
|
|||
"title": "OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone",
|
||||
"description": "Streaming event for when function call arguments are completed."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseInProgress": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "Current response state while in progress"
|
||||
},
|
||||
"sequence_number": {
|
||||
"type": "integer",
|
||||
"description": "Sequential number for ordering streaming events"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "response.in_progress",
|
||||
"default": "response.in_progress",
|
||||
"description": "Event type identifier, always \"response.in_progress\""
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"response",
|
||||
"sequence_number",
|
||||
"type"
|
||||
],
|
||||
"title": "OpenAIResponseObjectStreamResponseInProgress",
|
||||
"description": "Streaming event indicating the response remains in progress."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseIncomplete": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "Response object describing the incomplete state"
|
||||
},
|
||||
"sequence_number": {
|
||||
"type": "integer",
|
||||
"description": "Sequential number for ordering streaming events"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "response.incomplete",
|
||||
"default": "response.incomplete",
|
||||
"description": "Event type identifier, always \"response.incomplete\""
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"response",
|
||||
"sequence_number",
|
||||
"type"
|
||||
],
|
||||
"title": "OpenAIResponseObjectStreamResponseIncomplete",
|
||||
"description": "Streaming event emitted when a response ends in an incomplete state."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
158
docs/static/llama-stack-spec.yaml
vendored
158
docs/static/llama-stack-spec.yaml
vendored
|
@ -6240,13 +6240,57 @@ components:
|
|||
type: string
|
||||
const: output_text
|
||||
default: output_text
|
||||
description: >-
|
||||
Content part type identifier, always "output_text"
|
||||
text:
|
||||
type: string
|
||||
description: Text emitted for this content part
|
||||
annotations:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/OpenAIResponseAnnotations'
|
||||
description: >-
|
||||
Structured annotations associated with the text
|
||||
logprobs:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
additionalProperties:
|
||||
oneOf:
|
||||
- type: 'null'
|
||||
- type: boolean
|
||||
- type: number
|
||||
- type: string
|
||||
- type: array
|
||||
- type: object
|
||||
description: (Optional) Token log probability details
|
||||
additionalProperties: false
|
||||
required:
|
||||
- type
|
||||
- text
|
||||
- annotations
|
||||
title: OpenAIResponseContentPartOutputText
|
||||
description: >-
|
||||
Text content within a streamed response part.
|
||||
OpenAIResponseContentPartReasoningText:
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
const: reasoning_text
|
||||
default: reasoning_text
|
||||
description: >-
|
||||
Content part type identifier, always "reasoning_text"
|
||||
text:
|
||||
type: string
|
||||
description: Reasoning text supplied by the model
|
||||
additionalProperties: false
|
||||
required:
|
||||
- type
|
||||
- text
|
||||
title: OpenAIResponseContentPartReasoningText
|
||||
description: >-
|
||||
Reasoning text emitted as part of a streamed response.
|
||||
OpenAIResponseContentPartRefusal:
|
||||
type: object
|
||||
properties:
|
||||
|
@ -6254,16 +6298,22 @@ components:
|
|||
type: string
|
||||
const: refusal
|
||||
default: refusal
|
||||
description: >-
|
||||
Content part type identifier, always "refusal"
|
||||
refusal:
|
||||
type: string
|
||||
description: Refusal text supplied by the model
|
||||
additionalProperties: false
|
||||
required:
|
||||
- type
|
||||
- refusal
|
||||
title: OpenAIResponseContentPartRefusal
|
||||
description: >-
|
||||
Refusal content within a streamed response part.
|
||||
OpenAIResponseObjectStream:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta'
|
||||
|
@ -6283,11 +6333,14 @@ components:
|
|||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted'
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
response.created: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated'
|
||||
response.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress'
|
||||
response.output_item.added: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded'
|
||||
response.output_item.done: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone'
|
||||
response.output_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta'
|
||||
|
@ -6307,13 +6360,15 @@ components:
|
|||
response.mcp_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted'
|
||||
response.content_part.added: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded'
|
||||
response.content_part.done: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone'
|
||||
response.incomplete: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete'
|
||||
response.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed'
|
||||
response.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted'
|
||||
"OpenAIResponseObjectStreamResponseCompleted":
|
||||
type: object
|
||||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: The completed response object
|
||||
description: Completed response object
|
||||
type:
|
||||
type: string
|
||||
const: response.completed
|
||||
|
@ -6331,6 +6386,10 @@ components:
|
|||
"OpenAIResponseObjectStreamResponseContentPartAdded":
|
||||
type: object
|
||||
properties:
|
||||
content_index:
|
||||
type: integer
|
||||
description: >-
|
||||
Index position of the part within the content array
|
||||
response_id:
|
||||
type: string
|
||||
description: >-
|
||||
|
@ -6339,15 +6398,21 @@ components:
|
|||
type: string
|
||||
description: >-
|
||||
Unique identifier of the output item containing this content part
|
||||
output_index:
|
||||
type: integer
|
||||
description: >-
|
||||
Index position of the output item in the response
|
||||
part:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
||||
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
||||
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
||||
description: The content part that was added
|
||||
sequence_number:
|
||||
type: integer
|
||||
|
@ -6361,8 +6426,10 @@ components:
|
|||
Event type identifier, always "response.content_part.added"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- content_index
|
||||
- response_id
|
||||
- item_id
|
||||
- output_index
|
||||
- part
|
||||
- sequence_number
|
||||
- type
|
||||
|
@ -6373,6 +6440,10 @@ components:
|
|||
"OpenAIResponseObjectStreamResponseContentPartDone":
|
||||
type: object
|
||||
properties:
|
||||
content_index:
|
||||
type: integer
|
||||
description: >-
|
||||
Index position of the part within the content array
|
||||
response_id:
|
||||
type: string
|
||||
description: >-
|
||||
|
@ -6381,15 +6452,21 @@ components:
|
|||
type: string
|
||||
description: >-
|
||||
Unique identifier of the output item containing this content part
|
||||
output_index:
|
||||
type: integer
|
||||
description: >-
|
||||
Index position of the output item in the response
|
||||
part:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
||||
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
||||
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
||||
description: The completed content part
|
||||
sequence_number:
|
||||
type: integer
|
||||
|
@ -6403,8 +6480,10 @@ components:
|
|||
Event type identifier, always "response.content_part.done"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- content_index
|
||||
- response_id
|
||||
- item_id
|
||||
- output_index
|
||||
- part
|
||||
- sequence_number
|
||||
- type
|
||||
|
@ -6417,7 +6496,7 @@ components:
|
|||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: The newly created response object
|
||||
description: The response object that was created
|
||||
type:
|
||||
type: string
|
||||
const: response.created
|
||||
|
@ -6432,6 +6511,30 @@ components:
|
|||
OpenAIResponseObjectStreamResponseCreated
|
||||
description: >-
|
||||
Streaming event indicating a new response has been created.
|
||||
OpenAIResponseObjectStreamResponseFailed:
|
||||
type: object
|
||||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: Response object describing the failure
|
||||
sequence_number:
|
||||
type: integer
|
||||
description: >-
|
||||
Sequential number for ordering streaming events
|
||||
type:
|
||||
type: string
|
||||
const: response.failed
|
||||
default: response.failed
|
||||
description: >-
|
||||
Event type identifier, always "response.failed"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- response
|
||||
- sequence_number
|
||||
- type
|
||||
title: OpenAIResponseObjectStreamResponseFailed
|
||||
description: >-
|
||||
Streaming event emitted when a response fails.
|
||||
"OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta":
|
||||
type: object
|
||||
properties:
|
||||
|
@ -6504,6 +6607,57 @@ components:
|
|||
OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone
|
||||
description: >-
|
||||
Streaming event for when function call arguments are completed.
|
||||
"OpenAIResponseObjectStreamResponseInProgress":
|
||||
type: object
|
||||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: Current response state while in progress
|
||||
sequence_number:
|
||||
type: integer
|
||||
description: >-
|
||||
Sequential number for ordering streaming events
|
||||
type:
|
||||
type: string
|
||||
const: response.in_progress
|
||||
default: response.in_progress
|
||||
description: >-
|
||||
Event type identifier, always "response.in_progress"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- response
|
||||
- sequence_number
|
||||
- type
|
||||
title: >-
|
||||
OpenAIResponseObjectStreamResponseInProgress
|
||||
description: >-
|
||||
Streaming event indicating the response remains in progress.
|
||||
"OpenAIResponseObjectStreamResponseIncomplete":
|
||||
type: object
|
||||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: >-
|
||||
Response object describing the incomplete state
|
||||
sequence_number:
|
||||
type: integer
|
||||
description: >-
|
||||
Sequential number for ordering streaming events
|
||||
type:
|
||||
type: string
|
||||
const: response.incomplete
|
||||
default: response.incomplete
|
||||
description: >-
|
||||
Event type identifier, always "response.incomplete"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- response
|
||||
- sequence_number
|
||||
- type
|
||||
title: >-
|
||||
OpenAIResponseObjectStreamResponseIncomplete
|
||||
description: >-
|
||||
Streaming event emitted when a response ends in an incomplete state.
|
||||
"OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta":
|
||||
type: object
|
||||
properties:
|
||||
|
|
206
docs/static/stainless-llama-stack-spec.html
vendored
206
docs/static/stainless-llama-stack-spec.html
vendored
|
@ -10229,10 +10229,71 @@
|
|||
"type": {
|
||||
"type": "string",
|
||||
"const": "output_text",
|
||||
"default": "output_text"
|
||||
"default": "output_text",
|
||||
"description": "Content part type identifier, always \"output_text\""
|
||||
},
|
||||
"text": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "Text emitted for this content part"
|
||||
},
|
||||
"annotations": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseAnnotations"
|
||||
},
|
||||
"description": "Structured annotations associated with the text"
|
||||
},
|
||||
"logprobs": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "null"
|
||||
},
|
||||
{
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "object"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"description": "(Optional) Token log probability details"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"type",
|
||||
"text",
|
||||
"annotations"
|
||||
],
|
||||
"title": "OpenAIResponseContentPartOutputText",
|
||||
"description": "Text content within a streamed response part."
|
||||
},
|
||||
"OpenAIResponseContentPartReasoningText": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "reasoning_text",
|
||||
"default": "reasoning_text",
|
||||
"description": "Content part type identifier, always \"reasoning_text\""
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Reasoning text supplied by the model"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
|
@ -10240,7 +10301,8 @@
|
|||
"type",
|
||||
"text"
|
||||
],
|
||||
"title": "OpenAIResponseContentPartOutputText"
|
||||
"title": "OpenAIResponseContentPartReasoningText",
|
||||
"description": "Reasoning text emitted as part of a streamed response."
|
||||
},
|
||||
"OpenAIResponseContentPartRefusal": {
|
||||
"type": "object",
|
||||
|
@ -10248,10 +10310,12 @@
|
|||
"type": {
|
||||
"type": "string",
|
||||
"const": "refusal",
|
||||
"default": "refusal"
|
||||
"default": "refusal",
|
||||
"description": "Content part type identifier, always \"refusal\""
|
||||
},
|
||||
"refusal": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "Refusal text supplied by the model"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
|
@ -10259,13 +10323,17 @@
|
|||
"type",
|
||||
"refusal"
|
||||
],
|
||||
"title": "OpenAIResponseContentPartRefusal"
|
||||
"title": "OpenAIResponseContentPartRefusal",
|
||||
"description": "Refusal content within a streamed response part."
|
||||
},
|
||||
"OpenAIResponseObjectStream": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseCreated"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseInProgress"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded"
|
||||
},
|
||||
|
@ -10323,6 +10391,12 @@
|
|||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseFailed"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseObjectStreamResponseCompleted"
|
||||
}
|
||||
|
@ -10331,6 +10405,7 @@
|
|||
"propertyName": "type",
|
||||
"mapping": {
|
||||
"response.created": "#/components/schemas/OpenAIResponseObjectStreamResponseCreated",
|
||||
"response.in_progress": "#/components/schemas/OpenAIResponseObjectStreamResponseInProgress",
|
||||
"response.output_item.added": "#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded",
|
||||
"response.output_item.done": "#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone",
|
||||
"response.output_text.delta": "#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta",
|
||||
|
@ -10350,6 +10425,8 @@
|
|||
"response.mcp_call.completed": "#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted",
|
||||
"response.content_part.added": "#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded",
|
||||
"response.content_part.done": "#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone",
|
||||
"response.incomplete": "#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete",
|
||||
"response.failed": "#/components/schemas/OpenAIResponseObjectStreamResponseFailed",
|
||||
"response.completed": "#/components/schemas/OpenAIResponseObjectStreamResponseCompleted"
|
||||
}
|
||||
}
|
||||
|
@ -10359,7 +10436,7 @@
|
|||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "The completed response object"
|
||||
"description": "Completed response object"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
|
@ -10379,6 +10456,10 @@
|
|||
"OpenAIResponseObjectStreamResponseContentPartAdded": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"content_index": {
|
||||
"type": "integer",
|
||||
"description": "Index position of the part within the content array"
|
||||
},
|
||||
"response_id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier of the response containing this content"
|
||||
|
@ -10387,6 +10468,10 @@
|
|||
"type": "string",
|
||||
"description": "Unique identifier of the output item containing this content part"
|
||||
},
|
||||
"output_index": {
|
||||
"type": "integer",
|
||||
"description": "Index position of the output item in the response"
|
||||
},
|
||||
"part": {
|
||||
"oneOf": [
|
||||
{
|
||||
|
@ -10394,13 +10479,17 @@
|
|||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
||||
}
|
||||
],
|
||||
"discriminator": {
|
||||
"propertyName": "type",
|
||||
"mapping": {
|
||||
"output_text": "#/components/schemas/OpenAIResponseContentPartOutputText",
|
||||
"refusal": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
||||
"refusal": "#/components/schemas/OpenAIResponseContentPartRefusal",
|
||||
"reasoning_text": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
||||
}
|
||||
},
|
||||
"description": "The content part that was added"
|
||||
|
@ -10418,8 +10507,10 @@
|
|||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"content_index",
|
||||
"response_id",
|
||||
"item_id",
|
||||
"output_index",
|
||||
"part",
|
||||
"sequence_number",
|
||||
"type"
|
||||
|
@ -10430,6 +10521,10 @@
|
|||
"OpenAIResponseObjectStreamResponseContentPartDone": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"content_index": {
|
||||
"type": "integer",
|
||||
"description": "Index position of the part within the content array"
|
||||
},
|
||||
"response_id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier of the response containing this content"
|
||||
|
@ -10438,6 +10533,10 @@
|
|||
"type": "string",
|
||||
"description": "Unique identifier of the output item containing this content part"
|
||||
},
|
||||
"output_index": {
|
||||
"type": "integer",
|
||||
"description": "Index position of the output item in the response"
|
||||
},
|
||||
"part": {
|
||||
"oneOf": [
|
||||
{
|
||||
|
@ -10445,13 +10544,17 @@
|
|||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
||||
}
|
||||
],
|
||||
"discriminator": {
|
||||
"propertyName": "type",
|
||||
"mapping": {
|
||||
"output_text": "#/components/schemas/OpenAIResponseContentPartOutputText",
|
||||
"refusal": "#/components/schemas/OpenAIResponseContentPartRefusal"
|
||||
"refusal": "#/components/schemas/OpenAIResponseContentPartRefusal",
|
||||
"reasoning_text": "#/components/schemas/OpenAIResponseContentPartReasoningText"
|
||||
}
|
||||
},
|
||||
"description": "The completed content part"
|
||||
|
@ -10469,8 +10572,10 @@
|
|||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"content_index",
|
||||
"response_id",
|
||||
"item_id",
|
||||
"output_index",
|
||||
"part",
|
||||
"sequence_number",
|
||||
"type"
|
||||
|
@ -10483,7 +10588,7 @@
|
|||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "The newly created response object"
|
||||
"description": "The response object that was created"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
|
@ -10500,6 +10605,33 @@
|
|||
"title": "OpenAIResponseObjectStreamResponseCreated",
|
||||
"description": "Streaming event indicating a new response has been created."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseFailed": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "Response object describing the failure"
|
||||
},
|
||||
"sequence_number": {
|
||||
"type": "integer",
|
||||
"description": "Sequential number for ordering streaming events"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "response.failed",
|
||||
"default": "response.failed",
|
||||
"description": "Event type identifier, always \"response.failed\""
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"response",
|
||||
"sequence_number",
|
||||
"type"
|
||||
],
|
||||
"title": "OpenAIResponseObjectStreamResponseFailed",
|
||||
"description": "Streaming event emitted when a response fails."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
@ -10574,6 +10706,60 @@
|
|||
"title": "OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone",
|
||||
"description": "Streaming event for when function call arguments are completed."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseInProgress": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "Current response state while in progress"
|
||||
},
|
||||
"sequence_number": {
|
||||
"type": "integer",
|
||||
"description": "Sequential number for ordering streaming events"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "response.in_progress",
|
||||
"default": "response.in_progress",
|
||||
"description": "Event type identifier, always \"response.in_progress\""
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"response",
|
||||
"sequence_number",
|
||||
"type"
|
||||
],
|
||||
"title": "OpenAIResponseObjectStreamResponseInProgress",
|
||||
"description": "Streaming event indicating the response remains in progress."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseIncomplete": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"response": {
|
||||
"$ref": "#/components/schemas/OpenAIResponseObject",
|
||||
"description": "Response object describing the incomplete state"
|
||||
},
|
||||
"sequence_number": {
|
||||
"type": "integer",
|
||||
"description": "Sequential number for ordering streaming events"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"const": "response.incomplete",
|
||||
"default": "response.incomplete",
|
||||
"description": "Event type identifier, always \"response.incomplete\""
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"response",
|
||||
"sequence_number",
|
||||
"type"
|
||||
],
|
||||
"title": "OpenAIResponseObjectStreamResponseIncomplete",
|
||||
"description": "Streaming event emitted when a response ends in an incomplete state."
|
||||
},
|
||||
"OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
158
docs/static/stainless-llama-stack-spec.yaml
vendored
158
docs/static/stainless-llama-stack-spec.yaml
vendored
|
@ -7685,13 +7685,57 @@ components:
|
|||
type: string
|
||||
const: output_text
|
||||
default: output_text
|
||||
description: >-
|
||||
Content part type identifier, always "output_text"
|
||||
text:
|
||||
type: string
|
||||
description: Text emitted for this content part
|
||||
annotations:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/OpenAIResponseAnnotations'
|
||||
description: >-
|
||||
Structured annotations associated with the text
|
||||
logprobs:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
additionalProperties:
|
||||
oneOf:
|
||||
- type: 'null'
|
||||
- type: boolean
|
||||
- type: number
|
||||
- type: string
|
||||
- type: array
|
||||
- type: object
|
||||
description: (Optional) Token log probability details
|
||||
additionalProperties: false
|
||||
required:
|
||||
- type
|
||||
- text
|
||||
- annotations
|
||||
title: OpenAIResponseContentPartOutputText
|
||||
description: >-
|
||||
Text content within a streamed response part.
|
||||
OpenAIResponseContentPartReasoningText:
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
const: reasoning_text
|
||||
default: reasoning_text
|
||||
description: >-
|
||||
Content part type identifier, always "reasoning_text"
|
||||
text:
|
||||
type: string
|
||||
description: Reasoning text supplied by the model
|
||||
additionalProperties: false
|
||||
required:
|
||||
- type
|
||||
- text
|
||||
title: OpenAIResponseContentPartReasoningText
|
||||
description: >-
|
||||
Reasoning text emitted as part of a streamed response.
|
||||
OpenAIResponseContentPartRefusal:
|
||||
type: object
|
||||
properties:
|
||||
|
@ -7699,16 +7743,22 @@ components:
|
|||
type: string
|
||||
const: refusal
|
||||
default: refusal
|
||||
description: >-
|
||||
Content part type identifier, always "refusal"
|
||||
refusal:
|
||||
type: string
|
||||
description: Refusal text supplied by the model
|
||||
additionalProperties: false
|
||||
required:
|
||||
- type
|
||||
- refusal
|
||||
title: OpenAIResponseContentPartRefusal
|
||||
description: >-
|
||||
Refusal content within a streamed response part.
|
||||
OpenAIResponseObjectStream:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta'
|
||||
|
@ -7728,11 +7778,14 @@ components:
|
|||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed'
|
||||
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted'
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
response.created: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated'
|
||||
response.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress'
|
||||
response.output_item.added: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded'
|
||||
response.output_item.done: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone'
|
||||
response.output_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta'
|
||||
|
@ -7752,13 +7805,15 @@ components:
|
|||
response.mcp_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted'
|
||||
response.content_part.added: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded'
|
||||
response.content_part.done: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone'
|
||||
response.incomplete: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete'
|
||||
response.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed'
|
||||
response.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted'
|
||||
"OpenAIResponseObjectStreamResponseCompleted":
|
||||
type: object
|
||||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: The completed response object
|
||||
description: Completed response object
|
||||
type:
|
||||
type: string
|
||||
const: response.completed
|
||||
|
@ -7776,6 +7831,10 @@ components:
|
|||
"OpenAIResponseObjectStreamResponseContentPartAdded":
|
||||
type: object
|
||||
properties:
|
||||
content_index:
|
||||
type: integer
|
||||
description: >-
|
||||
Index position of the part within the content array
|
||||
response_id:
|
||||
type: string
|
||||
description: >-
|
||||
|
@ -7784,15 +7843,21 @@ components:
|
|||
type: string
|
||||
description: >-
|
||||
Unique identifier of the output item containing this content part
|
||||
output_index:
|
||||
type: integer
|
||||
description: >-
|
||||
Index position of the output item in the response
|
||||
part:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
||||
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
||||
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
||||
description: The content part that was added
|
||||
sequence_number:
|
||||
type: integer
|
||||
|
@ -7806,8 +7871,10 @@ components:
|
|||
Event type identifier, always "response.content_part.added"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- content_index
|
||||
- response_id
|
||||
- item_id
|
||||
- output_index
|
||||
- part
|
||||
- sequence_number
|
||||
- type
|
||||
|
@ -7818,6 +7885,10 @@ components:
|
|||
"OpenAIResponseObjectStreamResponseContentPartDone":
|
||||
type: object
|
||||
properties:
|
||||
content_index:
|
||||
type: integer
|
||||
description: >-
|
||||
Index position of the part within the content array
|
||||
response_id:
|
||||
type: string
|
||||
description: >-
|
||||
|
@ -7826,15 +7897,21 @@ components:
|
|||
type: string
|
||||
description: >-
|
||||
Unique identifier of the output item containing this content part
|
||||
output_index:
|
||||
type: integer
|
||||
description: >-
|
||||
Index position of the output item in the response
|
||||
part:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
||||
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
|
||||
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
|
||||
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
|
||||
description: The completed content part
|
||||
sequence_number:
|
||||
type: integer
|
||||
|
@ -7848,8 +7925,10 @@ components:
|
|||
Event type identifier, always "response.content_part.done"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- content_index
|
||||
- response_id
|
||||
- item_id
|
||||
- output_index
|
||||
- part
|
||||
- sequence_number
|
||||
- type
|
||||
|
@ -7862,7 +7941,7 @@ components:
|
|||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: The newly created response object
|
||||
description: The response object that was created
|
||||
type:
|
||||
type: string
|
||||
const: response.created
|
||||
|
@ -7877,6 +7956,30 @@ components:
|
|||
OpenAIResponseObjectStreamResponseCreated
|
||||
description: >-
|
||||
Streaming event indicating a new response has been created.
|
||||
OpenAIResponseObjectStreamResponseFailed:
|
||||
type: object
|
||||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: Response object describing the failure
|
||||
sequence_number:
|
||||
type: integer
|
||||
description: >-
|
||||
Sequential number for ordering streaming events
|
||||
type:
|
||||
type: string
|
||||
const: response.failed
|
||||
default: response.failed
|
||||
description: >-
|
||||
Event type identifier, always "response.failed"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- response
|
||||
- sequence_number
|
||||
- type
|
||||
title: OpenAIResponseObjectStreamResponseFailed
|
||||
description: >-
|
||||
Streaming event emitted when a response fails.
|
||||
"OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta":
|
||||
type: object
|
||||
properties:
|
||||
|
@ -7949,6 +8052,57 @@ components:
|
|||
OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone
|
||||
description: >-
|
||||
Streaming event for when function call arguments are completed.
|
||||
"OpenAIResponseObjectStreamResponseInProgress":
|
||||
type: object
|
||||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: Current response state while in progress
|
||||
sequence_number:
|
||||
type: integer
|
||||
description: >-
|
||||
Sequential number for ordering streaming events
|
||||
type:
|
||||
type: string
|
||||
const: response.in_progress
|
||||
default: response.in_progress
|
||||
description: >-
|
||||
Event type identifier, always "response.in_progress"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- response
|
||||
- sequence_number
|
||||
- type
|
||||
title: >-
|
||||
OpenAIResponseObjectStreamResponseInProgress
|
||||
description: >-
|
||||
Streaming event indicating the response remains in progress.
|
||||
"OpenAIResponseObjectStreamResponseIncomplete":
|
||||
type: object
|
||||
properties:
|
||||
response:
|
||||
$ref: '#/components/schemas/OpenAIResponseObject'
|
||||
description: >-
|
||||
Response object describing the incomplete state
|
||||
sequence_number:
|
||||
type: integer
|
||||
description: >-
|
||||
Sequential number for ordering streaming events
|
||||
type:
|
||||
type: string
|
||||
const: response.incomplete
|
||||
default: response.incomplete
|
||||
description: >-
|
||||
Event type identifier, always "response.incomplete"
|
||||
additionalProperties: false
|
||||
required:
|
||||
- response
|
||||
- sequence_number
|
||||
- type
|
||||
title: >-
|
||||
OpenAIResponseObjectStreamResponseIncomplete
|
||||
description: >-
|
||||
Streaming event emitted when a response ends in an incomplete state.
|
||||
"OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta":
|
||||
type: object
|
||||
properties:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue