@orq-ai/node 4.11.0-rc.4 → 4.11.0-rc.6

package/src/models/components/publicresponseresource.ts

@@ -0,0 +1,196 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ConversationParam,
+  ConversationParam$inboundSchema,
+} from "./conversationparam.js";
+import {
+  IncompleteDetails,
+  IncompleteDetails$inboundSchema,
+} from "./incompletedetails.js";
+import { MemoryParam, MemoryParam$inboundSchema } from "./memoryparam.js";
+import { PublicUsage, PublicUsage$inboundSchema } from "./publicusage.js";
+import { Reasoning, Reasoning$inboundSchema } from "./reasoning.js";
+import { ResponseError, ResponseError$inboundSchema } from "./responseerror.js";
+
+export const ServiceTier = {
+  Auto: "auto",
+  Default: "default",
+  Flex: "flex",
+  Priority: "priority",
+} as const;
+export type ServiceTier = ClosedEnum<typeof ServiceTier>;
+
+export const PublicResponseResourceStatus = {
+  Queued: "queued",
+  InProgress: "in_progress",
+  Completed: "completed",
+  Failed: "failed",
+  Incomplete: "incomplete",
+  RequiresAction: "requires_action",
+} as const;
+export type PublicResponseResourceStatus = ClosedEnum<
+  typeof PublicResponseResourceStatus
+>;
+
+export const Truncation = {
+  Disabled: "disabled",
+  Auto: "auto",
+} as const;
+export type Truncation = ClosedEnum<typeof Truncation>;
+
+export type PublicResponseResource = {
+  background: boolean;
+  completedAt: number | null;
+  conversation?: ConversationParam | undefined;
+  createdAt: number;
+  error: ResponseError;
+  frequencyPenalty: number;
+  id: string;
+  incompleteDetails: IncompleteDetails;
+  /**
+   * Array of input items (messages, function call outputs, etc.)
+   */
+  input: Array<any> | null;
+  instructions: string | null;
+  maxOutputTokens: number | null;
+  maxToolCalls: number | null;
+  memory?: MemoryParam | undefined;
+  /**
+   * Developer-defined key-value pairs attached to the response (OpenAI spec: Map<string, string>).
+   */
+  metadata: { [k: string]: string };
+  model: string;
+  /**
+   * Always "response"
+   */
+  object: string;
+  /**
+   * Array of output items (messages, function calls, reasoning, etc.)
+   */
+  output: Array<any> | null;
+  parallelToolCalls: boolean;
+  presencePenalty: number;
+  previousResponseId: string | null;
+  promptCacheKey: string | null;
+  promptCacheRetention: string | null;
+  reasoning: Reasoning;
+  safetyIdentifier: string | null;
+  serviceTier: ServiceTier;
+  status: PublicResponseResourceStatus;
+  store: boolean;
+  temperature: number;
+  /**
+   * Text output configuration including format and verbosity
+   */
+  text?: any | undefined;
+  /**
+   * Tool choice setting: "auto", "none", "required", or a specific function
+   */
+  toolChoice?: any | undefined;
+  /**
+   * Array of tool configurations used in this response
+   */
+  tools: Array<any> | null;
+  topLogprobs: number;
+  topP: number;
+  truncation: Truncation;
+  usage: PublicUsage;
+  user: string | null;
+  variables?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ServiceTier$inboundSchema: z.ZodNativeEnum<typeof ServiceTier> = z
+  .nativeEnum(ServiceTier);
+
+/** @internal */
+export const PublicResponseResourceStatus$inboundSchema: z.ZodNativeEnum<
+  typeof PublicResponseResourceStatus
+> = z.nativeEnum(PublicResponseResourceStatus);
+
+/** @internal */
+export const Truncation$inboundSchema: z.ZodNativeEnum<typeof Truncation> = z
+  .nativeEnum(Truncation);
+
+/** @internal */
+export const PublicResponseResource$inboundSchema: z.ZodType<
+  PublicResponseResource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  background: z.boolean(),
+  completed_at: z.nullable(z.number().int()),
+  conversation: ConversationParam$inboundSchema.optional(),
+  created_at: z.number().int(),
+  error: ResponseError$inboundSchema,
+  frequency_penalty: z.number(),
+  id: z.string(),
+  incomplete_details: IncompleteDetails$inboundSchema,
+  input: z.nullable(z.array(z.any())),
+  instructions: z.nullable(z.string()),
+  max_output_tokens: z.nullable(z.number().int()),
+  max_tool_calls: z.nullable(z.number().int()),
+  memory: MemoryParam$inboundSchema.optional(),
+  metadata: z.record(z.string()),
+  model: z.string(),
+  object: z.string(),
+  output: z.nullable(z.array(z.any())),
+  parallel_tool_calls: z.boolean(),
+  presence_penalty: z.number(),
+  previous_response_id: z.nullable(z.string()),
+  prompt_cache_key: z.nullable(z.string()),
+  prompt_cache_retention: z.nullable(z.string()),
+  reasoning: Reasoning$inboundSchema,
+  safety_identifier: z.nullable(z.string()),
+  service_tier: ServiceTier$inboundSchema,
+  status: PublicResponseResourceStatus$inboundSchema,
+  store: z.boolean(),
+  temperature: z.number(),
+  text: z.any().optional(),
+  tool_choice: z.any().optional(),
+  tools: z.nullable(z.array(z.any())),
+  top_logprobs: z.number().int(),
+  top_p: z.number(),
+  truncation: Truncation$inboundSchema,
+  usage: PublicUsage$inboundSchema,
+  user: z.nullable(z.string()),
+  variables: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "completed_at": "completedAt",
+    "created_at": "createdAt",
+    "frequency_penalty": "frequencyPenalty",
+    "incomplete_details": "incompleteDetails",
+    "max_output_tokens": "maxOutputTokens",
+    "max_tool_calls": "maxToolCalls",
+    "parallel_tool_calls": "parallelToolCalls",
+    "presence_penalty": "presencePenalty",
+    "previous_response_id": "previousResponseId",
+    "prompt_cache_key": "promptCacheKey",
+    "prompt_cache_retention": "promptCacheRetention",
+    "safety_identifier": "safetyIdentifier",
+    "service_tier": "serviceTier",
+    "tool_choice": "toolChoice",
+    "top_logprobs": "topLogprobs",
+    "top_p": "topP",
+  });
+});
+
+export function publicResponseResourceFromJSON(
+  jsonString: string,
+): SafeParseResult<PublicResponseResource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PublicResponseResource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PublicResponseResource' from JSON`,
+  );
+}

