@orq-ai/node 4.11.0-rc.28 → 4.11.0-rc.29

package/src/models/components/agentresponserequest.ts

@@ -0,0 +1,565 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import {
+  ErrorPart,
+  ErrorPart$Outbound,
+  ErrorPart$outboundSchema,
+} from "./errorpart.js";
+import {
+  FilePart,
+  FilePart$Outbound,
+  FilePart$outboundSchema,
+} from "./filepart.js";
+import {
+  TextPart,
+  TextPart$Outbound,
+  TextPart$outboundSchema,
+} from "./textpart.js";
+import {
+  ToolResultPart,
+  ToolResultPart$Outbound,
+  ToolResultPart$outboundSchema,
+} from "./toolresultpart.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 AgentResponseRequestRole = 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 =
+  | TextPart
+  | FilePart
+  | ToolResultPart
+  | 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<TextPart | FilePart | ToolResultPart | ErrorPart>;
+};
+
+/**
+ * Information about the identity making the request. If the identity does not exist, it will be created automatically.
+ */
+export type AgentResponseRequestIdentity = {
+  /**
+   * 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 AgentResponseRequestThread = {
+  /**
+   * 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 Engine = {
+  Text: "text",
+  Jinja: "jinja",
+  Mustache: "mustache",
+} as const;
+/**
+ * Override template engine for this invocation. If not provided, uses the agent default.
+ */
+export type Engine = ClosedEnum<typeof Engine>;
+
+/**
+ * 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;
+};
+
+/**
+ * Conversation context for chat studio integration
+ */
+export type Conversation = {
+  /**
+   * Unique ULID identifier for the conversation, prefixed with "conv_". Used to link agent executions to a specific conversation thread.
+   */
+  id: string;
+};
+
+/**
+ * Request body for creating an agent response. Extends A2AInvokeRequest with response options. Matches POST /v2/agents/{key}/responses
+ */
+export type AgentResponseRequest = {
+  /**
+   * 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?: AgentResponseRequestIdentity | 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?: AgentResponseRequestThread | 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?: Engine | undefined;
+  /**
+   * Configuration options for the agent invocation
+   */
+  configuration?: Configuration | undefined;
+  /**
+   * If true, returns immediately without waiting for completion. If false (default), waits until the agent becomes inactive or errors.
+   */
+  background?: boolean | undefined;
+  /**
+   * If true, returns Server-Sent Events (SSE) streaming response with real-time events. If false (default), returns standard JSON response.
+   */
+  stream?: boolean | undefined;
+  /**
+   * Conversation context for chat studio integration
+   */
+  conversation?: Conversation | 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 AgentResponseRequestRole$Outbound = string | string;
+
+/** @internal */
+export const AgentResponseRequestRole$outboundSchema: z.ZodType<
+  AgentResponseRequestRole$Outbound,
+  z.ZodTypeDef,
+  AgentResponseRequestRole
+> = z.union([RoleUserMessage$outboundSchema, RoleToolMessage$outboundSchema]);
+
+export function agentResponseRequestRoleToJSON(
+  agentResponseRequestRole: AgentResponseRequestRole,
+): string {
+  return JSON.stringify(
+    AgentResponseRequestRole$outboundSchema.parse(agentResponseRequestRole),
+  );
+}
+
+/** @internal */
+export type PublicMessagePart$Outbound =
+  | TextPart$Outbound
+  | FilePart$Outbound
+  | ToolResultPart$Outbound
+  | ErrorPart$Outbound;
+
+/** @internal */
+export const PublicMessagePart$outboundSchema: z.ZodType<
+  PublicMessagePart$Outbound,
+  z.ZodTypeDef,
+  PublicMessagePart
+> = z.union([
+  TextPart$outboundSchema,
+  FilePart$outboundSchema,
+  ToolResultPart$outboundSchema,
+  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<
+    | TextPart$Outbound
+    | FilePart$Outbound
+    | ToolResultPart$Outbound
+    | 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([
+      TextPart$outboundSchema,
+      FilePart$outboundSchema,
+      ToolResultPart$outboundSchema,
+      ErrorPart$outboundSchema,
+    ]),
+  ),
+});
+
+export function a2AMessageToJSON(a2AMessage: A2AMessage): string {
+  return JSON.stringify(A2AMessage$outboundSchema.parse(a2AMessage));
+}
+
+/** @internal */
+export type AgentResponseRequestIdentity$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 AgentResponseRequestIdentity$outboundSchema: z.ZodType<
+  AgentResponseRequestIdentity$Outbound,
+  z.ZodTypeDef,
+  AgentResponseRequestIdentity
+> = 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 agentResponseRequestIdentityToJSON(
+  agentResponseRequestIdentity: AgentResponseRequestIdentity,
+): string {
+  return JSON.stringify(
+    AgentResponseRequestIdentity$outboundSchema.parse(
+      agentResponseRequestIdentity,
+    ),
+  );
+}
+
+/** @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 AgentResponseRequestThread$Outbound = {
+  id: string;
+  tags?: Array<string> | undefined;
+};
+
+/** @internal */
+export const AgentResponseRequestThread$outboundSchema: z.ZodType<
+  AgentResponseRequestThread$Outbound,
+  z.ZodTypeDef,
+  AgentResponseRequestThread
+> = z.object({
+  id: z.string(),
+  tags: z.array(z.string()).optional(),
+});
+
+export function agentResponseRequestThreadToJSON(
+  agentResponseRequestThread: AgentResponseRequestThread,
+): string {
+  return JSON.stringify(
+    AgentResponseRequestThread$outboundSchema.parse(agentResponseRequestThread),
+  );
+}
+
+/** @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 Engine$outboundSchema: z.ZodNativeEnum<typeof Engine> = z
+  .nativeEnum(Engine);
+
+/** @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 Conversation$Outbound = {
+  _id: string;
+};
+
+/** @internal */
+export const Conversation$outboundSchema: z.ZodType<
+  Conversation$Outbound,
+  z.ZodTypeDef,
+  Conversation
+> = z.object({
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+  });
+});
+
+export function conversationToJSON(conversation: Conversation): string {
+  return JSON.stringify(Conversation$outboundSchema.parse(conversation));
+}
+
+/** @internal */
+export type AgentResponseRequest$Outbound = {
+  task_id?: string | undefined;
+  message: A2AMessage$Outbound;
+  variables?: { [k: string]: any } | undefined;
+  identity?: AgentResponseRequestIdentity$Outbound | undefined;
+  contact?: Contact$Outbound | undefined;
+  thread?: AgentResponseRequestThread$Outbound | undefined;
+  memory?: Memory$Outbound | undefined;
+  metadata?: { [k: string]: any } | undefined;
+  engine?: string | undefined;
+  configuration?: Configuration$Outbound | undefined;
+  background: boolean;
+  stream: boolean;
+  conversation?: Conversation$Outbound | undefined;
+};
+
+/** @internal */
+export const AgentResponseRequest$outboundSchema: z.ZodType<
+  AgentResponseRequest$Outbound,
+  z.ZodTypeDef,
+  AgentResponseRequest
+> = z.object({
+  taskId: z.string().optional(),
+  message: z.lazy(() => A2AMessage$outboundSchema),
+  variables: z.record(z.any()).optional(),
+  identity: z.lazy(() => AgentResponseRequestIdentity$outboundSchema)
+    .optional(),
+  contact: z.lazy(() => Contact$outboundSchema).optional(),
+  thread: z.lazy(() => AgentResponseRequestThread$outboundSchema).optional(),
+  memory: z.lazy(() => Memory$outboundSchema).optional(),
+  metadata: z.record(z.any()).optional(),
+  engine: Engine$outboundSchema.optional(),
+  configuration: z.lazy(() => Configuration$outboundSchema).optional(),
+  background: z.boolean().default(false),
+  stream: z.boolean().default(false),
+  conversation: z.lazy(() => Conversation$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    taskId: "task_id",
+  });
+});
+
+export function agentResponseRequestToJSON(
+  agentResponseRequest: AgentResponseRequest,
+): string {
+  return JSON.stringify(
+    AgentResponseRequest$outboundSchema.parse(agentResponseRequest),
+  );
+}