@orq-ai/node 3.3.13 → 3.4.0-rc.21

package/src/models/operations/deploymentcreatemetric.ts

@@ -211,6 +211,7 @@ export type DeploymentCreateMetricMessagesAssistantMessage = {
       | DeploymentCreateMetric2TextContentPart
       | DeploymentCreateMetric2RefusalContentPart
     >
+    | null
     | undefined;
   /**
    * The refusal message by the assistant.
@@ -605,6 +606,7 @@ export type ChoicesAssistantMessage = {
       | DeploymentCreateMetric2DeploymentsMetricsTextContentPart
       | DeploymentCreateMetric2DeploymentsMetricsRefusalContentPart
     >
+    | null
     | undefined;
   /**
    * The refusal message by the assistant.
@@ -1794,13 +1796,19 @@ export const DeploymentCreateMetricMessagesAssistantMessage$inboundSchema:
     z.ZodTypeDef,
     unknown
   > = z.object({
-    content: z.union([
-      z.string(),
-      z.array(z.union([
-        z.lazy(() => DeploymentCreateMetric2TextContentPart$inboundSchema),
-        z.lazy(() => DeploymentCreateMetric2RefusalContentPart$inboundSchema),
-      ])),
-    ]).optional(),
+    content: z.nullable(
+      z.union([
+        z.string(),
+        z.array(
+          z.union([
+            z.lazy(() => DeploymentCreateMetric2TextContentPart$inboundSchema),
+            z.lazy(() =>
+              DeploymentCreateMetric2RefusalContentPart$inboundSchema
+            ),
+          ]),
+        ),
+      ]),
+    ).optional(),
     refusal: z.nullable(z.string()).optional(),
     role:
       DeploymentCreateMetricMessagesDeploymentsMetricsRequestRequestBodyRole$inboundSchema,
@@ -1825,6 +1833,7 @@ export type DeploymentCreateMetricMessagesAssistantMessage$Outbound = {
       | DeploymentCreateMetric2TextContentPart$Outbound
       | DeploymentCreateMetric2RefusalContentPart$Outbound
     >
+    | null
     | undefined;
   refusal?: string | null | undefined;
   role: string;
@@ -1842,15 +1851,19 @@ export const DeploymentCreateMetricMessagesAssistantMessage$outboundSchema:
     z.ZodTypeDef,
     DeploymentCreateMetricMessagesAssistantMessage
   > = z.object({
-    content: z.union([
-      z.string(),
-      z.array(z.union([
-        z.lazy(() => DeploymentCreateMetric2TextContentPart$outboundSchema),
-        z.lazy(() =>
-          DeploymentCreateMetric2RefusalContentPart$outboundSchema
+    content: z.nullable(
+      z.union([
+        z.string(),
+        z.array(
+          z.union([
+            z.lazy(() => DeploymentCreateMetric2TextContentPart$outboundSchema),
+            z.lazy(() =>
+              DeploymentCreateMetric2RefusalContentPart$outboundSchema
+            ),
+          ]),
         ),
-      ])),
-    ]).optional(),
+      ]),
+    ).optional(),
     refusal: z.nullable(z.string()).optional(),
     role:
       DeploymentCreateMetricMessagesDeploymentsMetricsRequestRequestBodyRole$outboundSchema,
@@ -3569,17 +3582,21 @@ export const ChoicesAssistantMessage$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  content: z.union([
-    z.string(),
-    z.array(z.union([
-      z.lazy(() =>
-        DeploymentCreateMetric2DeploymentsMetricsTextContentPart$inboundSchema
-      ),
-      z.lazy(() =>
-        DeploymentCreateMetric2DeploymentsMetricsRefusalContentPart$inboundSchema
+  content: z.nullable(
+    z.union([
+      z.string(),
+      z.array(
+        z.union([
+          z.lazy(() =>
+            DeploymentCreateMetric2DeploymentsMetricsTextContentPart$inboundSchema
+          ),
+          z.lazy(() =>
+            DeploymentCreateMetric2DeploymentsMetricsRefusalContentPart$inboundSchema
+          ),
+        ]),
       ),
-    ])),
-  ]).optional(),
+    ]),
+  ).optional(),
   refusal: z.nullable(z.string()).optional(),
   role:
     DeploymentCreateMetricChoicesDeploymentsMetricsRequestRole$inboundSchema,
@@ -3600,6 +3617,7 @@ export type ChoicesAssistantMessage$Outbound = {
       | DeploymentCreateMetric2DeploymentsMetricsTextContentPart$Outbound
       | DeploymentCreateMetric2DeploymentsMetricsRefusalContentPart$Outbound
     >
+    | null
     | undefined;
   refusal?: string | null | undefined;
   role: string;
@@ -3614,17 +3632,21 @@ export const ChoicesAssistantMessage$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ChoicesAssistantMessage
 > = z.object({
-  content: z.union([
-    z.string(),
-    z.array(z.union([
-      z.lazy(() =>
-        DeploymentCreateMetric2DeploymentsMetricsTextContentPart$outboundSchema
-      ),
-      z.lazy(() =>
-        DeploymentCreateMetric2DeploymentsMetricsRefusalContentPart$outboundSchema
+  content: z.nullable(
+    z.union([
+      z.string(),
+      z.array(
+        z.union([
+          z.lazy(() =>
+            DeploymentCreateMetric2DeploymentsMetricsTextContentPart$outboundSchema
+          ),
+          z.lazy(() =>
+            DeploymentCreateMetric2DeploymentsMetricsRefusalContentPart$outboundSchema
+          ),
+        ]),
       ),
-    ])),
-  ]).optional(),
+    ]),
+  ).optional(),
   refusal: z.nullable(z.string()).optional(),
   role:
     DeploymentCreateMetricChoicesDeploymentsMetricsRequestRole$outboundSchema,

package/src/models/operations/deploymentgetconfig.ts

@@ -161,7 +161,11 @@ export type AssistantMessage = {
   /**
    * The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.
    */
-  content?: string | Array<TextContentPart | RefusalContentPart> | undefined;
+  content?:
+    | string
+    | Array<TextContentPart | RefusalContentPart>
+    | null
+    | undefined;
   /**
    * The refusal message by the assistant.
    */
@@ -519,6 +523,7 @@ export type MessagesAssistantMessage = {
   content?:
     | string
     | Array<TwoTextContentPart | TwoRefusalContentPart>
+    | null
     | undefined;
   /**
    * The refusal message by the assistant.
@@ -759,6 +764,21 @@ export type InvokeOptions = {
    * Whether to include the retrieved knowledge chunks in the response.
    */
   includeRetrievals?: boolean | undefined;
+  /**
+   * A mock response to use instead of calling the LLM API. This is useful for testing purposes. When provided, the system will return a response object with this content as the completion, without making an actual API call to the LLM provider. This works for both streaming and non-streaming requests. Mock responses will not generate logs, traces or be counted for your plan usage.
+   */
+  mockResponse?: string | undefined;
+};
+
+export type Thread = {
+  /**
+   * Unique thread identifier to group related invocations.
+   */
+  id: string;
+  /**
+   * Optional tags to differentiate or categorize threads
+   */
+  tags?: Array<string> | undefined;
 };
 
 export type DeploymentGetConfigRequestBody = {
@@ -815,6 +835,7 @@ export type DeploymentGetConfigRequestBody = {
    */
   documents?: Array<Documents> | undefined;
   invokeOptions?: InvokeOptions | undefined;
+  thread?: Thread | undefined;
 };
 
 /**
@@ -1897,13 +1918,15 @@ export const AssistantMessage$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  content: z.union([
-    z.string(),
-    z.array(z.union([
-      z.lazy(() => TextContentPart$inboundSchema),
-      z.lazy(() => RefusalContentPart$inboundSchema),
-    ])),
-  ]).optional(),
+  content: z.nullable(
+    z.union([
+      z.string(),
+      z.array(z.union([
+        z.lazy(() => TextContentPart$inboundSchema),
+        z.lazy(() => RefusalContentPart$inboundSchema),
+      ])),
+    ]),
+  ).optional(),
   refusal: z.nullable(z.string()).optional(),
   role: DeploymentGetConfigPrefixMessagesDeploymentsRole$inboundSchema,
   name: z.string().optional(),
@@ -1920,6 +1943,7 @@ export type AssistantMessage$Outbound = {
   content?:
     | string
     | Array<TextContentPart$Outbound | RefusalContentPart$Outbound>
+    | null
     | undefined;
   refusal?: string | null | undefined;
   role: string;
@@ -1934,13 +1958,17 @@ export const AssistantMessage$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AssistantMessage
 > = z.object({
-  content: z.union([
-    z.string(),
-    z.array(z.union([
-      z.lazy(() => TextContentPart$outboundSchema),
-      z.lazy(() => RefusalContentPart$outboundSchema),
-    ])),
-  ]).optional(),
+  content: z.nullable(
+    z.union([
+      z.string(),
+      z.array(
+        z.union([
+          z.lazy(() => TextContentPart$outboundSchema),
+          z.lazy(() => RefusalContentPart$outboundSchema),
+        ]),
+      ),
+    ]),
+  ).optional(),
   refusal: z.nullable(z.string()).optional(),
   role: DeploymentGetConfigPrefixMessagesDeploymentsRole$outboundSchema,
   name: z.string().optional(),
@@ -3441,13 +3469,17 @@ export const MessagesAssistantMessage$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  content: z.union([
-    z.string(),
-    z.array(z.union([
-      z.lazy(() => TwoTextContentPart$inboundSchema),
-      z.lazy(() => TwoRefusalContentPart$inboundSchema),
-    ])),
-  ]).optional(),
+  content: z.nullable(
+    z.union([
+      z.string(),
+      z.array(
+        z.union([
+          z.lazy(() => TwoTextContentPart$inboundSchema),
+          z.lazy(() => TwoRefusalContentPart$inboundSchema),
+        ]),
+      ),
+    ]),
+  ).optional(),
   refusal: z.nullable(z.string()).optional(),
   role: DeploymentGetConfigMessagesDeploymentsRequestRole$inboundSchema,
   name: z.string().optional(),
@@ -3464,6 +3496,7 @@ export type MessagesAssistantMessage$Outbound = {
   content?:
     | string
     | Array<TwoTextContentPart$Outbound | TwoRefusalContentPart$Outbound>
+    | null
     | undefined;
   refusal?: string | null | undefined;
   role: string;
@@ -3478,13 +3511,17 @@ export const MessagesAssistantMessage$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MessagesAssistantMessage
 > = z.object({
-  content: z.union([
-    z.string(),
-    z.array(z.union([
-      z.lazy(() => TwoTextContentPart$outboundSchema),
-      z.lazy(() => TwoRefusalContentPart$outboundSchema),
-    ])),
-  ]).optional(),
+  content: z.nullable(
+    z.union([
+      z.string(),
+      z.array(
+        z.union([
+          z.lazy(() => TwoTextContentPart$outboundSchema),
+          z.lazy(() => TwoRefusalContentPart$outboundSchema),
+        ]),
+      ),
+    ]),
+  ).optional(),
   refusal: z.nullable(z.string()).optional(),
   role: DeploymentGetConfigMessagesDeploymentsRequestRole$outboundSchema,
   name: z.string().optional(),
@@ -4494,15 +4531,18 @@ export const InvokeOptions$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   include_retrievals: z.boolean().default(false),
+  mock_response: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "include_retrievals": "includeRetrievals",
+    "mock_response": "mockResponse",
   });
 });
 
 /** @internal */
 export type InvokeOptions$Outbound = {
   include_retrievals: boolean;
+  mock_response?: string | undefined;
 };
 
 /** @internal */
@@ -4512,9 +4552,11 @@ export const InvokeOptions$outboundSchema: z.ZodType<
   InvokeOptions
 > = z.object({
   includeRetrievals: z.boolean().default(false),
+  mockResponse: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     includeRetrievals: "include_retrievals",
+    mockResponse: "mock_response",
   });
 });
 
