@effect/ai-openai 4.0.0-beta.7 → 4.0.0-beta.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/ai-openai",
-  "version": "4.0.0-beta.7",
+  "version": "4.0.0-beta.9",
   "type": "module",
   "license": "MIT",
   "description": "An OpenAI provider integration for Effect AI SDK",
@@ -43,10 +43,10 @@
     "provenance": true
   },
   "devDependencies": {
-    "effect": "^4.0.0-beta.7"
+    "effect": "^4.0.0-beta.9"
   },
   "peerDependencies": {
-    "effect": "^4.0.0-beta.7"
+    "effect": "^4.0.0-beta.9"
   },
   "scripts": {
     "codegen": "effect-utils codegen",

package/src/Generated.ts

@@ -14156,80 +14156,6 @@ export const ChatCompletionRequestAssistantMessage = Schema.Struct({
   "title": "Assistant message",
   "description": "Messages sent by the model in response to user messages.\n"
 })
-export type FineTuneChatCompletionRequestAssistantMessage = {
-  readonly "role": "assistant"
-  readonly "weight"?: 0 | 1
-  readonly "content"?: string | ReadonlyArray<ChatCompletionRequestAssistantMessageContentPart> | null
-  readonly "refusal"?: string | null
-  readonly "name"?: string
-  readonly "audio"?: { readonly "id": string } | null
-  readonly "tool_calls"?: ChatCompletionMessageToolCalls
-  readonly "function_call"?: { readonly "arguments": string; readonly "name": string } | null
-}
-export const FineTuneChatCompletionRequestAssistantMessage = Schema.Struct({
-  "role": Schema.Literal("assistant").annotate({
-    "description": "The role of the messages author, in this case `assistant`."
-  }),
-  "weight": Schema.optionalKey(
-    Schema.Literals([0, 1]).annotate({
-      "description": "Controls whether the assistant message is trained against (0 or 1)"
-    })
-  ),
-  "content": Schema.optionalKey(
-    Schema.Union([
-      Schema.Union([
-        Schema.String.annotate({ "title": "Text content", "description": "The contents of the assistant message." }),
-        Schema.Array(ChatCompletionRequestAssistantMessageContentPart).annotate({
-          "title": "Array of content parts",
-          "description":
-            "An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`."
-        }).check(Schema.isMinLength(1))
-      ], { mode: "oneOf" }).annotate({
-        "description":
-          "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.\n"
-      }),
-      Schema.Null
-    ])
-  ),
-  "refusal": Schema.optionalKey(
-    Schema.Union([Schema.String.annotate({ "description": "The refusal message by the assistant." }), Schema.Null])
-  ),
-  "name": Schema.optionalKey(
-    Schema.String.annotate({
-      "description":
-        "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
-    })
-  ),
-  "audio": Schema.optionalKey(
-    Schema.Union([
-      Schema.Struct({
-        "id": Schema.String.annotate({
-          "description": "Unique identifier for a previous audio response from the model.\n"
-        })
-      }).annotate({
-        "description": "Data about a previous audio response from the model.\n[Learn more](/docs/guides/audio).\n"
-      }),
-      Schema.Null
-    ])
-  ),
-  "tool_calls": Schema.optionalKey(ChatCompletionMessageToolCalls),
-  "function_call": Schema.optionalKey(Schema.Union([
-    Schema.Struct({
-      "arguments": Schema.String.annotate({
-        "description":
-          "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."
-      }),
-      "name": Schema.String.annotate({ "description": "The name of the function to call." })
-    }).annotate({
-      "description":
-        "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model."
-    }),
-    Schema.Null
-  ]))
-}).annotate({
-  "title": "Assistant message",
-  "description": "Messages sent by the model in response to user messages.\n"
-})
 export type ChatCompletionRequestSystemMessage = {
   readonly "content": string | ReadonlyArray<ChatCompletionRequestSystemMessageContentPart>
   readonly "role": "system"
@@ -19824,7 +19750,7 @@ export const CreateChatCompletionRequest = Schema.Struct({
   "safety_identifier": Schema.optionalKey(
     Schema.Union([Schema.String, Schema.Null]).annotate({
       "description":
-        "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
+        "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
     })
   ),
   "prompt_cache_key": Schema.optionalKey(
@@ -21714,7 +21640,7 @@ export const Response = Schema.Struct({
   "safety_identifier": Schema.optionalKey(
     Schema.Union([Schema.String, Schema.Null]).annotate({
       "description":
-        "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
+        "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
     })
   ),
   "prompt_cache_key": Schema.optionalKey(
@@ -21990,7 +21916,7 @@ export const ResponseCompletedEvent = Schema.Struct({
     "safety_identifier": Schema.optionalKey(
       Schema.Union([Schema.String, Schema.Null]).annotate({
         "description":
-          "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
+          "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
       })
     ),
     "prompt_cache_key": Schema.optionalKey(
@@ -22271,7 +22197,7 @@ export const ResponseCreatedEvent = Schema.Struct({
     "safety_identifier": Schema.optionalKey(
       Schema.Union([Schema.String, Schema.Null]).annotate({
         "description":
-          "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
+          "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
       })
     ),
     "prompt_cache_key": Schema.optionalKey(
@@ -22555,7 +22481,7 @@ export const ResponseFailedEvent = Schema.Struct({
     "safety_identifier": Schema.optionalKey(
       Schema.Union([Schema.String, Schema.Null]).annotate({
         "description":
-          "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
+          "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
       })
     ),
     "prompt_cache_key": Schema.optionalKey(
@@ -22833,7 +22759,7 @@ export const ResponseInProgressEvent = Schema.Struct({
     "safety_identifier": Schema.optionalKey(
       Schema.Union([Schema.String, Schema.Null]).annotate({
         "description":
-          "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
+          "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
       })
     ),
     "prompt_cache_key": Schema.optionalKey(
@@ -23114,7 +23040,7 @@ export const ResponseIncompleteEvent = Schema.Struct({
     "safety_identifier": Schema.optionalKey(
       Schema.Union([Schema.String, Schema.Null]).annotate({
         "description":
-          "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
+          "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
       })
     ),
     "prompt_cache_key": Schema.optionalKey(
@@ -23395,7 +23321,7 @@ export const ResponseQueuedEvent = Schema.Struct({
     "safety_identifier": Schema.optionalKey(
       Schema.Union([Schema.String, Schema.Null]).annotate({
         "description":
-          "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
+          "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
       })
     ),
     "prompt_cache_key": Schema.optionalKey(
@@ -23778,7 +23704,7 @@ export const CreateResponse = Schema.Struct({
   "safety_identifier": Schema.optionalKey(
     Schema.Union([Schema.String, Schema.Null]).annotate({
       "description":
-        "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
+        "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
     })
   ),
   "prompt_cache_key": Schema.optionalKey(
@@ -28212,12 +28138,16 @@ export interface OpenAiClient {
   >
   /**
    * Generates audio from the input text.
+   *
+   * Returns the audio file content, or a stream of audio events.
    */
   readonly "createSpeech": <Config extends OperationConfig>(
     options: { readonly payload: typeof CreateSpeechRequestJson.Encoded; readonly config?: Config | undefined }
   ) => Effect.Effect<WithOptionalResponse<void, Config>, HttpClientError.HttpClientError | SchemaError>
   /**
    * Generates audio from the input text.
+   *
+   * Returns the audio file content, or a stream of audio events.
    */
   readonly "createSpeechSse": (
     options: { readonly payload: typeof CreateSpeechRequestJson.Encoded }
@@ -28228,12 +28158,17 @@ export interface OpenAiClient {
   >
   /**
    * Generates audio from the input text.
+   *
+   * Returns the audio file content, or a stream of audio events.
    */
   readonly "createSpeechStream": (
     options: { readonly payload: typeof CreateSpeechRequestJson.Encoded }
   ) => Stream.Stream<Uint8Array, HttpClientError.HttpClientError>
   /**
    * Transcribes audio into the input language.
+   *
+   * Returns a transcription object in `json`, `diarized_json`, or `verbose_json`
+   * format, or a stream of transcript events.
    */
   readonly "createTranscription": <Config extends OperationConfig>(
     options: {
@@ -28246,6 +28181,9 @@ export interface OpenAiClient {
   >
   /**
    * Transcribes audio into the input language.
+   *
+   * Returns a transcription object in `json`, `diarized_json`, or `verbose_json`
+   * format, or a stream of transcript events.
    */
   readonly "createTranscriptionSse": (
     options: { readonly payload: typeof CreateTranscriptionRequestFormData.Encoded }
@@ -28407,6 +28345,9 @@ export interface OpenAiClient {
    * supported for reasoning models are noted below. For the current state of
    * unsupported parameters in reasoning models,
    * [refer to the reasoning guide](/docs/guides/reasoning).
+   *
+   * Returns a chat completion object, or a streamed sequence of chat completion
+   * chunk objects if the request is streamed.
    */
   readonly "createChatCompletion": <Config extends OperationConfig>(
     options: { readonly payload: typeof CreateChatCompletionRequestJson.Encoded; readonly config?: Config | undefined }
@@ -28430,6 +28371,9 @@ export interface OpenAiClient {
    * supported for reasoning models are noted below. For the current state of
    * unsupported parameters in reasoning models,
    * [refer to the reasoning guide](/docs/guides/reasoning).
+   *
+   * Returns a chat completion object, or a streamed sequence of chat completion
+   * chunk objects if the request is streamed.
    */
   readonly "createChatCompletionSse": (
     options: { readonly payload: typeof CreateChatCompletionRequestJson.Encoded }
@@ -28489,6 +28433,8 @@ export interface OpenAiClient {
   >
   /**
    * Creates a completion for the provided prompt and parameters.
+   *
+   * Returns a completion object, or a sequence of completion objects if the request is streamed.
    */
   readonly "createCompletion": <Config extends OperationConfig>(
     options: { readonly payload: typeof CreateCompletionRequestJson.Encoded; readonly config?: Config | undefined }
@@ -29460,6 +29406,9 @@ export interface OpenAiClient {
   >
   /**
    * Deletes an API key from the project.
+   *
+   * Returns confirmation of the key deletion, or an error if the key belonged to
+   * a service account.
    */
   readonly "deleteProjectApiKey": <Config extends OperationConfig>(
     projectId: string,
@@ -29629,6 +29578,9 @@ export interface OpenAiClient {
   >
   /**
    * Deletes a service account from the project.
+   *
+   * Returns confirmation of service account deletion, or an error if the project
+   * is archived (archived projects have no service accounts).
    */
   readonly "deleteProjectServiceAccount": <Config extends OperationConfig>(
     projectId: string,
@@ -29691,6 +29643,9 @@ export interface OpenAiClient {
   >
   /**
    * Deletes a user from the project.
+   *
+   * Returns confirmation of project user deletion, or an error if the project is
+   * archived (archived projects have no users).
    */
   readonly "deleteProjectUser": <Config extends OperationConfig>(
     projectId: string,
@@ -30056,6 +30011,18 @@ export interface OpenAiClient {
   ) => Effect.Effect<WithOptionalResponse<void, Config>, HttpClientError.HttpClientError | SchemaError>
   /**
    * Create a Realtime client secret with an associated session configuration.
+   *
+   * Client secrets are short-lived tokens that can be passed to a client app,
+   * such as a web frontend or mobile client, which grants access to the Realtime API without
+   * leaking your main API key. You can configure a custom TTL for each client secret.
+   *
+   * You can also attach session configuration options to the client secret, which will be
+   * applied to any sessions created using that client secret, but these can also be overridden
+   * by the client connection.
+   *
+   * [Learn more about authentication with client secrets over WebRTC](/docs/guides/realtime-webrtc).
+   *
+   * Returns the created client secret and the effective session object. The client secret is a string that looks like `ek_1234`.
    */
   readonly "createRealtimeClientSecret": <Config extends OperationConfig>(
     options: {
@@ -30074,6 +30041,8 @@ export interface OpenAiClient {
    * It responds with a session object, plus a `client_secret` key which contains
    * a usable ephemeral API token that can be used to authenticate browser clients
    * for the Realtime API.
+   *
+   * Returns the created Realtime session object, plus an ephemeral key.
    */
   readonly "createRealtimeSession": <Config extends OperationConfig>(
     options: { readonly payload: typeof CreateRealtimeSessionRequestJson.Encoded; readonly config?: Config | undefined }
@@ -30089,6 +30058,8 @@ export interface OpenAiClient {
    * It responds with a session object, plus a `client_secret` key which contains
    * a usable ephemeral API token that can be used to authenticate browser clients
    * for the Realtime API.
+   *
+   * Returns the created Realtime transcription session object, plus an ephemeral key.
    */
   readonly "createRealtimeTranscriptionSession": <Config extends OperationConfig>(
     options: {
@@ -30395,6 +30366,8 @@ export interface OpenAiClient {
    * For guidance on the proper filename extensions for each purpose, please
    * follow the documentation on [creating a
    * File](/docs/api-reference/files/create).
+   *
+   * Returns the Upload object with status `pending`.
    */
   readonly "createUpload": <Config extends OperationConfig>(
     options: { readonly payload: typeof CreateUploadRequestJson.Encoded; readonly config?: Config | undefined }
@@ -30404,6 +30377,8 @@ export interface OpenAiClient {
   >
   /**
    * Cancels the Upload. No Parts may be added after an Upload is cancelled.
+   *
+   * Returns the Upload object with status `cancelled`.
    */
   readonly "cancelUpload": <Config extends OperationConfig>(
     uploadId: string,
@@ -30420,6 +30395,7 @@ export interface OpenAiClient {
    * You can specify the order of the Parts by passing in an ordered list of the Part IDs.
    *
    * The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
+   * Returns the Upload object with status `completed`, including an additional `file` property containing the created usable File object.
    */
   readonly "completeUpload": <Config extends OperationConfig>(
     uploadId: string,
@@ -30703,6 +30679,8 @@ export interface OpenAiClient {
   >
   /**
    * Download the generated video bytes or a derived preview asset.
+   *
+   * Streams the rendered video content for the specified video job.
    */
   readonly "RetrieveVideoContent": <Config extends OperationConfig>(
     videoId: string,
@@ -30726,6 +30704,8 @@ export interface OpenAiClient {
   >
   /**
    * Returns input token counts of the request.
+   *
+   * Returns an object with `object` set to `response.input_tokens` and an `input_tokens` count.
    */
   readonly "Getinputtokencounts": <Config extends OperationConfig>(
     options: { readonly payload: typeof GetinputtokencountsRequestJson.Encoded; readonly config?: Config | undefined }
@@ -30734,7 +30714,9 @@ export interface OpenAiClient {
     HttpClientError.HttpClientError | SchemaError
   >
   /**
-   * Runs a compaction pass over a conversation. Compaction returns encrypted, opaque items and the underlying logic may evolve over time.
+   * Compact a conversation. Returns a compacted response object.
+   *
+   * Learn when and how to compact long-running conversations in the [conversation state guide](/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, see [Compaction (advanced)](/docs/guides/conversation-state#compaction-advanced).
    */
   readonly "Compactconversation": <Config extends OperationConfig>(
     options: { readonly payload: typeof CompactconversationRequestJson.Encoded; readonly config?: Config | undefined }
@@ -30866,6 +30848,8 @@ export interface OpenAiClient {
   >
   /**
    * Cancel an active ChatKit session and return its most recent metadata.
+   *
+   * Cancelling prevents new requests from using the issued client secret.
    */
   readonly "CancelChatSessionMethod": <Config extends OperationConfig>(
     sessionId: string,