@orq-ai/node 3.6.0-rc.9 → 3.7.0

package/packages/orq-rc/src/sdk/knowledge.ts

@@ -0,0 +1,264 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { knowledgeCreate } from "../funcs/knowledgeCreate.js";
+import { knowledgeCreateChunks } from "../funcs/knowledgeCreateChunks.js";
+import { knowledgeCreateDatasource } from "../funcs/knowledgeCreateDatasource.js";
+import { knowledgeDelete } from "../funcs/knowledgeDelete.js";
+import { knowledgeDeleteChunk } from "../funcs/knowledgeDeleteChunk.js";
+import { knowledgeDeleteDatasource } from "../funcs/knowledgeDeleteDatasource.js";
+import { knowledgeList } from "../funcs/knowledgeList.js";
+import { knowledgeListChunks } from "../funcs/knowledgeListChunks.js";
+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";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Knowledge extends ClientSDK {
+  /**
+   * List all knowledge bases
+   *
+   * @remarks
+   * Returns a list of your knowledge bases. The knowledge bases are returned sorted by creation date, with the most recent knowledge bases appearing first
+   */
+  async list(
+    request?: operations.ListKnowledgeBasesRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.ListKnowledgeBasesResponseBody> {
+    return unwrapAsync(knowledgeList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a knowledge
+   */
+  async create(
+    request: operations.CreateKnowledgeRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.CreateKnowledgeResponseBody> {
+    return unwrapAsync(knowledgeCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieves a knowledge base
+   *
+   * @remarks
+   * Retrieve a knowledge base with the settings.
+   */
+  async retrieve(
+    request: operations.GetOneKnowledgeRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetOneKnowledgeResponseBody> {
+    return unwrapAsync(knowledgeRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Updates a knowledge
+   */
+  async update(
+    request: operations.UpdateKnowledgeRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateKnowledgeResponseBody> {
+    return unwrapAsync(knowledgeUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Deletes a knowledge
+   *
+   * @remarks
+   * Deletes a knowledge base. Deleting a knowledge base will delete all the datasources and chunks associated with it.
+   */
+  async delete(
+    request: operations.DeleteKnowledgeRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(knowledgeDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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
+   */
+  async listDatasources(
+    request: operations.ListDatasourcesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListDatasourcesResponseBody> {
+    return unwrapAsync(knowledgeListDatasources(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a new datasource
+   */
+  async createDatasource(
+    request: operations.CreateDatasourceRequest,
+    options?: RequestOptions,
+  ): Promise<operations.CreateDatasourceResponseBody> {
+    return unwrapAsync(knowledgeCreateDatasource(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a datasource
+   */
+  async retrieveDatasource(
+    request: operations.RetrieveDatasourceRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveDatasourceResponseBody> {
+    return unwrapAsync(knowledgeRetrieveDatasource(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Deletes a datasource
+   *
+   * @remarks
+   * Deletes a datasource from a knowledge base. Deleting a datasource will remove it from the knowledge base and all associated chunks. This action is irreversible and cannot be undone.
+   */
+  async deleteDatasource(
+    request: operations.DeleteDatasourceRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(knowledgeDeleteDatasource(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a datasource
+   */
+  async updateDatasource(
+    request: operations.UpdateDatasourceRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateDatasourceResponseBody> {
+    return unwrapAsync(knowledgeUpdateDatasource(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create chunks for a datasource
+   */
+  async createChunks(
+    request: operations.CreateChunkRequest,
+    options?: RequestOptions,
+  ): Promise<Array<operations.CreateChunkResponseBody>> {
+    return unwrapAsync(knowledgeCreateChunks(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all chunks for a datasource
+   */
+  async listChunks(
+    request: operations.ListChunksRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListChunksResponseBody> {
+    return unwrapAsync(knowledgeListChunks(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a chunk
+   */
+  async updateChunk(
+    request: operations.UpdateChunkRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateChunkResponseBody> {
+    return unwrapAsync(knowledgeUpdateChunk(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a chunk
+   */
+  async deleteChunk(
+    request: operations.DeleteChunkRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(knowledgeDeleteChunk(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a chunk
+   */
+  async retrieveChunk(
+    request: operations.GetOneChunkRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetOneChunkResponseBody> {
+    return unwrapAsync(knowledgeRetrieveChunk(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/packages/orq-rc/src/sdk/metrics.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { deploymentsMetricsCreate } from "../funcs/deploymentsMetricsCreate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Metrics extends ClientSDK {
+  /**
+   * Add metrics
+   *
+   * @remarks
+   * Add metrics to a deployment
+   */
+  async create(
+    request: operations.DeploymentCreateMetricRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DeploymentCreateMetricResponseBody> {
+    return unwrapAsync(deploymentsMetricsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/packages/orq-rc/src/sdk/models.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { modelsList } from "../funcs/modelsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Models extends ClientSDK {
+  /**
+   * List models
+   *
+   * @remarks
+   * Lists the currently available models, and provides basic information about each one such as the owner and availability.
+   */
+  async list(
+    options?: RequestOptions,
+  ): Promise<operations.ListModelsResponseBody> {
+    return unwrapAsync(modelsList(
+      this,
+      options,
+    ));
+  }
+}

package/packages/orq-rc/src/sdk/prompts.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { promptsCreate } from "../funcs/promptsCreate.js";
+import { promptsDelete } from "../funcs/promptsDelete.js";
+import { promptsGetVersion } from "../funcs/promptsGetVersion.js";
+import { promptsList } from "../funcs/promptsList.js";
+import { promptsListVersions } from "../funcs/promptsListVersions.js";
+import { promptsRetrieve } from "../funcs/promptsRetrieve.js";
+import { promptsUpdate } from "../funcs/promptsUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Prompts extends ClientSDK {
+  /**
+   * List all prompts
+   *
+   * @remarks
+   * Returns a list of your prompts. The prompts are returned sorted by creation date, with the most recent prompts appearing first
+   */
+  async list(
+    request?: operations.GetAllPromptsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.GetAllPromptsResponseBody> {
+    return unwrapAsync(promptsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a prompt
+   */
+  async create(
+    request?: operations.CreatePromptRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreatePromptResponseBody> {
+    return unwrapAsync(promptsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a prompt
+   *
+   * @remarks
+   * Retrieves a prompt object
+   */
+  async retrieve(
+    request: operations.GetOnePromptRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetOnePromptResponseBody> {
+    return unwrapAsync(promptsRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a prompt
+   */
+  async update(
+    request: operations.UpdatePromptRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdatePromptResponseBody> {
+    return unwrapAsync(promptsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a prompt
+   */
+  async delete(
+    request: operations.DeletePromptRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(promptsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all prompt versions
+   *
+   * @remarks
+   * Returns a list of your prompt versions. The prompt versions are returned sorted by creation date, with the most recent prompt versions appearing first
+   */
+  async listVersions(
+    request: operations.ListPromptVersionsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListPromptVersionsResponseBody> {
+    return unwrapAsync(promptsListVersions(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a prompt version
+   *
+   * @remarks
+   * Retrieves a specific version of a prompt by its ID and version ID.
+   */
+  async getVersion(
+    request: operations.GetPromptVersionRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetPromptVersionResponseBody> {
+    return unwrapAsync(promptsGetVersion(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/packages/orq-rc/src/sdk/remoteconfigs.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remoteconfigsRetrieve } from "../funcs/remoteconfigsRetrieve.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Remoteconfigs extends ClientSDK {
+  /**
+   * Retrieve a remote config
+   */
+  async retrieve(
+    request?: operations.RemoteConfigsGetConfigRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.RemoteConfigsGetConfigResponseBody> {
+    return unwrapAsync(remoteconfigsRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/packages/orq-rc/src/sdk/sdk.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "../lib/sdks.js";
+import { Contacts } from "./contacts.js";
+import { Datasets } from "./datasets.js";
+import { Deployments } from "./deployments.js";
+import { Feedback } from "./feedback.js";
+import { Files } from "./files.js";
+import { Knowledge } from "./knowledge.js";
+import { Models } from "./models.js";
+import { Prompts } from "./prompts.js";
+import { Remoteconfigs } from "./remoteconfigs.js";
+
+export class Orq extends ClientSDK {
+  private _contacts?: Contacts;
+  get contacts(): Contacts {
+    return (this._contacts ??= new Contacts(this._options));
+  }
+
+  private _feedback?: Feedback;
+  get feedback(): Feedback {
+    return (this._feedback ??= new Feedback(this._options));
+  }
+
+  private _deployments?: Deployments;
+  get deployments(): Deployments {
+    return (this._deployments ??= new Deployments(this._options));
+  }
+
+  private _files?: Files;
+  get files(): Files {
+    return (this._files ??= new Files(this._options));
+  }
+
+  private _prompts?: Prompts;
+  get prompts(): Prompts {
+    return (this._prompts ??= new Prompts(this._options));
+  }
+
+  private _remoteconfigs?: Remoteconfigs;
+  get remoteconfigs(): Remoteconfigs {
+    return (this._remoteconfigs ??= new Remoteconfigs(this._options));
+  }
+
+  private _models?: Models;
+  get models(): Models {
+    return (this._models ??= new Models(this._options));
+  }
+
+  private _datasets?: Datasets;
+  get datasets(): Datasets {
+    return (this._datasets ??= new Datasets(this._options));
+  }
+
+  private _knowledge?: Knowledge;
+  get knowledge(): Knowledge {
+    return (this._knowledge ??= new Knowledge(this._options));
+  }
+}

package/packages/orq-rc/src/types/async.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export type APICall =
+  | {
+      status: "complete";
+      request: Request;
+      response: Response;
+    }
+  | {
+      status: "request-error";
+      request: Request;
+      response?: undefined;
+    }
+  | {
+      status: "invalid";
+      request?: undefined;
+      response?: undefined;
+    };
+
+export class APIPromise<T> implements Promise<T> {
+  readonly #promise: Promise<[T, APICall]>;
+  readonly #unwrapped: Promise<T>;
+
+  readonly [Symbol.toStringTag] = "APIPromise";
+
+  constructor(p: [T, APICall] | Promise<[T, APICall]>) {
+    this.#promise = p instanceof Promise ? p : Promise.resolve(p);
+    this.#unwrapped =
+      p instanceof Promise
+        ? this.#promise.then(([value]) => value)
+        : Promise.resolve(p[0]);
+  }
+
+  then<TResult1 = T, TResult2 = never>(
+    onfulfilled?:
+      | ((value: T) => TResult1 | PromiseLike<TResult1>)
+      | null
+      | undefined,
+    onrejected?:
+      | ((reason: any) => TResult2 | PromiseLike<TResult2>)
+      | null
+      | undefined,
+  ): Promise<TResult1 | TResult2> {
+    return this.#promise.then(
+      onfulfilled ? ([value]) => onfulfilled(value) : void 0,
+      onrejected,
+    );
+  }
+
+  catch<TResult = never>(
+    onrejected?:
+      | ((reason: any) => TResult | PromiseLike<TResult>)
+      | null
+      | undefined,
+  ): Promise<T | TResult> {
+    return this.#unwrapped.catch(onrejected);
+  }
+
+  finally(onfinally?: (() => void) | null | undefined): Promise<T> {
+    return this.#unwrapped.finally(onfinally);
+  }
+
+  $inspect(): Promise<[T, APICall]> {
+    return this.#promise;
+  }
+}

package/packages/orq-rc/src/types/blobs.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> =
+  z.custom<Blob>(isBlobLike, {
+    message: "expected a Blob, File or Blob-like object",
+    fatal: true,
+  });
+
+export function isBlobLike(val: unknown): val is Blob {
+  if (val instanceof Blob) {
+    return true;
+  }
+
+  if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) {
+    return false;
+  }
+
+  const name = val[Symbol.toStringTag];
+  if (typeof name !== "string") {
+    return false;
+  }
+  if (name !== "Blob" && name !== "File") {
+    return false;
+  }
+
+  return "stream" in val && typeof val.stream === "function";
+}

package/packages/orq-rc/src/types/constdatetime.ts

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export function constDateTime(
+  val: string,
+): z.ZodType<string, z.ZodTypeDef, unknown> {
+  return z.custom<string>((v) => {
+    return (
+      typeof v === "string" && new Date(v).getTime() === new Date(val).getTime()
+    );
+  }, `Value must be equivelant to ${val}`);
+}

package/packages/orq-rc/src/types/enums.ts

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+declare const __brand: unique symbol;
+export type Unrecognized<T> = T & { [__brand]: "unrecognized" };
+
+export function catchUnrecognizedEnum<T>(value: T): Unrecognized<T> {
+  return value as Unrecognized<T>;
+}
+
+type Prettify<T> = { [K in keyof T]: T[K] } & {};
+export type ClosedEnum<T> = T[keyof T];
+export type OpenEnum<T> =
+  | Prettify<T[keyof T]>
+  | Unrecognized<T[keyof T] extends number ? number : string>;