@orq-ai/node 4.5.0-rc.9 → 4.5.3

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,
+    ));
+  }
+}

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

@@ -0,0 +1,286 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { memoryStoresCreate } from "../funcs/memoryStoresCreate.js";
+import { memoryStoresCreateDocument } from "../funcs/memoryStoresCreateDocument.js";
+import { memoryStoresCreateMemory } from "../funcs/memoryStoresCreateMemory.js";
+import { memoryStoresDelete } from "../funcs/memoryStoresDelete.js";
+import { memoryStoresDeleteDocument } from "../funcs/memoryStoresDeleteDocument.js";
+import { memoryStoresDeleteMemory } from "../funcs/memoryStoresDeleteMemory.js";
+import { memoryStoresList } from "../funcs/memoryStoresList.js";
+import { memoryStoresListDocuments } from "../funcs/memoryStoresListDocuments.js";
+import { memoryStoresListMemories } from "../funcs/memoryStoresListMemories.js";
+import { memoryStoresRetrieve } from "../funcs/memoryStoresRetrieve.js";
+import { memoryStoresRetrieveDocument } from "../funcs/memoryStoresRetrieveDocument.js";
+import { memoryStoresRetrieveMemory } from "../funcs/memoryStoresRetrieveMemory.js";
+import { memoryStoresUpdate } from "../funcs/memoryStoresUpdate.js";
+import { memoryStoresUpdateDocument } from "../funcs/memoryStoresUpdateDocument.js";
+import { memoryStoresUpdateMemory } from "../funcs/memoryStoresUpdateMemory.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class MemoryStores extends ClientSDK {
+  /**
+   * List memory stores
+   *
+   * @remarks
+   * Retrieves a paginated list of memory stores in the workspace. Use cursor-based pagination parameters to navigate through the results.
+   */
+  async list(
+    request?: operations.GetAllMemoryStoresRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.GetAllMemoryStoresResponseBody> {
+    return unwrapAsync(memoryStoresList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create memory store
+   */
+  async create(
+    request?: operations.CreateMemoryStoreRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreateMemoryStoreResponseBody> {
+    return unwrapAsync(memoryStoresCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve memory store
+   *
+   * @remarks
+   * Retrieves detailed information about a specific memory store, including its configuration and metadata.
+   */
+  async retrieve(
+    request: operations.RetrieveMemoryStoreRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveMemoryStoreResponseBody> {
+    return unwrapAsync(memoryStoresRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update memory store
+   *
+   * @remarks
+   * Update the memory store configuration
+   */
+  async update(
+    request: operations.UpdateMemoryStoreRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateMemoryStoreResponseBody> {
+    return unwrapAsync(memoryStoresUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete memory store
+   *
+   * @remarks
+   * Permanently delete a memory store, including memories and documents.
+   */
+  async delete(
+    request: operations.DeleteMemoryStoreRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(memoryStoresDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all memories
+   *
+   * @remarks
+   * Retrieves a paginated list of memories for the memory store
+   */
+  async listMemories(
+    request: operations.GetAllMemoriesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetAllMemoriesResponseBody> {
+    return unwrapAsync(memoryStoresListMemories(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a new memory
+   *
+   * @remarks
+   * Creates a new memory in the specified memory store.
+   */
+  async createMemory(
+    request: operations.CreateMemoryRequest,
+    options?: RequestOptions,
+  ): Promise<operations.CreateMemoryResponseBody> {
+    return unwrapAsync(memoryStoresCreateMemory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a specific memory
+   *
+   * @remarks
+   * Retrieves details of a specific memory by its ID
+   */
+  async retrieveMemory(
+    request: operations.RetrieveMemoryRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveMemoryResponseBody> {
+    return unwrapAsync(memoryStoresRetrieveMemory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a specific memory
+   *
+   * @remarks
+   * Updates the details of a specific memory.
+   */
+  async updateMemory(
+    request: operations.UpdateMemoryRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateMemoryResponseBody> {
+    return unwrapAsync(memoryStoresUpdateMemory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a specific memory
+   *
+   * @remarks
+   * Permanently deletes a specific memory.
+   *
+   *         Use this endpoint to:
+   *         - Remove a memory from the store
+   *         - Clean up unused memories
+   *         - Manage memory storage space
+   */
+  async deleteMemory(
+    request: operations.DeleteMemoryRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(memoryStoresDeleteMemory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all documents for a memory
+   *
+   * @remarks
+   * Retrieves a paginated list of documents associated with a specific memory.
+   */
+  async listDocuments(
+    request: operations.GetAllMemoryDocumentsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetAllMemoryDocumentsResponseBody> {
+    return unwrapAsync(memoryStoresListDocuments(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a new memory document
+   *
+   * @remarks
+   * Creates a new document in the specified memory.
+   */
+  async createDocument(
+    request: operations.CreateMemoryDocumentRequest,
+    options?: RequestOptions,
+  ): Promise<operations.CreateMemoryDocumentResponseBody> {
+    return unwrapAsync(memoryStoresCreateDocument(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a specific memory document
+   *
+   * @remarks
+   * Retrieves details of a specific memory document by its ID.
+   */
+  async retrieveDocument(
+    request: operations.RetrieveMemoryDocumentRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveMemoryDocumentResponseBody> {
+    return unwrapAsync(memoryStoresRetrieveDocument(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a specific memory document
+   *
+   * @remarks
+   * Updates the details of a specific memory document.
+   */
+  async updateDocument(
+    request: operations.UpdateMemoryDocumentRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateMemoryDocumentResponseBody> {
+    return unwrapAsync(memoryStoresUpdateDocument(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a specific memory document
+   *
+   * @remarks
+   * Permanently deletes a specific memory document.
+   *
+   *         Use this endpoint to:
+   *         - Remove a document from a memory
+   *         - Clean up unused documents
+   *         - Manage document storage space
+   */
+  async deleteDocument(
+    request: operations.DeleteMemoryDocumentRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(memoryStoresDeleteDocument(
+      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/moderations.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { routerModerationsCreate } from "../funcs/routerModerationsCreate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Moderations extends ClientSDK {
+  /**
+   * Create moderation
+   */
+  async create(
+    request: operations.CreateModerationRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.CreateModerationResponseBody> {
+    return unwrapAsync(routerModerationsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  CreateAcceptEnum,
+  routerChatCompletionsCreate,
+} from "../funcs/routerChatCompletionsCreate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export { CreateAcceptEnum } from "../funcs/routerChatCompletionsCreate.js";
+
+export class OrqCompletions extends ClientSDK {
+  /**
+   * Create chat completion
+   *
+   * @remarks
+   * Creates a model response for the given chat conversation with support for retries, fallbacks, prompts, and variables.
+   */
+  async create(
+    request: operations.CreateChatCompletionRequestBody,
+    options?: RequestOptions & { acceptHeaderOverride?: CreateAcceptEnum },
+  ): Promise<operations.CreateChatCompletionResponse> {
+    return unwrapAsync(routerChatCompletionsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+}