Skip to content

docs(api): describe response stream event unions #862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jbeckwith-oai wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −6
Open

docs(api): describe response stream event unions #862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .castiron.stats.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
schema_version: 1
generation_id: 44af854c-977e-4576-b575-1e97d7b130db
openapi_spec_hash: 15849b9fe3deb3c72da0825905cc0ad9
openapi_transformed_spec_hash: 9a60ddf3a1c752e15eb43fce666d6da8
generation_id: a68d69bb-f8a7-4e0c-8eea-a2c0215d752b
openapi_spec_hash: 143aa2ed6323d61a1834c74044e29d30
openapi_transformed_spec_hash: 5af6fa4fd590fcc79ba2fdd69b9f7b82
config_hash: fcda4ecfe265daddba6fad25a8504a3f
codegen_sha: b320692e9103694cfc5d48b1de7c0cdf96f7b0e6
codegen_sha: fb74fa30832d64dc32800aa4f537b047086fffd9
2 changes: 2 additions & 0 deletions api_reference/openapi.transformed.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54296,6 +54296,7 @@ components:
"sequence_number": 1
}
ResponseStreamEvent:
description: Event emitted while a response is streamed.
anyOf:
- $ref: '#/components/schemas/ResponseAudioDeltaEvent'
- $ref: '#/components/schemas/ResponseAudioDoneEvent'
Expand Down Expand Up @@ -77148,6 +77149,7 @@ components:
when the originating `response.create` event supplied a
`stream_id`.
BetaResponseStreamEvent:
description: Event emitted while a response is streamed.
anyOf:
- $ref: '#/components/schemas/BetaResponseAudioDeltaEvent'
- $ref: '#/components/schemas/BetaResponseAudioDoneEvent'
Expand Down
2 changes: 1 addition & 1 deletion openai-java-core/src/main/kotlin/com/openai/models/beta/responses/BetaResponseStreamEvent.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import java.util.Objects
import java.util.Optional
import kotlin.jvm.optionals.getOrNull

/** Emitted when there is a partial audio response. */
/** Event emitted while a response is streamed. */
@JsonDeserialize(using = BetaResponseStreamEvent.Deserializer::class)
@JsonSerialize(using = BetaResponseStreamEvent.Serializer::class)
class BetaResponseStreamEvent
Expand Down
2 changes: 1 addition & 1 deletion openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseStreamEvent.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import java.util.Objects
import java.util.Optional
import kotlin.jvm.optionals.getOrNull

/** Emitted when there is a partial audio response. */
/** Event emitted while a response is streamed. */
@JsonDeserialize(using = ResponseStreamEvent.Deserializer::class)
@JsonSerialize(using = ResponseStreamEvent.Serializer::class)
class ResponseStreamEvent
Expand Down
Loading