@orq-ai/node 4.2.0-rc.3 → 4.2.0-rc.30

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;

package/src/models/components/messageresponse.ts

@@ -0,0 +1,217 @@
+/*
+ * 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 {
+  ErrorPart,
+  ErrorPart$inboundSchema,
+  ErrorPart$Outbound,
+  ErrorPart$outboundSchema,
+} from "./errorpart.js";
+import {
+  FilePart,
+  FilePart$inboundSchema,
+  FilePart$Outbound,
+  FilePart$outboundSchema,
+} from "./filepart.js";
+import {
+  TextPart,
+  TextPart$inboundSchema,
+  TextPart$Outbound,
+  TextPart$outboundSchema,
+} from "./textpart.js";
+import {
+  ToolResultPart,
+  ToolResultPart$inboundSchema,
+  ToolResultPart$Outbound,
+  ToolResultPart$outboundSchema,
+} from "./toolresultpart.js";
+
+/**
+ * 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;
+
+/**
+ * Message author role. `user` for end-user messages, `assistant` for AI-generated responses.
+ */
+export const MessageResponseRole = {
+  User: "user",
+  Assistant: "assistant",
+} as const;
+/**
+ * Message author role. `user` for end-user messages, `assistant` for AI-generated responses.
+ */
+export type MessageResponseRole = ClosedEnum<typeof MessageResponseRole>;
+
+export type MessageResponse = {
+  /**
+   * Unique message identifier with `msg_` prefix.
+   */
+  id: string;
+  /**
+   * Conversation identifier this message belongs to.
+   */
+  conversationId: string;
+  /**
+   * Unix timestamp in milliseconds when the message was created.
+   */
+  createdAt: number;
+  /**
+   * Identifier of the message author. User ID for user messages, "system" for assistant messages.
+   */
+  createdById: string;
+  /**
+   * Content parts composing the message. Supports multiple content types (text, images, files, tool results).
+   */
+  parts: Array<TextPart | FilePart | ToolResultPart | ErrorPart>;
+  /**
+   * Message author role. `user` for end-user messages, `assistant` for AI-generated responses.
+   */
+  role: MessageResponseRole;
+};
+
+/** @internal */
+export const PublicMessagePart$inboundSchema: z.ZodType<
+  PublicMessagePart,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  TextPart$inboundSchema,
+  FilePart$inboundSchema,
+  ToolResultPart$inboundSchema,
+  ErrorPart$inboundSchema,
+]);
+/** @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),
+  );
+}
+export function publicMessagePartFromJSON(
+  jsonString: string,
+): SafeParseResult<PublicMessagePart, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PublicMessagePart$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PublicMessagePart' from JSON`,
+  );
+}
+
+/** @internal */
+export const MessageResponseRole$inboundSchema: z.ZodNativeEnum<
+  typeof MessageResponseRole
+> = z.nativeEnum(MessageResponseRole);
+/** @internal */
+export const MessageResponseRole$outboundSchema: z.ZodNativeEnum<
+  typeof MessageResponseRole
+> = MessageResponseRole$inboundSchema;
+
+/** @internal */
+export const MessageResponse$inboundSchema: z.ZodType<
+  MessageResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  conversationId: z.string(),
+  createdAt: z.number(),
+  createdById: z.string(),
+  parts: z.array(
+    z.union([
+      TextPart$inboundSchema,
+      FilePart$inboundSchema,
+      ToolResultPart$inboundSchema,
+      ErrorPart$inboundSchema,
+    ]),
+  ),
+  role: MessageResponseRole$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+/** @internal */
+export type MessageResponse$Outbound = {
+  _id: string;
+  conversationId: string;
+  createdAt: number;
+  createdById: string;
+  parts: Array<
+    | TextPart$Outbound
+    | FilePart$Outbound
+    | ToolResultPart$Outbound
+    | ErrorPart$Outbound
+  >;
+  role: string;
+};
+
+/** @internal */
+export const MessageResponse$outboundSchema: z.ZodType<
+  MessageResponse$Outbound,
+  z.ZodTypeDef,
+  MessageResponse
+> = z.object({
+  id: z.string(),
+  conversationId: z.string(),
+  createdAt: z.number(),
+  createdById: z.string(),
+  parts: z.array(
+    z.union([
+      TextPart$outboundSchema,
+      FilePart$outboundSchema,
+      ToolResultPart$outboundSchema,
+      ErrorPart$outboundSchema,
+    ]),
+  ),
+  role: MessageResponseRole$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+  });
+});
+
+export function messageResponseToJSON(
+  messageResponse: MessageResponse,
+): string {
+  return JSON.stringify(MessageResponse$outboundSchema.parse(messageResponse));
+}
+export function messageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<MessageResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageResponse' from JSON`,
+  );
+}

