@orq-ai/node 4.4.12 → 4.4.14

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/index.ts

@@ -20,8 +20,10 @@ 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";
@@ -39,6 +41,7 @@ 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";

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

@@ -76,7 +76,7 @@ export const PartReasoningPart$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("reasoning_01kjsjh584s9m498bpvtnqhzmc"),
+  _id: z.string().default("reasoning_01kjz6j2j4jm79rvv8nmq2wm7m"),
   metadata: z.record(z.any()).optional(),
   kind: PartKind$inboundSchema,
   reasoning: z.string(),

package/packages/orq-rc/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_01kjsjh57qyxek3wcv6b4st35j"),
+  _id: z.string().default("reasoning_01kjz6j2hwc2e1ea5npjnhgvmy"),
   metadata: z.record(z.any()).optional(),
   kind: z.literal("reasoning"),
   reasoning: z.string(),

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

@@ -8,6 +8,7 @@ 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
@@ -110,6 +111,10 @@ export type ResponseDoneEventData = {
    * 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;
 };
 
 /**
@@ -284,6 +289,7 @@ export const ResponseDoneEventData$inboundSchema: z.ZodType<
   pendingToolCalls: z.array(
     z.lazy(() => ResponseDoneEventPendingToolCalls$inboundSchema),
   ).optional(),
+  telemetry: Telemetry$inboundSchema.optional(),
 });
 
 export function responseDoneEventDataFromJSON(

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

@@ -6,6 +6,7 @@ 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";
+import { Telemetry, Telemetry$inboundSchema } from "./telemetry.js";
 
 export type Data = {
   /**
@@ -34,6 +35,10 @@ export type Data = {
    * Server-generated ID for the assistant message. Use this ID for frontend state consistency.
    */
   assistantMessageId?: string | undefined;
+  /**
+   * Telemetry information for correlating the response with traces
+   */
+  telemetry?: Telemetry | undefined;
 };
 
 /**
@@ -57,6 +62,7 @@ export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
     workflowRunId: z.string(),
     userMessageId: z.string().optional(),
     assistantMessageId: z.string().optional(),
+    telemetry: Telemetry$inboundSchema.optional(),
   });
 
 export function dataFromJSON(

package/packages/orq-rc/src/models/components/telemetry.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";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Telemetry information for correlating the response with traces
+ */
+export type Telemetry = {
+  /**
+   * The root trace ID for the agent execution
+   */
+  traceId: string;
+  /**
+   * The span ID of the agent execution within the trace
+   */
+  spanId: string;
+};
+
+/** @internal */
+export const Telemetry$inboundSchema: z.ZodType<
+  Telemetry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  trace_id: z.string(),
+  span_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "trace_id": "traceId",
+    "span_id": "spanId",
+  });
+});
+
+export function telemetryFromJSON(
+  jsonString: string,
+): SafeParseResult<Telemetry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Telemetry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Telemetry' from JSON`,
+  );
+}

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

@@ -20,6 +20,8 @@ export * from "./honoapierror.js";
 export * from "./httpclienterrors.js";
 export * from "./invokeeval.js";
 export * from "./orqerror.js";
+export * from "./postv2agentsa2a.js";
+export * from "./postv2agentskeycardrefresh.js";
 export * from "./responsevalidationerror.js";
 export * from "./retrieveagentrequest.js";
 export * from "./retrieveidentity.js";

package/packages/orq-rc/src/models/errors/postv2agentsa2a.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { OrqError } from "./orqerror.js";
+
+/**
+ * Agent with this key already exists
+ */
+export type PostV2AgentsA2aAgentsResponseBodyData = {
+  message: string;
+};
+
+/**
+ * Agent with this key already exists
+ */
+export class PostV2AgentsA2aAgentsResponseBody extends OrqError {
+  /** The original data that was passed to this error instance. */
+  data$: PostV2AgentsA2aAgentsResponseBodyData;
+
+  constructor(
+    err: PostV2AgentsA2aAgentsResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+
+    this.name = "PostV2AgentsA2aAgentsResponseBody";
+  }
+}
+
+/**
+ * Invalid request or agent card fetch failed
+ */
+export type PostV2AgentsA2aResponseBodyData = {
+  message: string;
+};
+
+/**
+ * Invalid request or agent card fetch failed
+ */
+export class PostV2AgentsA2aResponseBody extends OrqError {
+  /** The original data that was passed to this error instance. */
+  data$: PostV2AgentsA2aResponseBodyData;
+
+  constructor(
+    err: PostV2AgentsA2aResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+
+    this.name = "PostV2AgentsA2aResponseBody";
+  }
+}
+
+/** @internal */
+export const PostV2AgentsA2aAgentsResponseBody$inboundSchema: z.ZodType<
+  PostV2AgentsA2aAgentsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new PostV2AgentsA2aAgentsResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const PostV2AgentsA2aResponseBody$inboundSchema: z.ZodType<
+  PostV2AgentsA2aResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new PostV2AgentsA2aResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/packages/orq-rc/src/models/errors/postv2agentskeycardrefresh.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { OrqError } from "./orqerror.js";
+
+/**
+ * Agent not found
+ */
+export type PostV2AgentsKeyCardRefreshAgentsResponseBodyData = {
+  message: string;
+};
+
+/**
+ * Agent not found
+ */
+export class PostV2AgentsKeyCardRefreshAgentsResponseBody extends OrqError {
+  /** The original data that was passed to this error instance. */
+  data$: PostV2AgentsKeyCardRefreshAgentsResponseBodyData;
+
+  constructor(
+    err: PostV2AgentsKeyCardRefreshAgentsResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+
+    this.name = "PostV2AgentsKeyCardRefreshAgentsResponseBody";
+  }
+}
+
+/**
+ * Invalid request - Agent is not an A2A agent or card fetch failed
+ */
+export type PostV2AgentsKeyCardRefreshResponseBodyData = {
+  message: string;
+};
+
+/**
+ * Invalid request - Agent is not an A2A agent or card fetch failed
+ */
+export class PostV2AgentsKeyCardRefreshResponseBody extends OrqError {
+  /** The original data that was passed to this error instance. */
+  data$: PostV2AgentsKeyCardRefreshResponseBodyData;
+
+  constructor(
+    err: PostV2AgentsKeyCardRefreshResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+
+    this.name = "PostV2AgentsKeyCardRefreshResponseBody";
+  }
+}
+
+/** @internal */
+export const PostV2AgentsKeyCardRefreshAgentsResponseBody$inboundSchema:
+  z.ZodType<
+    PostV2AgentsKeyCardRefreshAgentsResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    message: z.string(),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new PostV2AgentsKeyCardRefreshAgentsResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const PostV2AgentsKeyCardRefreshResponseBody$inboundSchema: z.ZodType<
+  PostV2AgentsKeyCardRefreshResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new PostV2AgentsKeyCardRefreshResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });