Skip to content

Commit 138a4af

Browse files
authored
Merge pull request #12 from dwalker-va/dwalker-va/response-cancel-response-id-param
feat: add ResponseID to ResponseCancelEvent
2 parents 5e45cbb + 09652a7 commit 138a4af

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

client_event.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,8 @@ func (m ResponseCreateEvent) MarshalJSON() ([]byte, error) {
278278
// See https://platform.openai.com/docs/api-reference/realtime-client-events/response/cancel
279279
type ResponseCancelEvent struct {
280280
EventBase
281+
// A specific response ID to cancel - if not provided, will cancel an in-progress response in the default conversation.
282+
ResponseID string `json:"response_id,omitempty"`
281283
}
282284

283285
func (m ResponseCancelEvent) ClientEventType() ClientEventType {

client_event_test.go

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -397,15 +397,17 @@ func TestResponseCreateEvent(t *testing.T) {
397397
}
398398

399399
func TestResponseCancelEvent(t *testing.T) {
400-
message := openairt.ResponseCancelEvent{}
400+
message := openairt.ResponseCancelEvent{
401+
ResponseID: "test-response-id",
402+
}
401403
data, err := json.Marshal(message)
402404
require.NoError(t, err)
403-
expected := `{"type":"response.cancel"}`
405+
expected := `{"response_id":"test-response-id","type":"response.cancel"}`
404406
require.JSONEq(t, expected, string(data))
405407

406408
message.EventBase.EventID = "test-id"
407409
data, err = json.Marshal(message)
408410
require.NoError(t, err)
409-
expected = `{"event_id":"test-id","type":"response.cancel"}`
411+
expected = `{"event_id":"test-id","response_id":"test-response-id","type":"response.cancel"}`
410412
require.JSONEq(t, expected, string(data))
411413
}

0 commit comments

Comments
 (0)