@orq-ai/node 3.5.12 → 3.6.0-rc.10

package/src/models/operations/updatechunk.ts

@@ -9,15 +9,7 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-/**
- * Metadata of the chunk
- */
-export type UpdateChunkMetadata = {
-  /**
-   * In case you are using PDFs, Word, PowerPoint, etc. this is the page number of the chunk.
-   */
-  pageNumber?: number | undefined;
-};
+export type UpdateChunkMetadata = string | number | boolean;
 
 export type UpdateChunkRequestBody = {
   /**
@@ -31,7 +23,7 @@ export type UpdateChunkRequestBody = {
   /**
    * Metadata of the chunk
    */
-  metadata?: UpdateChunkMetadata | undefined;
+  metadata?: { [k: string]: string | number | boolean } | undefined;
 };
 
 export type UpdateChunkRequest = {
@@ -50,6 +42,8 @@ export type UpdateChunkRequest = {
   requestBody?: UpdateChunkRequestBody | undefined;
 };
 
+export type UpdateChunkKnowledgeMetadata = string | number | boolean;
+
 /**
  * The status of the chunk
  */
@@ -78,9 +72,9 @@ export type UpdateChunkResponseBody = {
    */
   text: string;
   /**
-   * Metadata of the chunk. Can include `page_number` or any other key-value pairs. Only values of type string are supported.
+   * Metadata of the chunk. Can include `page_number` or any other key-value pairs
    */
-  metadata?: { [k: string]: string } | undefined;
+  metadata?: { [k: string]: string | number | boolean } | undefined;
   /**
    * Whether the chunk is enabled
    */
@@ -112,31 +106,17 @@ export const UpdateChunkMetadata$inboundSchema: z.ZodType<
   UpdateChunkMetadata,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  page_number: z.number().int().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "page_number": "pageNumber",
-  });
-});
+> = z.union([z.string(), z.number(), z.boolean()]);
 
 /** @internal */
-export type UpdateChunkMetadata$Outbound = {
-  page_number?: number | undefined;
-};
+export type UpdateChunkMetadata$Outbound = string | number | boolean;
 
 /** @internal */
 export const UpdateChunkMetadata$outboundSchema: z.ZodType<
   UpdateChunkMetadata$Outbound,
   z.ZodTypeDef,
   UpdateChunkMetadata
-> = z.object({
-  pageNumber: z.number().int().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    pageNumber: "page_number",
-  });
-});
+> = z.union([z.string(), z.number(), z.boolean()]);
 
 /**
  * @internal
@@ -177,14 +157,14 @@ export const UpdateChunkRequestBody$inboundSchema: z.ZodType<
 > = z.object({
   text: z.string().optional(),
   embedding: z.array(z.number()).optional(),
-  metadata: z.lazy(() => UpdateChunkMetadata$inboundSchema).optional(),
+  metadata: z.record(z.union([z.string(), z.number(), z.boolean()])).optional(),
 });
 
 /** @internal */
 export type UpdateChunkRequestBody$Outbound = {
   text?: string | undefined;
   embedding?: Array<number> | undefined;
-  metadata?: UpdateChunkMetadata$Outbound | undefined;
+  metadata?: { [k: string]: string | number | boolean } | undefined;
 };
 
 /** @internal */
