@orq-ai/node 4.10.0-rc.88 → 4.10.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/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/responseidentity.ts

@@ -0,0 +1,48 @@
+/*
+ * 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 ResponseIdentity = {
+  displayName?: string | undefined;
+  email?: string | undefined;
+  id: string;
+  metadata?: Array<{ [k: string]: any }> | null | undefined;
+  tags?: Array<string> | null | undefined;
+};
+
+/** @internal */
+export type ResponseIdentity$Outbound = {
+  display_name?: string | undefined;
+  email?: string | undefined;
+  id: string;
+  metadata?: Array<{ [k: string]: any }> | null | undefined;
+  tags?: Array<string> | null | undefined;
+};
+
+/** @internal */
+export const ResponseIdentity$outboundSchema: z.ZodType<
+  ResponseIdentity$Outbound,
+  z.ZodTypeDef,
+  ResponseIdentity
+> = z.object({
+  displayName: z.string().optional(),
+  email: z.string().optional(),
+  id: z.string(),
+  metadata: z.nullable(z.array(z.record(z.any()))).optional(),
+  tags: z.nullable(z.array(z.string())).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+  });
+});
+
+export function responseIdentityToJSON(
+  responseIdentity: ResponseIdentity,
+): string {
+  return JSON.stringify(
+    ResponseIdentity$outboundSchema.parse(responseIdentity),
+  );
+}

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

@@ -0,0 +1,103 @@
+/*
+ * 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";
+
+/**
+ * Bucket grain actually applied by the planner.
+ */
+export const EffectiveGrain = {
+  Minute: "minute",
+  Hour: "hour",
+  Day: "day",
+} as const;
+/**
+ * Bucket grain actually applied by the planner.
+ */
+export type EffectiveGrain = ClosedEnum<typeof EffectiveGrain>;
+
+/**
+ * ISO 4217 currency code for cost fields. Always `USD` today.
+ */
+export const ResponseMetaCurrency = {
+  Usd: "USD",
+} as const;
+/**
+ * ISO 4217 currency code for cost fields. Always `USD` today.
+ */
+export type ResponseMetaCurrency = ClosedEnum<typeof ResponseMetaCurrency>;
+
+export type ResponseMeta = {
+  /**
+   * Bucket grain actually applied by the planner.
+   */
+  effectiveGrain?: EffectiveGrain | undefined;
+  /**
+   * Number of rows in `data`. Cheap hint for clients that paginate
+   *
+   * @remarks
+   *  client-side; mirrors `len(data)`.
+   */
+  rowCount?: number | undefined;
+  /**
+   * Stable identifier for this query. Forward in support tickets so
+   *
+   * @remarks
+   *  server logs can be correlated. Also returned in the
+   *  `X-Request-Id` response header.
+   */
+  requestId?: string | undefined;
+  /**
+   * ISO 4217 currency code for cost fields. Always `USD` today.
+   */
+  currency?: ResponseMetaCurrency | undefined;
+  /**
+   * Non-fatal warnings about the response. May contain `totals_unavailable` when totals were requested but failed.
+   */
+  warnings?: Array<string> | undefined;
+};
+
+/** @internal */
+export const EffectiveGrain$inboundSchema: z.ZodNativeEnum<
+  typeof EffectiveGrain
+> = z.nativeEnum(EffectiveGrain);
+
+/** @internal */
+export const ResponseMetaCurrency$inboundSchema: z.ZodNativeEnum<
+  typeof ResponseMetaCurrency
+> = z.nativeEnum(ResponseMetaCurrency);
+
+/** @internal */
+export const ResponseMeta$inboundSchema: z.ZodType<
+  ResponseMeta,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  effective_grain: EffectiveGrain$inboundSchema.optional(),
+  row_count: z.number().int().optional(),
+  request_id: z.string().optional(),
+  currency: ResponseMetaCurrency$inboundSchema.optional(),
+  warnings: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "effective_grain": "effectiveGrain",
+    "row_count": "rowCount",
+    "request_id": "requestId",
+  });
+});
+
+export function responseMetaFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseMeta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseMeta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseMeta' from JSON`,
+  );
+}

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

@@ -0,0 +1,45 @@
+/*
+ * 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 ResponseRetryConfig = {
+  /**
+   * Number of retries (1-5).
+   */
+  count: number;
+  /**
+   * HTTP status codes that trigger a retry (e.g. [429, 500, 502, 503]).
+   */
+  onCodes: Array<number> | null;
+};
+
+/** @internal */
+export type ResponseRetryConfig$Outbound = {
+  count: number;
+  on_codes: Array<number> | null;
+};
+
+/** @internal */
+export const ResponseRetryConfig$outboundSchema: z.ZodType<
+  ResponseRetryConfig$Outbound,
+  z.ZodTypeDef,
+  ResponseRetryConfig
+> = z.object({
+  count: z.number().int(),
+  onCodes: z.nullable(z.array(z.number().int())),
+}).transform((v) => {
+  return remap$(v, {
+    onCodes: "on_codes",
+  });
+});
+
+export function responseRetryConfigToJSON(
+  responseRetryConfig: ResponseRetryConfig,
+): string {
+  return JSON.stringify(
+    ResponseRetryConfig$outboundSchema.parse(responseRetryConfig),
+  );
+}