@orq-ai/node 4.5.0-rc.9 → 4.5.3

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

@@ -0,0 +1,348 @@
+/*
+ * 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 {
+  AgentResponseMessage,
+  AgentResponseMessage$inboundSchema,
+} from "./agentresponsemessage.js";
+import { Telemetry, Telemetry$inboundSchema } from "./telemetry.js";
+
+export type GetAgentResponsePromptTokensDetails = {
+  cachedTokens?: number | null | undefined;
+  cacheCreationTokens?: number | null | undefined;
+  /**
+   * The number of audio input tokens consumed by the request.
+   */
+  audioTokens?: number | null | undefined;
+};
+
+export type GetAgentResponseCompletionTokensDetails = {
+  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 from the agent execution
+ */
+export type GetAgentResponseUsage = {
+  /**
+   * 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?: GetAgentResponsePromptTokensDetails | null | undefined;
+  completionTokensDetails?:
+    | GetAgentResponseCompletionTokensDetails
+    | null
+    | undefined;
+};
+
+/**
+ * The reason why the agent stopped generating
+ */
+export const GetAgentResponseFinishReason = {
+  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 GetAgentResponseFinishReason = ClosedEnum<
+  typeof GetAgentResponseFinishReason
+>;
+
+export const GetAgentResponseType = {
+  Function: "function",
+} as const;
+export type GetAgentResponseType = ClosedEnum<typeof GetAgentResponseType>;
+
+export type GetAgentResponseFunction = {
+  name?: string | undefined;
+  arguments?: string | undefined;
+};
+
+export type GetAgentResponsePendingToolCalls = {
+  id: string;
+  type: GetAgentResponseType;
+  function: GetAgentResponseFunction;
+};
+
+/**
+ * Current status of the agent response
+ */
+export const Status = {
+  InProgress: "in_progress",
+  Completed: "completed",
+  Failed: "failed",
+} as const;
+/**
+ * Current status of the agent response
+ */
+export type Status = ClosedEnum<typeof Status>;
+
+/**
+ * Response type from the get-response endpoint. Includes a status field indicating the current state of the agent execution.
+ */
+export type GetAgentResponse = {
+  /**
+   * The unique response ID
+   */
+  id: string;
+  /**
+   * The agent execution task ID
+   */
+  taskId: string;
+  /**
+   * Array of messages from the agent execution
+   */
+  output: Array<AgentResponseMessage>;
+  /**
+   * ISO timestamp of response creation
+   */
+  createdAt: string;
+  /**
+   * Model used in provider/model format
+   */
+  model: string;
+  /**
+   * Token usage from the agent execution
+   */
+  usage?: GetAgentResponseUsage | null | undefined;
+  /**
+   * The reason why the agent stopped generating
+   */
+  finishReason?: GetAgentResponseFinishReason | undefined;
+  /**
+   * Tool calls awaiting user response (when finish_reason is function_call)
+   */
+  pendingToolCalls?: Array<GetAgentResponsePendingToolCalls> | undefined;
+  /**
+   * Telemetry information for correlating the response with traces
+   */
+  telemetry?: Telemetry | undefined;
+  /**
+   * Current status of the agent response
+   */
+  status: Status;
+  /**
+   * Error message when status is failed
+   */
+  error?: string | undefined;
+};
+
+/** @internal */
+export const GetAgentResponsePromptTokensDetails$inboundSchema: z.ZodType<
+  GetAgentResponsePromptTokensDetails,
+  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 getAgentResponsePromptTokensDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAgentResponsePromptTokensDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetAgentResponsePromptTokensDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAgentResponsePromptTokensDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAgentResponseCompletionTokensDetails$inboundSchema: z.ZodType<
+  GetAgentResponseCompletionTokensDetails,
+  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 getAgentResponseCompletionTokensDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetAgentResponseCompletionTokensDetails,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetAgentResponseCompletionTokensDetails$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetAgentResponseCompletionTokensDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAgentResponseUsage$inboundSchema: z.ZodType<
+  GetAgentResponseUsage,
+  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(() => GetAgentResponsePromptTokensDetails$inboundSchema),
+  ).optional(),
+  completion_tokens_details: z.nullable(
+    z.lazy(() => GetAgentResponseCompletionTokensDetails$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 getAgentResponseUsageFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAgentResponseUsage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAgentResponseUsage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAgentResponseUsage' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAgentResponseFinishReason$inboundSchema: z.ZodNativeEnum<
+  typeof GetAgentResponseFinishReason
+> = z.nativeEnum(GetAgentResponseFinishReason);
+
+/** @internal */
+export const GetAgentResponseType$inboundSchema: z.ZodNativeEnum<
+  typeof GetAgentResponseType
+> = z.nativeEnum(GetAgentResponseType);
+
+/** @internal */
+export const GetAgentResponseFunction$inboundSchema: z.ZodType<
+  GetAgentResponseFunction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  arguments: z.string().optional(),
+});
+
+export function getAgentResponseFunctionFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAgentResponseFunction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAgentResponseFunction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAgentResponseFunction' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAgentResponsePendingToolCalls$inboundSchema: z.ZodType<
+  GetAgentResponsePendingToolCalls,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  type: GetAgentResponseType$inboundSchema,
+  function: z.lazy(() => GetAgentResponseFunction$inboundSchema),
+});
+
+export function getAgentResponsePendingToolCallsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAgentResponsePendingToolCalls, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAgentResponsePendingToolCalls$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAgentResponsePendingToolCalls' from JSON`,
+  );
+}
+
+/** @internal */
+export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
+  .nativeEnum(Status);
+
+/** @internal */
+export const GetAgentResponse$inboundSchema: z.ZodType<
+  GetAgentResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  task_id: z.string(),
+  output: z.array(AgentResponseMessage$inboundSchema),
+  created_at: z.string(),
+  model: z.string(),
+  usage: z.nullable(z.lazy(() => GetAgentResponseUsage$inboundSchema))
+    .optional(),
+  finish_reason: GetAgentResponseFinishReason$inboundSchema.optional(),
+  pending_tool_calls: z.array(
+    z.lazy(() => GetAgentResponsePendingToolCalls$inboundSchema),
+  ).optional(),
+  telemetry: Telemetry$inboundSchema.optional(),
+  status: Status$inboundSchema,
+  error: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "task_id": "taskId",
+    "created_at": "createdAt",
+    "finish_reason": "finishReason",
+    "pending_tool_calls": "pendingToolCalls",
+  });
+});
+
+export function getAgentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAgentResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAgentResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAgentResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,268 @@
+/*
+ * 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";
+
+/**
+ * Specifies the detail level of the image.
+ */
+export const Detail = {
+  Low: "low",
+  High: "high",
+  Auto: "auto",
+} as const;
+/**
+ * Specifies the detail level of the image.
+ */
+export type Detail = ClosedEnum<typeof Detail>;
+
+export type ImageUrl = {
+  /**
+   * Either a URL of the image or the base64 encoded image data.
+   */
+  url: string;
+  /**
+   * Specifies the detail level of the image.
+   */
+  detail?: Detail | undefined;
+};
+
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export const ImageContentPartSchemaCacheControlType = {
+  Ephemeral: "ephemeral",
+} as const;
+/**
+ * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+ */
+export type ImageContentPartSchemaCacheControlType = ClosedEnum<
+  typeof ImageContentPartSchemaCacheControlType
+>;
+
+/**
+ * The time-to-live for the cache control breakpoint. This may be one of the following values:
+ *
+ * @remarks
+ *
+ * - `5m`: 5 minutes
+ * - `1h`: 1 hour
+ *
+ * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+ */
+export const ImageContentPartSchemaTtl = {
+  Fivem: "5m",
+  Oneh: "1h",
+} as const;
+/**
+ * The time-to-live for the cache control breakpoint. This may be one of the following values:
+ *
+ * @remarks
+ *
+ * - `5m`: 5 minutes
+ * - `1h`: 1 hour
+ *
+ * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+ */
+export type ImageContentPartSchemaTtl = ClosedEnum<
+  typeof ImageContentPartSchemaTtl
+>;
+
+export type ImageContentPartSchemaCacheControl = {
+  /**
+   * Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
+   */
+  type: ImageContentPartSchemaCacheControlType;
+  /**
+   * The time-to-live for the cache control breakpoint. This may be one of the following values:
+   *
+   * @remarks
+   *
+   * - `5m`: 5 minutes
+   * - `1h`: 1 hour
+   *
+   * Defaults to `5m`. Only supported by `Anthropic` Claude models.
+   */
+  ttl?: ImageContentPartSchemaTtl | undefined;
+};
+
+/**
+ * An image content part
+ */
+export type ImageContentPartSchema = {
+  type: "image_url";
+  imageUrl: ImageUrl;
+  cacheControl?: ImageContentPartSchemaCacheControl | undefined;
+};
+
+/** @internal */
+export const Detail$inboundSchema: z.ZodNativeEnum<typeof Detail> = z
+  .nativeEnum(Detail);
+/** @internal */
+export const Detail$outboundSchema: z.ZodNativeEnum<typeof Detail> =
+  Detail$inboundSchema;
+
+/** @internal */
+export const ImageUrl$inboundSchema: z.ZodType<
+  ImageUrl,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string(),
+  detail: Detail$inboundSchema.optional(),
+});
+/** @internal */
+export type ImageUrl$Outbound = {
+  url: string;
+  detail?: string | undefined;
+};
+
+/** @internal */
+export const ImageUrl$outboundSchema: z.ZodType<
+  ImageUrl$Outbound,
+  z.ZodTypeDef,
+  ImageUrl
+> = z.object({
+  url: z.string(),
+  detail: Detail$outboundSchema.optional(),
+});
+
+export function imageUrlToJSON(imageUrl: ImageUrl): string {
+  return JSON.stringify(ImageUrl$outboundSchema.parse(imageUrl));
+}
+export function imageUrlFromJSON(
+  jsonString: string,
+): SafeParseResult<ImageUrl, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ImageUrl$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ImageUrl' from JSON`,
+  );
+}
+
+/** @internal */
+export const ImageContentPartSchemaCacheControlType$inboundSchema:
+  z.ZodNativeEnum<typeof ImageContentPartSchemaCacheControlType> = z.nativeEnum(
+    ImageContentPartSchemaCacheControlType,
+  );
+/** @internal */
+export const ImageContentPartSchemaCacheControlType$outboundSchema:
+  z.ZodNativeEnum<typeof ImageContentPartSchemaCacheControlType> =
+    ImageContentPartSchemaCacheControlType$inboundSchema;
+
+/** @internal */
+export const ImageContentPartSchemaTtl$inboundSchema: z.ZodNativeEnum<
+  typeof ImageContentPartSchemaTtl
+> = z.nativeEnum(ImageContentPartSchemaTtl);
+/** @internal */
+export const ImageContentPartSchemaTtl$outboundSchema: z.ZodNativeEnum<
+  typeof ImageContentPartSchemaTtl
+> = ImageContentPartSchemaTtl$inboundSchema;
+
+/** @internal */
+export const ImageContentPartSchemaCacheControl$inboundSchema: z.ZodType<
+  ImageContentPartSchemaCacheControl,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: ImageContentPartSchemaCacheControlType$inboundSchema,
+  ttl: ImageContentPartSchemaTtl$inboundSchema.default("5m"),
+});
+/** @internal */
+export type ImageContentPartSchemaCacheControl$Outbound = {
+  type: string;
+  ttl: string;
+};
+
+/** @internal */
+export const ImageContentPartSchemaCacheControl$outboundSchema: z.ZodType<
+  ImageContentPartSchemaCacheControl$Outbound,
+  z.ZodTypeDef,
+  ImageContentPartSchemaCacheControl
+> = z.object({
+  type: ImageContentPartSchemaCacheControlType$outboundSchema,
+  ttl: ImageContentPartSchemaTtl$outboundSchema.default("5m"),
+});
+
+export function imageContentPartSchemaCacheControlToJSON(
+  imageContentPartSchemaCacheControl: ImageContentPartSchemaCacheControl,
+): string {
+  return JSON.stringify(
+    ImageContentPartSchemaCacheControl$outboundSchema.parse(
+      imageContentPartSchemaCacheControl,
+    ),
+  );
+}
+export function imageContentPartSchemaCacheControlFromJSON(
+  jsonString: string,
+): SafeParseResult<ImageContentPartSchemaCacheControl, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ImageContentPartSchemaCacheControl$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ImageContentPartSchemaCacheControl' from JSON`,
+  );
+}
+
+/** @internal */
+export const ImageContentPartSchema$inboundSchema: z.ZodType<
+  ImageContentPartSchema,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("image_url"),
+  image_url: z.lazy(() => ImageUrl$inboundSchema),
+  cache_control: z.lazy(() => ImageContentPartSchemaCacheControl$inboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "image_url": "imageUrl",
+    "cache_control": "cacheControl",
+  });
+});
+/** @internal */
+export type ImageContentPartSchema$Outbound = {
+  type: "image_url";
+  image_url: ImageUrl$Outbound;
+  cache_control?: ImageContentPartSchemaCacheControl$Outbound | undefined;
+};
+
+/** @internal */
+export const ImageContentPartSchema$outboundSchema: z.ZodType<
+  ImageContentPartSchema$Outbound,
+  z.ZodTypeDef,
+  ImageContentPartSchema
+> = z.object({
+  type: z.literal("image_url"),
+  imageUrl: z.lazy(() => ImageUrl$outboundSchema),
+  cacheControl: z.lazy(() => ImageContentPartSchemaCacheControl$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    imageUrl: "image_url",
+    cacheControl: "cache_control",
+  });
+});
+
+export function imageContentPartSchemaToJSON(
+  imageContentPartSchema: ImageContentPartSchema,
+): string {
+  return JSON.stringify(
+    ImageContentPartSchema$outboundSchema.parse(imageContentPartSchema),
+  );
+}
+export function imageContentPartSchemaFromJSON(
+  jsonString: string,
+): SafeParseResult<ImageContentPartSchema, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ImageContentPartSchema$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ImageContentPartSchema' from JSON`,
+  );
+}

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

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./actionreviewedstreamingevent.js";
+export * from "./actionreviewrequestedstreamingevent.js";
+export * from "./agenterroredstreamingevent.js";
+export * from "./agentexecutionstartedstreamingevent.js";
+export * from "./agenthandedoffstreamingevent.js";
+export * from "./agentinactivestreamingevent.js";
+export * from "./agentmessagecreatedstreamingevent.js";
+export * from "./agentresponsemessage.js";
+export * from "./agentstartedstreamingevent.js";
+export * from "./agentthoughtstreamingevent.js";
+export * from "./audiocontentpartschema.js";
+export * from "./createagentresponse.js";
+export * from "./datapart.js";
+export * from "./errorpart.js";
+export * from "./errorstreamingevent.js";
+export * from "./executionnamedstreamingevent.js";
+export * from "./executionreviewedstreamingevent.js";
+export * from "./executionreviewrequiredstreamingevent.js";
+export * from "./extendedmessage.js";
+export * from "./filecontentpartschema.js";
+export * from "./filepart.js";
+export * from "./getagentresponse.js";
+export * from "./imagecontentpartschema.js";
+export * from "./invokedeploymentrequest.js";
+export * from "./partdelta.js";
+export * from "./partdeltaevent.js";
+export * from "./partdoneevent.js";
+export * from "./publiccontact.js";
+export * from "./publicidentity.js";
+export * from "./reasoningpart.js";
+export * from "./reasoningpartschema.js";
+export * from "./redactedreasoningpartschema.js";
+export * from "./refusalpartschema.js";
+export * from "./responsedoneevent.js";
+export * from "./responsefailedevent.js";
+export * from "./responsestartedevent.js";
+export * from "./responsestreamingevent.js";
+export * from "./reviewoutcome.js";
+export * from "./security.js";
+export * from "./telemetry.js";
+export * from "./textcontentpartschema.js";
+export * from "./textpart.js";
+export * from "./thinkingconfigdisabledschema.js";
+export * from "./thinkingconfigenabledschema.js";
+export * from "./timeoutstreamingevent.js";
+export * from "./toolcallpart.js";
+export * from "./tooldoneevent.js";
+export * from "./toolexecutionfailedstreamingevent.js";
+export * from "./toolexecutionfinishedstreamingevent.js";
+export * from "./toolexecutionstartedstreamingevent.js";
+export * from "./toolfailedevent.js";
+export * from "./toolresultpart.js";
+export * from "./toolreviewdoneevent.js";
+export * from "./toolreviewrequestedevent.js";
+export * from "./toolstartedevent.js";