@@ -195,7 +175,7 @@ export const UpdateChunkRequestBody$outboundSchema: z.ZodType<
 > = z.object({
   text: z.string().optional(),
   embedding: z.array(z.number()).optional(),
-  metadata: z.lazy(() => UpdateChunkMetadata$outboundSchema).optional(),
+  metadata: z.record(z.union([z.string(), z.number(), z.boolean()])).optional(),
 });
 
 /**
@@ -306,6 +286,56 @@ export function updateChunkRequestFromJSON(
   );
 }
 
+/** @internal */
+export const UpdateChunkKnowledgeMetadata$inboundSchema: z.ZodType<
+  UpdateChunkKnowledgeMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number(), z.boolean()]);
+
+/** @internal */
+export type UpdateChunkKnowledgeMetadata$Outbound = string | number | boolean;
+
+/** @internal */
+export const UpdateChunkKnowledgeMetadata$outboundSchema: z.ZodType<
+  UpdateChunkKnowledgeMetadata$Outbound,
+  z.ZodTypeDef,
+  UpdateChunkKnowledgeMetadata
+> = z.union([z.string(), z.number(), z.boolean()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateChunkKnowledgeMetadata$ {
+  /** @deprecated use `UpdateChunkKnowledgeMetadata$inboundSchema` instead. */
+  export const inboundSchema = UpdateChunkKnowledgeMetadata$inboundSchema;
+  /** @deprecated use `UpdateChunkKnowledgeMetadata$outboundSchema` instead. */
+  export const outboundSchema = UpdateChunkKnowledgeMetadata$outboundSchema;
+  /** @deprecated use `UpdateChunkKnowledgeMetadata$Outbound` instead. */
+  export type Outbound = UpdateChunkKnowledgeMetadata$Outbound;
+}
+
+export function updateChunkKnowledgeMetadataToJSON(
+  updateChunkKnowledgeMetadata: UpdateChunkKnowledgeMetadata,
+): string {
+  return JSON.stringify(
+    UpdateChunkKnowledgeMetadata$outboundSchema.parse(
+      updateChunkKnowledgeMetadata,
+    ),
+  );
+}
+
+export function updateChunkKnowledgeMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateChunkKnowledgeMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateChunkKnowledgeMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateChunkKnowledgeMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const UpdateChunkStatus$inboundSchema: z.ZodNativeEnum<
   typeof UpdateChunkStatus
@@ -335,7 +365,7 @@ export const UpdateChunkResponseBody$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   text: z.string(),
-  metadata: z.record(z.string()).optional(),
+  metadata: z.record(z.union([z.string(), z.number(), z.boolean()])).optional(),
   enabled: z.boolean(),
   status: UpdateChunkStatus$inboundSchema,
   created: z.string(),
@@ -354,7 +384,7 @@ export const UpdateChunkResponseBody$inboundSchema: z.ZodType<
 export type UpdateChunkResponseBody$Outbound = {
   _id: string;
   text: string;
-  metadata?: { [k: string]: string } | undefined;
+  metadata?: { [k: string]: string | number | boolean } | undefined;
   enabled: boolean;
   status: string;
   created: string;
@@ -371,7 +401,7 @@ export const UpdateChunkResponseBody$outboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   text: z.string(),
-  metadata: z.record(z.string()).optional(),
+  metadata: z.record(z.union([z.string(), z.number(), z.boolean()])).optional(),
   enabled: z.boolean(),
   status: UpdateChunkStatus$outboundSchema,
   created: z.string(),

package/src/models/operations/updatedatapoint.ts

@@ -1650,7 +1650,7 @@ export const UpdateDatapointResponseBody$inboundSchema: z.ZodType<
   created: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   updated: z.string().datetime({ offset: true }).default(
-    "2025-05-18T10:01:18.894Z",
+    "2025-05-18T21:00:21.233Z",
   ).transform(v => new Date(v)),
 }).transform((v) => {
   return remap$(v, {
@@ -1694,7 +1694,7 @@ export const UpdateDatapointResponseBody$outboundSchema: z.ZodType<
   createdById: z.string().optional(),
   updatedById: z.string().optional(),
   created: z.date().transform(v => v.toISOString()).optional(),
-  updated: z.date().default(() => new Date("2025-05-18T10:01:18.894Z"))
+  updated: z.date().default(() => new Date("2025-05-18T21:00:21.233Z"))
     .transform(v => v.toISOString()),
 }).transform((v) => {
   return remap$(v, {

package/src/models/operations/updatedataset.ts

@@ -302,7 +302,7 @@ export const UpdateDatasetResponseBody$inboundSchema: z.ZodType<
   created: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   updated: z.string().datetime({ offset: true }).default(
-    "2025-05-18T10:01:18.894Z",
+    "2025-05-18T21:00:21.233Z",
   ).transform(v => new Date(v)),
 }).transform((v) => {
   return remap$(v, {
@@ -347,7 +347,7 @@ export const UpdateDatasetResponseBody$outboundSchema: z.ZodType<
   parentId: z.string().optional(),
   version: z.string().optional(),
   created: z.date().transform(v => v.toISOString()).optional(),
-  updated: z.date().default(() => new Date("2025-05-18T10:01:18.894Z"))
+  updated: z.date().default(() => new Date("2025-05-18T21:00:21.233Z"))
     .transform(v => v.toISOString()),
 }).transform((v) => {
   return remap$(v, {

package/src/models/operations/updatedatasource.ts

@@ -244,7 +244,7 @@ export const UpdateDatasourceResponseBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("01JVHDENB1869G7D81MN5KZ5XG"),
+  _id: z.string().default("01JVJK5DFFWZEFDEK93DWT94EA"),
   display_name: z.string(),
   description: z.string().optional(),
   status: UpdateDatasourceStatus$inboundSchema,
@@ -288,7 +288,7 @@ export const UpdateDatasourceResponseBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateDatasourceResponseBody
 > = z.object({
-  id: z.string().default("01JVHDENB1869G7D81MN5KZ5XG"),
+  id: z.string().default("01JVJK5DFFWZEFDEK93DWT94EA"),
   displayName: z.string(),
   description: z.string().optional(),
   status: UpdateDatasourceStatus$outboundSchema,

package/src/sdk/datasets.ts

@@ -6,6 +6,7 @@ import { datasetsClear } from "../funcs/datasetsClear.js";
 import { datasetsCreate } from "../funcs/datasetsCreate.js";
 import { datasetsCreateDatapoint } from "../funcs/datasetsCreateDatapoint.js";
 import { datasetsCreateDatapoints } from "../funcs/datasetsCreateDatapoints.js";
+import { datasetsCreateExperiment } from "../funcs/datasetsCreateExperiment.js";
 import { datasetsDelete } from "../funcs/datasetsDelete.js";
 import { datasetsDeleteDatapoint } from "../funcs/datasetsDeleteDatapoint.js";
 import { datasetsList } from "../funcs/datasetsList.js";
@@ -104,6 +105,23 @@ export class Datasets extends ClientSDK {
     ));
   }
 
+  /**
+   * Create an experiment from a dataset
+   *
+   * @remarks
+   * Create an experiment from a dataset
+   */
+  async createExperiment(
+    request: operations.CreateDatasetExperimentRequest,
+    options?: RequestOptions,
+  ): Promise<operations.CreateDatasetExperimentResponseBody> {
+    return unwrapAsync(datasetsCreateExperiment(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List datapoints
    *

package/src/sdk/deployments.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { deploymentsCreateExperiment } from "../funcs/deploymentsCreateExperiment.js";
 import { deploymentsGetConfig } from "../funcs/deploymentsGetConfig.js";
 import { deploymentsInvoke } from "../funcs/deploymentsInvoke.js";
 import { deploymentsList } from "../funcs/deploymentsList.js";
@@ -86,4 +87,21 @@ export class Deployments extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Create an experiment from a deployment
+   *
+   * @remarks
+   * Create an experiment from a deployment
+   */
+  async createExperiment(
+    request: operations.CreateDeploymentExperimentRequest,
+    options?: RequestOptions,
+  ): Promise<operations.CreateDeploymentExperimentResponseBody> {
+    return unwrapAsync(deploymentsCreateExperiment(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/knowledge.ts

@@ -14,6 +14,7 @@ import { knowledgeListDatasources } from "../funcs/knowledgeListDatasources.js";
 import { knowledgeRetrieve } from "../funcs/knowledgeRetrieve.js";
 import { knowledgeRetrieveChunk } from "../funcs/knowledgeRetrieveChunk.js";
 import { knowledgeRetrieveDatasource } from "../funcs/knowledgeRetrieveDatasource.js";
+import { knowledgeSearch } from "../funcs/knowledgeSearch.js";
 import { knowledgeUpdate } from "../funcs/knowledgeUpdate.js";
 import { knowledgeUpdateChunk } from "../funcs/knowledgeUpdateChunk.js";
 import { knowledgeUpdateDatasource } from "../funcs/knowledgeUpdateDatasource.js";
@@ -101,6 +102,23 @@ export class Knowledge extends ClientSDK {
     ));
   }
 
+  /**
+   * Search knowledge base
+   *
+   * @remarks
+   * Search a Knowledge Base and return the most similar chunks, along with their search and rerank scores.
+   */
+  async search(
+    request: operations.SearchKnowledgeRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SearchKnowledgeResponseBody> {
+    return unwrapAsync(knowledgeSearch(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List all datasources
    */

package/packages/orq-rc/FUNCTIONS.md

@@ -1,106 +0,0 @@
-# Standalone Functions
-
-> [!NOTE]
-> This section is useful if you are using a bundler and targetting browsers and
-> runtimes where the size of an application affects performance and load times. 
-
-Every method in this SDK is also available as a standalone function. This
-alternative API is suitable when targetting the browser or serverless runtimes
-and using a bundler to build your application since all unused functionality
-will be tree-shaken away. This includes code for unused methods, Zod schemas,
-encoding helpers and response handlers. The result is dramatically smaller
-impact on the application's final bundle size which grows very slowly as you use
-more and more functionality from this SDK.
-
-Calling methods through the main SDK class remains a valid and generally more
-more ergonomic option. Standalone functions represent an optimisation for a
-specific category of applications.
-
-## Example
-
-```typescript
-import { OrqCore } from "@orq-ai/node/core.js";
-import { contactsCreate } from "@orq-ai/node/funcs/contactsCreate.js";
-import { SDKValidationError } from "@orq-ai/node/models/errors/sdkvalidationerror.js";
-
-// Use `OrqCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const orq = new OrqCore({
-  apiKey: process.env["ORQ_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await contactsCreate(orq, {
-    externalId: "<id>",
-  });
-
-  switch (true) {
-    case res.ok:
-      // The success case will be handled outside of the switch block
-      break;
-    case res.error instanceof SDKValidationError:
-      // Pretty-print validation errors.
-      return console.log(res.error.pretty());
-    case res.error instanceof Error:
-      return console.log(res.error);
-    default:
-      // TypeScript's type checking will fail on the following line if the above
-      // cases were not exhaustive.
-      res.error satisfies never;
-      throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
-  }
-
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-## Result types
-
-Standalone functions differ from SDK methods in that they return a
-`Result<Value, Error>` type to capture _known errors_ and document them using
-the type system. By avoiding throwing errors, application code maintains clear
-control flow and error-handling become part of the regular flow of application
-code.
-
-> We use the term "known errors" because standalone functions, and JavaScript
-> code in general, can still throw unexpected errors such as `TypeError`s,
-> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
-> something this SDK addresses in the future. Nevertheless, there is still a lot
-> of benefit from capturing most errors and turning them into values.
-
-The second reason for this style of programming is because these functions will
-typically be used in front-end applications where exception throwing is
-sometimes discouraged or considered unidiomatic. React and similar ecosystems
-and libraries tend to promote this style of programming so that components
-render useful content under all states (loading, success, error and so on).
-
-The general pattern when calling standalone functions looks like this:
-
-```typescript
-import { Core } from "<sdk-package-name>";
-import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
-
-const client = new Core();
-
-async function run() {
-  const result = await fetchSomething(client, { id: "123" });
-  if (!result.ok) {
-    // You can throw the error or handle it. It's your choice now.
-    throw result.error;
-  }
-
-  console.log(result.value);
-}
-
-run();
-```
-
-Notably, `result.error` above will have an explicit type compared to a try-catch
-variation where the error in the catch block can only be of type `unknown` (or
-`any` depending on your TypeScript settings).