@orq-ai/node 4.2.0-rc.4 → 4.2.0-rc.40

package/src/models/components/agentstartedstreamingevent.ts

@@ -14,6 +14,12 @@ import {
   DataPart$Outbound,
   DataPart$outboundSchema,
 } from "./datapart.js";
+import {
+  ErrorPart,
+  ErrorPart$inboundSchema,
+  ErrorPart$Outbound,
+  ErrorPart$outboundSchema,
+} from "./errorpart.js";
 import {
   FilePart,
   FilePart$inboundSchema,
@@ -57,6 +63,7 @@ export type AgentStartedStreamingEventRole = ClosedEnum<
 
 export type AgentStartedStreamingEventParts =
   | TextPart
+  | ErrorPart
   | DataPart
   | FilePart
   | ToolCallPart
@@ -68,7 +75,9 @@ export type InputMessage = {
    * Extended A2A message role
    */
   role: AgentStartedStreamingEventRole;
-  parts: Array<TextPart | DataPart | FilePart | ToolCallPart | ToolResultPart>;
+  parts: Array<
+    TextPart | ErrorPart | DataPart | FilePart | ToolCallPart | ToolResultPart
+  >;
   metadata?: { [k: string]: any } | undefined;
 };
 
@@ -252,6 +261,7 @@ export const AgentStartedStreamingEventParts$inboundSchema: z.ZodType<
   unknown
 > = z.union([
   TextPart$inboundSchema,
+  ErrorPart$inboundSchema,
   DataPart$inboundSchema,
   FilePart$inboundSchema,
   ToolCallPart$inboundSchema,
@@ -260,6 +270,7 @@ export const AgentStartedStreamingEventParts$inboundSchema: z.ZodType<
 /** @internal */
 export type AgentStartedStreamingEventParts$Outbound =
   | TextPart$Outbound
+  | ErrorPart$Outbound
   | DataPart$Outbound
   | FilePart$Outbound
   | ToolCallPart$Outbound
@@ -272,6 +283,7 @@ export const AgentStartedStreamingEventParts$outboundSchema: z.ZodType<
   AgentStartedStreamingEventParts
 > = z.union([
   TextPart$outboundSchema,
+  ErrorPart$outboundSchema,
   DataPart$outboundSchema,
   FilePart$outboundSchema,
   ToolCallPart$outboundSchema,
@@ -308,6 +320,7 @@ export const InputMessage$inboundSchema: z.ZodType<
   parts: z.array(
     z.union([
       TextPart$inboundSchema,
+      ErrorPart$inboundSchema,
       DataPart$inboundSchema,
       FilePart$inboundSchema,
       ToolCallPart$inboundSchema,
@@ -322,6 +335,7 @@ export type InputMessage$Outbound = {
   role: string;
   parts: Array<
     | TextPart$Outbound
+    | ErrorPart$Outbound
     | DataPart$Outbound
     | FilePart$Outbound
     | ToolCallPart$Outbound
@@ -341,6 +355,7 @@ export const InputMessage$outboundSchema: z.ZodType<
   parts: z.array(
     z.union([
       TextPart$outboundSchema,
+      ErrorPart$outboundSchema,
       DataPart$outboundSchema,
       FilePart$outboundSchema,
       ToolCallPart$outboundSchema,

package/src/models/components/agentthoughtstreamingevent.ts

@@ -14,6 +14,12 @@ import {
   DataPart$Outbound,
   DataPart$outboundSchema,
 } from "./datapart.js";
+import {
+  ErrorPart,
+  ErrorPart$inboundSchema,
+  ErrorPart$Outbound,
+  ErrorPart$outboundSchema,
+} from "./errorpart.js";
 import {
   FilePart,
   FilePart$inboundSchema,
@@ -51,6 +57,7 @@ export type AgentThoughtStreamingEventRole = ClosedEnum<
 
 export type AgentThoughtStreamingEventParts =
   | TextPart
+  | ErrorPart
   | DataPart
   | FilePart
   | ToolCallPart
@@ -59,7 +66,9 @@ export type AgentThoughtStreamingEventParts =
 export type MessageDifference = {
   messageId: string;
   role: AgentThoughtStreamingEventRole;
-  parts: Array<TextPart | DataPart | FilePart | ToolCallPart | ToolResultPart>;
+  parts: Array<
+    TextPart | ErrorPart | DataPart | FilePart | ToolCallPart | ToolResultPart
+  >;
   metadata?: { [k: string]: any } | undefined;
   agentId: string;
   agentExecutionId: string;
@@ -343,6 +352,7 @@ export const AgentThoughtStreamingEventParts$inboundSchema: z.ZodType<
   unknown
 > = z.union([
   TextPart$inboundSchema,
+  ErrorPart$inboundSchema,
   DataPart$inboundSchema,
   FilePart$inboundSchema,
   ToolCallPart$inboundSchema,
@@ -351,6 +361,7 @@ export const AgentThoughtStreamingEventParts$inboundSchema: z.ZodType<
 /** @internal */
 export type AgentThoughtStreamingEventParts$Outbound =
   | TextPart$Outbound
+  | ErrorPart$Outbound
   | DataPart$Outbound
   | FilePart$Outbound
   | ToolCallPart$Outbound
@@ -363,6 +374,7 @@ export const AgentThoughtStreamingEventParts$outboundSchema: z.ZodType<
   AgentThoughtStreamingEventParts
 > = z.union([
   TextPart$outboundSchema,
+  ErrorPart$outboundSchema,
   DataPart$outboundSchema,
   FilePart$outboundSchema,
   ToolCallPart$outboundSchema,
@@ -399,6 +411,7 @@ export const MessageDifference$inboundSchema: z.ZodType<
   parts: z.array(
     z.union([
       TextPart$inboundSchema,
+      ErrorPart$inboundSchema,
       DataPart$inboundSchema,
       FilePart$inboundSchema,
       ToolCallPart$inboundSchema,
@@ -422,6 +435,7 @@ export type MessageDifference$Outbound = {
   role: string;
   parts: Array<
     | TextPart$Outbound
+    | ErrorPart$Outbound
     | DataPart$Outbound
     | FilePart$Outbound
     | ToolCallPart$Outbound
@@ -444,6 +458,7 @@ export const MessageDifference$outboundSchema: z.ZodType<
   parts: z.array(
     z.union([
       TextPart$outboundSchema,
+      ErrorPart$outboundSchema,
       DataPart$outboundSchema,
       FilePart$outboundSchema,
       ToolCallPart$outboundSchema,

package/src/models/components/conversationresponse.ts

@@ -10,67 +10,67 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Type discriminator indicating this is a conversation
+ * Resource type discriminator.
  */
 export const ConversationResponseKind = {
   Conversation: "conversation",
 } as const;
 /**
- * Type discriminator indicating this is a conversation
+ * Resource type discriminator.
  */
 export type ConversationResponseKind = ClosedEnum<
   typeof ConversationResponseKind
 >;
 
 /**
- * Optional metadata associated with the conversation.
+ * Additional conversation metadata.
  */
 export type Metadata = {
   /**
-   * Indicates whether the conversation title is currently being generated by AI.
+   * When `true`, indicates the conversation title is being auto-generated.
    */
   generatingTitle?: boolean | undefined;
   /**
-   * Identifier of the parent entity (agent, deployment, etc.) this conversation belongs to. Used for filtering conversations by entity.
+   * Parent entity identifier (e.g., agent or deployment). Set to `null` for standalone conversations.
    */
-  entityId?: string | undefined;
+  entityId?: string | null | undefined;
+  /**
+   * Model identifier for standalone conversations in `provider/model_id` format. Set to `null` for entity-bound conversations.
+   */
+  model?: string | null | undefined;
 };
 
 export type ConversationResponse = {
   /**
-   * Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the conversation, prefixed with "conv_"
+   * Unique conversation identifier with `conv_` prefix.
    */
   id?: string | undefined;
   /**
-   * Identifier of the parent entity (agent, deployment, etc.) this conversation belongs to.
-   */
-  entityId: string;
-  /**
-   * Type discriminator indicating this is a conversation
+   * Resource type discriminator.
    */
   kind: ConversationResponseKind;
   /**
-   * Display name for the conversation. Can be auto-generated or set by the user.
+   * Human-readable name for the conversation. Maximum 100 characters.
    */
   displayName: string;
   /**
-   * Unix timestamp (in milliseconds) when the conversation was created
+   * Unix timestamp in milliseconds when the conversation was created.
    */
   createdAt: number;
   /**
-   * Unix timestamp (in milliseconds) when the conversation was last updated
+   * Unix timestamp in milliseconds when the conversation was last modified.
    */
   updatedAt: number;
   /**
-   * Optional identifier of the user or agent that created the conversation
+   * Identifier of the user or system that created the conversation.
    */
   createdById?: string | undefined;
   /**
-   * Optional identifier of the user or agent that last updated the conversation
+   * Identifier of the user or system that last modified the conversation.
    */
   updatedById?: string | undefined;
   /**
-   * Optional metadata associated with the conversation.
+   * Additional conversation metadata.
    */
   metadata?: Metadata | undefined;
 };
@@ -91,12 +91,14 @@ export const Metadata$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   generatingTitle: z.boolean().optional(),
-  entityId: z.string().optional(),
+  entityId: z.nullable(z.string()).optional(),
+  model: z.nullable(z.string()).optional(),
 });
 /** @internal */
 export type Metadata$Outbound = {
   generatingTitle?: boolean | undefined;
-  entityId?: string | undefined;
+  entityId?: string | null | undefined;
+  model?: string | null | undefined;
 };
 
 /** @internal */
@@ -106,7 +108,8 @@ export const Metadata$outboundSchema: z.ZodType<
   Metadata
 > = z.object({
   generatingTitle: z.boolean().optional(),
-  entityId: z.string().optional(),
+  entityId: z.nullable(z.string()).optional(),
+  model: z.nullable(z.string()).optional(),
 });
 
 export function metadataToJSON(metadata: Metadata): string {
@@ -128,8 +131,7 @@ export const ConversationResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("conv_01kdw0p5pc4sny6s95kh84244q"),
-  entityId: z.string(),
+  _id: z.string().default("conv_01kfb0s059b050mszyqwh5d88z"),
   kind: ConversationResponseKind$inboundSchema,
   displayName: z.string(),
   createdAt: z.number(),
@@ -145,7 +147,6 @@ export const ConversationResponse$inboundSchema: z.ZodType<
 /** @internal */
 export type ConversationResponse$Outbound = {
   _id: string;
-  entityId: string;
   kind: string;
   displayName: string;
   createdAt: number;
@@ -161,8 +162,7 @@ export const ConversationResponse$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ConversationResponse
 > = z.object({
-  id: z.string().default("conv_01kdw0p5pc4sny6s95kh84244q"),
-  entityId: z.string(),
+  id: z.string().default("conv_01kfb0s059b050mszyqwh5d88z"),
   kind: ConversationResponseKind$outboundSchema,
   displayName: z.string(),
   createdAt: z.number(),

package/src/models/components/conversationwithmessagesresponse.ts

@@ -0,0 +1,226 @@
+/*
+ * 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 {
+  MessageResponse,
+  MessageResponse$inboundSchema,
+  MessageResponse$Outbound,
+  MessageResponse$outboundSchema,
+} from "./messageresponse.js";
+
+/**
+ * Resource type discriminator.
+ */
+export const ConversationWithMessagesResponseKind = {
+  Conversation: "conversation",
+} as const;
+/**
+ * Resource type discriminator.
+ */
+export type ConversationWithMessagesResponseKind = ClosedEnum<
+  typeof ConversationWithMessagesResponseKind
+>;
+
+/**
+ * Additional conversation metadata.
+ */
+export type ConversationWithMessagesResponseMetadata = {
+  /**
+   * When `true`, indicates the conversation title is being auto-generated.
+   */
+  generatingTitle?: boolean | undefined;
+  /**
+   * Parent entity identifier (e.g., agent or deployment). Set to `null` for standalone conversations.
+   */
+  entityId?: string | null | undefined;
+  /**
+   * Model identifier for standalone conversations in `provider/model_id` format. Set to `null` for entity-bound conversations.
+   */
+  model?: string | null | undefined;
+};
+
+export type ConversationWithMessagesResponse = {
+  /**
+   * Unique conversation identifier with `conv_` prefix.
+   */
+  id?: string | undefined;
+  /**
+   * Resource type discriminator.
+   */
+  kind: ConversationWithMessagesResponseKind;
+  /**
+   * Human-readable name for the conversation. Maximum 100 characters.
+   */
+  displayName: string;
+  /**
+   * Unix timestamp in milliseconds when the conversation was created.
+   */
+  createdAt: number;
+  /**
+   * Unix timestamp in milliseconds when the conversation was last modified.
+   */
+  updatedAt: number;
+  /**
+   * Identifier of the user or system that created the conversation.
+   */
+  createdById?: string | undefined;
+  /**
+   * Identifier of the user or system that last modified the conversation.
+   */
+  updatedById?: string | undefined;
+  /**
+   * Additional conversation metadata.
+   */
+  metadata?: ConversationWithMessagesResponseMetadata | undefined;
+  /**
+   * Conversation messages ordered chronologically (oldest first).
+   */
+  messages: Array<MessageResponse>;
+};
+
+/** @internal */
+export const ConversationWithMessagesResponseKind$inboundSchema:
+  z.ZodNativeEnum<typeof ConversationWithMessagesResponseKind> = z.nativeEnum(
+    ConversationWithMessagesResponseKind,
+  );
+/** @internal */
+export const ConversationWithMessagesResponseKind$outboundSchema:
+  z.ZodNativeEnum<typeof ConversationWithMessagesResponseKind> =
+    ConversationWithMessagesResponseKind$inboundSchema;
+
+/** @internal */
+export const ConversationWithMessagesResponseMetadata$inboundSchema: z.ZodType<
+  ConversationWithMessagesResponseMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  generatingTitle: z.boolean().optional(),
+  entityId: z.nullable(z.string()).optional(),
+  model: z.nullable(z.string()).optional(),
+});
+/** @internal */
+export type ConversationWithMessagesResponseMetadata$Outbound = {
+  generatingTitle?: boolean | undefined;
+  entityId?: string | null | undefined;
+  model?: string | null | undefined;
+};
+
+/** @internal */
+export const ConversationWithMessagesResponseMetadata$outboundSchema: z.ZodType<
+  ConversationWithMessagesResponseMetadata$Outbound,
+  z.ZodTypeDef,
+  ConversationWithMessagesResponseMetadata
+> = z.object({
+  generatingTitle: z.boolean().optional(),
+  entityId: z.nullable(z.string()).optional(),
+  model: z.nullable(z.string()).optional(),
+});
+
+export function conversationWithMessagesResponseMetadataToJSON(
+  conversationWithMessagesResponseMetadata:
+    ConversationWithMessagesResponseMetadata,
+): string {
+  return JSON.stringify(
+    ConversationWithMessagesResponseMetadata$outboundSchema.parse(
+      conversationWithMessagesResponseMetadata,
+    ),
+  );
+}
+export function conversationWithMessagesResponseMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ConversationWithMessagesResponseMetadata,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ConversationWithMessagesResponseMetadata$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ConversationWithMessagesResponseMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConversationWithMessagesResponse$inboundSchema: z.ZodType<
+  ConversationWithMessagesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().default("conv_01kfb0s05ewff640dy4yksk5av"),
+  kind: ConversationWithMessagesResponseKind$inboundSchema,
+  displayName: z.string(),
+  createdAt: z.number(),
+  updatedAt: z.number(),
+  createdById: z.string().optional(),
+  updatedById: z.string().optional(),
+  metadata: z.lazy(() => ConversationWithMessagesResponseMetadata$inboundSchema)
+    .optional(),
+  messages: z.array(MessageResponse$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+/** @internal */
+export type ConversationWithMessagesResponse$Outbound = {
+  _id: string;
+  kind: string;
+  displayName: string;
+  createdAt: number;
+  updatedAt: number;
+  createdById?: string | undefined;
+  updatedById?: string | undefined;
+  metadata?: ConversationWithMessagesResponseMetadata$Outbound | undefined;
+  messages: Array<MessageResponse$Outbound>;
+};
+
+/** @internal */
+export const ConversationWithMessagesResponse$outboundSchema: z.ZodType<
+  ConversationWithMessagesResponse$Outbound,
+  z.ZodTypeDef,
+  ConversationWithMessagesResponse
+> = z.object({
+  id: z.string().default("conv_01kfb0s05ewff640dy4yksk5av"),
+  kind: ConversationWithMessagesResponseKind$outboundSchema,
+  displayName: z.string(),
+  createdAt: z.number(),
+  updatedAt: z.number(),
+  createdById: z.string().optional(),
+  updatedById: z.string().optional(),
+  metadata: z.lazy(() =>
+    ConversationWithMessagesResponseMetadata$outboundSchema
+  ).optional(),
+  messages: z.array(MessageResponse$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+  });
+});
+
+export function conversationWithMessagesResponseToJSON(
+  conversationWithMessagesResponse: ConversationWithMessagesResponse,
+): string {
+  return JSON.stringify(
+    ConversationWithMessagesResponse$outboundSchema.parse(
+      conversationWithMessagesResponse,
+    ),
+  );
+}
+export function conversationWithMessagesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ConversationWithMessagesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConversationWithMessagesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConversationWithMessagesResponse' from JSON`,
+  );
+}

package/src/models/components/errorpart.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+
+/**
+ * Error content part. Generated by the system when an error occurs during agent execution.
+ */
+export type ErrorPart = {
+  kind: "error";
+  error: string;
+  code?: number | undefined;
+};
+
+/** @internal */
+export const ErrorPart$inboundSchema: z.ZodType<
+  ErrorPart,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  kind: z.literal("error"),
+  error: z.string(),
+  code: z.number().optional(),
+});
+/** @internal */
+export type ErrorPart$Outbound = {
+  kind: "error";
+  error: string;
+  code?: number | undefined;
+};
+
+/** @internal */
+export const ErrorPart$outboundSchema: z.ZodType<
+  ErrorPart$Outbound,
+  z.ZodTypeDef,
+  ErrorPart
+> = z.object({
+  kind: z.literal("error"),
+  error: z.string(),
+  code: z.number().optional(),
+});
+
+export function errorPartToJSON(errorPart: ErrorPart): string {
+  return JSON.stringify(ErrorPart$outboundSchema.parse(errorPart));
+}
+export function errorPartFromJSON(
+  jsonString: string,
+): SafeParseResult<ErrorPart, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ErrorPart$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ErrorPart' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -14,8 +14,10 @@ export * from "./agentstartedstreamingevent.js";
 export * from "./agentthoughtstreamingevent.js";
 export * from "./audiocontentpartschema.js";
 export * from "./conversationresponse.js";
+export * from "./conversationwithmessagesresponse.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";
@@ -24,6 +26,7 @@ export * from "./filecontentpartschema.js";
 export * from "./filepart.js";
 export * from "./imagecontentpartschema.js";
 export * from "./invokedeploymentrequest.js";
+export * from "./messageresponse.js";
 export * from "./partdelta.js";
 export * from "./partdeltaevent.js";
 export * from "./partdoneevent.js";
@@ -53,3 +56,4 @@ export * from "./toolresultpart.js";
 export * from "./toolreviewdoneevent.js";
 export * from "./toolreviewrequestedevent.js";
 export * from "./toolstartedevent.js";
+export * from "./usermessagerequest.js";

package/src/models/components/invokedeploymentrequest.ts

@@ -1137,7 +1137,7 @@ export type InvokeDeploymentRequest = {
    */
   extraParams?: { [k: string]: any } | undefined;
   /**
-   * A list of relevant documents that evaluators and guardrails can cite to evaluate the user input or the model response based on your deployment settings.
+   * A list of documents from your external knowledge base (e.g., chunks retrieved from your own vector database or RAG pipeline) that provide context for the model response. These documents can be used by evaluators and guardrails to assess the relevance and accuracy of the model output against the provided context.
    */
   documents?: Array<Documents> | undefined;
   invokeOptions?: InvokeOptions | undefined;