@orq-ai/node 3.12.13 → 3.12.16

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

@@ -103,7 +103,7 @@ export type PartsKind = ClosedEnum<typeof PartsKind>;
 
 export type Parts2 = {
   kind: PartsKind;
-  data?: any | undefined;
+  data: { [k: string]: any };
   metadata?: { [k: string]: any } | undefined;
 };
 
@@ -117,7 +117,7 @@ export type Parts1 = {
   text: string;
 };
 
-export type Parts = Parts4 | Parts1 | Parts3 | Five | Parts2;
+export type Parts = Parts4 | Parts1 | Parts2 | Parts3 | Five;
 
 /**
  * The A2A format message containing the task for the agent to perform.
@@ -134,13 +134,57 @@ export type Message = {
   /**
    * A2A message parts
    */
-  parts: Array<Parts4 | Parts1 | Parts3 | Five | Parts2>;
+  parts: Array<Parts4 | Parts1 | Parts2 | Parts3 | Five>;
   /**
    * Optional message metadata
    */
   metadata?: { [k: string]: any } | undefined;
 };
 
+/**
+ * Information about the contact making the request. If the contact does not exist, it will be created automatically.
+ */
+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 RunAgentThread = {
+  /**
+   * 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.
  */
@@ -327,7 +371,7 @@ export type Twelve = {
   /**
    * The path where the entity is stored in the project structure. The first element of the path always represents the project name. Any subsequent path element after the project will be created as a folder in the project if it does not exists.
    */
-  path: string;
+  path?: string | undefined;
   /**
    * Unique key of the tool as it will be displayed in the UI
    */
@@ -570,9 +614,13 @@ export type RunAgentRequestBody = {
    */
   variables?: { [k: string]: any } | undefined;
   /**
-   * Optional context ID that maps to thread_id
+   * Information about the contact making the request. If the contact does not exist, it will be created automatically.
+   */
+  contact?: Contact | undefined;
+  /**
+   * Thread information to group related requests
    */
-  contextId?: string | undefined;
+  thread?: RunAgentThread | undefined;
   /**
    * Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions.
    */
@@ -585,10 +633,6 @@ export type RunAgentRequestBody = {
    * A brief summary of the agent's purpose.
    */
   description?: string | undefined;
-  /**
-   * Optional URL to an icon for the agent
-   */
-  iconUrl?: string | undefined;
   /**
    * A custom system prompt template for the agent. If omitted, the default template is used.
    */
@@ -600,6 +644,10 @@ export type RunAgentRequestBody = {
    */
   teamOfAgents?: Array<TeamOfAgents> | undefined;
   settings: Settings;
+  /**
+   * Optional metadata for the agent run as key-value pairs that will be included in traces
+   */
+  metadata?: { [k: string]: any } | undefined;
 };
 
 /**
@@ -1223,14 +1271,14 @@ export namespace PartsKind$ {
 export const Parts2$inboundSchema: z.ZodType<Parts2, z.ZodTypeDef, unknown> = z
   .object({
     kind: PartsKind$inboundSchema,
-    data: z.any().optional(),
+    data: z.record(z.any()),
     metadata: z.record(z.any()).optional(),
   });
 
 /** @internal */
 export type Parts2$Outbound = {
   kind: string;
-  data?: any | undefined;
+  data: { [k: string]: any };
   metadata?: { [k: string]: any } | undefined;
 };
 
@@ -1241,7 +1289,7 @@ export const Parts2$outboundSchema: z.ZodType<
   Parts2
 > = z.object({
   kind: PartsKind$outboundSchema,
-  data: z.any().optional(),
+  data: z.record(z.any()),
   metadata: z.record(z.any()).optional(),
 });
 
@@ -1347,18 +1395,18 @@ export const Parts$inboundSchema: z.ZodType<Parts, z.ZodTypeDef, unknown> = z
   .union([
     z.lazy(() => Parts4$inboundSchema),
     z.lazy(() => Parts1$inboundSchema),
+    z.lazy(() => Parts2$inboundSchema),
     z.lazy(() => Parts3$inboundSchema),
     z.lazy(() => Five$inboundSchema),
-    z.lazy(() => Parts2$inboundSchema),
   ]);
 
 /** @internal */
 export type Parts$Outbound =
   | Parts4$Outbound
   | Parts1$Outbound
+  | Parts2$Outbound
   | Parts3$Outbound
-  | Five$Outbound
-  | Parts2$Outbound;
+  | Five$Outbound;
 
 /** @internal */
 export const Parts$outboundSchema: z.ZodType<
@@ -1368,9 +1416,9 @@ export const Parts$outboundSchema: z.ZodType<
 > = z.union([
   z.lazy(() => Parts4$outboundSchema),
   z.lazy(() => Parts1$outboundSchema),
+  z.lazy(() => Parts2$outboundSchema),
   z.lazy(() => Parts3$outboundSchema),
   z.lazy(() => Five$outboundSchema),
-  z.lazy(() => Parts2$outboundSchema),
 ]);
 
 /**
@@ -1409,9 +1457,9 @@ export const Message$inboundSchema: z.ZodType<Message, z.ZodTypeDef, unknown> =
       z.union([
         z.lazy(() => Parts4$inboundSchema),
         z.lazy(() => Parts1$inboundSchema),
+        z.lazy(() => Parts2$inboundSchema),
         z.lazy(() => Parts3$inboundSchema),
         z.lazy(() => Five$inboundSchema),
-        z.lazy(() => Parts2$inboundSchema),
       ]),
     ),
     metadata: z.record(z.any()).optional(),
@@ -1424,9 +1472,9 @@ export type Message$Outbound = {
   parts: Array<
     | Parts4$Outbound
     | Parts1$Outbound
+    | Parts2$Outbound
     | Parts3$Outbound
     | Five$Outbound
-    | Parts2$Outbound
   >;
   metadata?: { [k: string]: any } | undefined;
 };
@@ -1443,9 +1491,9 @@ export const Message$outboundSchema: z.ZodType<
     z.union([
       z.lazy(() => Parts4$outboundSchema),
       z.lazy(() => Parts1$outboundSchema),
+      z.lazy(() => Parts2$outboundSchema),
       z.lazy(() => Parts3$outboundSchema),
       z.lazy(() => Five$outboundSchema),
-      z.lazy(() => Parts2$outboundSchema),
     ]),
   ),
   metadata: z.record(z.any()).optional(),
@@ -1478,6 +1526,131 @@ export function messageFromJSON(
   );
 }
 
+/** @internal */
+export const Contact$inboundSchema: z.ZodType<Contact, z.ZodTypeDef, unknown> =
+  z.object({
+    id: z.string(),
+    display_name: z.string().optional(),
+    email: z.string().optional(),
+    metadata: z.array(z.record(z.any())).optional(),
+    logo_url: z.string().optional(),
+    tags: z.array(z.string()).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "display_name": "displayName",
+      "logo_url": "logoUrl",
+    });
+  });
+
+/** @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",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Contact$ {
+  /** @deprecated use `Contact$inboundSchema` instead. */
+  export const inboundSchema = Contact$inboundSchema;
+  /** @deprecated use `Contact$outboundSchema` instead. */
+  export const outboundSchema = Contact$outboundSchema;
+  /** @deprecated use `Contact$Outbound` instead. */
+  export type Outbound = Contact$Outbound;
+}
+
+export function contactToJSON(contact: Contact): string {
+  return JSON.stringify(Contact$outboundSchema.parse(contact));
+}
+
+export function contactFromJSON(
+  jsonString: string,
+): SafeParseResult<Contact, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Contact$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Contact' from JSON`,
+  );
+}
+
+/** @internal */
+export const RunAgentThread$inboundSchema: z.ZodType<
+  RunAgentThread,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  tags: z.array(z.string()).optional(),
+});
+
+/** @internal */
+export type RunAgentThread$Outbound = {
+  id: string;
+  tags?: Array<string> | undefined;
+};
+
+/** @internal */
+export const RunAgentThread$outboundSchema: z.ZodType<
+  RunAgentThread$Outbound,
+  z.ZodTypeDef,
+  RunAgentThread
+> = z.object({
+  id: z.string(),
+  tags: z.array(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RunAgentThread$ {
+  /** @deprecated use `RunAgentThread$inboundSchema` instead. */
+  export const inboundSchema = RunAgentThread$inboundSchema;
+  /** @deprecated use `RunAgentThread$outboundSchema` instead. */
+  export const outboundSchema = RunAgentThread$outboundSchema;
+  /** @deprecated use `RunAgentThread$Outbound` instead. */
+  export type Outbound = RunAgentThread$Outbound;
+}
+
+export function runAgentThreadToJSON(runAgentThread: RunAgentThread): string {
+  return JSON.stringify(RunAgentThread$outboundSchema.parse(runAgentThread));
+}
+
+export function runAgentThreadFromJSON(
+  jsonString: string,
+): SafeParseResult<RunAgentThread, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RunAgentThread$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RunAgentThread' from JSON`,
+  );
+}
+
 /** @internal */
 export const Memory$inboundSchema: z.ZodType<Memory, z.ZodTypeDef, unknown> = z
   .object({
@@ -2317,8 +2490,8 @@ export function httpFromJSON(
 /** @internal */
 export const Twelve$inboundSchema: z.ZodType<Twelve, z.ZodTypeDef, unknown> = z
   .object({
-    _id: z.string().default("01K5ENCKSWHJKG9277SMJ4E28Y"),
-    path: z.string(),
+    _id: z.string().default("01K5X16BV17ZPH27JT1JZGNS5R"),
+    path: z.string().optional(),
     key: z.string(),
     display_name: z.string(),
     description: z.string(),
@@ -2339,7 +2512,7 @@ export const Twelve$inboundSchema: z.ZodType<Twelve, z.ZodTypeDef, unknown> = z
 /** @internal */
 export type Twelve$Outbound = {
   _id: string;
-  path: string;
+  path?: string | undefined;
   key: string;
   display_name: string;
   description: string;
@@ -2356,8 +2529,8 @@ export const Twelve$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Twelve
 > = z.object({
-  id: z.string().default("01K5ENCKSWHJKG9277SMJ4E28Y"),
-  path: z.string(),
+  id: z.string().default("01K5X16BV17ZPH27JT1JZGNS5R"),
+  path: z.string().optional(),
   key: z.string(),
   displayName: z.string(),
   description: z.string(),
@@ -3508,17 +3681,18 @@ export const RunAgentRequestBody$inboundSchema: z.ZodType<
   instructions: z.string(),
   message: z.lazy(() => Message$inboundSchema),
   variables: z.record(z.any()).optional(),
-  contextId: z.string().optional(),
+  contact: z.lazy(() => Contact$inboundSchema).optional(),
+  thread: z.lazy(() => RunAgentThread$inboundSchema).optional(),
   memory: z.lazy(() => Memory$inboundSchema).optional(),
   path: z.string(),
   description: z.string().optional(),
-  iconUrl: z.string().optional(),
   system_prompt: z.string().optional(),
   memory_stores: z.array(z.string()).optional(),
   knowledge_bases: z.array(z.lazy(() => KnowledgeBases$inboundSchema))
     .optional(),
   team_of_agents: z.array(z.lazy(() => TeamOfAgents$inboundSchema)).optional(),
   settings: z.lazy(() => Settings$inboundSchema),
+  metadata: z.record(z.any()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "fallback_models": "fallbackModels",
@@ -3539,16 +3713,17 @@ export type RunAgentRequestBody$Outbound = {
   instructions: string;
   message: Message$Outbound;
   variables?: { [k: string]: any } | undefined;
-  contextId?: string | undefined;
+  contact?: Contact$Outbound | undefined;
+  thread?: RunAgentThread$Outbound | undefined;
   memory?: Memory$Outbound | undefined;
   path: string;
   description?: string | undefined;
-  iconUrl?: string | undefined;
   system_prompt?: string | undefined;
   memory_stores?: Array<string> | undefined;
   knowledge_bases?: Array<KnowledgeBases$Outbound> | undefined;
   team_of_agents?: Array<TeamOfAgents$Outbound> | undefined;
   settings: Settings$Outbound;
+  metadata?: { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -3565,17 +3740,18 @@ export const RunAgentRequestBody$outboundSchema: z.ZodType<
   instructions: z.string(),
   message: z.lazy(() => Message$outboundSchema),
   variables: z.record(z.any()).optional(),
-  contextId: z.string().optional(),
+  contact: z.lazy(() => Contact$outboundSchema).optional(),
+  thread: z.lazy(() => RunAgentThread$outboundSchema).optional(),
   memory: z.lazy(() => Memory$outboundSchema).optional(),
   path: z.string(),
   description: z.string().optional(),
-  iconUrl: z.string().optional(),
   systemPrompt: z.string().optional(),
   memoryStores: z.array(z.string()).optional(),
   knowledgeBases: z.array(z.lazy(() => KnowledgeBases$outboundSchema))
     .optional(),
   teamOfAgents: z.array(z.lazy(() => TeamOfAgents$outboundSchema)).optional(),
   settings: z.lazy(() => Settings$outboundSchema),
+  metadata: z.record(z.any()).optional(),
 }).transform((v) => {
   return remap$(v, {
     fallbackModels: "fallback_models",

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

@@ -338,7 +338,7 @@ export type SearchOptions = {
  */
 export type SearchKnowledgeRerankConfig = {
   /**
-   * The name of the rerank model to use
+   * The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/rerank-models).
    */
   model: string;
   /**
@@ -356,7 +356,7 @@ export type SearchKnowledgeRerankConfig = {
  */
 export type SearchKnowledgeAgenticRagConfig = {
   /**
-   * The name of the model for the Agent to use. This model must support function calling.
+   * The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/chat-models).
    */
   model: string;
 };