package/src/models/components/reasoning.ts

@@ -4,22 +4,68 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
+ */
+export const ReasoningEffort = {
+  None: "none",
+  Minimal: "minimal",
+  Low: "low",
+  Medium: "medium",
+  High: "high",
+  Xhigh: "xhigh",
+} as const;
+/**
+ * Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
+ */
+export type ReasoningEffort = ClosedEnum<typeof ReasoningEffort>;
+
+/**
+ * The format of the reasoning summary returned by the model.
+ */
+export const ReasoningSummary = {
+  Concise: "concise",
+  Detailed: "detailed",
+  Auto: "auto",
+} as const;
+/**
+ * The format of the reasoning summary returned by the model.
+ */
+export type ReasoningSummary = ClosedEnum<typeof ReasoningSummary>;
+
 export type Reasoning = {
-  effort?: string | undefined;
-  summary?: string | undefined;
+  /**
+   * Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
+   */
+  effort?: ReasoningEffort | undefined;
+  /**
+   * The format of the reasoning summary returned by the model.
+   */
+  summary?: ReasoningSummary | undefined;
 };
 
+/** @internal */
+export const ReasoningEffort$inboundSchema: z.ZodNativeEnum<
+  typeof ReasoningEffort
+> = z.nativeEnum(ReasoningEffort);
+
+/** @internal */
+export const ReasoningSummary$inboundSchema: z.ZodNativeEnum<
+  typeof ReasoningSummary
+> = z.nativeEnum(ReasoningSummary);
+
 /** @internal */
 export const Reasoning$inboundSchema: z.ZodType<
   Reasoning,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  effort: z.string().optional(),
