@orq-ai/node 3.3.0-rc.11 → 3.3.0-rc.13

package/src/models/operations/updateprompt.ts

@@ -383,6 +383,9 @@ export const UpdatePromptUseCases = {
   Sql: "SQL",
   Summarization: "Summarization",
   Tagging: "Tagging",
+  TranslationDocument: "Translation (document)",
+  TranslationSentences: "Translation (sentences)",
+  SentimentAnalysis: "Sentiment analysis",
 } as const;
 export type UpdatePromptUseCases = ClosedEnum<typeof UpdatePromptUseCases>;
 
@@ -853,6 +856,9 @@ export const UpdatePromptPromptsUseCases = {
   Sql: "SQL",
   Summarization: "Summarization",
   Tagging: "Tagging",
+  TranslationDocument: "Translation (document)",
+  TranslationSentences: "Translation (sentences)",
+  SentimentAnalysis: "Sentiment analysis",
 } as const;
 export type UpdatePromptPromptsUseCases = ClosedEnum<
   typeof UpdatePromptPromptsUseCases

package/src/sdk/files.ts

@@ -18,7 +18,7 @@ export class Files extends ClientSDK {
    * 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,
+    request: operations.FileUploadRequestBody,
     options?: RequestOptions,
   ): Promise<operations.FileUploadResponseBody> {
     return unwrapAsync(filesCreate(

package/src/sdk/knowledge.ts

@@ -0,0 +1,246 @@
+/*
+ * 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 { knowledgeRetrieveDatasource } from "../funcs/knowledgeRetrieveDatasource.js";
+import { knowledgeRetrieveFileUrl } from "../funcs/knowledgeRetrieveFileUrl.js";
+import { knowledgeSearch } from "../funcs/knowledgeSearch.js";
+import { knowledgeUpdate } from "../funcs/knowledgeUpdate.js";
+import { knowledgeUpdateChunk } from "../funcs/knowledgeUpdateChunk.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,
+    ));
+  }
+
+  /**
+   * Retrieves the file upload url
+   */
+  async retrieveFileUrl(
+    request: operations.GetOneFileUploadUrlRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetOneFileUploadUrlResponseBody> {
+    return unwrapAsync(knowledgeRetrieveFileUrl(
+      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,
+    ));
+  }
+
+  /**
+   * 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,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -8,6 +8,7 @@ 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 { Prompts } from "./prompts.js";
 import { Remoteconfigs } from "./remoteconfigs.js";
 
@@ -46,4 +47,9 @@ export class Orq extends ClientSDK {
   get datasets(): Datasets {
     return (this._datasets ??= new Datasets(this._options));
   }
+
+  private _knowledge?: Knowledge;
+  get knowledge(): Knowledge {
+    return (this._knowledge ??= new Knowledge(this._options));
+  }
 }