105 lines
4.4 KiB
JavaScript
105 lines
4.4 KiB
JavaScript
import { OpenAI } from "../index.mjs";
|
|
import { OpenAIError } from "../error.mjs";
|
|
import { OpenAIRealtimeEmitter, buildRealtimeURL, isAzure } from "./internal-base.mjs";
|
|
import { isRunningInBrowser } from "../internal/detect-platform.mjs";
|
|
export class OpenAIRealtimeWebSocket extends OpenAIRealtimeEmitter {
|
|
constructor(props, client) {
|
|
super();
|
|
const hasProvider = typeof client?._options?.apiKey === 'function';
|
|
const dangerouslyAllowBrowser = props.dangerouslyAllowBrowser ??
|
|
client?._options?.dangerouslyAllowBrowser ??
|
|
(client?.apiKey?.startsWith('ek_') ? true : null);
|
|
if (!dangerouslyAllowBrowser && isRunningInBrowser()) {
|
|
throw new OpenAIError("It looks like you're running in a browser-like environment.\n\nThis is disabled by default, as it risks exposing your secret API credentials to attackers.\n\nYou can avoid this error by creating an ephemeral session token:\nhttps://platform.openai.com/docs/api-reference/realtime-sessions\n");
|
|
}
|
|
client ?? (client = new OpenAI({ dangerouslyAllowBrowser }));
|
|
if (hasProvider && !props?.__resolvedApiKey) {
|
|
throw new Error([
|
|
'Cannot open Realtime WebSocket with a function-based apiKey.',
|
|
'Use the .create() method so that the key is resolved before connecting:',
|
|
'await OpenAIRealtimeWebSocket.create(client, { model })',
|
|
].join('\n'));
|
|
}
|
|
this.url = buildRealtimeURL(client, props.model);
|
|
props.onURL?.(this.url);
|
|
// @ts-ignore
|
|
this.socket = new WebSocket(this.url.toString(), [
|
|
'realtime',
|
|
...(isAzure(client) ? [] : [`openai-insecure-api-key.${client.apiKey}`]),
|
|
]);
|
|
this.socket.addEventListener('message', (websocketEvent) => {
|
|
const event = (() => {
|
|
try {
|
|
return JSON.parse(websocketEvent.data.toString());
|
|
}
|
|
catch (err) {
|
|
this._onError(null, 'could not parse websocket event', err);
|
|
return null;
|
|
}
|
|
})();
|
|
if (event) {
|
|
this._emit('event', event);
|
|
if (event.type === 'error') {
|
|
this._onError(event);
|
|
}
|
|
else {
|
|
// @ts-expect-error TS isn't smart enough to get the relationship right here
|
|
this._emit(event.type, event);
|
|
}
|
|
}
|
|
});
|
|
this.socket.addEventListener('error', (event) => {
|
|
this._onError(null, event.message, null);
|
|
});
|
|
if (isAzure(client)) {
|
|
if (this.url.searchParams.get('Authorization') !== null) {
|
|
this.url.searchParams.set('Authorization', '<REDACTED>');
|
|
}
|
|
else {
|
|
this.url.searchParams.set('api-key', '<REDACTED>');
|
|
}
|
|
}
|
|
}
|
|
static async create(client, props) {
|
|
return new OpenAIRealtimeWebSocket({ ...props, __resolvedApiKey: await client._callApiKey() }, client);
|
|
}
|
|
static async azure(client, options = {}) {
|
|
const isApiKeyProvider = await client._callApiKey();
|
|
function onURL(url) {
|
|
if (isApiKeyProvider) {
|
|
url.searchParams.set('Authorization', `Bearer ${client.apiKey}`);
|
|
}
|
|
else {
|
|
url.searchParams.set('api-key', client.apiKey);
|
|
}
|
|
}
|
|
const deploymentName = options.deploymentName ?? client.deploymentName;
|
|
if (!deploymentName) {
|
|
throw new Error('No deployment name provided');
|
|
}
|
|
const { dangerouslyAllowBrowser } = options;
|
|
return new OpenAIRealtimeWebSocket({
|
|
model: deploymentName,
|
|
onURL,
|
|
...(dangerouslyAllowBrowser ? { dangerouslyAllowBrowser } : {}),
|
|
__resolvedApiKey: isApiKeyProvider,
|
|
}, client);
|
|
}
|
|
send(event) {
|
|
try {
|
|
this.socket.send(JSON.stringify(event));
|
|
}
|
|
catch (err) {
|
|
this._onError(null, 'could not send data', err);
|
|
}
|
|
}
|
|
close(props) {
|
|
try {
|
|
this.socket.close(props?.code ?? 1000, props?.reason ?? 'OK');
|
|
}
|
|
catch (err) {
|
|
this._onError(null, 'could not close the connection', err);
|
|
}
|
|
}
|
|
}
|
|
//# sourceMappingURL=websocket.mjs.map
|