@orq-ai/node 4.11.0 → 4.12.0-rc.1

package/packages/orq-rc/src/models/operations/invokeagent.ts

@@ -1,775 +0,0 @@
-/*
- * 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 * as components from "../components/index.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-/**
- * Message containing tool execution results
- */
-export const RoleToolMessage = {
-  Tool: "tool",
-} as const;
-/**
- * Message containing tool execution results
- */
-export type RoleToolMessage = ClosedEnum<typeof RoleToolMessage>;
-
-/**
- * Message from the end user
- */
-export const RoleUserMessage = {
-  User: "user",
-} as const;
-/**
- * Message from the end user
- */
-export type RoleUserMessage = ClosedEnum<typeof RoleUserMessage>;
-
-/**
- * Message role (user or tool for continuing executions)
- */
-export type InvokeAgentRole = RoleUserMessage | RoleToolMessage;
-
-/**
- * Message part that can be provided by users. Use "text" for regular messages, "file" for attachments, or "tool_result" when responding to tool call requests.
- */
-export type PublicMessagePart =
-  | components.TextPart
-  | components.FilePart
-  | components.ToolResultPart
-  | components.ErrorPart;
-
-/**
- * The A2A message to send to the agent (user input or tool results)
- */
-export type A2AMessage = {
-  /**
-   * Optional A2A message ID in ULID format
-   */
-  messageId?: string | undefined;
-  /**
-   * Message role (user or tool for continuing executions)
-   */
-  role: RoleUserMessage | RoleToolMessage;
-  /**
-   * A2A message parts (text, file, or tool_result only). Note: Tool role messages must only contain tool_result parts.
-   */
-  parts: Array<
-    | components.TextPart
-    | components.FilePart
-    | components.ToolResultPart
-    | components.ErrorPart
-  >;
-};
-
-/**
- * Information about the identity making the request. If the identity does not exist, it will be created automatically.
- */
-export type Identity = {
-  /**
-   * Unique identifier for the contact
-   */
-  id: string;
-  /**
-   * Display name of the contact
-   */
-  displayName?: string | undefined;
-  /**
-   * Email address of the contact
-   */
-  email?: string | undefined;
-  /**
-   * A hash of key/value pairs containing any other data about the contact
-   */
-  metadata?: Array<{ [k: string]: any }> | undefined;
-  /**
-   * URL to the contact's avatar or logo
-   */
-  logoUrl?: string | undefined;
-  /**
-   * A list of tags associated with the contact
-   */
-  tags?: Array<string> | undefined;
-};
-
-/**
- * @deprecated Use identity instead. Information about the contact making the request.
- *
- * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
- */
-export type Contact = {
-  /**
-   * Unique identifier for the contact
-   */
-  id: string;
-  /**
-   * Display name of the contact
-   */
-  displayName?: string | undefined;
-  /**
-   * Email address of the contact
-   */
-  email?: string | undefined;
-  /**
-   * A hash of key/value pairs containing any other data about the contact
-   */
-  metadata?: Array<{ [k: string]: any }> | undefined;
-  /**
-   * URL to the contact's avatar or logo
-   */
-  logoUrl?: string | undefined;
-  /**
-   * A list of tags associated with the contact
-   */
-  tags?: Array<string> | undefined;
-};
-
-/**
- * Thread information to group related requests
- */
-export type InvokeAgentThread = {
-  /**
-   * Unique thread identifier to group related invocations.
-   */
-  id: string;
-  /**
-   * Optional tags to differentiate or categorize threads
-   */
-  tags?: Array<string> | undefined;
-};
-
-/**
- * Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions.
- */
-export type Memory = {
-  /**
-   * An entity ID used to link memory stores to a specific user, session, or conversation. This ID is used to isolate and retrieve memories specific to the entity across agent executions.
-   */
-  entityId: string;
-};
-
-/**
- * Override template engine for this invocation. If not provided, uses the agent default.
- */
-export const InvokeAgentEngine = {
-  Text: "text",
-  Jinja: "jinja",
-  Mustache: "mustache",
-} as const;
-/**
- * Override template engine for this invocation. If not provided, uses the agent default.
- */
-export type InvokeAgentEngine = ClosedEnum<typeof InvokeAgentEngine>;
-
-/**
- * Configuration options for the agent invocation
- */
-export type Configuration = {
-  /**
-   * Whether to block until the agent task completes. When true, the response will include the full task with messages. When false (default), returns immediately with task ID and status.
-   */
-  blocking?: boolean | undefined;
-};
-
-/**
- * Request body for invoking an existing agent (stream-task endpoint). Used to start a new task or continue an existing conversation.
- */
-export type InvokeAgentA2AInvokeRequest = {
-  /**
-   * Optional task ID to continue an existing agent execution. When provided, the agent will continue the conversation from the existing task state. The task must be in an inactive state to continue.
-   */
-  taskId?: string | undefined;
-  /**
-   * The A2A message to send to the agent (user input or tool results)
-   */
-  message: A2AMessage;
-  /**
-   * Optional variables for template replacement in system prompt, instructions, and messages
-   */
-  variables?: { [k: string]: any } | undefined;
-  /**
-   * Information about the identity making the request. If the identity does not exist, it will be created automatically.
-   */
-  identity?: Identity | undefined;
-  /**
-   * @deprecated Use identity instead. Information about the contact making the request.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  contact?: Contact | undefined;
-  /**
-   * Thread information to group related requests
-   */
-  thread?: InvokeAgentThread | undefined;
-  /**
-   * Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions.
-   */
-  memory?: Memory | undefined;
-  /**
-   * Optional metadata for the agent invocation as key-value pairs that will be included in traces
-   */
-  metadata?: { [k: string]: any } | undefined;
-  /**
-   * Override template engine for this invocation. If not provided, uses the agent default.
-   */
-  engine?: InvokeAgentEngine | undefined;
-  /**
-   * Configuration options for the agent invocation
-   */
-  configuration?: Configuration | undefined;
-};
-
-export type InvokeAgentRequest = {
-  /**
-   * The key or ID of the agent to invoke
-   */
-  key: string;
-  requestBody?: InvokeAgentA2AInvokeRequest | undefined;
-};
-
-/**
- * A2A entity type identifier
- */
-export const Kind = {
-  Task: "task",
-} as const;
-/**
- * A2A entity type identifier
- */
-export type Kind = ClosedEnum<typeof Kind>;
-
-/**
- * Current state of the agent task execution. Values: submitted (queued), working (executing), input-required (awaiting user input), completed (finished successfully), failed (error occurred). Note: auth-required, canceled, and rejected statuses are defined for A2A protocol compatibility but are not currently supported in task execution.
- */
-export const TaskState = {
-  Submitted: "submitted",
-  Working: "working",
-  InputRequired: "input-required",
-  AuthRequired: "auth-required",
-  Completed: "completed",
-  Failed: "failed",
-  Canceled: "canceled",
-  Rejected: "rejected",
-} as const;
-/**
- * Current state of the agent task execution. Values: submitted (queued), working (executing), input-required (awaiting user input), completed (finished successfully), failed (error occurred). Note: auth-required, canceled, and rejected statuses are defined for A2A protocol compatibility but are not currently supported in task execution.
- */
-export type TaskState = ClosedEnum<typeof TaskState>;
-
-export const InvokeAgentKind = {
-  Message: "message",
-} as const;
-export type InvokeAgentKind = ClosedEnum<typeof InvokeAgentKind>;
-
-/**
- * Role of the message sender in the A2A protocol. Values: user (end user), agent (AI agent), tool (tool execution result), system (system instructions/prompts).
- */
-export const ExtendedMessageRole = {
-  User: "user",
-  Agent: "agent",
-  Tool: "tool",
-  System: "system",
-} as const;
-/**
- * Role of the message sender in the A2A protocol. Values: user (end user), agent (AI agent), tool (tool execution result), system (system instructions/prompts).
- */
-export type ExtendedMessageRole = ClosedEnum<typeof ExtendedMessageRole>;
-
-export type Parts =
-  | components.TextPart
-  | components.ErrorPart
-  | components.DataPart
-  | components.FilePart
-  | components.ToolCallPart
-  | components.ToolResultPart;
-
-/**
- * Optional A2A message providing additional context about the current status
- */
-export type TaskStatusMessage = {
-  kind: InvokeAgentKind;
-  messageId: string;
-  /**
-   * Role of the message sender in the A2A protocol. Values: user (end user), agent (AI agent), tool (tool execution result), system (system instructions/prompts).
-   */
-  role: ExtendedMessageRole;
-  parts: Array<
-    | components.TextPart
-    | components.ErrorPart
-    | components.DataPart
-    | components.FilePart
-    | components.ToolCallPart
-    | components.ToolResultPart
-  >;
-};
-
-/**
- * Current task status information
- */
-export type TaskStatus = {
-  /**
-   * Current state of the agent task execution. Values: submitted (queued), working (executing), input-required (awaiting user input), completed (finished successfully), failed (error occurred). Note: auth-required, canceled, and rejected statuses are defined for A2A protocol compatibility but are not currently supported in task execution.
-   */
-  state: TaskState;
-  /**
-   * ISO 8601 timestamp of when the status was updated
-   */
-  timestamp?: string | undefined;
-  /**
-   * Optional A2A message providing additional context about the current status
-   */
-  message?: TaskStatusMessage | undefined;
-};
-
-/**
- * Response format following the Agent-to-Agent (A2A) protocol. Returned when starting or continuing an agent task execution.
- */
-export type InvokeAgentA2ATaskResponse = {
-  /**
-   * The unique ID of the created agent execution task
-   */
-  id: string;
-  /**
-   * The correlation ID for this execution (used for tracking)
-   */
-  contextId: string;
-  /**
-   * A2A entity type identifier
-   */
-  kind: Kind;
-  /**
-   * Current task status information
-   */
-  status: TaskStatus;
-  /**
-   * Array of messages in the task conversation. Only present when blocking mode is enabled.
-   */
-  messages?: Array<components.ExtendedMessage> | undefined;
-  /**
-   * Task metadata containing workspace_id and trace_id for feedback and tracking
-   */
-  metadata?: { [k: string]: any } | undefined;
-};
-
-/** @internal */
-export const RoleToolMessage$outboundSchema: z.ZodNativeEnum<
-  typeof RoleToolMessage
-> = z.nativeEnum(RoleToolMessage);
-
-/** @internal */
-export const RoleUserMessage$outboundSchema: z.ZodNativeEnum<
-  typeof RoleUserMessage
-> = z.nativeEnum(RoleUserMessage);
-
-/** @internal */
-export type InvokeAgentRole$Outbound = string | string;
-
-/** @internal */
-export const InvokeAgentRole$outboundSchema: z.ZodType<
-  InvokeAgentRole$Outbound,
-  z.ZodTypeDef,
-  InvokeAgentRole
-> = z.union([RoleUserMessage$outboundSchema, RoleToolMessage$outboundSchema]);
-
-export function invokeAgentRoleToJSON(
-  invokeAgentRole: InvokeAgentRole,
-): string {
-  return JSON.stringify(InvokeAgentRole$outboundSchema.parse(invokeAgentRole));
-}
-
-/** @internal */
-export type PublicMessagePart$Outbound =
-  | components.TextPart$Outbound
-  | components.FilePart$Outbound
-  | components.ToolResultPart$Outbound
-  | components.ErrorPart$Outbound;
-
-/** @internal */
-export const PublicMessagePart$outboundSchema: z.ZodType<
-  PublicMessagePart$Outbound,
-  z.ZodTypeDef,
-  PublicMessagePart
-> = z.union([
-  components.TextPart$outboundSchema,
-  components.FilePart$outboundSchema,
-  components.ToolResultPart$outboundSchema,
-  components.ErrorPart$outboundSchema,
-]);
-
-export function publicMessagePartToJSON(
-  publicMessagePart: PublicMessagePart,
-): string {
-  return JSON.stringify(
-    PublicMessagePart$outboundSchema.parse(publicMessagePart),
-  );
-}
-
-/** @internal */
-export type A2AMessage$Outbound = {
-  messageId?: string | undefined;
-  role: string | string;
-  parts: Array<
-    | components.TextPart$Outbound
-    | components.FilePart$Outbound
-    | components.ToolResultPart$Outbound
-    | components.ErrorPart$Outbound
-  >;
-};
-
-/** @internal */
-export const A2AMessage$outboundSchema: z.ZodType<
-  A2AMessage$Outbound,
-  z.ZodTypeDef,
-  A2AMessage
-> = z.object({
-  messageId: z.string().optional(),
-  role: z.union([
-    RoleUserMessage$outboundSchema,
-    RoleToolMessage$outboundSchema,
-  ]),
-  parts: z.array(
-    z.union([
-      components.TextPart$outboundSchema,
-      components.FilePart$outboundSchema,
-      components.ToolResultPart$outboundSchema,
-      components.ErrorPart$outboundSchema,
-    ]),
-  ),
-});
-
-export function a2AMessageToJSON(a2AMessage: A2AMessage): string {
-  return JSON.stringify(A2AMessage$outboundSchema.parse(a2AMessage));
-}
-
-/** @internal */
-export type Identity$Outbound = {
-  id: string;
-  display_name?: string | undefined;
-  email?: string | undefined;
-  metadata?: Array<{ [k: string]: any }> | undefined;
-  logo_url?: string | undefined;
-  tags?: Array<string> | undefined;
-};
-
-/** @internal */
-export const Identity$outboundSchema: z.ZodType<
-  Identity$Outbound,
-  z.ZodTypeDef,
-  Identity
-> = z.object({
-  id: z.string(),
-  displayName: z.string().optional(),
-  email: z.string().optional(),
-  metadata: z.array(z.record(z.any())).optional(),
-  logoUrl: z.string().optional(),
-  tags: z.array(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    displayName: "display_name",
-    logoUrl: "logo_url",
-  });
-});
-
-export function identityToJSON(identity: Identity): string {
-  return JSON.stringify(Identity$outboundSchema.parse(identity));
-}
-
-/** @internal */
-export type Contact$Outbound = {
-  id: string;
-  display_name?: string | undefined;
-  email?: string | undefined;
-  metadata?: Array<{ [k: string]: any }> | undefined;
-  logo_url?: string | undefined;
-  tags?: Array<string> | undefined;
-};
-
-/** @internal */
-export const Contact$outboundSchema: z.ZodType<
-  Contact$Outbound,
-  z.ZodTypeDef,
-  Contact
-> = z.object({
-  id: z.string(),
-  displayName: z.string().optional(),
-  email: z.string().optional(),
-  metadata: z.array(z.record(z.any())).optional(),
-  logoUrl: z.string().optional(),
-  tags: z.array(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    displayName: "display_name",
-    logoUrl: "logo_url",
-  });
-});
-
-export function contactToJSON(contact: Contact): string {
-  return JSON.stringify(Contact$outboundSchema.parse(contact));
-}
-
-/** @internal */
-export type InvokeAgentThread$Outbound = {
-  id: string;
-  tags?: Array<string> | undefined;
-};
-
-/** @internal */
-export const InvokeAgentThread$outboundSchema: z.ZodType<
-  InvokeAgentThread$Outbound,
-  z.ZodTypeDef,
-  InvokeAgentThread
-> = z.object({
-  id: z.string(),
-  tags: z.array(z.string()).optional(),
-});
-
-export function invokeAgentThreadToJSON(
-  invokeAgentThread: InvokeAgentThread,
-): string {
-  return JSON.stringify(
-    InvokeAgentThread$outboundSchema.parse(invokeAgentThread),
-  );
-}
-
-/** @internal */
-export type Memory$Outbound = {
-  entity_id: string;
-};
-
-/** @internal */
-export const Memory$outboundSchema: z.ZodType<
-  Memory$Outbound,
-  z.ZodTypeDef,
-  Memory
-> = z.object({
-  entityId: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    entityId: "entity_id",
-  });
-});
-
-export function memoryToJSON(memory: Memory): string {
-  return JSON.stringify(Memory$outboundSchema.parse(memory));
-}
-
-/** @internal */
-export const InvokeAgentEngine$outboundSchema: z.ZodNativeEnum<
-  typeof InvokeAgentEngine
-> = z.nativeEnum(InvokeAgentEngine);
-
-/** @internal */
-export type Configuration$Outbound = {
-  blocking: boolean;
-};
-
-/** @internal */
-export const Configuration$outboundSchema: z.ZodType<
-  Configuration$Outbound,
-  z.ZodTypeDef,
-  Configuration
-> = z.object({
-  blocking: z.boolean().default(false),
-});
-
-export function configurationToJSON(configuration: Configuration): string {
-  return JSON.stringify(Configuration$outboundSchema.parse(configuration));
-}
-
-/** @internal */
-export type InvokeAgentA2AInvokeRequest$Outbound = {
-  task_id?: string | undefined;
-  message: A2AMessage$Outbound;
-  variables?: { [k: string]: any } | undefined;
-  identity?: Identity$Outbound | undefined;
-  contact?: Contact$Outbound | undefined;
-  thread?: InvokeAgentThread$Outbound | undefined;
-  memory?: Memory$Outbound | undefined;
-  metadata?: { [k: string]: any } | undefined;
-  engine?: string | undefined;
-  configuration?: Configuration$Outbound | undefined;
-};
-
-/** @internal */
-export const InvokeAgentA2AInvokeRequest$outboundSchema: z.ZodType<
-  InvokeAgentA2AInvokeRequest$Outbound,
-  z.ZodTypeDef,
-  InvokeAgentA2AInvokeRequest
-> = z.object({
-  taskId: z.string().optional(),
-  message: z.lazy(() => A2AMessage$outboundSchema),
-  variables: z.record(z.any()).optional(),
-  identity: z.lazy(() => Identity$outboundSchema).optional(),
-  contact: z.lazy(() => Contact$outboundSchema).optional(),
-  thread: z.lazy(() => InvokeAgentThread$outboundSchema).optional(),
-  memory: z.lazy(() => Memory$outboundSchema).optional(),
-  metadata: z.record(z.any()).optional(),
-  engine: InvokeAgentEngine$outboundSchema.optional(),
-  configuration: z.lazy(() => Configuration$outboundSchema).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    taskId: "task_id",
-  });
-});
-
-export function invokeAgentA2AInvokeRequestToJSON(
-  invokeAgentA2AInvokeRequest: InvokeAgentA2AInvokeRequest,
-): string {
-  return JSON.stringify(
-    InvokeAgentA2AInvokeRequest$outboundSchema.parse(
-      invokeAgentA2AInvokeRequest,
-    ),
-  );
-}
-
-/** @internal */
-export type InvokeAgentRequest$Outbound = {
-  key: string;
-  RequestBody?: InvokeAgentA2AInvokeRequest$Outbound | undefined;
-};
-
-/** @internal */
-export const InvokeAgentRequest$outboundSchema: z.ZodType<
-  InvokeAgentRequest$Outbound,
-  z.ZodTypeDef,
-  InvokeAgentRequest
-> = z.object({
-  key: z.string(),
-  requestBody: z.lazy(() => InvokeAgentA2AInvokeRequest$outboundSchema)
-    .optional(),
-}).transform((v) => {
-  return remap$(v, {
-    requestBody: "RequestBody",
-  });
-});
-
-export function invokeAgentRequestToJSON(
-  invokeAgentRequest: InvokeAgentRequest,
-): string {
-  return JSON.stringify(
-    InvokeAgentRequest$outboundSchema.parse(invokeAgentRequest),
-  );
-}
-
-/** @internal */
-export const Kind$inboundSchema: z.ZodNativeEnum<typeof Kind> = z.nativeEnum(
-  Kind,
-);
-
-/** @internal */
-export const TaskState$inboundSchema: z.ZodNativeEnum<typeof TaskState> = z
-  .nativeEnum(TaskState);
-
-/** @internal */
-export const InvokeAgentKind$inboundSchema: z.ZodNativeEnum<
-  typeof InvokeAgentKind
-> = z.nativeEnum(InvokeAgentKind);
-
-/** @internal */
-export const ExtendedMessageRole$inboundSchema: z.ZodNativeEnum<
-  typeof ExtendedMessageRole
-> = z.nativeEnum(ExtendedMessageRole);
-
-/** @internal */
-export const Parts$inboundSchema: z.ZodType<Parts, z.ZodTypeDef, unknown> = z
-  .union([
-    components.TextPart$inboundSchema,
-    components.ErrorPart$inboundSchema,
-    components.DataPart$inboundSchema,
-    components.FilePart$inboundSchema,
-    components.ToolCallPart$inboundSchema,
-    components.ToolResultPart$inboundSchema,
-  ]);
-
-export function partsFromJSON(
-  jsonString: string,
-): SafeParseResult<Parts, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Parts$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Parts' from JSON`,
-  );
-}
-
-/** @internal */
-export const TaskStatusMessage$inboundSchema: z.ZodType<
-  TaskStatusMessage,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  kind: InvokeAgentKind$inboundSchema,
-  messageId: z.string(),
-  role: ExtendedMessageRole$inboundSchema,
-  parts: z.array(
-    z.union([
-      components.TextPart$inboundSchema,
-      components.ErrorPart$inboundSchema,
-      components.DataPart$inboundSchema,
-      components.FilePart$inboundSchema,
-      components.ToolCallPart$inboundSchema,
-      components.ToolResultPart$inboundSchema,
-    ]),
-  ),
-});
-
-export function taskStatusMessageFromJSON(
-  jsonString: string,
-): SafeParseResult<TaskStatusMessage, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => TaskStatusMessage$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'TaskStatusMessage' from JSON`,
-  );
-}
-
-/** @internal */
-export const TaskStatus$inboundSchema: z.ZodType<
-  TaskStatus,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  state: TaskState$inboundSchema,
-  timestamp: z.string().optional(),
-  message: z.lazy(() => TaskStatusMessage$inboundSchema).optional(),
-});
-
-export function taskStatusFromJSON(
-  jsonString: string,
-): SafeParseResult<TaskStatus, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => TaskStatus$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'TaskStatus' from JSON`,
-  );
-}
-
-/** @internal */
-export const InvokeAgentA2ATaskResponse$inboundSchema: z.ZodType<
-  InvokeAgentA2ATaskResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  id: z.string(),
-  contextId: z.string(),
-  kind: Kind$inboundSchema,
-  status: z.lazy(() => TaskStatus$inboundSchema),
-  messages: z.array(components.ExtendedMessage$inboundSchema).optional(),
-  metadata: z.record(z.any()).optional(),
-});
-
-export function invokeAgentA2ATaskResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<InvokeAgentA2ATaskResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => InvokeAgentA2ATaskResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'InvokeAgentA2ATaskResponse' from JSON`,
-  );
-}