-
Notifications
You must be signed in to change notification settings - Fork 474
Open
Description
As of today, the spec says:
RealtimeResponse:
type: object
description: The response resource.
properties:
id:
type: string
description: The unique ID of the response.
object:
description: The object type, must be `realtime.response`.
x-stainless-const: true
const: realtime.response
status:
type: string
enum:
- completed
- cancelled
- failed
- incomplete
- in_progress
description: |
The final status of the response (`completed`, `cancelled`, `failed`, or
`incomplete`, `in_progress`).
status_details:
type: object
description: Additional details about the status.
properties:
type:
type: string
enum:
- completed
- cancelled
- incomplete
- failed
description: |
The type of error that caused the response to fail, corresponding
with the `status` field (`completed`, `cancelled`, `incomplete`,
`failed`).
reason:
type: string
enum:
- turn_detected
- client_cancelled
- max_output_tokens
- content_filter
description: |
The reason the Response did not complete. For a `cancelled` Response,
one of `turn_detected` (the server VAD detected a new start of speech)
or `client_cancelled` (the client sent a cancel event). For an
`incomplete` Response, one of `max_output_tokens` or `content_filter`
(the server-side safety filter activated and cut off the response).
error:
type: object
description: |
A description of the error that caused the response to fail,
populated when the `status` is `failed`.
properties:
type:
type: string
description: The type of error.
code:
type: string
description: Error code, if any.
Here the error should be:
error:
type: object
description: |
A description of the error that caused the response to fail,
populated when the `status` is `failed`.
properties:
type:
type: string
description: The type of error.
code:
type: string
description: Error code, if any.
messasge:
type: string
description: Error message, if any.
For reasons/examples explained here - the message field is in use currently
Metadata
Metadata
Assignees
Labels
No labels