-  summary: z.string().optional(),
+  effort: ReasoningEffort$inboundSchema.optional(),
+  summary: ReasoningSummary$inboundSchema.optional(),
 });
 
 export function reasoningFromJSON(

package/src/models/components/reasoningparam.ts

@@ -3,12 +3,56 @@
  */
 
 import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
+ */
+export const Effort = {
+  None: "none",
+  Minimal: "minimal",
+  Low: "low",
+  Medium: "medium",
+  High: "high",
+  Xhigh: "xhigh",
+} as const;
+/**
+ * Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
+ */
+export type Effort = ClosedEnum<typeof Effort>;
+
+/**
+ * The format of the reasoning summary returned by the model.
+ */
+export const Summary = {
+  Concise: "concise",
+  Detailed: "detailed",
+  Auto: "auto",
+} as const;
+/**
+ * The format of the reasoning summary returned by the model.
+ */
+export type Summary = ClosedEnum<typeof Summary>;
 
 export type ReasoningParam = {
-  effort?: string | undefined;
-  summary?: string | undefined;
+  /**
+   * Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
+   */
+  effort?: Effort | undefined;
+  /**
+   * The format of the reasoning summary returned by the model.
+   */
+  summary?: Summary | undefined;
 };
 
+/** @internal */
+export const Effort$outboundSchema: z.ZodNativeEnum<typeof Effort> = z
+  .nativeEnum(Effort);
+
+/** @internal */
+export const Summary$outboundSchema: z.ZodNativeEnum<typeof Summary> = z
+  .nativeEnum(Summary);
+
 /** @internal */
 export type ReasoningParam$Outbound = {
   effort?: string | undefined;
@@ -21,8 +65,8 @@ export const ReasoningParam$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ReasoningParam
 > = z.object({
-  effort: z.string().optional(),
-  summary: z.string().optional(),
+  effort: Effort$outboundSchema.optional(),
+  summary: Summary$outboundSchema.optional(),
 });
 
 export function reasoningParamToJSON(reasoningParam: ReasoningParam): string {

package/src/models/components/reasoningpart.ts

@@ -40,7 +40,7 @@ export const ReasoningPart$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("reasoning_01ktnkv43kzmr4chyfct7590ex"),
+  _id: z.string().default("reasoning_01ktprqqkjhe2f0dgt0wfxx3xj"),
   metadata: z.record(z.any()).optional(),
   kind: z.literal("reasoning"),
   reasoning: z.string(),

package/src/models/components/responsecodeinterpretercodedeltastreamevent.ts

@@ -0,0 +1,149 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  safeParse,
+} from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The event type. Matches the SSE `event` field.
+ */
+export const ResponseCodeInterpreterCodeDeltaStreamEventType = {
+  ResponseCodeInterpreterCallCodeDelta:
+    "response.code_interpreter_call_code.delta",
+} as const;
+/**
+ * The event type. Matches the SSE `event` field.
+ */
+export type ResponseCodeInterpreterCodeDeltaStreamEventType = ClosedEnum<
+  typeof ResponseCodeInterpreterCodeDeltaStreamEventType
+>;
+
+/**
+ * The event payload.
+ */
+export type ResponseCodeInterpreterCodeDeltaStreamEventData = {
+  /**
+   * Incremental text or argument chunk.
+   */
+  delta: string;
+  /**
+   * ID of the output item this event refers to.
+   */
+  itemId: string;
+  /**
+   * Index of the output item in the response output array.
+   */
+  outputIndex: number;
+  /**
+   * Monotonically increasing sequence number for ordering events.
+   */
+  sequenceNumber: number;
+  /**
+   * The event type. Matches the SSE `event` field.
+   */
+  type: ResponseCodeInterpreterCodeDeltaStreamEventType;
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+export type ResponseCodeInterpreterCodeDeltaStreamEvent = {
+  /**
+   * The event payload.
+   */
+  data: ResponseCodeInterpreterCodeDeltaStreamEventData;
+  /**
+   * The SSE event name, equal to the payload's `type`.
+   */
+  event: "response.code_interpreter_call_code.delta";
+};
+
+/** @internal */
+export const ResponseCodeInterpreterCodeDeltaStreamEventType$inboundSchema:
+  z.ZodNativeEnum<typeof ResponseCodeInterpreterCodeDeltaStreamEventType> = z
+    .nativeEnum(ResponseCodeInterpreterCodeDeltaStreamEventType);
+
+/** @internal */
+export const ResponseCodeInterpreterCodeDeltaStreamEventData$inboundSchema:
+  z.ZodType<
+    ResponseCodeInterpreterCodeDeltaStreamEventData,
+    z.ZodTypeDef,
+    unknown
+  > = collectExtraKeys$(
+    z.object({
+      delta: z.string(),
+      item_id: z.string(),
+      output_index: z.number().int(),
+      sequence_number: z.number().int(),
+      type: ResponseCodeInterpreterCodeDeltaStreamEventType$inboundSchema,
+    }).catchall(z.any()),
+    "additionalProperties",
+    true,
+  ).transform((v) => {
+    return remap$(v, {
+      "item_id": "itemId",
+      "output_index": "outputIndex",
+      "sequence_number": "sequenceNumber",
+    });
+  });
+
+export function responseCodeInterpreterCodeDeltaStreamEventDataFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ResponseCodeInterpreterCodeDeltaStreamEventData,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ResponseCodeInterpreterCodeDeltaStreamEventData$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ResponseCodeInterpreterCodeDeltaStreamEventData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseCodeInterpreterCodeDeltaStreamEvent$inboundSchema:
+  z.ZodType<
+    ResponseCodeInterpreterCodeDeltaStreamEvent,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    data: z.unknown().transform((v, ctx) => {
+      if (typeof v !== "string") return v;
+      try {
+        return JSON.parse(v);
+      } catch (err) {
+        ctx.addIssue({ code: "custom", message: `malformed json: ${err}` });
+        return z.NEVER;
+      }
+    }).pipe(
+      z.lazy(() =>
+        ResponseCodeInterpreterCodeDeltaStreamEventData$inboundSchema
+      ),
+    ),
+    event: z.literal("response.code_interpreter_call_code.delta"),
+  });
+
+export function responseCodeInterpreterCodeDeltaStreamEventFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ResponseCodeInterpreterCodeDeltaStreamEvent,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ResponseCodeInterpreterCodeDeltaStreamEvent$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ResponseCodeInterpreterCodeDeltaStreamEvent' from JSON`,
+  );
+}