@@ -4545,6 +4587,56 @@ export function invokeOptionsFromJSON(
   );
 }
 
+/** @internal */
+export const Thread$inboundSchema: z.ZodType<Thread, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string(),
+    tags: z.array(z.string()).optional(),
+  });
+
+/** @internal */
+export type Thread$Outbound = {
+  id: string;
+  tags?: Array<string> | undefined;
+};
+
+/** @internal */
+export const Thread$outboundSchema: z.ZodType<
+  Thread$Outbound,
+  z.ZodTypeDef,
+  Thread
+> = 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 Thread$ {
+  /** @deprecated use `Thread$inboundSchema` instead. */
+  export const inboundSchema = Thread$inboundSchema;
+  /** @deprecated use `Thread$outboundSchema` instead. */
+  export const outboundSchema = Thread$outboundSchema;
+  /** @deprecated use `Thread$Outbound` instead. */
+  export type Outbound = Thread$Outbound;
+}
+
+export function threadToJSON(thread: Thread): string {
+  return JSON.stringify(Thread$outboundSchema.parse(thread));
+}
+
+export function threadFromJSON(
+  jsonString: string,
+): SafeParseResult<Thread, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Thread$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Thread' from JSON`,
+  );
+}
+
 /** @internal */
 export const DeploymentGetConfigRequestBody$inboundSchema: z.ZodType<
   DeploymentGetConfigRequestBody,
