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

package/dist/Generated.d.ts

@@ -9187,56 +9187,6 @@ export declare const ChatCompletionRequestAssistantMessage: Schema.Struct<{
         readonly name: Schema.String;
     }>, Schema.Null]>>;
 }>;
-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 declare const FineTuneChatCompletionRequestAssistantMessage: Schema.Struct<{
-    readonly role: Schema.Literal<"assistant">;
-    readonly weight: Schema.optionalKey<Schema.Literals<readonly [0, 1]>>;
-    readonly content: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.$Array<Schema.Union<readonly [Schema.Struct<{
-        readonly type: Schema.Literal<"text">;
-        readonly text: Schema.String;
-    }>, Schema.Struct<{
-        readonly type: Schema.Literal<"refusal">;
-        readonly refusal: Schema.String;
-    }>]>>]>, Schema.Null]>>;
-    readonly refusal: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
-    readonly name: Schema.optionalKey<Schema.String>;
-    readonly audio: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
-        readonly id: Schema.String;
-    }>, Schema.Null]>>;
-    readonly tool_calls: Schema.optionalKey<Schema.$Array<Schema.Union<readonly [Schema.Struct<{
-        readonly id: Schema.String;
-        readonly type: Schema.Literal<"function">;
-        readonly function: Schema.Struct<{
-            readonly name: Schema.String;
-            readonly arguments: Schema.String;
-        }>;
-    }>, Schema.Struct<{
-        readonly id: Schema.String;
-        readonly type: Schema.Literal<"custom">;
-        readonly custom: Schema.Struct<{
-            readonly name: Schema.String;
-            readonly input: Schema.String;
-        }>;
-    }>]>>>;
-    readonly function_call: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
-        readonly arguments: Schema.String;
-        readonly name: Schema.String;
-    }>, Schema.Null]>>;
-}>;
 export type ChatCompletionRequestSystemMessage = {
     readonly "content": string | ReadonlyArray<ChatCompletionRequestSystemMessageContentPart>;
     readonly "role": "system";
@@ -69113,6 +69063,8 @@ export interface OpenAiClient {
     } | undefined) => Effect.Effect<WithOptionalResponse<typeof DeleteAssistant200.Type, Config>, HttpClientError.HttpClientError | SchemaError>;
     /**
      * 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;
@@ -69120,6 +69072,8 @@ export interface OpenAiClient {
     }) => 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;
@@ -69130,12 +69084,17 @@ export interface OpenAiClient {
     }, HttpClientError.HttpClientError | SchemaError | Sse.Retry, typeof CreateSpeech200Sse.DecodingServices>;
     /**
      * 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: {
         readonly payload: typeof CreateTranscriptionRequestFormData.Encoded;
@@ -69143,6 +69102,9 @@ export interface OpenAiClient {
     }) => Effect.Effect<WithOptionalResponse<typeof CreateTranscription200.Type, Config>, HttpClientError.HttpClientError | SchemaError>;
     /**
      * 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;
@@ -69260,6 +69222,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;
@@ -69281,6 +69246,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;
@@ -69323,6 +69291,8 @@ export interface OpenAiClient {
     } | undefined) => Effect.Effect<WithOptionalResponse<typeof GetChatCompletionMessages200.Type, Config>, HttpClientError.HttpClientError | SchemaError>;
     /**
      * 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;
@@ -69957,6 +69927,9 @@ export interface OpenAiClient {
     } | undefined) => Effect.Effect<WithOptionalResponse<typeof RetrieveProjectApiKey200.Type, Config>, HttpClientError.HttpClientError | SchemaError>;
     /**
      * 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, keyId: string, options: {
         readonly config?: Config | undefined;
@@ -70047,6 +70020,9 @@ export interface OpenAiClient {
     } | undefined) => Effect.Effect<WithOptionalResponse<typeof RetrieveProjectServiceAccount200.Type, Config>, HttpClientError.HttpClientError | SchemaError>;
     /**
      * 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, serviceAccountId: string, options: {
         readonly config?: Config | undefined;
@@ -70080,6 +70056,9 @@ export interface OpenAiClient {
     }) => Effect.Effect<WithOptionalResponse<typeof ModifyProjectUser200.Type, Config>, HttpClientError.HttpClientError | SchemaError | OpenAiClientError<"ModifyProjectUser400", typeof ModifyProjectUser400.Type>>;
     /**
      * 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, userId: string, options: {
         readonly config?: Config | undefined;
@@ -70319,6 +70298,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: {
         readonly payload: typeof CreateRealtimeClientSecretRequestJson.Encoded;
@@ -70332,6 +70323,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;
@@ -70345,6 +70338,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: {
         readonly payload: typeof CreateRealtimeTranscriptionSessionRequestJson.Encoded;
@@ -70546,6 +70541,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;
@@ -70553,6 +70550,8 @@ export interface OpenAiClient {
     }) => Effect.Effect<WithOptionalResponse<typeof CreateUpload200.Type, Config>, HttpClientError.HttpClientError | SchemaError>;
     /**
      * 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, options: {
         readonly config?: Config | undefined;
@@ -70565,6 +70564,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, options: {
         readonly payload: typeof CompleteUploadRequestJson.Encoded;
@@ -70740,6 +70740,8 @@ export interface OpenAiClient {
     } | undefined) => Effect.Effect<WithOptionalResponse<typeof DeleteVideo200.Type, Config>, HttpClientError.HttpClientError | SchemaError>;
     /**
      * 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, options: {
         readonly params?: typeof RetrieveVideoContentParams.Encoded | undefined;
@@ -70754,13 +70756,17 @@ export interface OpenAiClient {
     }) => Effect.Effect<WithOptionalResponse<typeof CreateVideoRemix200.Type, Config>, HttpClientError.HttpClientError | SchemaError>;
     /**
      * 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;
     }) => Effect.Effect<WithOptionalResponse<typeof Getinputtokencounts200.Type, Config>, 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;
@@ -70839,6 +70845,8 @@ export interface OpenAiClient {
     } | undefined) => Effect.Effect<WithOptionalResponse<typeof GetSkillVersionContent200.Type, Config>, HttpClientError.HttpClientError | SchemaError>;
     /**
      * 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, options: {
         readonly config?: Config | undefined;