Skip to content

Commit 07939c0

Browse files
authored
fix: correct typo in RealtimeTransportEventTypes and add changeset (#167)
1 parent 6e0d1bd commit 07939c0

File tree

8 files changed

+16
-11
lines changed

8 files changed

+16
-11
lines changed

.changeset/funny-memes-cover.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@openai/agents-realtime': patch
3+
---
4+
5+
Correct typo in RealtimeTransportEventTypes in code and docs

docs/src/content/docs/guides/voice-agents/transport.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Use any recording/playback library to handle the raw PCM16 audio bytes.
4949
### Building your own transport mechanism
5050

5151
If you want to use a different speech-to-speech API or have your own custom transport mechanism, you
52-
can create your own by implementing the `RealtimeTransportLayer` interface and emit the `RealtimeTranportEventTypes` events.
52+
can create your own by implementing the `RealtimeTransportLayer` interface and emit the `RealtimeTransportEventTypes` events.
5353

5454
## Interacting with the Realtime API more directly
5555

docs/src/content/docs/ja/guides/voice-agents/transport.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ WebRTC の代わりに WebSocket 接続を使用する場合は、セッショ
4545

4646
### 独自のトランスポートメカニズムの構築
4747

48-
別の speech-to-speech API を使用したい場合や独自のトランスポートメカニズムを持っている場合は、`RealtimeTransportLayer` インターフェースを実装し、`RealtimeTranportEventTypes` イベントを発火することで独自実装が可能です。
48+
別の speech-to-speech API を使用したい場合や独自のトランスポートメカニズムを持っている場合は、`RealtimeTransportLayer` インターフェースを実装し、`RealtimeTransportEventTypes` イベントを発火することで独自実装が可能です。
4949

5050
## Realtime API との直接的なインタラクション
5151

packages/agents-realtime/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export {
1919
TransportLayerTranscriptDelta,
2020
TransportError,
2121
TransportToolCallEvent,
22-
RealtimeTranportEventTypes,
22+
RealtimeTransportEventTypes,
2323
} from './transportLayerEvents';
2424

2525
export {

packages/agents-realtime/src/openaiRealtimeBase.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import {
2525
RealtimeTransportLayerConnectOptions,
2626
} from './transportLayer';
2727
import {
28-
RealtimeTranportEventTypes,
28+
RealtimeTransportEventTypes,
2929
TransportToolCallEvent,
3030
} from './transportLayerEvents';
3131
import { arrayBufferToBase64, diffRealtimeHistory } from './utils';
@@ -93,7 +93,7 @@ export type OpenAIRealtimeEventTypes = {
9393
* Triggered when the connection is closed.
9494
*/
9595
disconnected: [];
96-
} & RealtimeTranportEventTypes;
96+
} & RealtimeTransportEventTypes;
9797

9898
export abstract class OpenAIRealtimeBase
9999
extends EventEmitterDelegate<OpenAIRealtimeEventTypes>

packages/agents-realtime/src/transportLayer.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import {
66
} from './clientMessages';
77
import { RealtimeItem } from './items';
88
import {
9-
RealtimeTranportEventTypes,
9+
RealtimeTransportEventTypes,
1010
TransportToolCallEvent,
1111
} from './transportLayerEvents';
1212

@@ -46,7 +46,7 @@ export type RealtimeTransportLayerConnectOptions = {
4646
* and the communication with the model.
4747
*/
4848
export interface RealtimeTransportLayer
49-
extends EventEmitter<RealtimeTranportEventTypes> {
49+
extends EventEmitter<RealtimeTransportEventTypes> {
5050
status: 'connected' | 'disconnected' | 'connecting' | 'disconnecting';
5151

5252
/**

packages/agents-realtime/src/transportLayerEvents.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ export type TransportEvent =
6262
[key: string]: any;
6363
};
6464

65-
export type RealtimeTranportEventTypes = {
65+
export type RealtimeTransportEventTypes = {
6666
/**
6767
* A raw event from the transport layer. Allows a user to tap directly into the events of the
6868
* transport layer.

packages/agents-realtime/test/stubs.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import type {
2222
RealtimeTransportLayerConnectOptions,
2323
} from '../src/transportLayer';
2424
import type { TransportToolCallEvent } from '../src/transportLayerEvents';
25-
import { RealtimeTranportEventTypes } from '../src/transportLayerEvents';
25+
import { RealtimeTransportEventTypes } from '../src/transportLayerEvents';
2626

2727
export const TEST_MODEL_MESSAGE: protocol.AssistantMessageItem = {
2828
id: '123',
@@ -123,7 +123,7 @@ export class FakeModelProvider implements ModelProvider {
123123
}
124124

125125
export class FakeTransport
126-
extends EventEmitterDelegate<RealtimeTranportEventTypes>
126+
extends EventEmitterDelegate<RealtimeTransportEventTypes>
127127
implements RealtimeTransportLayer
128128
{
129129
status: 'connected' | 'disconnected' | 'connecting' | 'disconnecting' =
@@ -135,7 +135,7 @@ export class FakeTransport
135135
sendAudioCalls: [ArrayBuffer, { commit?: boolean }][] = [];
136136
updateSessionConfigCalls: Partial<RealtimeSessionConfig>[] = [];
137137
closeCalls = 0;
138-
eventEmitter = new RuntimeEventEmitter<RealtimeTranportEventTypes>();
138+
eventEmitter = new RuntimeEventEmitter<RealtimeTransportEventTypes>();
139139
muteCalls: boolean[] = [];
140140
sendFunctionCallOutputCalls: [TransportToolCallEvent, string, boolean][] = [];
141141
interruptCalls = 0;

0 commit comments

Comments
 (0)