@orq-ai/node 3.4.0-rc.37 → 3.6.0-rc.8

package/src/models/operations/createdeploymentexperiment.ts

@@ -0,0 +1,321 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+
+export const CreateDeploymentExperimentType = {
+  DeploymentExperiment: "deployment_experiment",
+} as const;
+export type CreateDeploymentExperimentType = ClosedEnum<
+  typeof CreateDeploymentExperimentType
+>;
+
+export type CreateDeploymentExperimentRequestBody = {
+  /**
+   * The unique key of the experiment
+   */
+  experimentKey: string;
+  /**
+   * The list of evaluators to use for the experiment. You can apply multiple evaluators to the same experiment. By default we always consider latency and cost as evaluators.
+   */
+  evaluators?: Array<string> | undefined;
+  /**
+   * The path where the experiment needs to be stored. If not provided, the experiment will be stored in the same path of the dataset used for the experiment.
+   */
+  path?: string | undefined;
+  /**
+   * The id of the dataset to run the experiment on
+   */
+  datasetId: string;
+  type: CreateDeploymentExperimentType;
+  /**
+   * Key-value pairs that match your data model and fields declared in your deployment routing configuration. If not provided, the default variant of the deployment will be used to create the experiment
+   */
+  context?: { [k: string]: any } | undefined;
+};
+
+export type CreateDeploymentExperimentRequest = {
+  /**
+   * Deployment Key
+   */
+  deploymentKey: string;
+  requestBody?: CreateDeploymentExperimentRequestBody | undefined;
+};
+
+/**
+ * Experiment created
+ */
+export type CreateDeploymentExperimentResponseBody = {
+  /**
+   * The url of the experiment run that was just created
+   */
+  url: string;
+  /**
+   * The unique identifier of the experiment
+   */
+  experimentId: string;
+  /**
+   * The unique identifier of the experiment run
+   */
+  experimentRunId: string;
+};
+
+/** @internal */
+export const CreateDeploymentExperimentType$inboundSchema: z.ZodNativeEnum<
+  typeof CreateDeploymentExperimentType
+> = z.nativeEnum(CreateDeploymentExperimentType);
+
+/** @internal */
+export const CreateDeploymentExperimentType$outboundSchema: z.ZodNativeEnum<
+  typeof CreateDeploymentExperimentType
+> = CreateDeploymentExperimentType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateDeploymentExperimentType$ {
+  /** @deprecated use `CreateDeploymentExperimentType$inboundSchema` instead. */
+  export const inboundSchema = CreateDeploymentExperimentType$inboundSchema;
+  /** @deprecated use `CreateDeploymentExperimentType$outboundSchema` instead. */
+  export const outboundSchema = CreateDeploymentExperimentType$outboundSchema;
+}
+
+/** @internal */
+export const CreateDeploymentExperimentRequestBody$inboundSchema: z.ZodType<
+  CreateDeploymentExperimentRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  experiment_key: z.string(),
+  evaluators: z.array(z.string()).optional(),
+  path: z.string().optional(),
+  dataset_id: z.string(),
+  type: CreateDeploymentExperimentType$inboundSchema,
+  context: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "experiment_key": "experimentKey",
+    "dataset_id": "datasetId",
+  });
+});
+
+/** @internal */
+export type CreateDeploymentExperimentRequestBody$Outbound = {
+  experiment_key: string;
+  evaluators?: Array<string> | undefined;
+  path?: string | undefined;
+  dataset_id: string;
+  type: string;
+  context?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CreateDeploymentExperimentRequestBody$outboundSchema: z.ZodType<
+  CreateDeploymentExperimentRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateDeploymentExperimentRequestBody
+> = z.object({
+  experimentKey: z.string(),
+  evaluators: z.array(z.string()).optional(),
+  path: z.string().optional(),
+  datasetId: z.string(),
+  type: CreateDeploymentExperimentType$outboundSchema,
+  context: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    experimentKey: "experiment_key",
+    datasetId: "dataset_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateDeploymentExperimentRequestBody$ {
+  /** @deprecated use `CreateDeploymentExperimentRequestBody$inboundSchema` instead. */
+  export const inboundSchema =
+    CreateDeploymentExperimentRequestBody$inboundSchema;
+  /** @deprecated use `CreateDeploymentExperimentRequestBody$outboundSchema` instead. */
+  export const outboundSchema =
+    CreateDeploymentExperimentRequestBody$outboundSchema;
+  /** @deprecated use `CreateDeploymentExperimentRequestBody$Outbound` instead. */
+  export type Outbound = CreateDeploymentExperimentRequestBody$Outbound;
+}
+
+export function createDeploymentExperimentRequestBodyToJSON(
+  createDeploymentExperimentRequestBody: CreateDeploymentExperimentRequestBody,
+): string {
+  return JSON.stringify(
+    CreateDeploymentExperimentRequestBody$outboundSchema.parse(
+      createDeploymentExperimentRequestBody,
+    ),
+  );
+}
+
+export function createDeploymentExperimentRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateDeploymentExperimentRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateDeploymentExperimentRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateDeploymentExperimentRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateDeploymentExperimentRequest$inboundSchema: z.ZodType<
+  CreateDeploymentExperimentRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  deployment_key: z.string(),
+  RequestBody: z.lazy(() => CreateDeploymentExperimentRequestBody$inboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "deployment_key": "deploymentKey",
+    "RequestBody": "requestBody",
+  });
+});
+
+/** @internal */
+export type CreateDeploymentExperimentRequest$Outbound = {
+  deployment_key: string;
+  RequestBody?: CreateDeploymentExperimentRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateDeploymentExperimentRequest$outboundSchema: z.ZodType<
+  CreateDeploymentExperimentRequest$Outbound,
+  z.ZodTypeDef,
+  CreateDeploymentExperimentRequest
+> = z.object({
+  deploymentKey: z.string(),
+  requestBody: z.lazy(() =>
+    CreateDeploymentExperimentRequestBody$outboundSchema
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    deploymentKey: "deployment_key",
+    requestBody: "RequestBody",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateDeploymentExperimentRequest$ {
+  /** @deprecated use `CreateDeploymentExperimentRequest$inboundSchema` instead. */
+  export const inboundSchema = CreateDeploymentExperimentRequest$inboundSchema;
+  /** @deprecated use `CreateDeploymentExperimentRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    CreateDeploymentExperimentRequest$outboundSchema;
+  /** @deprecated use `CreateDeploymentExperimentRequest$Outbound` instead. */
+  export type Outbound = CreateDeploymentExperimentRequest$Outbound;
+}
+
+export function createDeploymentExperimentRequestToJSON(
+  createDeploymentExperimentRequest: CreateDeploymentExperimentRequest,
+): string {
+  return JSON.stringify(
+    CreateDeploymentExperimentRequest$outboundSchema.parse(
+      createDeploymentExperimentRequest,
+    ),
+  );
+}
+
+export function createDeploymentExperimentRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateDeploymentExperimentRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateDeploymentExperimentRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateDeploymentExperimentRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateDeploymentExperimentResponseBody$inboundSchema: z.ZodType<
+  CreateDeploymentExperimentResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string(),
+  experiment_id: z.string(),
+  experiment_run_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "experiment_id": "experimentId",
+    "experiment_run_id": "experimentRunId",
+  });
+});
+
+/** @internal */
+export type CreateDeploymentExperimentResponseBody$Outbound = {
+  url: string;
+  experiment_id: string;
+  experiment_run_id: string;
+};
+
+/** @internal */
+export const CreateDeploymentExperimentResponseBody$outboundSchema: z.ZodType<
+  CreateDeploymentExperimentResponseBody$Outbound,
+  z.ZodTypeDef,
+  CreateDeploymentExperimentResponseBody
+> = z.object({
+  url: z.string(),
+  experimentId: z.string(),
+  experimentRunId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    experimentId: "experiment_id",
+    experimentRunId: "experiment_run_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateDeploymentExperimentResponseBody$ {
+  /** @deprecated use `CreateDeploymentExperimentResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    CreateDeploymentExperimentResponseBody$inboundSchema;
+  /** @deprecated use `CreateDeploymentExperimentResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    CreateDeploymentExperimentResponseBody$outboundSchema;
+  /** @deprecated use `CreateDeploymentExperimentResponseBody$Outbound` instead. */
+  export type Outbound = CreateDeploymentExperimentResponseBody$Outbound;
+}
+
+export function createDeploymentExperimentResponseBodyToJSON(
+  createDeploymentExperimentResponseBody:
+    CreateDeploymentExperimentResponseBody,
+): string {
+  return JSON.stringify(
+    CreateDeploymentExperimentResponseBody$outboundSchema.parse(
+      createDeploymentExperimentResponseBody,
+    ),
+  );
+}
+
+export function createDeploymentExperimentResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateDeploymentExperimentResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateDeploymentExperimentResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateDeploymentExperimentResponseBody' from JSON`,
+  );
+}

