@orq-ai/node 3.2.0-rc.8 → 3.2.0

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

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { contactsCreate } from "../funcs/contactsCreate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Contacts extends ClientSDK {
+  /**
+   * Update user information
+   *
+   * @remarks
+   * Update or add user information to workspace
+   */
+  async create(
+    request: operations.CreateContactRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.CreateContactResponseBody> {
+    return unwrapAsync(contactsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,222 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 { datasetsDelete } from "../funcs/datasetsDelete.js";
+import { datasetsDeleteDatapoint } from "../funcs/datasetsDeleteDatapoint.js";
+import { datasetsList } from "../funcs/datasetsList.js";
+import { datasetsListDatapoints } from "../funcs/datasetsListDatapoints.js";
+import { datasetsRetrieve } from "../funcs/datasetsRetrieve.js";
+import { datasetsRetrieveDatapoint } from "../funcs/datasetsRetrieveDatapoint.js";
+import { datasetsUpdate } from "../funcs/datasetsUpdate.js";
+import { datasetsUpdateDatapoint } from "../funcs/datasetsUpdateDatapoint.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Datasets extends ClientSDK {
+  /**
+   * List datasets
+   *
+   * @remarks
+   * Retrieves a paginated list of datasets for the current workspace. Results can be paginated using cursor-based pagination.
+   */
+  async list(
+    request?: operations.ListDatasetsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.ListDatasetsResponseBody> {
+    return unwrapAsync(datasetsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a dataset
+   *
+   * @remarks
+   * Creates a new dataset in the specified project.
+   */
+  async create(
+    request?: operations.CreateDatasetRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreateDatasetResponseBody> {
+    return unwrapAsync(datasetsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a dataset
+   *
+   * @remarks
+   * Retrieves a specific dataset by its unique identifier
+   */
+  async retrieve(
+    request: operations.RetrieveDatasetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveDatasetResponseBody> {
+    return unwrapAsync(datasetsRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a dataset
+   *
+   * @remarks
+   * Update a dataset
+   */
+  async update(
+    request: operations.UpdateDatasetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateDatasetResponseBody> {
+    return unwrapAsync(datasetsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a dataset
+   *
+   * @remarks
+   * Permanently deletes a dataset and all its datapoints. This action is irreversible.
+   */
+  async delete(
+    request: operations.DeleteDatasetRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(datasetsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List datapoints
+   *
+   * @remarks
+   * Retrieves a paginated list of datapoints from a specific dataset.
+   */
+  async listDatapoints(
+    request: operations.ListDatasetDatapointsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListDatasetDatapointsResponseBody> {
+    return unwrapAsync(datasetsListDatapoints(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a datapoint
+   *
+   * @remarks
+   * Creates a new datapoint in the specified dataset.
+   */
+  async createDatapoint(
+    request: operations.CreateDatasetItemRequest,
+    options?: RequestOptions,
+  ): Promise<operations.CreateDatasetItemResponseBody> {
+    return unwrapAsync(datasetsCreateDatapoint(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a datapoint
+   *
+   * @remarks
+   * Retrieves a datapoint object
+   */
+  async retrieveDatapoint(
+    request: operations.RetrieveDatapointRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveDatapointResponseBody> {
+    return unwrapAsync(datasetsRetrieveDatapoint(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a datapoint
+   */
+  async updateDatapoint(
+    request: operations.UpdateDatapointRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateDatapointResponseBody> {
+    return unwrapAsync(datasetsUpdateDatapoint(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a datapoint
+   *
+   * @remarks
+   * Permanently deletes a specific datapoint from a dataset.
+   */
+  async deleteDatapoint(
+    request: operations.DeleteDatapointRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(datasetsDeleteDatapoint(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create multiple datapoints
+   *
+   * @remarks
+   * Create multiple datapoints at once.
+   */
+  async createDatapoints(
+    request: operations.BulkCreateDatapointsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<operations.ResponseBody>> {
+    return unwrapAsync(datasetsCreateDatapoints(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete all datapoints
+   *
+   * @remarks
+   * Delete all datapoints from a dataset. This action is irreversible.
+   */
+  async clear(
+    request: operations.ClearDatasetRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(datasetsClear(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { deploymentsGetConfig } from "../funcs/deploymentsGetConfig.js";
+import { deploymentsInvoke } from "../funcs/deploymentsInvoke.js";
+import { deploymentsList } from "../funcs/deploymentsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { Metrics } from "./metrics.js";
+
+export class Deployments extends ClientSDK {
+  private _metrics?: Metrics;
+  get metrics(): Metrics {
+    return (this._metrics ??= new Metrics(this._options));
+  }
+
+  /**
+   * List all deployments
+   *
+   * @remarks
+   * Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first.
+   */
+  async list(
+    request?: operations.DeploymentsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.DeploymentsResponseBody> {
+    return unwrapAsync(deploymentsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get config
+   *
+   * @remarks
+   * Retrieve the deployment configuration
+   */
+  async getConfig(
+    request: operations.DeploymentGetConfigRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.DeploymentGetConfigResponseBody | undefined> {
+    return unwrapAsync(deploymentsGetConfig(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Invoke
+   *
+   * @remarks
+   * Invoke a deployment with a given payload
+   */
+  async invoke(
+    request: components.Deployments,
+    options?: RequestOptions,
+  ): Promise<operations.DeploymentInvokeResponseBody | undefined> {
+    return unwrapAsync(deploymentsInvoke(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { feedbackCreate } from "../funcs/feedbackCreate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Feedback extends ClientSDK {
+  /**
+   * Submit feedback
+   *
+   * @remarks
+   * Submit feedback for the LLM transaction via the API
+   */
+  async create(
+    request: operations.CreateFeedbackRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.CreateFeedbackResponseBody> {
+    return unwrapAsync(feedbackCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { filesCreate } from "../funcs/filesCreate.js";
+import { filesDelete } from "../funcs/filesDelete.js";
+import { filesGet } from "../funcs/filesGet.js";
+import { filesList } from "../funcs/filesList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Files extends ClientSDK {
+  /**
+   * Create file
+   *
+   * @remarks
+   * Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/deploymentinvoke-1).
+   */
+  async create(
+    request?: operations.FileUploadRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.FileUploadResponseBody> {
+    return unwrapAsync(filesCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all files
+   *
+   * @remarks
+   * Returns a list of the files that your account has access to. orq.ai sorts and returns the files by their creation dates, placing the most recently created files at the top.
+   */
+  async list(
+    request?: operations.FileListRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.FileListResponseBody> {
+    return unwrapAsync(filesList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a file
+   *
+   * @remarks
+   * Retrieves the details of an existing file object. After you supply a unique file ID, orq.ai returns the corresponding file object
+   */
+  async get(
+    request: operations.FileGetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.FileGetResponseBody> {
+    return unwrapAsync(filesGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete file
+   */
+  async delete(
+    request: operations.FileDeleteRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(filesDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,5 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./sdk.js";

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/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,
+    ));
+  }
+
+  /**
+   * 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,
+    ));
+  }
+
+  /**
+   * Create a prompt
+   */
+  async create(
+    request?: operations.CreatePromptRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreatePromptResponseBody> {
+    return unwrapAsync(promptsCreate(
+      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,49 @@
+/*
+ * 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 { 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 _datasets?: Datasets;
+  get datasets(): Datasets {
+    return (this._datasets ??= new Datasets(this._options));
+  }
+}