@effect/ai-openai 4.0.0-beta.66 → 4.0.0-beta.68

package/dist/OpenAiSchema.d.ts

@@ -1,22 +1,40 @@
 import * as Schema from "effect/Schema";
 /**
- * @since 1.0.0
+ * Schema for optional `include` values on OpenAI Responses requests.
+ *
+ * **Details**
+ * These values request additional response fields such as image URLs, encrypted reasoning content, output logprobs, code interpreter outputs, or web search sources.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const IncludeEnum: Schema.Literals<readonly ["message.input_image.image_url", "reasoning.encrypted_content", "message.output_text.logprobs", "code_interpreter_call.outputs", "web_search_call.action.sources"]>;
 /**
- * @since 1.0.0
+ * Type of optional `include` values accepted by OpenAI Responses requests.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type IncludeEnum = typeof IncludeEnum.Type;
 /**
- * @since 1.0.0
+ * Schema for lifecycle statuses shared by messages, reasoning items, and tool calls.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const MessageStatus: Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>;
 /**
- * @since 1.0.0
+ * Lifecycle status shared by messages, reasoning items, and tool calls.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type MessageStatus = typeof MessageStatus.Type;
 /**
- * @since 1.0.0
+ * Schema for content blocks accepted in OpenAI Responses input messages.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const InputContent: Schema.Union<readonly [Schema.Struct<{
     readonly type: Schema.Literal<"input_text">;
@@ -34,22 +52,34 @@ export declare const InputContent: Schema.Union<readonly [Schema.Struct<{
     readonly file_data: Schema.optionalKey<Schema.String>;
 }>]>;
 /**
- * @since 1.0.0
+ * Content block accepted in OpenAI Responses input messages.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type InputContent = typeof InputContent.Type;
 /**
- * @since 1.0.0
+ * Schema for a text block containing a model-provided reasoning summary.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const SummaryTextContent: Schema.Struct<{
     readonly type: Schema.Literal<"summary_text">;
     readonly text: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Text content block used for model-provided reasoning summaries.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type SummaryTextContent = typeof SummaryTextContent.Type;
 /**
- * @since 1.0.0
+ * Schema for citation and file-path annotations attached to output text content.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const Annotation: Schema.Union<readonly [Schema.Struct<{
     readonly type: Schema.Literal<"file_citation">;
@@ -75,11 +105,17 @@ export declare const Annotation: Schema.Union<readonly [Schema.Struct<{
     readonly index: Schema.Number;
 }>]>;
 /**
- * @since 1.0.0
+ * Citation or file-path annotation attached to output text content.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type Annotation = typeof Annotation.Type;
 /**
- * @since 1.0.0
+ * Schema for a reasoning output item containing encrypted content, summaries, and optional reasoning text.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const ReasoningItem: Schema.Struct<{
     readonly type: Schema.Literal<"reasoning">;
@@ -96,11 +132,17 @@ export declare const ReasoningItem: Schema.Struct<{
     readonly status: Schema.optionalKey<Schema.Literals<readonly ["in_progress", "completed", "incomplete"]>>;
 }>;
 /**
- * @since 1.0.0
+ * Reasoning output item containing encrypted content, summaries, and optional reasoning text.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type ReasoningItem = typeof ReasoningItem.Type;
 /**
- * @since 1.0.0
+ * Schema for item shapes accepted by an OpenAI Responses request `input` field.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const InputItem: Schema.Union<readonly [Schema.Struct<{
     readonly type: Schema.optionalKey<Schema.Literal<"message">>;
@@ -263,11 +305,17 @@ export declare const InputItem: Schema.Union<readonly [Schema.Struct<{
     readonly approve: Schema.Boolean;
 }>]>;
 /**
- * @since 1.0.0
+ * Item shape accepted by an OpenAI Responses request `input` field.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type InputItem = typeof InputItem.Type;
 /**
- * @since 1.0.0
+ * Schema for tool definitions that can be supplied to an OpenAI Responses request.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const Tool: Schema.Union<readonly [Schema.Struct<{
     readonly type: Schema.Literal<"function">;
@@ -284,11 +332,17 @@ export declare const Tool: Schema.Union<readonly [Schema.Struct<{
     readonly type: Schema.Literals<readonly ["apply_patch", "code_interpreter", "file_search", "image_generation", "local_shell", "mcp", "shell", "web_search", "web_search_preview"]>;
 }>, readonly [Schema.$Record<Schema.String, Schema.Unknown>]>]>;
 /**
- * @since 1.0.0
+ * Tool definition that can be supplied to an OpenAI Responses request.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type Tool = typeof Tool.Type;
 /**
- * @since 1.0.0
+ * Schema for selecting whether and which tools the model may call in a Responses request.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const ToolChoice: Schema.Union<readonly [Schema.Literals<readonly ["none", "auto", "required"]>, Schema.Struct<{
     readonly type: Schema.Literal<"allowed_tools">;
@@ -304,11 +358,17 @@ export declare const ToolChoice: Schema.Union<readonly [Schema.Literals<readonly
     readonly type: Schema.Literals<readonly ["apply_patch", "code_interpreter", "file_search", "image_generation", "local_shell", "mcp", "shell", "web_search", "web_search_preview"]>;
 }>, readonly [Schema.$Record<Schema.String, Schema.Unknown>]>]>;
 /**
- * @since 1.0.0
+ * Tool selection mode or named tool choice for a Responses request.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type ToolChoice = typeof ToolChoice.Type;
 /**
- * @since 1.0.0
+ * Schema for text output format configuration, including plain text, JSON object, and JSON Schema responses.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const TextResponseFormatConfiguration: Schema.Union<readonly [Schema.Struct<{
     readonly type: Schema.Literal<"text">;
@@ -322,11 +382,17 @@ export declare const TextResponseFormatConfiguration: Schema.Union<readonly [Sch
     readonly type: Schema.Literal<"json_object">;
 }>]>;
 /**
- * @since 1.0.0
+ * Text output format configuration for plain text, JSON object, or JSON Schema responses.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type TextResponseFormatConfiguration = typeof TextResponseFormatConfiguration.Type;
 /**
- * @since 1.0.0
+ * Schema for request options used to create an OpenAI Responses API response.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const CreateResponse: Schema.Struct<{
     readonly metadata: Schema.optional<Schema.$Record<Schema.String, Schema.String>>;
@@ -556,11 +622,17 @@ export declare const CreateResponse: Schema.Struct<{
     readonly seed: Schema.optional<Schema.Number>;
 }>;
 /**
- * @since 1.0.0
+ * Request options used to create an OpenAI Responses API response.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type CreateResponse = typeof CreateResponse.Type;
 /**
- * @since 1.0.0
+ * Schema for token accounting reported on OpenAI Responses API response objects.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const ResponseUsage: Schema.StructWithRest<Schema.Struct<{
     readonly input_tokens: Schema.Number;
@@ -570,11 +642,17 @@ export declare const ResponseUsage: Schema.StructWithRest<Schema.Struct<{
     readonly output_tokens_details: Schema.optionalKey<Schema.Unknown>;
 }>, readonly [Schema.$Record<Schema.String, Schema.Unknown>]>;
 /**
- * @since 1.0.0
+ * Token accounting reported on OpenAI Responses API response objects.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type ResponseUsage = typeof ResponseUsage.Type;
 /**
- * @since 1.0.0
+ * Schema for an OpenAI Responses API response object.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const Response: Schema.Struct<{
     readonly id: Schema.String;
@@ -745,18 +823,27 @@ export declare const Response: Schema.Struct<{
     readonly service_tier: Schema.optionalKey<Schema.String>;
 }>;
 /**
- * @since 1.0.0
+ * OpenAI Responses API response object.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type Response = typeof Response.Type;
 /**
- * @since 1.0.0
+ * Fallback event shape for future or provider-specific response stream events.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type UnknownResponseStreamEvent = {
     readonly type: string;
     readonly [key: string]: unknown;
 };
 /**
- * @since 1.0.0
+ * Schema for server-sent event shapes emitted by OpenAI Responses API streams.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const ResponseStreamEvent: Schema.Union<readonly [Schema.Struct<{
     readonly type: Schema.Literal<"response.created">;
@@ -1868,11 +1955,17 @@ export declare const ResponseStreamEvent: Schema.Union<readonly [Schema.Struct<{
     readonly status: Schema.optionalKey<Schema.Number>;
 }>, Schema.declare<UnknownResponseStreamEvent, UnknownResponseStreamEvent>]>;
 /**
- * @since 1.0.0
+ * Server-sent event shape emitted by OpenAI Responses API streams.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type ResponseStreamEvent = typeof ResponseStreamEvent.Type;
 /**
- * @since 1.0.0
+ * Schema for one embedding item returned by the OpenAI embeddings API.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const Embedding: Schema.Struct<{
     readonly embedding: Schema.Union<readonly [Schema.$Array<Schema.Number>, Schema.String]>;
@@ -1880,11 +1973,17 @@ export declare const Embedding: Schema.Struct<{
     readonly object: Schema.optionalKey<Schema.String>;
 }>;
 /**
- * @since 1.0.0
+ * One embedding item returned by the OpenAI embeddings API.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type Embedding = typeof Embedding.Type;
 /**
- * @since 1.0.0
+ * Schema for the request payload sent to the OpenAI embeddings endpoint.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const CreateEmbeddingRequest: Schema.Struct<{
     readonly input: Schema.Union<readonly [Schema.String, Schema.$Array<Schema.String>, Schema.$Array<Schema.Number>, Schema.$Array<Schema.$Array<Schema.Number>>]>;
@@ -1894,11 +1993,17 @@ export declare const CreateEmbeddingRequest: Schema.Struct<{
     readonly user: Schema.optionalKey<Schema.String>;
 }>;
 /**
- * @since 1.0.0
+ * Request payload sent to the OpenAI embeddings endpoint.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type CreateEmbeddingRequest = typeof CreateEmbeddingRequest.Type;
 /**
- * @since 1.0.0
+ * Schema for a successful response payload returned by the OpenAI embeddings endpoint.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export declare const CreateEmbeddingResponse: Schema.Struct<{
     readonly data: Schema.$Array<Schema.Struct<{
@@ -1914,7 +2019,10 @@ export declare const CreateEmbeddingResponse: Schema.Struct<{
     }>>;
 }>;
 /**
- * @since 1.0.0
+ * Successful response payload returned by the OpenAI embeddings endpoint.
+ *
+ * @category models
+ * @since 4.0.0
  */
 export type CreateEmbeddingResponse = typeof CreateEmbeddingResponse.Type;
 //# sourceMappingURL=OpenAiSchema.d.ts.map