package/src/models/components/partdoneevent.ts

@@ -79,7 +79,7 @@ export const PartReasoningPart$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("reasoning_01kdt3bqr5wjxv936avgwyz4et"),
+  _id: z.string().default("reasoning_01kezxqfz85kehwvprzc4smnxa"),
   metadata: z.record(z.any()).optional(),
   kind: PartKind$inboundSchema,
   reasoning: z.string(),
@@ -104,7 +104,7 @@ export const PartReasoningPart$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PartReasoningPart
 > = z.object({
-  id: z.string().default("reasoning_01kdt3bqr5wjxv936avgwyz4et"),
+  id: z.string().default("reasoning_01kezxqfz85kehwvprzc4smnxa"),
   metadata: z.record(z.any()).optional(),
   kind: PartKind$outboundSchema,
   reasoning: z.string(),

package/src/models/components/publiccontact.ts

@@ -9,7 +9,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Information about the contact making the request. If the contact does not exist, it will be created automatically.
+ * Information about the identity making the request. If the identity does not exist, it will be created automatically.
  */
 export type PublicContact = {
   /**

package/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_01kdt3bqqw88zq77me8x3v5tpy"),
+  _id: z.string().default("reasoning_01kezxqfz1cb8hpqcbav2dq58n"),
   metadata: z.record(z.any()).optional(),
   kind: z.literal("reasoning"),
   reasoning: z.string(),
@@ -65,7 +65,7 @@ export const ReasoningPart$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ReasoningPart
 > = z.object({
-  id: z.string().default("reasoning_01kdt3bqqw88zq77me8x3v5tpy"),
+  id: z.string().default("reasoning_01kezxqfz1cb8hpqcbav2dq58n"),
   metadata: z.record(z.any()).optional(),
   kind: z.literal("reasoning"),
   reasoning: z.string(),

package/src/models/components/responsestartedevent.ts

@@ -26,6 +26,14 @@ export type Data = {
    * Trace ID for this turn of the conversation (new for each continuation)
    */
   workflowRunId: string;
+  /**
+   * Server-generated ID for the user message. Use this ID for frontend state consistency.
+   */
+  userMessageId?: string | undefined;
+  /**
+   * Server-generated ID for the assistant message. Use this ID for frontend state consistency.
+   */
+  assistantMessageId?: string | undefined;
 };
 
 /**
@@ -47,6 +55,8 @@ export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
     taskId: z.string(),
     model: z.string(),
     workflowRunId: z.string(),
+    userMessageId: z.string().optional(),
+    assistantMessageId: z.string().optional(),
   });
 /** @internal */
 export type Data$Outbound = {
@@ -54,6 +64,8 @@ export type Data$Outbound = {
   taskId: string;
   model: string;
   workflowRunId: string;
+  userMessageId?: string | undefined;
+  assistantMessageId?: string | undefined;
 };
 
 /** @internal */
@@ -63,6 +75,8 @@ export const Data$outboundSchema: z.ZodType<Data$Outbound, z.ZodTypeDef, Data> =
     taskId: z.string(),
     model: z.string(),
     workflowRunId: z.string(),
+    userMessageId: z.string().optional(),
+    assistantMessageId: z.string().optional(),
   });
 
 export function dataToJSON(data: Data): string {

package/src/models/components/toolexecutionfailedstreamingevent.ts

@@ -34,6 +34,7 @@ export const ToolExecutionFailedStreamingEventProduct = {
   Generic: "generic",
   Evaluators: "evaluators",
   Otel: "otel",
+  AiChat: "ai-chat",
 } as const;
 /**
  * Orquesta product

package/src/models/components/toolexecutionfinishedstreamingevent.ts

@@ -29,6 +29,7 @@ export const ToolExecutionFinishedStreamingEventProduct = {
   Generic: "generic",
   Evaluators: "evaluators",
   Otel: "otel",
+  AiChat: "ai-chat",
 } as const;
 /**
  * Orquesta product

package/src/models/components/toolexecutionstartedstreamingevent.ts

@@ -29,6 +29,7 @@ export const Product = {
   Generic: "generic",
   Evaluators: "evaluators",
   Otel: "otel",
+  AiChat: "ai-chat",
 } as const;
 /**
  * Orquesta product

package/src/models/components/usermessagerequest.ts

@@ -0,0 +1,194 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  ErrorPart,
+  ErrorPart$inboundSchema,
+  ErrorPart$Outbound,
+  ErrorPart$outboundSchema,
+} from "./errorpart.js";
+import {
+  FilePart,
+  FilePart$inboundSchema,
+  FilePart$Outbound,
+  FilePart$outboundSchema,
+} from "./filepart.js";
+import {
+  TextPart,
+  TextPart$inboundSchema,
+  TextPart$Outbound,
+  TextPart$outboundSchema,
+} from "./textpart.js";
+import {
+  ToolResultPart,
+  ToolResultPart$inboundSchema,
+  ToolResultPart$Outbound,
+  ToolResultPart$outboundSchema,
+} from "./toolresultpart.js";
+
+/**
+ * Role indicating this message is from a user
+ */
+export const UserMessageRequestRole = {
+  User: "user",
+} as const;
+/**
+ * Role indicating this message is from a user
+ */
+export type UserMessageRequestRole = ClosedEnum<typeof UserMessageRequestRole>;
+
+/**
+ * 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 UserMessageRequestPublicMessagePart =
+  | TextPart
+  | FilePart
+  | ToolResultPart
+  | ErrorPart;
+
+/**
+ * The user message to send to the model
+ */
+export type UserMessageRequest = {
+  /**
+   * Optional message ID in ULID format
+   */
+  messageId?: string | undefined;
+  /**
+   * Role indicating this message is from a user
+   */
+  role: UserMessageRequestRole;
+  /**
+   * Array of message parts. User messages can contain text, file, tool_result, and error parts.
+   */
+  parts: Array<TextPart | FilePart | ToolResultPart | ErrorPart>;
+};
+
+/** @internal */
+export const UserMessageRequestRole$inboundSchema: z.ZodNativeEnum<
+  typeof UserMessageRequestRole
+> = z.nativeEnum(UserMessageRequestRole);
+/** @internal */
+export const UserMessageRequestRole$outboundSchema: z.ZodNativeEnum<
+  typeof UserMessageRequestRole
+> = UserMessageRequestRole$inboundSchema;
+
+/** @internal */
+export const UserMessageRequestPublicMessagePart$inboundSchema: z.ZodType<
+  UserMessageRequestPublicMessagePart,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  TextPart$inboundSchema,
+  FilePart$inboundSchema,
+  ToolResultPart$inboundSchema,
+  ErrorPart$inboundSchema,
+]);
+/** @internal */
+export type UserMessageRequestPublicMessagePart$Outbound =
+  | TextPart$Outbound
+  | FilePart$Outbound
+  | ToolResultPart$Outbound
+  | ErrorPart$Outbound;
+
+/** @internal */
+export const UserMessageRequestPublicMessagePart$outboundSchema: z.ZodType<
+  UserMessageRequestPublicMessagePart$Outbound,
+  z.ZodTypeDef,
+  UserMessageRequestPublicMessagePart
+> = z.union([
+  TextPart$outboundSchema,
+  FilePart$outboundSchema,
+  ToolResultPart$outboundSchema,
+  ErrorPart$outboundSchema,
+]);
+
+export function userMessageRequestPublicMessagePartToJSON(
+  userMessageRequestPublicMessagePart: UserMessageRequestPublicMessagePart,
+): string {
+  return JSON.stringify(
+    UserMessageRequestPublicMessagePart$outboundSchema.parse(
+      userMessageRequestPublicMessagePart,
+    ),
+  );
+}
+export function userMessageRequestPublicMessagePartFromJSON(
+  jsonString: string,
+): SafeParseResult<UserMessageRequestPublicMessagePart, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      UserMessageRequestPublicMessagePart$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserMessageRequestPublicMessagePart' from JSON`,
+  );
+}
+
+/** @internal */
+export const UserMessageRequest$inboundSchema: z.ZodType<
+  UserMessageRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  messageId: z.string().optional(),
+  role: UserMessageRequestRole$inboundSchema,
+  parts: z.array(
+    z.union([
+      TextPart$inboundSchema,
+      FilePart$inboundSchema,
+      ToolResultPart$inboundSchema,
+      ErrorPart$inboundSchema,
+    ]),
+  ),
+});
+/** @internal */
+export type UserMessageRequest$Outbound = {
+  messageId?: string | undefined;
+  role: string;
+  parts: Array<
+    | TextPart$Outbound
+    | FilePart$Outbound
+    | ToolResultPart$Outbound
+    | ErrorPart$Outbound
+  >;
+};
+
+/** @internal */
+export const UserMessageRequest$outboundSchema: z.ZodType<
+  UserMessageRequest$Outbound,
+  z.ZodTypeDef,
+  UserMessageRequest
+> = z.object({
+  messageId: z.string().optional(),
+  role: UserMessageRequestRole$outboundSchema,
+  parts: z.array(
+    z.union([
+      TextPart$outboundSchema,
+      FilePart$outboundSchema,
+      ToolResultPart$outboundSchema,
+      ErrorPart$outboundSchema,
+    ]),
+  ),
+});
+
+export function userMessageRequestToJSON(
+  userMessageRequest: UserMessageRequest,
+): string {
+  return JSON.stringify(
+    UserMessageRequest$outboundSchema.parse(userMessageRequest),
+  );
+}
+export function userMessageRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UserMessageRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UserMessageRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserMessageRequest' from JSON`,
+  );
+}

package/src/models/errors/deleteidentity.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { OrqError } from "./orqerror.js";
+
+/**
+ * Identity not found
+ */
+export type DeleteIdentityResponseBodyData = {
+  /**
+   * Error message
+   */
+  error: string;
+};
+
+/**
+ * Identity not found
+ */
+export class DeleteIdentityResponseBody extends OrqError {
+  /**
+   * Error message
+   */
+  error: string;
+
+  /** The original data that was passed to this error instance. */
+  data$: DeleteIdentityResponseBodyData;
+
+  constructor(
+    err: DeleteIdentityResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "DeleteIdentityResponseBody";
+  }
+}
+
+/** @internal */
+export const DeleteIdentityResponseBody$inboundSchema: z.ZodType<
+  DeleteIdentityResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new DeleteIdentityResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type DeleteIdentityResponseBody$Outbound = {
+  error: string;
+};
+
+/** @internal */
+export const DeleteIdentityResponseBody$outboundSchema: z.ZodType<
+  DeleteIdentityResponseBody$Outbound,
+  z.ZodTypeDef,
+  DeleteIdentityResponseBody
+> = z.instanceof(DeleteIdentityResponseBody)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    error: z.string(),
+  }));