@orq-ai/node 3.3.0-rc.8 → 3.3.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,89 @@
+/*
+ * 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 { deploymentsStream } from "../funcs/deploymentsStream.js";
+import { EventStream } from "../lib/event-streams.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,
+    ));
+  }
+
+  /**
+   * Stream
+   *
+   * @remarks
+   * Stream deployment generation. Only supported for completions and chat completions.
+   */
+  async stream(
+    request: operations.DeploymentStreamRequestBody,
+    options?: RequestOptions,
+  ): Promise<EventStream<operations.DeploymentStreamResponseBody>> {
+    return unwrapAsync(deploymentsStream(
+      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,
+    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/knowledge.ts

@@ -0,0 +1,261 @@
+/*
+ * 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,
+    ));
+  }
+
+  /**
+   * Retrieves the documents used for retrieval
+   */
+  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,
+    ));
+  }
+}