@orq-ai/node 3.14.5-rc.1 → 3.14.6

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/evals.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { evalsAll } from "../funcs/evalsAll.js";
+import { evalsCreate } from "../funcs/evalsCreate.js";
+import { evalsDelete } from "../funcs/evalsDelete.js";
+import { evalsUpdate } from "../funcs/evalsUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Evals extends ClientSDK {
+  /**
+   * Get all Evaluators
+   */
+  async all(
+    request?: operations.GetEvalsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.GetEvalsResponseBody> {
+    return unwrapAsync(evalsAll(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create an Evaluator
+   */
+  async create(
+    request?: operations.CreateEvalRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreateEvalResponseBody> {
+    return unwrapAsync(evalsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update an Evaluator
+   */
+  async update(
+    request: operations.UpdateEvalRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateEvalResponseBody> {
+    return unwrapAsync(evalsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete an Evaluator
+   */
+  async delete(
+    request: operations.DeleteEvalRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(evalsDelete(
+      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,309 @@
+/*
+ * 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 { knowledgeDeleteChunks } from "../funcs/knowledgeDeleteChunks.js";
+import { knowledgeDeleteDatasource } from "../funcs/knowledgeDeleteDatasource.js";
+import { knowledgeGetChunksCount } from "../funcs/knowledgeGetChunksCount.js";
+import { knowledgeList } from "../funcs/knowledgeList.js";
+import { knowledgeListChunks } from "../funcs/knowledgeListChunks.js";
+import { knowledgeListChunksPaginated } from "../funcs/knowledgeListChunksPaginated.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. Note that all configuration changes made in the API will override the settings in the UI.
+   */
+  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.ResponseBody>> {
+    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,
+    ));
+  }
+
+  /**
+   * Delete multiple chunks
+   */
+  async deleteChunks(
+    request: operations.DeleteChunksRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DeleteChunksResponseBody> {
+    return unwrapAsync(knowledgeDeleteChunks(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List chunks with offset-based pagination
+   */
+  async listChunksPaginated(
+    request: operations.ListChunksPaginatedRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListChunksPaginatedResponseBody> {
+    return unwrapAsync(knowledgeListChunksPaginated(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get chunks total count
+   */
+  async getChunksCount(
+    request: operations.GetChunksCountRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetChunksCountResponseBody> {
+    return unwrapAsync(knowledgeGetChunksCount(
+      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,
+    ));
+  }
+}