websocket.js 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", { value: true });
  3. exports.OpenAIRealtimeWebSocket = void 0;
  4. const index_1 = require("../../index.js");
  5. const error_1 = require("../../error.js");
  6. const internal_base_1 = require("./internal-base.js");
  7. const detect_platform_1 = require("../../internal/detect-platform.js");
  8. class OpenAIRealtimeWebSocket extends internal_base_1.OpenAIRealtimeEmitter {
  9. constructor(props, client) {
  10. super();
  11. const hasProvider = typeof client?._options?.apiKey === 'function';
  12. const dangerouslyAllowBrowser = props.dangerouslyAllowBrowser ??
  13. client?._options?.dangerouslyAllowBrowser ??
  14. (client?.apiKey?.startsWith('ek_') ? true : null);
  15. if (!dangerouslyAllowBrowser && (0, detect_platform_1.isRunningInBrowser)()) {
  16. throw new error_1.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");
  17. }
  18. client ?? (client = new index_1.OpenAI({ dangerouslyAllowBrowser }));
  19. if (hasProvider && !props?.__resolvedApiKey) {
  20. throw new Error([
  21. 'Cannot open Realtime WebSocket with a function-based apiKey.',
  22. 'Use the .create() method so that the key is resolved before connecting:',
  23. 'await OpenAIRealtimeWebSocket.create(client, { model })',
  24. ].join('\n'));
  25. }
  26. this.url = (0, internal_base_1.buildRealtimeURL)(client, props.model);
  27. props.onURL?.(this.url);
  28. // @ts-ignore
  29. this.socket = new WebSocket(this.url.toString(), [
  30. 'realtime',
  31. ...((0, internal_base_1.isAzure)(client) ? [] : [`openai-insecure-api-key.${client.apiKey}`]),
  32. 'openai-beta.realtime-v1',
  33. ]);
  34. this.socket.addEventListener('message', (websocketEvent) => {
  35. const event = (() => {
  36. try {
  37. return JSON.parse(websocketEvent.data.toString());
  38. }
  39. catch (err) {
  40. this._onError(null, 'could not parse websocket event', err);
  41. return null;
  42. }
  43. })();
  44. if (event) {
  45. this._emit('event', event);
  46. if (event.type === 'error') {
  47. this._onError(event);
  48. }
  49. else {
  50. // @ts-expect-error TS isn't smart enough to get the relationship right here
  51. this._emit(event.type, event);
  52. }
  53. }
  54. });
  55. this.socket.addEventListener('error', (event) => {
  56. this._onError(null, event.message, null);
  57. });
  58. if ((0, internal_base_1.isAzure)(client)) {
  59. if (this.url.searchParams.get('Authorization') !== null) {
  60. this.url.searchParams.set('Authorization', '<REDACTED>');
  61. }
  62. else {
  63. this.url.searchParams.set('api-key', '<REDACTED>');
  64. }
  65. }
  66. }
  67. static async create(client, props) {
  68. return new OpenAIRealtimeWebSocket({ ...props, __resolvedApiKey: await client._callApiKey() }, client);
  69. }
  70. static async azure(client, options = {}) {
  71. const isApiKeyProvider = await client._callApiKey();
  72. function onURL(url) {
  73. if (isApiKeyProvider) {
  74. url.searchParams.set('Authorization', `Bearer ${client.apiKey}`);
  75. }
  76. else {
  77. url.searchParams.set('api-key', client.apiKey);
  78. }
  79. }
  80. const deploymentName = options.deploymentName ?? client.deploymentName;
  81. if (!deploymentName) {
  82. throw new Error('No deployment name provided');
  83. }
  84. const { dangerouslyAllowBrowser } = options;
  85. return new OpenAIRealtimeWebSocket({
  86. model: deploymentName,
  87. onURL,
  88. ...(dangerouslyAllowBrowser ? { dangerouslyAllowBrowser } : {}),
  89. __resolvedApiKey: isApiKeyProvider,
  90. }, client);
  91. }
  92. send(event) {
  93. try {
  94. this.socket.send(JSON.stringify(event));
  95. }
  96. catch (err) {
  97. this._onError(null, 'could not send data', err);
  98. }
  99. }
  100. close(props) {
  101. try {
  102. this.socket.close(props?.code ?? 1000, props?.reason ?? 'OK');
  103. }
  104. catch (err) {
  105. this._onError(null, 'could not close the connection', err);
  106. }
  107. }
  108. }
  109. exports.OpenAIRealtimeWebSocket = OpenAIRealtimeWebSocket;
  110. //# sourceMappingURL=websocket.js.map