@orq-ai/node 4.11.0-rc.8 → 4.11.0

package/packages/orq-rc/src/models/components/responsedoneevent.ts

@@ -0,0 +1,324 @@
+/*
+ * 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 { Telemetry, Telemetry$inboundSchema } from "./telemetry.js";
+
+/**
+ * The reason why the agent stopped generating
+ */
+export const ResponseDoneEventFinishReason = {
+  Stop: "stop",
+  Length: "length",
+  ToolCalls: "tool_calls",
+  ContentFilter: "content_filter",
+  FunctionCall: "function_call",
+  MaxIterations: "max_iterations",
+  MaxTime: "max_time",
+} as const;
+/**
+ * The reason why the agent stopped generating
+ */
+export type ResponseDoneEventFinishReason = ClosedEnum<
+  typeof ResponseDoneEventFinishReason
+>;
+
+export type ResponseDoneEventPromptTokensDetails = {
+  cachedTokens?: number | null | undefined;
+  cacheCreationTokens?: number | null | undefined;
+  /**
+   * The number of audio input tokens consumed by the request.
+   */
+  audioTokens?: number | null | undefined;
+};
+
+export type ResponseDoneEventCompletionTokensDetails = {
+  reasoningTokens?: number | null | undefined;
+  acceptedPredictionTokens?: number | null | undefined;
+  rejectedPredictionTokens?: number | null | undefined;
+  /**
+   * The number of audio output tokens produced by the response.
+   */
+  audioTokens?: number | null | undefined;
+};
+
+/**
+ * Token usage statistics for the complete response
+ */
+export type ResponseDoneEventUsage = {
+  /**
+   * Number of tokens in the generated completion.
+   */
+  completionTokens?: number | undefined;
+  /**
+   * Number of tokens in the prompt.
+   */
+  promptTokens?: number | undefined;
+  /**
+   * Total number of tokens used in the request (prompt + completion).
+   */
+  totalTokens?: number | undefined;
+  promptTokensDetails?: ResponseDoneEventPromptTokensDetails | null | undefined;
+  completionTokensDetails?:
+    | ResponseDoneEventCompletionTokensDetails
+    | null
+    | undefined;
+};
+
+export const ResponseDoneEventDataType = {
+  Function: "function",
+} as const;
+export type ResponseDoneEventDataType = ClosedEnum<
+  typeof ResponseDoneEventDataType
+>;
+
+export type ResponseDoneEventFunction = {
+  /**
+   * The name of the function to call
+   */
+  name?: string | undefined;
+  /**
+   * The arguments to pass to the function as JSON string
+   */
+  arguments?: string | undefined;
+};
+
+export type ResponseDoneEventPendingToolCalls = {
+  /**
+   * Unique identifier for the tool call
+   */
+  id: string;
+  type: ResponseDoneEventDataType;
+  function: ResponseDoneEventFunction;
+};
+
+export type ResponseDoneEventData = {
+  /**
+   * The reason why the agent stopped generating
+   */
+  finishReason: ResponseDoneEventFinishReason;
+  /**
+   * Token usage statistics for the complete response
+   */
+  usage?: ResponseDoneEventUsage | undefined;
+  /**
+   * Tool calls awaiting user response (when finishReason is function_call)
+   */
+  pendingToolCalls?: Array<ResponseDoneEventPendingToolCalls> | undefined;
+  /**
+   * Telemetry information for correlating the response with traces
+   */
+  telemetry?: Telemetry | undefined;
+};
+
+/**
+ * Emitted when the agent completes processing. Contains the finish reason and usage statistics.
+ */
+export type ResponseDoneEvent = {
+  type: "response.done";
+  /**
+   * ISO timestamp of when the event occurred
+   */
+  timestamp: string;
+  data: ResponseDoneEventData;
+};
+
+/** @internal */
+export const ResponseDoneEventFinishReason$inboundSchema: z.ZodNativeEnum<
+  typeof ResponseDoneEventFinishReason
+> = z.nativeEnum(ResponseDoneEventFinishReason);
+
+/** @internal */
+export const ResponseDoneEventPromptTokensDetails$inboundSchema: z.ZodType<
+  ResponseDoneEventPromptTokensDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  cached_tokens: z.nullable(z.number().int()).optional(),
+  cache_creation_tokens: z.nullable(z.number().int()).optional(),
+  audio_tokens: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "cached_tokens": "cachedTokens",
+    "cache_creation_tokens": "cacheCreationTokens",
+    "audio_tokens": "audioTokens",
+  });
+});
+
+export function responseDoneEventPromptTokensDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseDoneEventPromptTokensDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ResponseDoneEventPromptTokensDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseDoneEventPromptTokensDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseDoneEventCompletionTokensDetails$inboundSchema: z.ZodType<
+  ResponseDoneEventCompletionTokensDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  reasoning_tokens: z.nullable(z.number()).optional(),
+  accepted_prediction_tokens: z.nullable(z.number()).optional(),
+  rejected_prediction_tokens: z.nullable(z.number()).optional(),
+  audio_tokens: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "reasoning_tokens": "reasoningTokens",
+    "accepted_prediction_tokens": "acceptedPredictionTokens",
+    "rejected_prediction_tokens": "rejectedPredictionTokens",
+    "audio_tokens": "audioTokens",
+  });
+});
+
+export function responseDoneEventCompletionTokensDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ResponseDoneEventCompletionTokensDetails,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ResponseDoneEventCompletionTokensDetails$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ResponseDoneEventCompletionTokensDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseDoneEventUsage$inboundSchema: z.ZodType<
+  ResponseDoneEventUsage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  completion_tokens: z.number().optional(),
+  prompt_tokens: z.number().optional(),
+  total_tokens: z.number().optional(),
+  prompt_tokens_details: z.nullable(
+    z.lazy(() => ResponseDoneEventPromptTokensDetails$inboundSchema),
+  ).optional(),
+  completion_tokens_details: z.nullable(
+    z.lazy(() => ResponseDoneEventCompletionTokensDetails$inboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "completion_tokens": "completionTokens",
+    "prompt_tokens": "promptTokens",
+    "total_tokens": "totalTokens",
+    "prompt_tokens_details": "promptTokensDetails",
+    "completion_tokens_details": "completionTokensDetails",
+  });
+});
+
+export function responseDoneEventUsageFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseDoneEventUsage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseDoneEventUsage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseDoneEventUsage' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseDoneEventDataType$inboundSchema: z.ZodNativeEnum<
+  typeof ResponseDoneEventDataType
+> = z.nativeEnum(ResponseDoneEventDataType);
+
+/** @internal */
+export const ResponseDoneEventFunction$inboundSchema: z.ZodType<
+  ResponseDoneEventFunction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  arguments: z.string().optional(),
+});
+
+export function responseDoneEventFunctionFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseDoneEventFunction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseDoneEventFunction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseDoneEventFunction' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseDoneEventPendingToolCalls$inboundSchema: z.ZodType<
+  ResponseDoneEventPendingToolCalls,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  type: ResponseDoneEventDataType$inboundSchema,
+  function: z.lazy(() => ResponseDoneEventFunction$inboundSchema),
+});
+
+export function responseDoneEventPendingToolCallsFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseDoneEventPendingToolCalls, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseDoneEventPendingToolCalls$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseDoneEventPendingToolCalls' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseDoneEventData$inboundSchema: z.ZodType<
+  ResponseDoneEventData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  finishReason: ResponseDoneEventFinishReason$inboundSchema,
+  usage: z.lazy(() => ResponseDoneEventUsage$inboundSchema).optional(),
+  pendingToolCalls: z.array(
+    z.lazy(() => ResponseDoneEventPendingToolCalls$inboundSchema),
+  ).optional(),
+  telemetry: Telemetry$inboundSchema.optional(),
+});
+
+export function responseDoneEventDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseDoneEventData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseDoneEventData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseDoneEventData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseDoneEvent$inboundSchema: z.ZodType<
+  ResponseDoneEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("response.done"),
+  timestamp: z.string(),
+  data: z.lazy(() => ResponseDoneEventData$inboundSchema),
+});
+
+export function responseDoneEventFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseDoneEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseDoneEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseDoneEvent' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/responseerror.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ResponseError = {
+  code: string;
+  message: string;
+};
+
+/** @internal */
+export const ResponseError$inboundSchema: z.ZodType<
+  ResponseError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  message: z.string(),
+});
+
+export function responseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseError' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/responseerrorstreamevent.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { ResponseError, ResponseError$inboundSchema } from "./responseerror.js";
+
+/**
+ * A `error` server-sent event.
+ */
+export type ResponseErrorStreamEvent = {
+  error: ResponseError;
+  /**
+   * Monotonically increasing sequence number for ordering events.
+   */
+  sequenceNumber: number;
+  /**
+   * The event type. Discriminates the payload.
+   */
+  type: "error";
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ResponseErrorStreamEvent$inboundSchema: z.ZodType<
+  ResponseErrorStreamEvent,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    error: ResponseError$inboundSchema,
+    sequence_number: z.number().int(),
+    type: z.literal("error"),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+).transform((v) => {
+  return remap$(v, {
+    "sequence_number": "sequenceNumber",
+  });
+});
+
+export function responseErrorStreamEventFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseErrorStreamEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseErrorStreamEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseErrorStreamEvent' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/responseexecutionlimits.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type ResponseExecutionLimits = {
+  maxCost?: number | undefined;
+  maxDepth?: number | undefined;
+  maxExecutionTime?: number | undefined;
+  maxIterations?: number | undefined;
+  toolTimeout?: number | undefined;
+};
+
+/** @internal */
+export type ResponseExecutionLimits$Outbound = {
+  max_cost?: number | undefined;
+  max_depth?: number | undefined;
+  max_execution_time?: number | undefined;
+  max_iterations?: number | undefined;
+  tool_timeout?: number | undefined;
+};
+
+/** @internal */
+export const ResponseExecutionLimits$outboundSchema: z.ZodType<
+  ResponseExecutionLimits$Outbound,
+  z.ZodTypeDef,
+  ResponseExecutionLimits
+> = z.object({
+  maxCost: z.number().optional(),
+  maxDepth: z.number().int().optional(),
+  maxExecutionTime: z.number().int().optional(),
+  maxIterations: z.number().int().optional(),
+  toolTimeout: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    maxCost: "max_cost",
+    maxDepth: "max_depth",
+    maxExecutionTime: "max_execution_time",
+    maxIterations: "max_iterations",
+    toolTimeout: "tool_timeout",
+  });
+});
+
+export function responseExecutionLimitsToJSON(
+  responseExecutionLimits: ResponseExecutionLimits,
+): string {
+  return JSON.stringify(
+    ResponseExecutionLimits$outboundSchema.parse(responseExecutionLimits),
+  );
+}

