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

package/dist/OpenAiSchema.js

@@ -0,0 +1,814 @@
+/**
+ * The `OpenAiSchema` module defines the request, response, streaming, and
+ * embedding schemas used by the handwritten OpenAI client. These schemas are
+ * the transport boundary for JSON sent to and decoded from the Responses and
+ * embeddings endpoints.
+ *
+ * **Mental model**
+ *
+ * - Request schemas such as {@link CreateResponse} and
+ *   {@link CreateEmbeddingRequest} describe the encoded payloads sent to OpenAI.
+ * - Response schemas such as {@link Response}, {@link ResponseStreamEvent}, and
+ *   {@link CreateEmbeddingResponse} describe provider data after schema
+ *   decoding.
+ * - Shared schemas such as {@link InputItem}, {@link Tool}, and
+ *   {@link TextResponseFormatConfiguration} cover the message, tool, and output
+ *   format fragments reused across request and response shapes.
+ *
+ * **Common tasks**
+ *
+ * - Use {@link CreateResponse} with {@link Response} for non-streaming
+ *   Responses API calls.
+ * - Use {@link ResponseStreamEvent} for server-sent events emitted by streaming
+ *   Responses API calls.
+ * - Use {@link CreateEmbeddingRequest} and {@link CreateEmbeddingResponse} for
+ *   embeddings endpoint payloads.
+ * - Use smaller schemas like {@link IncludeEnum}, {@link InputContent}, and
+ *   {@link ToolChoice} when validating request fragments.
+ *
+ * **Gotchas**
+ *
+ * - The module models the subset of OpenAI shapes supported by this client
+ *   path; it is not a complete mirror of every OpenAI REST API field.
+ * - Unknown future stream event types decode through
+ *   {@link UnknownResponseStreamEvent}, while malformed known event types still
+ *   fail schema decoding.
+ *
+ * @since 4.0.0
+ */
+import * as Effect from "effect/Effect";
+import * as Predicate from "effect/Predicate";
+import * as Schema from "effect/Schema";
+const UnknownRecord = /*#__PURE__*/Schema.Record(Schema.String, Schema.Unknown);
+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"]);
+/**
+ * Schema for optional `include` values supported by the local handwritten
+ * Responses client schema.
+ *
+ * **Details**
+ *
+ * These values request additional response fields such as image URLs, encrypted
+ * reasoning content, output logprobs, code interpreter outputs, or web search
+ * sources. This schema enumerates the include values supported by this client
+ * path.
+ *
+ * @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"]);
+/**
+ * Schema for lifecycle statuses shared by messages, reasoning items, and tool calls.
+ *
+ * **Details**
+ *
+ * Accepted values are `"in_progress"`, `"completed"`, and `"incomplete"`.
+ * This item-level status is used by message, reasoning, and tool-call shapes.
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const MessageStatus = /*#__PURE__*/Schema.Literals(["in_progress", "completed", "incomplete"]);
+const InputTextContent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("input_text"),
+  text: Schema.String
+});
+const InputImageContent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("input_image"),
+  image_url: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(Schema.String)),
+  file_id: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(Schema.String)),
+  detail: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(ImageDetail))
+});
+const InputFileContent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("input_file"),
+  file_id: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(Schema.String)),
+  filename: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  file_url: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  file_data: /*#__PURE__*/Schema.optionalKey(Schema.String)
+});
+/**
+ * Schema for content blocks accepted in OpenAI Responses input messages.
+ *
+ * **Details**
+ *
+ * Accepted block variants are `input_text`, `input_image`, and `input_file`.
+ *
+ * @see {@link InputItem} for request input item shapes that can contain these content blocks
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const InputContent = /*#__PURE__*/Schema.Union([InputTextContent, InputImageContent, InputFileContent]);
+/**
+ * Schema for a text block containing a model-provided reasoning summary.
+ *
+ * **Details**
+ *
+ * The decoded shape is `type: "summary_text"` plus `text` containing the
+ * reasoning summary text.
+ *
+ * @see {@link ReasoningItem} for reasoning output items that contain summary text blocks
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const SummaryTextContent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("summary_text"),
+  text: Schema.String
+});
+const ReasoningTextContent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("reasoning_text"),
+  text: Schema.String
+});
+const RefusalContent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("refusal"),
+  refusal: Schema.String
+});
+const TextContent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("text"),
+  text: Schema.String
+});
+const ComputerScreenshotContent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("computer_screenshot"),
+  image_url: /*#__PURE__*/Schema.NullOr(Schema.String),
+  file_id: /*#__PURE__*/Schema.NullOr(Schema.String)
+});
+const FileCitationAnnotation = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("file_citation"),
+  file_id: Schema.String,
+  index: Schema.Number,
+  filename: Schema.String
+});
+const UrlCitationAnnotation = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("url_citation"),
+  url: Schema.String,
+  start_index: Schema.Number,
+  end_index: Schema.Number,
+  title: Schema.String
+});
+const ContainerFileCitationAnnotation = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("container_file_citation"),
+  container_id: Schema.String,
+  file_id: Schema.String,
+  start_index: Schema.Number,
+  end_index: Schema.Number,
+  filename: Schema.String
+});
+const FilePathAnnotation = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("file_path"),
+  file_id: Schema.String,
+  index: Schema.Number
+});
+/**
+ * Schema for citation and file-path annotations attached to output text content.
+ *
+ * **Details**
+ *
+ * Accepts annotation objects discriminated by `type`: `file_citation`,
+ * `url_citation`, `container_file_citation`, or `file_path`.
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const Annotation = /*#__PURE__*/Schema.Union([FileCitationAnnotation, UrlCitationAnnotation, ContainerFileCitationAnnotation, FilePathAnnotation]);
+const OutputTextContent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("output_text"),
+  text: Schema.String,
+  annotations: /*#__PURE__*/Schema.Array(Annotation),
+  logprobs: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.Array(Schema.Unknown))
+});
+const OutputMessageContent = /*#__PURE__*/Schema.Union([InputTextContent, OutputTextContent, TextContent, SummaryTextContent, ReasoningTextContent, RefusalContent, InputImageContent, ComputerScreenshotContent, InputFileContent]);
+const OutputMessage = /*#__PURE__*/Schema.Struct({
+  id: Schema.String,
+  type: /*#__PURE__*/Schema.Literal("message"),
+  role: /*#__PURE__*/Schema.Literal("assistant"),
+  content: /*#__PURE__*/Schema.Array(OutputMessageContent),
+  status: MessageStatus
+});
+/**
+ * Schema for a reasoning output item containing encrypted content, summaries, and optional reasoning text.
+ *
+ * **When to use**
+ *
+ * Use when decoding or encoding OpenAI Responses reasoning items that may be
+ * carried into later request input.
+ *
+ * **Details**
+ *
+ * Reasoning items represent model reasoning content. `summary` is required,
+ * while `content` and `status` are optional.
+ *
+ * **Gotchas**
+ *
+ * `encrypted_content` is populated only when `reasoning.encrypted_content` is
+ * requested through `include`.
+ *
+ * @see {@link InputItem} for request input items that can carry reasoning items
+ * @see {@link IncludeEnum} for requesting encrypted reasoning content
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const ReasoningItem = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("reasoning"),
+  id: Schema.String,
+  encrypted_content: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(Schema.String)),
+  summary: /*#__PURE__*/Schema.Array(SummaryTextContent),
+  content: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.Array(ReasoningTextContent)),
+  status: /*#__PURE__*/Schema.optionalKey(MessageStatus)
+});
+const FunctionCall = /*#__PURE__*/Schema.Struct({
+  id: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  type: /*#__PURE__*/Schema.Literal("function_call"),
+  call_id: Schema.String,
+  name: Schema.String,
+  arguments: Schema.String,
+  status: /*#__PURE__*/Schema.optionalKey(MessageStatus)
+});
+const FunctionCallOutput = /*#__PURE__*/Schema.Struct({
+  id: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(Schema.String)),
+  type: /*#__PURE__*/Schema.Literal("function_call_output"),
+  call_id: Schema.String,
+  output: /*#__PURE__*/Schema.Union([Schema.String, /*#__PURE__*/Schema.Array(InputContent)]),
+  status: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(MessageStatus))
+});
+const ItemReference = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("item_reference"),
+  id: Schema.String
+});
+const LocalShellCall = /*#__PURE__*/Schema.Struct({
+  id: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  type: /*#__PURE__*/Schema.Literal("local_shell_call"),
+  call_id: Schema.String,
+  action: Schema.Unknown,
+  status: /*#__PURE__*/Schema.optionalKey(MessageStatus)
+});
+const LocalShellCallOutput = /*#__PURE__*/Schema.Struct({
+  id: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  type: /*#__PURE__*/Schema.Literal("local_shell_call_output"),
+  call_id: Schema.String,
+  output: Schema.Unknown,
+  status: /*#__PURE__*/Schema.optionalKey(MessageStatus)
+});
+const ShellCall = /*#__PURE__*/Schema.Struct({
+  id: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  type: /*#__PURE__*/Schema.Literal("shell_call"),
+  call_id: Schema.String,
+  action: Schema.Unknown,
+  status: /*#__PURE__*/Schema.optionalKey(MessageStatus)
+});
+const ShellCallOutput = /*#__PURE__*/Schema.Struct({
+  id: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  type: /*#__PURE__*/Schema.Literal("shell_call_output"),
+  call_id: Schema.String,
+  output: Schema.Unknown,
+  status: /*#__PURE__*/Schema.optionalKey(MessageStatus)
+});
+const ApplyPatchCallOutput = /*#__PURE__*/Schema.Struct({
+  id: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  type: /*#__PURE__*/Schema.Literal("apply_patch_call_output"),
+  call_id: Schema.String,
+  status: /*#__PURE__*/Schema.optionalKey(MessageStatus),
+  output: /*#__PURE__*/Schema.optionalKey(Schema.Unknown)
+});
+const McpApprovalResponse = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("mcp_approval_response"),
+  approval_request_id: Schema.String,
+  approve: Schema.Boolean
+});
+const RequestMessageItem = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.Literal("message")),
+  role: MessageRole,
+  status: /*#__PURE__*/Schema.optionalKey(MessageStatus),
+  content: /*#__PURE__*/Schema.Union([Schema.String, /*#__PURE__*/Schema.Array(InputContent)])
+});
+/**
+ * Schema for item shapes accepted by an OpenAI Responses request `input` field.
+ *
+ * **When to use**
+ *
+ * Use when validating structured `CreateResponse.input` array items.
+ *
+ * **Details**
+ *
+ * Accepted item families include request/output messages, function call and
+ * function call output, reasoning items, item references, shell and local shell
+ * calls and outputs, apply-patch output, and MCP approval responses.
+ *
+ * @see {@link CreateResponse} for the request schema that consumes input items
+ * @see {@link InputContent} for content blocks inside message items
+ *
+ * @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({
+  type: /*#__PURE__*/Schema.Literal("function"),
+  name: Schema.String,
+  description: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(Schema.String)),
+  parameters: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(JsonObject)),
+  strict: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(Schema.Boolean))
+});
+const CustomTool = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("custom"),
+  name: Schema.String,
+  description: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  format: /*#__PURE__*/Schema.optionalKey(Schema.Unknown)
+});
+const ProviderDefinedTool = /*#__PURE__*/Schema.StructWithRest(/*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literals(["apply_patch", "code_interpreter", "file_search", "image_generation", "local_shell", "mcp", "shell", "web_search", "web_search_preview"])
+}), [UnknownRecord]);
+/**
+ * Schema for tool definitions that can be supplied to an OpenAI Responses request.
+ *
+ * **Details**
+ *
+ * Accepted variants are function tools, custom tools, and provider-defined
+ * OpenAI tools. Provider-defined `type` literals include `apply_patch`,
+ * `code_interpreter`, `file_search`, `image_generation`, `local_shell`, `mcp`,
+ * `shell`, `web_search`, and `web_search_preview`.
+ *
+ * **Gotchas**
+ *
+ * Provider-defined tools use `Schema.StructWithRest`, so this schema checks the
+ * provider tool `type` and permits additional provider fields rather than fully
+ * validating every provider-specific tool payload.
+ *
+ * @see {@link ToolChoice} for selecting whether and which tools the model may call
+ * @see {@link CreateResponse} for the request schema that consumes tools
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const Tool = /*#__PURE__*/Schema.Union([FunctionTool, CustomTool, ProviderDefinedTool]);
+/**
+ * Schema for selecting whether and which tools the model may call in a Responses request.
+ *
+ * **Details**
+ *
+ * Accepted forms are `"none"`, `"auto"`, `"required"`, an allowed-tools set,
+ * a named function or custom tool, or a provider-defined tool choice.
+ *
+ * @see {@link Tool} for tool definitions referenced by tool choices
+ * @see {@link CreateResponse} for the request schema that consumes `tool_choice`
+ *
+ * @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"),
+  mode: /*#__PURE__*/Schema.Literals(["auto", "required"]),
+  tools: /*#__PURE__*/Schema.Array(JsonObject)
+}), /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("function"),
+  name: Schema.String
+}), /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("custom"),
+  name: Schema.String
+}), /*#__PURE__*/Schema.StructWithRest(/*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literals(["apply_patch", "code_interpreter", "file_search", "image_generation", "local_shell", "mcp", "shell", "web_search", "web_search_preview"])
+}), [UnknownRecord])]);
+/**
+ * Schema for text output format configuration, including plain text, JSON object, and JSON Schema responses.
+ *
+ * **Details**
+ *
+ * Accepted variants are `text`, `json_schema`, and `json_object`.
+ *
+ * **Gotchas**
+ *
+ * `json_object` is the older JSON mode. Prefer `json_schema` for models that
+ * support it.
+ *
+ * @see {@link CreateResponse} for the request schema that consumes text format configuration
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const TextResponseFormatConfiguration = /*#__PURE__*/Schema.Union([/*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("text")
+}), /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("json_schema"),
+  description: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  name: Schema.String,
+  schema: JsonObject,
+  strict: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(Schema.Boolean))
+}), /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("json_object")
+})]);
+/**
+ * Schema for request options used to create an OpenAI Responses API response.
+ *
+ * **When to use**
+ *
+ * Use to validate or encode payloads sent to the OpenAI Responses API.
+ *
+ * **Details**
+ *
+ * Validates the Responses API request payload, including input content, model
+ * selection, instructions, reasoning options, text output format, tools,
+ * `tool_choice`, streaming, storage, response continuation, sampling options,
+ * and optional response fields requested through `include`.
+ *
+ * **Gotchas**
+ *
+ * When `stream` is `true`, the API returns stream events instead of a single
+ * response object.
+ *
+ * @see {@link Response} for decoded non-streaming response objects
+ * @see {@link ResponseStreamEvent} for decoded streaming event objects
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const CreateResponse = /*#__PURE__*/Schema.Struct({
+  metadata: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Record(Schema.String, Schema.String)),
+  top_logprobs: /*#__PURE__*/Schema.optional(Schema.Number),
+  temperature: /*#__PURE__*/Schema.optional(Schema.Number),
+  top_p: /*#__PURE__*/Schema.optional(Schema.Number),
+  user: /*#__PURE__*/Schema.optional(Schema.String),
+  service_tier: /*#__PURE__*/Schema.optional(Schema.String),
+  previous_response_id: /*#__PURE__*/Schema.optional(Schema.String),
+  model: /*#__PURE__*/Schema.optional(Schema.String),
+  reasoning: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Struct({
+    effort: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Literals(["none", "minimal", "low", "medium", "high", "xhigh"])),
+    summary: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Literals(["auto", "concise", "detailed"])),
+    generate_summary: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Literals(["auto", "concise", "detailed"]))
+  })),
+  background: /*#__PURE__*/Schema.optional(Schema.Boolean),
+  max_output_tokens: /*#__PURE__*/Schema.optional(Schema.Number),
+  max_tool_calls: /*#__PURE__*/Schema.optional(Schema.Number),
+  text: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Struct({
+    format: /*#__PURE__*/Schema.optional(TextResponseFormatConfiguration),
+    verbosity: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Literals(["low", "medium", "high"]))
+  })),
+  tools: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Array(Tool)),
+  tool_choice: /*#__PURE__*/Schema.optional(ToolChoice),
+  truncation: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Literals(["auto", "disabled"])),
+  input: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Union([Schema.String, /*#__PURE__*/Schema.Array(InputItem)])),
+  include: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Array(IncludeEnum)),
+  store: /*#__PURE__*/Schema.optional(Schema.Boolean),
+  instructions: /*#__PURE__*/Schema.optional(Schema.String),
+  stream: /*#__PURE__*/Schema.optional(Schema.Boolean),
+  conversation: /*#__PURE__*/Schema.optional(Schema.String),
+  modalities: /*#__PURE__*/Schema.optional(/*#__PURE__*/Schema.Array(/*#__PURE__*/Schema.Literals(["text", "audio"]))),
+  seed: /*#__PURE__*/Schema.optional(Schema.Number)
+});
+/**
+ * Schema for token accounting reported on OpenAI Responses API response objects.
+ *
+ * **Details**
+ *
+ * The required counters are `input_tokens`, `output_tokens`, and
+ * `total_tokens`. Provider-specific token detail objects are preserved through
+ * `input_tokens_details`, `output_tokens_details`, and additional fields.
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const ResponseUsage = /*#__PURE__*/Schema.StructWithRest(/*#__PURE__*/Schema.Struct({
+  input_tokens: Schema.Number,
+  output_tokens: Schema.Number,
+  total_tokens: Schema.Number,
+  input_tokens_details: /*#__PURE__*/Schema.optionalKey(Schema.Unknown),
+  output_tokens_details: /*#__PURE__*/Schema.optionalKey(Schema.Unknown)
+}), [UnknownRecord]);
+const ApplyPatchOperation = /*#__PURE__*/Schema.Struct({
+  type: Schema.String,
+  path: Schema.String,
+  diff: /*#__PURE__*/Schema.optionalKey(Schema.String)
+});
+const ApplyPatchCall = /*#__PURE__*/Schema.Struct({
+  id: Schema.String,
+  type: /*#__PURE__*/Schema.Literal("apply_patch_call"),
+  call_id: Schema.String,
+  operation: ApplyPatchOperation,
+  status: /*#__PURE__*/Schema.optionalKey(MessageStatus)
+});
+const CodeInterpreterCall = /*#__PURE__*/Schema.Struct({
+  id: Schema.String,
+  type: /*#__PURE__*/Schema.Literal("code_interpreter_call"),
+  code: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  container_id: Schema.String,
+  outputs: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.Array(Schema.Unknown)),
+  status: /*#__PURE__*/Schema.optionalKey(MessageStatus)
+});
+const ComputerCall = /*#__PURE__*/Schema.Struct({
+  id: Schema.String,
+  type: /*#__PURE__*/Schema.Literal("computer_call"),
+  status: /*#__PURE__*/Schema.optionalKey(MessageStatus)
+});
+const FileSearchCall = /*#__PURE__*/Schema.Struct({
+  id: Schema.String,
+  type: /*#__PURE__*/Schema.Literal("file_search_call"),
+  status: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  queries: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.Array(Schema.String)),
+  results: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(Schema.Unknown))
+});
+const ImageGenerationCall = /*#__PURE__*/Schema.Struct({
+  id: Schema.String,
+  type: /*#__PURE__*/Schema.Literal("image_generation_call"),
+  result: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  status: /*#__PURE__*/Schema.optionalKey(MessageStatus)
+});
+const McpCall = /*#__PURE__*/Schema.Struct({
+  id: Schema.String,
+  type: /*#__PURE__*/Schema.Literal("mcp_call"),
+  approval_request_id: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(Schema.String)),
+  name: Schema.String,
+  arguments: Schema.Unknown,
+  output: /*#__PURE__*/Schema.optionalKey(Schema.Unknown),
+  error: /*#__PURE__*/Schema.optionalKey(Schema.Unknown),
+  server_label: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(Schema.String))
+});
+const McpListTools = /*#__PURE__*/Schema.Struct({
+  id: Schema.String,
+  type: /*#__PURE__*/Schema.Literal("mcp_list_tools")
+});
+const McpApprovalRequest = /*#__PURE__*/Schema.Struct({
+  id: Schema.String,
+  type: /*#__PURE__*/Schema.Literal("mcp_approval_request"),
+  approval_request_id: /*#__PURE__*/Schema.optionalKey(Schema.String),
+  name: Schema.String,
+  arguments: Schema.Unknown
+});
+const WebSearchCall = /*#__PURE__*/Schema.Struct({
+  id: Schema.String,
+  type: /*#__PURE__*/Schema.Literal("web_search_call"),
+  action: /*#__PURE__*/Schema.optionalKey(Schema.Unknown),
+  status: /*#__PURE__*/Schema.optionalKey(Schema.String)
+});
+const OutputItem = /*#__PURE__*/Schema.Union([ApplyPatchCall, CodeInterpreterCall, ComputerCall, FileSearchCall, FunctionCall, ImageGenerationCall, LocalShellCall, McpCall, McpListTools, McpApprovalRequest, OutputMessage, ReasoningItem, ShellCall, WebSearchCall]);
+/**
+ * Schema for an OpenAI Responses API response object.
+ *
+ * **When to use**
+ *
+ * Use to decode non-streaming OpenAI Responses API responses.
+ *
+ * **Details**
+ *
+ * Response objects include the response id, model, creation time, output items,
+ * optional token usage, optional incomplete details, and optional service tier.
+ *
+ * @see {@link CreateResponse} for the request schema that creates responses
+ * @see {@link ResponseUsage} for token accounting on responses
+ * @see {@link ResponseStreamEvent} for streaming response events
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const Response = /*#__PURE__*/Schema.Struct({
+  id: Schema.String,
+  object: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.Literal("response")),
+  model: Schema.String,
+  created_at: Schema.Number,
+  output: /*#__PURE__*/Schema.Array(OutputItem).pipe(/*#__PURE__*/Schema.withDecodingDefault(/*#__PURE__*/Effect.succeed([]))),
+  usage: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(ResponseUsage)),
+  incomplete_details: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.NullOr(/*#__PURE__*/Schema.Struct({
+    reason: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.Literals(["max_output_tokens", "content_filter"]))
+  }))),
+  service_tier: /*#__PURE__*/Schema.optionalKey(Schema.String)
+});
+const ResponseCreatedEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.created"),
+  response: Response,
+  sequence_number: Schema.Number
+});
+const ResponseCompletedEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.completed"),
+  response: Response,
+  sequence_number: Schema.Number
+});
+const ResponseIncompleteEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.incomplete"),
+  response: Response,
+  sequence_number: Schema.Number
+});
+const ResponseFailedEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.failed"),
+  response: Response,
+  sequence_number: Schema.Number
+});
+const ResponseOutputItemAddedEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.output_item.added"),
+  output_index: Schema.Number,
+  sequence_number: Schema.Number,
+  item: OutputItem
+});
+const ResponseOutputItemDoneEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.output_item.done"),
+  output_index: Schema.Number,
+  sequence_number: Schema.Number,
+  item: OutputItem
+});
+const ResponseOutputTextDeltaEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.output_text.delta"),
+  item_id: Schema.String,
+  output_index: Schema.Number,
+  content_index: Schema.Number,
+  delta: Schema.String,
+  sequence_number: Schema.Number,
+  logprobs: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.Array(Schema.Unknown))
+});
+const ResponseOutputTextAnnotationAddedEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.output_text.annotation.added"),
+  item_id: Schema.String,
+  output_index: Schema.Number,
+  content_index: Schema.Number,
+  annotation_index: Schema.Number,
+  sequence_number: Schema.Number,
+  annotation: Annotation
+});
+const ResponseReasoningSummaryPartAddedEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.reasoning_summary_part.added"),
+  item_id: Schema.String,
+  output_index: Schema.Number,
+  summary_index: Schema.Number,
+  sequence_number: Schema.Number,
+  part: SummaryTextContent
+});
+const ResponseReasoningSummaryPartDoneEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.reasoning_summary_part.done"),
+  item_id: Schema.String,
+  output_index: Schema.Number,
+  summary_index: Schema.Number,
+  sequence_number: Schema.Number,
+  part: SummaryTextContent
+});
+const ResponseReasoningSummaryTextDeltaEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.reasoning_summary_text.delta"),
+  item_id: Schema.String,
+  output_index: Schema.Number,
+  summary_index: Schema.Number,
+  delta: Schema.String,
+  sequence_number: Schema.Number
+});
+const ResponseFunctionCallArgumentsDeltaEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.function_call_arguments.delta"),
+  item_id: Schema.String,
+  output_index: Schema.Number,
+  sequence_number: Schema.Number,
+  delta: Schema.String
+});
+const ResponseFunctionCallArgumentsDoneEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.function_call_arguments.done"),
+  item_id: Schema.String,
+  output_index: Schema.Number,
+  sequence_number: Schema.Number,
+  arguments: Schema.String
+});
+const ResponseCodeInterpreterCallCodeDeltaEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.code_interpreter_call_code.delta"),
+  item_id: Schema.String,
+  output_index: Schema.Number,
+  sequence_number: Schema.Number,
+  delta: Schema.String
+});
+const ResponseCodeInterpreterCallCodeDoneEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.code_interpreter_call_code.done"),
+  item_id: Schema.String,
+  output_index: Schema.Number,
+  sequence_number: Schema.Number,
+  code: Schema.String
+});
+const ResponseApplyPatchCallOperationDiffDeltaEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.apply_patch_call_operation_diff.delta"),
+  item_id: Schema.String,
+  output_index: Schema.Number,
+  sequence_number: Schema.Number,
+  delta: Schema.String
+});
+const ResponseApplyPatchCallOperationDiffDoneEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.apply_patch_call_operation_diff.done"),
+  item_id: Schema.String,
+  output_index: Schema.Number,
+  sequence_number: Schema.Number,
+  delta: /*#__PURE__*/Schema.optionalKey(Schema.String)
+});
+const ResponseImageGenerationCallPartialImageEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("response.image_generation_call.partial_image"),
+  item_id: Schema.String,
+  output_index: Schema.Number,
+  sequence_number: Schema.Number,
+  partial_image_b64: Schema.String
+});
+const ResponseErrorEvent = /*#__PURE__*/Schema.Struct({
+  type: /*#__PURE__*/Schema.Literal("error"),
+  code: /*#__PURE__*/Schema.NullOr(Schema.String),
+  message: Schema.String,
+  param: /*#__PURE__*/Schema.NullOr(Schema.String),
+  sequence_number: Schema.Number,
+  status: /*#__PURE__*/Schema.optionalKey(Schema.Number)
+});
+const knownResponseStreamEventTypes = /*#__PURE__*/new Set(["response.created", "response.completed", "response.incomplete", "response.failed", "response.output_item.added", "response.output_item.done", "response.output_text.delta", "response.output_text.annotation.added", "response.reasoning_summary_part.added", "response.reasoning_summary_part.done", "response.reasoning_summary_text.delta", "response.function_call_arguments.delta", "response.function_call_arguments.done", "response.code_interpreter_call_code.delta", "response.code_interpreter_call_code.done", "response.apply_patch_call_operation_diff.delta", "response.apply_patch_call_operation_diff.done", "response.image_generation_call.partial_image", "error"]);
+const UnknownResponseStreamEvent = /*#__PURE__*/Schema.declare(value => Predicate.hasProperty(value, "type") && typeof value.type === "string" && !knownResponseStreamEventTypes.has(value.type), {
+  identifier: "UnknownResponseStreamEvent",
+  description: "Fallback for unknown future stream events"
+});
+/**
+ * Schema for server-sent event shapes emitted by OpenAI Responses API streams.
+ *
+ * **When to use**
+ *
+ * Use to decode events from a streaming OpenAI Responses API request.
+ *
+ * **Details**
+ *
+ * Known event variants include response lifecycle events, output item events,
+ * text and reasoning deltas, tool-call deltas, partial image events, and error
+ * events.
+ *
+ * **Gotchas**
+ *
+ * Future event types decode through the fallback only when their `type` is not
+ * one of the known event types. Malformed known events still fail to decode.
+ *
+ * @see {@link Response} for complete response objects carried by lifecycle events
+ * @see {@link UnknownResponseStreamEvent} for the fallback shape for future event types
+ *
+ * @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]);
+/**
+ * Schema for one embedding item returned by the OpenAI embeddings API.
+ *
+ * **Details**
+ *
+ * An embedding item contains its `index`, optional `object` marker, and an
+ * `embedding` represented either as a numeric vector or as a string.
+ *
+ * **Gotchas**
+ *
+ * Callers that need numeric vectors must account for string embeddings, such as
+ * base64-encoded embeddings returned for string encoding formats.
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const Embedding = /*#__PURE__*/Schema.Struct({
+  embedding: /*#__PURE__*/Schema.Union([/*#__PURE__*/Schema.Array(Schema.Number), Schema.String]),
+  index: Schema.Number,
+  object: /*#__PURE__*/Schema.optionalKey(Schema.String)
+});
+/**
+ * Schema for the request payload sent to the OpenAI embeddings endpoint.
+ *
+ * **Details**
+ *
+ * Requires `input` and `model`. `input` may be a string, an array of strings,
+ * a token array, or an array of token arrays. Optional fields configure the
+ * embedding encoding format, requested dimensions, and user identifier.
+ *
+ * **Gotchas**
+ *
+ * This schema validates the transport shape, but OpenAI still enforces
+ * provider-side constraints such as non-empty input, integer token ids, input
+ * size limits, positive dimensions, and model-specific dimension support.
+ *
+ * @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))]),
+  model: Schema.String,
+  encoding_format: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.Literals(["float", "base64"])),
+  dimensions: /*#__PURE__*/Schema.optionalKey(Schema.Number),
+  user: /*#__PURE__*/Schema.optionalKey(Schema.String)
+});
+/**
+ * Schema for a successful response payload returned by the OpenAI embeddings endpoint.
+ *
+ * **When to use**
+ *
+ * Use to decode successful OpenAI embeddings responses.
+ *
+ * **Details**
+ *
+ * The response contains an array of `Embedding` items, the model name, an
+ * optional `object: "list"` marker, and optional token usage counts for prompt
+ * and total tokens.
+ *
+ * **Gotchas**
+ *
+ * Each `Embedding` may contain either a numeric vector or a string embedding.
+ * Callers that require numeric vectors must account for string embeddings.
+ *
+ * @see {@link CreateEmbeddingRequest} for the request schema sent to the embeddings endpoint
+ * @see {@link Embedding} for individual embedding items in the response
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const CreateEmbeddingResponse = /*#__PURE__*/Schema.Struct({
+  data: /*#__PURE__*/Schema.Array(Embedding),
+  model: Schema.String,
+  object: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.Literal("list")),
+  usage: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.Struct({
+    prompt_tokens: Schema.Number,
+    total_tokens: Schema.Number
+  }))
+});
+//# sourceMappingURL=OpenAiSchema.js.map