package/src/models/operations/createknowledge.ts

@@ -178,6 +178,10 @@ export type CreateKnowledgeResponseBody = {
    * The embeddings model used for the knowledge base.
    */
   model: string;
+  /**
+   * The project/domain ID of the knowledge base.
+   */
+  domainId: string;
   /**
    * 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.
    */
@@ -746,6 +750,7 @@ export const CreateKnowledgeResponseBody$inboundSchema: z.ZodType<
   description: z.string().optional(),
   key: z.string(),
   model: z.string(),
+  domain_id: z.string(),
   path: z.string().optional(),
   retrieval_settings: z.lazy(() =>
     CreateKnowledgeRetrievalSettings$inboundSchema
@@ -756,6 +761,7 @@ export const CreateKnowledgeResponseBody$inboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
+    "domain_id": "domainId",
     "retrieval_settings": "retrievalSettings",
     "created_by_id": "createdById",
     "updated_by_id": "updatedById",
@@ -769,6 +775,7 @@ export type CreateKnowledgeResponseBody$Outbound = {
   description?: string | undefined;
   key: string;
   model: string;
+  domain_id: string;
   path?: string | undefined;
   retrieval_settings?: CreateKnowledgeRetrievalSettings$Outbound | undefined;
   created_by_id?: string | null | undefined;
@@ -787,6 +794,7 @@ export const CreateKnowledgeResponseBody$outboundSchema: z.ZodType<
   description: z.string().optional(),
   key: z.string(),
   model: z.string(),
+  domainId: z.string(),
   path: z.string().optional(),
   retrievalSettings: z.lazy(() =>
     CreateKnowledgeRetrievalSettings$outboundSchema
@@ -797,6 +805,7 @@ export const CreateKnowledgeResponseBody$outboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     id: "_id",
+    domainId: "domain_id",
     retrievalSettings: "retrieval_settings",
     createdById: "created_by_id",
     updatedById: "updated_by_id",

package/src/models/operations/createprompt.ts

@@ -42,18 +42,6 @@ export const CreatePromptFormat = {
  */
 export type CreatePromptFormat = ClosedEnum<typeof CreatePromptFormat>;
 
-/**
- * Only supported on `image` models.
- */
-export const Quality = {
-  Standard: "standard",
-  Hd: "hd",
-} as const;
-/**
- * Only supported on `image` models.
- */
-export type Quality = ClosedEnum<typeof Quality>;
-
 export const CreatePromptResponseFormatType = {
   JsonObject: "json_object",
 } as const;
@@ -178,7 +166,7 @@ export type ModelParameters = {
   /**
    * Only supported on `image` models.
    */
-  quality?: Quality | undefined;
+  quality?: string | undefined;
   /**
    * Only supported on `image` models.
    */
@@ -331,6 +319,7 @@ export type CreatePromptMessages = {
    */
   content: string | Array<CreatePrompt21 | CreatePrompt22>;
   toolCalls?: Array<CreatePromptToolCalls> | undefined;
+  toolCallId?: string | undefined;
 };
 
 /**
@@ -466,18 +455,6 @@ export type CreatePromptPromptsFormat = ClosedEnum<
   typeof CreatePromptPromptsFormat
 >;
 
-/**
- * Only supported on `image` models.
- */
-export const CreatePromptQuality = {
-  Standard: "standard",
-  Hd: "hd",
-} as const;
-/**
- * Only supported on `image` models.
- */
-export type CreatePromptQuality = ClosedEnum<typeof CreatePromptQuality>;
-
 export const CreatePromptResponseFormatPromptsResponseType = {
   JsonObject: "json_object",
 } as const;
@@ -612,7 +589,7 @@ export type CreatePromptModelParameters = {
   /**
    * Only supported on `image` models.
    */
-  quality?: CreatePromptQuality | undefined;
+  quality?: string | undefined;
   /**
    * Only supported on `image` models.
    */
@@ -781,6 +758,7 @@ export type CreatePromptPromptsMessages = {
    */
   content: string | Array<CreatePrompt2Prompts1 | CreatePrompt2Prompts2>;
   toolCalls?: Array<CreatePromptPromptsToolCalls> | undefined;
+  toolCallId?: string | undefined;
 };
 
 /**
@@ -929,25 +907,6 @@ export namespace CreatePromptFormat$ {
   export const outboundSchema = CreatePromptFormat$outboundSchema;
 }
 
-/** @internal */
-export const Quality$inboundSchema: z.ZodNativeEnum<typeof Quality> = z
-  .nativeEnum(Quality);
-
-/** @internal */
-export const Quality$outboundSchema: z.ZodNativeEnum<typeof Quality> =
-  Quality$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Quality$ {
-  /** @deprecated use `Quality$inboundSchema` instead. */
-  export const inboundSchema = Quality$inboundSchema;
-  /** @deprecated use `Quality$outboundSchema` instead. */
-  export const outboundSchema = Quality$outboundSchema;
-}
-
 /** @internal */
 export const CreatePromptResponseFormatType$inboundSchema: z.ZodNativeEnum<
   typeof CreatePromptResponseFormatType
@@ -1292,7 +1251,7 @@ export const ModelParameters$inboundSchema: z.ZodType<
   seed: z.number().optional(),
   format: CreatePromptFormat$inboundSchema.optional(),
   dimensions: z.string().optional(),
-  quality: Quality$inboundSchema.optional(),
+  quality: z.string().optional(),
   style: z.string().optional(),
   responseFormat: z.nullable(
     z.union([
@@ -1351,7 +1310,7 @@ export const ModelParameters$outboundSchema: z.ZodType<
   seed: z.number().optional(),
   format: CreatePromptFormat$outboundSchema.optional(),
   dimensions: z.string().optional(),
-  quality: Quality$outboundSchema.optional(),
+  quality: z.string().optional(),
   style: z.string().optional(),
   responseFormat: z.nullable(
     z.union([
@@ -1926,9 +1885,11 @@ export const CreatePromptMessages$inboundSchema: z.ZodType<
   ]),
   tool_calls: z.array(z.lazy(() => CreatePromptToolCalls$inboundSchema))
     .optional(),
+  tool_call_id: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "tool_calls": "toolCalls",
+    "tool_call_id": "toolCallId",
   });
 });
 
@@ -1937,6 +1898,7 @@ export type CreatePromptMessages$Outbound = {
   role: string;
   content: string | Array<CreatePrompt21$Outbound | CreatePrompt22$Outbound>;
   tool_calls?: Array<CreatePromptToolCalls$Outbound> | undefined;
+  tool_call_id?: string | undefined;
 };
 
 /** @internal */
@@ -1955,9 +1917,11 @@ export const CreatePromptMessages$outboundSchema: z.ZodType<
   ]),
   toolCalls: z.array(z.lazy(() => CreatePromptToolCalls$outboundSchema))
     .optional(),
+  toolCallId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     toolCalls: "tool_calls",
+    toolCallId: "tool_call_id",
   });
 });
 
@@ -2312,27 +2276,6 @@ export namespace CreatePromptPromptsFormat$ {
   export const outboundSchema = CreatePromptPromptsFormat$outboundSchema;
 }
 
-/** @internal */
-export const CreatePromptQuality$inboundSchema: z.ZodNativeEnum<
-  typeof CreatePromptQuality
-> = z.nativeEnum(CreatePromptQuality);
-
-/** @internal */
-export const CreatePromptQuality$outboundSchema: z.ZodNativeEnum<
-  typeof CreatePromptQuality
-> = CreatePromptQuality$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CreatePromptQuality$ {
-  /** @deprecated use `CreatePromptQuality$inboundSchema` instead. */
-  export const inboundSchema = CreatePromptQuality$inboundSchema;
-  /** @deprecated use `CreatePromptQuality$outboundSchema` instead. */
-  export const outboundSchema = CreatePromptQuality$outboundSchema;
-}
-
 /** @internal */
 export const CreatePromptResponseFormatPromptsResponseType$inboundSchema:
   z.ZodNativeEnum<typeof CreatePromptResponseFormatPromptsResponseType> = z
@@ -2703,7 +2646,7 @@ export const CreatePromptModelParameters$inboundSchema: z.ZodType<
   seed: z.number().optional(),
   format: CreatePromptPromptsFormat$inboundSchema.optional(),
   dimensions: z.string().optional(),
-  quality: CreatePromptQuality$inboundSchema.optional(),
+  quality: z.string().optional(),
   style: z.string().optional(),
   responseFormat: z.nullable(
     z.union([
@@ -2762,7 +2705,7 @@ export const CreatePromptModelParameters$outboundSchema: z.ZodType<
   seed: z.number().optional(),
   format: CreatePromptPromptsFormat$outboundSchema.optional(),
   dimensions: z.string().optional(),
-  quality: CreatePromptQuality$outboundSchema.optional(),
+  quality: z.string().optional(),
   style: z.string().optional(),
   responseFormat: z.nullable(
     z.union([
@@ -3364,9 +3307,11 @@ export const CreatePromptPromptsMessages$inboundSchema: z.ZodType<
   ]),
   tool_calls: z.array(z.lazy(() => CreatePromptPromptsToolCalls$inboundSchema))
     .optional(),
+  tool_call_id: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "tool_calls": "toolCalls",
+    "tool_call_id": "toolCallId",
   });
 });
 
@@ -3377,6 +3322,7 @@ export type CreatePromptPromptsMessages$Outbound = {
     | string
     | Array<CreatePrompt2Prompts1$Outbound | CreatePrompt2Prompts2$Outbound>;
   tool_calls?: Array<CreatePromptPromptsToolCalls$Outbound> | undefined;
+  tool_call_id?: string | undefined;
 };
 
 /** @internal */
@@ -3395,9 +3341,11 @@ export const CreatePromptPromptsMessages$outboundSchema: z.ZodType<
   ]),
   toolCalls: z.array(z.lazy(() => CreatePromptPromptsToolCalls$outboundSchema))
     .optional(),
+  toolCallId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     toolCalls: "tool_calls",
+    toolCallId: "tool_call_id",
   });
 });