package/packages/orq-rc/src/models/components/responsefailedevent.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ResponseFailedEventData = {
+  /**
+   * Error message describing what went wrong
+   */
+  error: string;
+  /**
+   * HTTP status code indicating the error type
+   */
+  code: number;
+};
+
+/**
+ * Emitted when an error occurs during agent execution. Contains error details.
+ */
+export type ResponseFailedEvent = {
+  type: "response.failed";
+  /**
+   * ISO timestamp of when the event occurred
+   */
+  timestamp: string;
+  data: ResponseFailedEventData;
+};
+
+/** @internal */
+export const ResponseFailedEventData$inboundSchema: z.ZodType<
+  ResponseFailedEventData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.string(),
+  code: z.number(),
+});
+
+export function responseFailedEventDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseFailedEventData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseFailedEventData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseFailedEventData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseFailedEvent$inboundSchema: z.ZodType<
+  ResponseFailedEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("response.failed"),
+  timestamp: z.string(),
+  data: z.lazy(() => ResponseFailedEventData$inboundSchema),
+});
+
+export function responseFailedEventFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseFailedEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseFailedEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseFailedEvent' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/responsefailedstreamevent.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PublicResponseResource,
+  PublicResponseResource$inboundSchema,
+} from "./publicresponseresource.js";
+
+/**
+ * A `response.failed` server-sent event.
+ */
+export type ResponseFailedStreamEvent = {
+  response: PublicResponseResource;
+  /**
+   * Monotonically increasing sequence number for ordering events.
+   */
+  sequenceNumber: number;
+  /**
+   * The event type. Discriminates the payload.
+   */
+  type: "response.failed";
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ResponseFailedStreamEvent$inboundSchema: z.ZodType<
+  ResponseFailedStreamEvent,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    response: PublicResponseResource$inboundSchema,
+    sequence_number: z.number().int(),
+    type: z.literal("response.failed"),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+).transform((v) => {
+  return remap$(v, {
+    "sequence_number": "sequenceNumber",
+  });
+});
+
+export function responseFailedStreamEventFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseFailedStreamEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseFailedStreamEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseFailedStreamEvent' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/responsefilesearchcallcompletedstreamevent.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * A `response.file_search_call.completed` server-sent event.
+ */
+export type ResponseFileSearchCallCompletedStreamEvent = {
+  /**
+   * 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. Discriminates the payload.
+   */
+  type: "response.file_search_call.completed";
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ResponseFileSearchCallCompletedStreamEvent$inboundSchema:
+  z.ZodType<ResponseFileSearchCallCompletedStreamEvent, z.ZodTypeDef, unknown> =
+    collectExtraKeys$(
+      z.object({
+        item_id: z.string(),
+        output_index: z.number().int(),
+        sequence_number: z.number().int(),
+        type: z.literal("response.file_search_call.completed"),
+      }).catchall(z.any()),
+      "additionalProperties",
+      true,
+    ).transform((v) => {
+      return remap$(v, {
+        "item_id": "itemId",
+        "output_index": "outputIndex",
+        "sequence_number": "sequenceNumber",
+      });
+    });
+
+export function responseFileSearchCallCompletedStreamEventFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ResponseFileSearchCallCompletedStreamEvent,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ResponseFileSearchCallCompletedStreamEvent$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ResponseFileSearchCallCompletedStreamEvent' from JSON`,
+  );
+}