package/src/models/components/responsecodeinterpretercodedonestreamevent.ts

@@ -0,0 +1,146 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  safeParse,
+} from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The event type. Matches the SSE `event` field.
+ */
+export const ResponseCodeInterpreterCodeDoneStreamEventType = {
+  ResponseCodeInterpreterCallCodeDone:
+    "response.code_interpreter_call_code.done",
+} as const;
+/**
+ * The event type. Matches the SSE `event` field.
+ */
+export type ResponseCodeInterpreterCodeDoneStreamEventType = ClosedEnum<
+  typeof ResponseCodeInterpreterCodeDoneStreamEventType
+>;
+
+/**
+ * The event payload.
+ */
+export type ResponseCodeInterpreterCodeDoneStreamEventData = {
+  /**
+   * The completed code interpreter code.
+   */
+  code: string;
+  /**
+   * ID of the output item this event refers to.
+   */
+  itemId: string;
+  /**
+   * Index of the output item in the response output array.
+   */
+  outputIndex: number;
+  /**
+   * Monotonically increasing sequence number for ordering events.
+   */
+  sequenceNumber: number;
+  /**
+   * The event type. Matches the SSE `event` field.
+   */
+  type: ResponseCodeInterpreterCodeDoneStreamEventType;
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+export type ResponseCodeInterpreterCodeDoneStreamEvent = {
+  /**
+   * The event payload.
+   */
+  data: ResponseCodeInterpreterCodeDoneStreamEventData;
+  /**
+   * The SSE event name, equal to the payload's `type`.
+   */
+  event: "response.code_interpreter_call_code.done";
+};
+
+/** @internal */
+export const ResponseCodeInterpreterCodeDoneStreamEventType$inboundSchema:
+  z.ZodNativeEnum<typeof ResponseCodeInterpreterCodeDoneStreamEventType> = z
+    .nativeEnum(ResponseCodeInterpreterCodeDoneStreamEventType);
+
+/** @internal */
+export const ResponseCodeInterpreterCodeDoneStreamEventData$inboundSchema:
+  z.ZodType<
+    ResponseCodeInterpreterCodeDoneStreamEventData,
+    z.ZodTypeDef,
+    unknown
+  > = collectExtraKeys$(
+    z.object({
+      code: z.string(),
+      item_id: z.string(),
+      output_index: z.number().int(),
+      sequence_number: z.number().int(),
+      type: ResponseCodeInterpreterCodeDoneStreamEventType$inboundSchema,
+    }).catchall(z.any()),
+    "additionalProperties",
+    true,
+  ).transform((v) => {
+    return remap$(v, {
+      "item_id": "itemId",
+      "output_index": "outputIndex",
+      "sequence_number": "sequenceNumber",
+    });
+  });
+
+export function responseCodeInterpreterCodeDoneStreamEventDataFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ResponseCodeInterpreterCodeDoneStreamEventData,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ResponseCodeInterpreterCodeDoneStreamEventData$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ResponseCodeInterpreterCodeDoneStreamEventData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseCodeInterpreterCodeDoneStreamEvent$inboundSchema:
+  z.ZodType<ResponseCodeInterpreterCodeDoneStreamEvent, z.ZodTypeDef, unknown> =
+    z.object({
+      data: z.unknown().transform((v, ctx) => {
+        if (typeof v !== "string") return v;
+        try {
+          return JSON.parse(v);
+        } catch (err) {
+          ctx.addIssue({ code: "custom", message: `malformed json: ${err}` });
+          return z.NEVER;
+        }
+      }).pipe(
+        z.lazy(() =>
+          ResponseCodeInterpreterCodeDoneStreamEventData$inboundSchema
+        ),
+      ),
+      event: z.literal("response.code_interpreter_call_code.done"),
+    });
+
+export function responseCodeInterpreterCodeDoneStreamEventFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ResponseCodeInterpreterCodeDoneStreamEvent,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ResponseCodeInterpreterCodeDoneStreamEvent$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ResponseCodeInterpreterCodeDoneStreamEvent' from JSON`,
+  );
+}