@@ -4577,6 +4669,7 @@ export const DeploymentGetConfigRequestBody$inboundSchema: z.ZodType<
   extra_params: z.record(z.any()).optional(),
   documents: z.array(z.lazy(() => Documents$inboundSchema)).optional(),
   invoke_options: z.lazy(() => InvokeOptions$inboundSchema).optional(),
+  thread: z.lazy(() => Thread$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "prefix_messages": "prefixMessages",
@@ -4614,6 +4707,7 @@ export type DeploymentGetConfigRequestBody$Outbound = {
   extra_params?: { [k: string]: any } | undefined;
   documents?: Array<Documents$Outbound> | undefined;
   invoke_options?: InvokeOptions$Outbound | undefined;
+  thread?: Thread$Outbound | undefined;
 };
 
 /** @internal */
@@ -4648,6 +4742,7 @@ export const DeploymentGetConfigRequestBody$outboundSchema: z.ZodType<
   extraParams: z.record(z.any()).optional(),
   documents: z.array(z.lazy(() => Documents$outboundSchema)).optional(),
   invokeOptions: z.lazy(() => InvokeOptions$outboundSchema).optional(),
+  thread: z.lazy(() => Thread$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     prefixMessages: "prefix_messages",

package/src/models/operations/deployments.ts

@@ -91,7 +91,7 @@ export type DeploymentsTools = {
 };
 
 /**
- * The type of the model
+ * The modality of the model
  */
 export const DeploymentsModelType = {
   Chat: "chat",
@@ -105,7 +105,7 @@ export const DeploymentsModelType = {
   Moderations: "moderations",
 } as const;
 /**
- * The type of the model
+ * The modality of the model
  */
 export type DeploymentsModelType = ClosedEnum<typeof DeploymentsModelType>;
 
@@ -436,7 +436,7 @@ export type DeploymentsPromptConfig = {
   tools: Array<DeploymentsTools>;
   model: string;
   /**
-   * The type of the model
+   * The modality of the model
    */
   modelType: DeploymentsModelType;
   /**