package/dist/OpenAiSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OpenAiSchema.d.ts","sourceRoot":"","sources":["../src/OpenAiSchema.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAUvC;;GAEG;AACH,eAAO,MAAM,WAAW,+LAMtB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,WAAW,CAAC,IAAI,CAAA;AAEjD;;GAEG;AACH,eAAO,MAAM,aAAa,sEAA8D,CAAA;AAExF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,IAAI,CAAA;AAsBrD;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;IAIvB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC,IAAI,CAAA;AAEnD;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;EAG7B,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,kBAAkB,CAAC,IAAI,CAAA;AAqD/D;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;IAKrB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;AA6B/C;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;EAOxB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,IAAI,CAAA;AAmFrD;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAapB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC,IAAI,CAAA;AAkC7C;;GAEG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;+DAIf,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,IAAI,CAAA;AAEnC;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;+DA+BrB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;IAU1C,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG,OAAO,+BAA+B,CAAC,IAAI,CAAA;AAEzF;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwCzB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC,IAAI,CAAA;AAEvD;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;6DASzB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,IAAI,CAAA;AA8FrD;;GAEG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAenB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC,IAAI,CAAA;AA8K3C;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAChC,CAAA;AAaD;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EAqB9B,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAC,IAAI,CAAA;AAEjE;;GAEG;AACH,eAAO,MAAM,SAAS;;;;EAOpB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC,IAAI,CAAA;AAE7C;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;EAWjC,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,sBAAsB,CAAC,IAAI,CAAA;AAEvE;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;EAUlC,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAC,IAAI,CAAA"}
+{"version":3,"file":"OpenAiSchema.d.ts","sourceRoot":"","sources":["../src/OpenAiSchema.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAUvC;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,+LAMtB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,WAAW,CAAC,IAAI,CAAA;AAEjD;;;;;GAKG;AACH,eAAO,MAAM,aAAa,sEAA8D,CAAA;AAExF;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,IAAI,CAAA;AAsBrD;;;;;GAKG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;IAIvB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC,IAAI,CAAA;AAEnD;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB;;;EAG7B,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,kBAAkB,CAAC,IAAI,CAAA;AAqD/D;;;;;GAKG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;IAKrB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;AA6B/C;;;;;GAKG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;EAOxB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,IAAI,CAAA;AAmFrD;;;;;GAKG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAapB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC,IAAI,CAAA;AAkC7C;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;+DAIf,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,IAAI,CAAA;AAEnC;;;;;GAKG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;+DA+BrB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAA;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;IAU1C,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,+BAA+B,GAAG,OAAO,+BAA+B,CAAC,IAAI,CAAA;AAEzF;;;;;GAKG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwCzB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC,IAAI,CAAA;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,aAAa;;;;;;6DASzB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,IAAI,CAAA;AA8FrD;;;;;GAKG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAenB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC,IAAI,CAAA;AA8K3C;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAChC,CAAA;AAaD;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EAqB9B,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAC,IAAI,CAAA;AAEjE;;;;;GAKG;AACH,eAAO,MAAM,SAAS;;;;EAOpB,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC,IAAI,CAAA;AAE7C;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB;;;;;;EAWjC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,sBAAsB,CAAC,IAAI,CAAA;AAEvE;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;EAUlC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAC,IAAI,CAAA"}

package/dist/OpenAiSchema.js

@@ -1,7 +1,7 @@
 /**
  * Minimal local OpenAI schemas used by the handwritten Responses client path.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 import * as Predicate from "effect/Predicate";
 import * as Schema from "effect/Schema";
@@ -10,11 +10,20 @@ const JsonObject = /*#__PURE__*/Schema.Record(Schema.String, Schema.Unknown);
 const MessageRole = /*#__PURE__*/Schema.Literals(["system", "developer", "user", "assistant"]);
 const ImageDetail = /*#__PURE__*/Schema.Literals(["low", "high", "auto"]);
 /**
- * @since 1.0.0
+ * Schema for optional `include` values on OpenAI Responses requests.
+ *
+ * **Details**
+ * These values request additional response fields such as image URLs, encrypted reasoning content, output logprobs, code interpreter outputs, or web search sources.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const IncludeEnum = /*#__PURE__*/Schema.Literals(["message.input_image.image_url", "reasoning.encrypted_content", "message.output_text.logprobs", "code_interpreter_call.outputs", "web_search_call.action.sources"]);
 /**
- * @since 1.0.0
+ * Schema for lifecycle statuses shared by messages, reasoning items, and tool calls.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const MessageStatus = /*#__PURE__*/Schema.Literals(["in_progress", "completed", "incomplete"]);
 const InputTextContent = /*#__PURE__*/Schema.Struct({
@@ -35,11 +44,17 @@ const InputFileContent = /*#__PURE__*/Schema.Struct({
   file_data: /*#__PURE__*/Schema.optionalKey(Schema.String)
 });
 /**
- * @since 1.0.0
+ * Schema for content blocks accepted in OpenAI Responses input messages.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const InputContent = /*#__PURE__*/Schema.Union([InputTextContent, InputImageContent, InputFileContent]);
 /**
- * @since 1.0.0
+ * Schema for a text block containing a model-provided reasoning summary.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const SummaryTextContent = /*#__PURE__*/Schema.Struct({
   type: /*#__PURE__*/Schema.Literal("summary_text"),
@@ -89,7 +104,10 @@ const FilePathAnnotation = /*#__PURE__*/Schema.Struct({
   index: Schema.Number
 });
 /**
- * @since 1.0.0
+ * Schema for citation and file-path annotations attached to output text content.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const Annotation = /*#__PURE__*/Schema.Union([FileCitationAnnotation, UrlCitationAnnotation, ContainerFileCitationAnnotation, FilePathAnnotation]);
 const OutputTextContent = /*#__PURE__*/Schema.Struct({
@@ -107,7 +125,10 @@ const OutputMessage = /*#__PURE__*/Schema.Struct({
   status: MessageStatus
 });
 /**
- * @since 1.0.0
+ * Schema for a reasoning output item containing encrypted content, summaries, and optional reasoning text.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const ReasoningItem = /*#__PURE__*/Schema.Struct({
   type: /*#__PURE__*/Schema.Literal("reasoning"),
@@ -183,7 +204,10 @@ const RequestMessageItem = /*#__PURE__*/Schema.Struct({
   content: /*#__PURE__*/Schema.Union([Schema.String, /*#__PURE__*/Schema.Array(InputContent)])
 });
 /**
- * @since 1.0.0
+ * Schema for item shapes accepted by an OpenAI Responses request `input` field.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const InputItem = /*#__PURE__*/Schema.Union([RequestMessageItem, OutputMessage, FunctionCall, FunctionCallOutput, ReasoningItem, ItemReference, LocalShellCall, LocalShellCallOutput, ShellCall, ShellCallOutput, ApplyPatchCallOutput, McpApprovalResponse]);
 const FunctionTool = /*#__PURE__*/Schema.Struct({
@@ -203,11 +227,17 @@ const ProviderDefinedTool = /*#__PURE__*/Schema.StructWithRest(/*#__PURE__*/Sche
   type: /*#__PURE__*/Schema.Literals(["apply_patch", "code_interpreter", "file_search", "image_generation", "local_shell", "mcp", "shell", "web_search", "web_search_preview"])
 }), [UnknownRecord]);
 /**
- * @since 1.0.0
+ * Schema for tool definitions that can be supplied to an OpenAI Responses request.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const Tool = /*#__PURE__*/Schema.Union([FunctionTool, CustomTool, ProviderDefinedTool]);
 /**
- * @since 1.0.0
+ * Schema for selecting whether and which tools the model may call in a Responses request.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const ToolChoice = /*#__PURE__*/Schema.Union([/*#__PURE__*/Schema.Literals(["none", "auto", "required"]), /*#__PURE__*/Schema.Struct({
   type: /*#__PURE__*/Schema.Literal("allowed_tools"),
@@ -223,7 +253,10 @@ export const ToolChoice = /*#__PURE__*/Schema.Union([/*#__PURE__*/Schema.Literal
   type: /*#__PURE__*/Schema.Literals(["apply_patch", "code_interpreter", "file_search", "image_generation", "local_shell", "mcp", "shell", "web_search", "web_search_preview"])
 }), [UnknownRecord])]);
 /**
- * @since 1.0.0
+ * Schema for text output format configuration, including plain text, JSON object, and JSON Schema responses.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const TextResponseFormatConfiguration = /*#__PURE__*/Schema.Union([/*#__PURE__*/Schema.Struct({
   type: /*#__PURE__*/Schema.Literal("text")
@@ -237,7 +270,10 @@ export const TextResponseFormatConfiguration = /*#__PURE__*/Schema.Union([/*#__P
   type: /*#__PURE__*/Schema.Literal("json_object")
 })]);
 /**
- * @since 1.0.0
+ * Schema for request options used to create an OpenAI Responses API response.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const CreateResponse = /*#__PURE__*/Schema.Struct({
   metadata: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Record(Schema.String, Schema.String)),
@@ -273,7 +309,10 @@ export const CreateResponse = /*#__PURE__*/Schema.Struct({
   seed: /*#__PURE__*/Schema.optional(Schema.Number)
 });
 /**
- * @since 1.0.0
+ * Schema for token accounting reported on OpenAI Responses API response objects.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const ResponseUsage = /*#__PURE__*/Schema.StructWithRest(/*#__PURE__*/Schema.Struct({
   input_tokens: Schema.Number,
@@ -349,7 +388,10 @@ const WebSearchCall = /*#__PURE__*/Schema.Struct({
 });
 const OutputItem = /*#__PURE__*/Schema.Union([ApplyPatchCall, CodeInterpreterCall, ComputerCall, FileSearchCall, FunctionCall, ImageGenerationCall, LocalShellCall, McpCall, McpListTools, McpApprovalRequest, OutputMessage, ReasoningItem, ShellCall, WebSearchCall]);
 /**
- * @since 1.0.0
+ * Schema for an OpenAI Responses API response object.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const Response = /*#__PURE__*/Schema.Struct({
   id: Schema.String,
@@ -500,11 +542,17 @@ const UnknownResponseStreamEvent = /*#__PURE__*/Schema.declare(value => Predicat
   description: "Fallback for unknown future stream events"
 });
 /**
- * @since 1.0.0
+ * Schema for server-sent event shapes emitted by OpenAI Responses API streams.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const ResponseStreamEvent = /*#__PURE__*/Schema.Union([ResponseCreatedEvent, ResponseCompletedEvent, ResponseIncompleteEvent, ResponseFailedEvent, ResponseOutputItemAddedEvent, ResponseOutputItemDoneEvent, ResponseOutputTextDeltaEvent, ResponseOutputTextAnnotationAddedEvent, ResponseReasoningSummaryPartAddedEvent, ResponseReasoningSummaryPartDoneEvent, ResponseReasoningSummaryTextDeltaEvent, ResponseFunctionCallArgumentsDeltaEvent, ResponseFunctionCallArgumentsDoneEvent, ResponseCodeInterpreterCallCodeDeltaEvent, ResponseCodeInterpreterCallCodeDoneEvent, ResponseApplyPatchCallOperationDiffDeltaEvent, ResponseApplyPatchCallOperationDiffDoneEvent, ResponseImageGenerationCallPartialImageEvent, ResponseErrorEvent, UnknownResponseStreamEvent]);
 /**
- * @since 1.0.0
+ * Schema for one embedding item returned by the OpenAI embeddings API.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const Embedding = /*#__PURE__*/Schema.Struct({
   embedding: /*#__PURE__*/Schema.Union([/*#__PURE__*/Schema.Array(Schema.Number), Schema.String]),
@@ -512,7 +560,10 @@ export const Embedding = /*#__PURE__*/Schema.Struct({
   object: /*#__PURE__*/Schema.optionalKey(Schema.String)
 });
 /**
- * @since 1.0.0
+ * Schema for the request payload sent to the OpenAI embeddings endpoint.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const CreateEmbeddingRequest = /*#__PURE__*/Schema.Struct({
   input: /*#__PURE__*/Schema.Union([Schema.String, /*#__PURE__*/Schema.Array(Schema.String), /*#__PURE__*/Schema.Array(Schema.Number), /*#__PURE__*/Schema.Array(/*#__PURE__*/Schema.Array(Schema.Number))]),
@@ -522,7 +573,10 @@ export const CreateEmbeddingRequest = /*#__PURE__*/Schema.Struct({
   user: /*#__PURE__*/Schema.optionalKey(Schema.String)
 });
 /**
- * @since 1.0.0
+ * Schema for a successful response payload returned by the OpenAI embeddings endpoint.
+ *
+ * @category schemas
+ * @since 4.0.0
  */
 export const CreateEmbeddingResponse = /*#__PURE__*/Schema.Struct({
   data: /*#__PURE__*/Schema.Array(Embedding),