@orq-ai/node 4.14.0-rc.20 → 4.14.0-rc.37

package/src/sdk/evals.ts

@@ -10,12 +10,16 @@ import { evalsInvoke } from "../funcs/evalsInvoke.js";
 import { evalsListVersions } from "../funcs/evalsListVersions.js";
 import { evalsUpdate } from "../funcs/evalsUpdate.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";
 
 export class Evals extends ClientSDK {
   /**
    * Get all Evaluators
+   *
+   * @remarks
+   * List all evaluators in the workspace.
    */
   async all(
     request?: operations.GetEvalsRequest | undefined,
@@ -30,6 +34,9 @@ export class Evals extends ClientSDK {
 
   /**
    * Create an Evaluator
+   *
+   * @remarks
+   * Create a new evaluator in the workspace.
    */
   async create(
     request?: operations.CreateEvalRequestBody | undefined,
@@ -46,11 +53,7 @@ export class Evals extends ClientSDK {
    * Retrieve an Evaluator
    *
    * @remarks
-   * Retrieve a single evaluator by its unique identifier. Returns the evaluator exactly as stored, including its type-specific configuration — prompt and model for LLM evaluators, source code for Python and TypeScript evaluators, the JSON Schema for schema evaluators, and so on.
-   *
-   * Use this when you already know the evaluator id (for example to refresh the state of a resource you manage declaratively). To discover evaluator ids, list them with `GET /v2/evaluators`.
-   *
-   * This endpoint returns the stored record, which carries more detail than the representation `GET /v2/evaluators` returns: `display_name` rather than `key`, `model` as an object rather than a provider-qualified string, plus the `owner`, `domain_id`, `metadata`, `enabled` and `output_type` fields.
+   * Retrieve a single evaluator by ID with more detail than the list endpoint: full type-specific config, owner, domain_id, metadata, enabled, and output_type.
    */
   async get(
     request: operations.GetEvalRequest,
@@ -65,6 +68,9 @@ export class Evals extends ClientSDK {
 
   /**
    * Update an Evaluator
+   *
+   * @remarks
+   * Update an evaluator by ID with the provided fields.
    */
   async update(
     request: operations.UpdateEvalRequest,
@@ -79,6 +85,9 @@ export class Evals extends ClientSDK {
 
   /**
    * Delete an Evaluator
+   *
+   * @remarks
+   * Delete an evaluator by its unique identifier.
    */
   async delete(
     request: operations.DeleteEvalRequest,
@@ -93,11 +102,14 @@ export class Evals extends ClientSDK {
 
   /**
    * Invoke a Custom Evaluator
+   *
+   * @remarks
+   * Runs an evaluator that already exists in the workspace. Accepts either a conversation or the structured input and output fields; when both are present the conversation wins.
    */
   async invoke(
     request: operations.InvokeEvalRequest,
     options?: RequestOptions,
-  ): Promise<operations.InvokeEvalResponseBody> {
+  ): Promise<components.InvokeEvaluatorResponse> {
     return unwrapAsync(evalsInvoke(
       this,
       request,

package/src/sdk/feedback.ts

@@ -44,12 +44,6 @@ export class Feedback extends ClientSDK {
     ));
   }
 
-  /**
-   * Create completion
-   *
-   * @remarks
-   * For sending requests to legacy completion models
-   */
   async create(
     request?: operations.PostV2FeedbackRequestBody | undefined,
     options?: RequestOptions,

package/src/sdk/guardrailrules.ts

@@ -35,7 +35,7 @@ export class GuardrailRules extends ClientSDK {
    * Create a guardrail rule
    *
    * @remarks
-   * Creates a guardrail rule with metadata and optional evaluator, plugin, timeout, and matching configuration. Rules default to disabled when `enabled` is omitted.
+   * Creates a guardrail rule with metadata and optional evaluator, plugin, and matching configuration. Rules default to disabled when `enabled` is omitted.
    */
   async create(
     request: components.CreateGuardrailRuleRequest,

package/src/sdk/knowledge.ts

@@ -17,11 +17,15 @@ 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 { knowledgeRetrieveFileUrl } from "../funcs/knowledgeRetrieveFileUrl.js";
+import { knowledgeRetrieveProcessingStatus } from "../funcs/knowledgeRetrieveProcessingStatus.js";
 import { knowledgeSearch } from "../funcs/knowledgeSearch.js";
+import { knowledgeToggleChunk } from "../funcs/knowledgeToggleChunk.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 components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
@@ -35,7 +39,7 @@ export class Knowledge extends ClientSDK {
   async list(
     request?: operations.ListKnowledgeBasesRequest | undefined,
     options?: RequestOptions,
-  ): Promise<operations.ListKnowledgeBasesResponseBody> {
+  ): Promise<components.KnowledgeBasesServiceListResponse> {
     return unwrapAsync(knowledgeList(
       this,
       request,
@@ -45,11 +49,14 @@ export class Knowledge extends ClientSDK {
 
   /**
    * Create a knowledge
+   *
+   * @remarks
+   * Creates an internal or external knowledge base. Internal knowledge bases embed and index uploaded content; external knowledge bases query the configured external retrieval API.
    */
   async create(
-    request: operations.CreateKnowledgeRequestBody,
+    request: components.KnowledgeBasesServiceCreateRequest,
     options?: RequestOptions,
-  ): Promise<operations.CreateKnowledgeResponseBody> {
+  ): Promise<components.Knowledge> {
     return unwrapAsync(knowledgeCreate(
       this,
       request,
@@ -66,7 +73,7 @@ export class Knowledge extends ClientSDK {
   async retrieve(
     request: operations.GetOneKnowledgeRequest,
     options?: RequestOptions,
-  ): Promise<operations.GetOneKnowledgeResponseBody> {
+  ): Promise<components.Knowledge> {
     return unwrapAsync(knowledgeRetrieve(
       this,
       request,
@@ -74,20 +81,6 @@ export class Knowledge extends ClientSDK {
     ));
   }
 
-  /**
-   * Updates a knowledge
-   */
-  async update(
-    request: operations.UpdateKnowledgeRequest,
-    options?: RequestOptions,
-  ): Promise<operations.UpdateKnowledgeResponseBody> {
-    return unwrapAsync(knowledgeUpdate(
-      this,
-      request,
-      options,
-    ));
-  }
-
   /**
    * Deletes a knowledge
    *
@@ -106,16 +99,16 @@ export class Knowledge extends ClientSDK {
   }
 
   /**
-   * Search knowledge base
+   * Updates a knowledge
    *
    * @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.
+   * Updates a knowledge base. Omitted optional fields retain their current values.
    */
-  async search(
-    request: operations.SearchKnowledgeRequest,
+  async update(
+    request: operations.UpdateKnowledgeRequest,
     options?: RequestOptions,
-  ): Promise<operations.SearchKnowledgeResponseBody> {
-    return unwrapAsync(knowledgeSearch(
+  ): Promise<components.Knowledge> {
+    return unwrapAsync(knowledgeUpdate(
       this,
       request,
       options,
@@ -124,11 +117,14 @@ export class Knowledge extends ClientSDK {
 
   /**
    * List all datasources
+   *
+   * @remarks
+   * Returns the datasources in a knowledge base. Use cursors to page through results and optional query or status filters to narrow the list.
    */
   async listDatasources(
     request: operations.ListDatasourcesRequest,
     options?: RequestOptions,
-  ): Promise<operations.ListDatasourcesResponseBody> {
+  ): Promise<components.DatasourcesServiceListResponse> {
     return unwrapAsync(knowledgeListDatasources(
       this,
       request,
@@ -138,11 +134,14 @@ export class Knowledge extends ClientSDK {
 
   /**
    * Create a new datasource
+   *
+   * @remarks
+   * Creates a datasource shell when only a display name is provided. When file_id is provided, the uploaded file is queued for chunking and ingestion.
    */
   async createDatasource(
     request: operations.CreateDatasourceRequest,
     options?: RequestOptions,
-  ): Promise<operations.CreateDatasourceResponseBody> {
+  ): Promise<components.Datasource> {
     return unwrapAsync(knowledgeCreateDatasource(
       this,
       request,
@@ -152,11 +151,14 @@ export class Knowledge extends ClientSDK {
 
   /**
    * Retrieve a datasource
+   *
+   * @remarks
+   * Retrieves a datasource and its current processing status and chunk count.
    */
   async retrieveDatasource(
     request: operations.RetrieveDatasourceRequest,
     options?: RequestOptions,
-  ): Promise<operations.RetrieveDatasourceResponseBody> {
+  ): Promise<components.Datasource> {
     return unwrapAsync(knowledgeRetrieveDatasource(
       this,
       request,
@@ -183,11 +185,14 @@ export class Knowledge extends ClientSDK {
 
   /**
    * Update a datasource
+   *
+   * @remarks
+   * Updates the display name of a datasource.
    */
   async updateDatasource(
     request: operations.UpdateDatasourceRequest,
     options?: RequestOptions,
-  ): Promise<operations.UpdateDatasourceResponseBody> {
+  ): Promise<components.Datasource> {
     return unwrapAsync(knowledgeUpdateDatasource(
       this,
       request,
@@ -196,13 +201,16 @@ export class Knowledge extends ClientSDK {
   }
 
   /**
-   * Create chunks for a datasource
+   * List all chunks for a datasource
+   *
+   * @remarks
+   * Returns chunks using cursor pagination, with optional text and processing-status filters.
    */
-  async createChunks(
-    request: operations.CreateChunkRequest,
+  async listChunks(
+    request: operations.ListChunksRequest,
     options?: RequestOptions,
-  ): Promise<Array<operations.ResponseBody>> {
-    return unwrapAsync(knowledgeCreateChunks(
+  ): Promise<components.ChunksServiceListResponse> {
+    return unwrapAsync(knowledgeListChunks(
       this,
       request,
       options,
@@ -210,13 +218,16 @@ export class Knowledge extends ClientSDK {
   }
 
   /**
-   * List all chunks for a datasource
+   * Create chunks for a datasource
+   *
+   * @remarks
+   * Creates between 1 and 100 chunks. Chunks with supplied embeddings are indexed immediately; chunks without embeddings are queued for embedding.
    */
-  async listChunks(
-    request: operations.ListChunksRequest,
+  async createChunks(
+    request: operations.CreateChunkRequest,
     options?: RequestOptions,
-  ): Promise<operations.ListChunksResponseBody> {
-    return unwrapAsync(knowledgeListChunks(
+  ): Promise<Array<components.KnowledgeChunk>> {
+    return unwrapAsync(knowledgeCreateChunks(
       this,
       request,
       options,
@@ -225,11 +236,14 @@ export class Knowledge extends ClientSDK {
 
   /**
    * Delete multiple chunks
+   *
+   * @remarks
+   * Deletes up to 100 chunks and reports IDs that were not found or could not be deleted.
    */
   async deleteChunks(
     request: operations.DeleteChunksRequest,
     options?: RequestOptions,
-  ): Promise<operations.DeleteChunksResponseBody> {
+  ): Promise<components.ChunksServiceDeleteManyResponse> {
     return unwrapAsync(knowledgeDeleteChunks(
       this,
       request,
@@ -237,13 +251,33 @@ export class Knowledge extends ClientSDK {
     ));
   }
 
+  /**
+   * Get chunks total count
+   *
+   * @remarks
+   * Returns the total count of chunks in a datasource. When `q` is provided, the count reflects indexed chunks only — recently created chunks may not be counted until embedding completes.
+   */
+  async getChunksCount(
+    request: operations.GetChunksCountRequest,
+    options?: RequestOptions,
+  ): Promise<components.ChunksServiceCountResponse> {
+    return unwrapAsync(knowledgeGetChunksCount(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List chunks with offset-based pagination
+   *
+   * @remarks
+   * Returns a page of chunks, with optional text, enabled-state, and processing-status filters.
    */
   async listChunksPaginated(
     request: operations.ListChunksPaginatedRequest,
     options?: RequestOptions,
-  ): Promise<operations.ListChunksPaginatedResponseBody> {
+  ): Promise<components.ChunksServiceListPaginatedResponse> {
     return unwrapAsync(knowledgeListChunksPaginated(
       this,
       request,
@@ -252,16 +286,33 @@ export class Knowledge extends ClientSDK {
   }
 
   /**
-   * Get chunks total count
+   * Retrieve a chunk
    *
    * @remarks
-   * Returns the total count of chunks in a datasource. When `q` is provided, the count reflects indexed chunks only — recently created chunks may not be counted until embedding completes.
+   * Retrieves a chunk by its chunk identifier.
    */
-  async getChunksCount(
-    request: operations.GetChunksCountRequest,
+  async retrieveChunk(
+    request: operations.GetOneChunkRequest,
     options?: RequestOptions,
-  ): Promise<operations.GetChunksCountResponseBody> {
-    return unwrapAsync(knowledgeGetChunksCount(
+  ): Promise<components.KnowledgeChunk> {
+    return unwrapAsync(knowledgeRetrieveChunk(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a chunk
+   *
+   * @remarks
+   * Deletes a chunk from the datasource and its vector index.
+   */
+  async deleteChunk(
+    request: operations.DeleteChunkRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(knowledgeDeleteChunk(
       this,
       request,
       options,
@@ -270,11 +321,14 @@ export class Knowledge extends ClientSDK {
 
   /**
    * Update a chunk
+   *
+   * @remarks
+   * Updates chunk text, metadata, or a supplied embedding. Changing text without an embedding queues the chunk for re-embedding.
    */
   async updateChunk(
     request: operations.UpdateChunkRequest,
     options?: RequestOptions,
-  ): Promise<operations.UpdateChunkResponseBody> {
+  ): Promise<components.KnowledgeChunk> {
     return unwrapAsync(knowledgeUpdateChunk(
       this,
       request,
@@ -283,13 +337,16 @@ export class Knowledge extends ClientSDK {
   }
 
   /**
-   * Delete a chunk
+   * Set a chunk's enabled status
+   *
+   * @remarks
+   * Enables or disables a chunk for retrieval. If the vector-index document is missing, enabling the chunk queues it for embedding.
    */
-  async deleteChunk(
-    request: operations.DeleteChunkRequest,
+  async toggleChunk(
+    request: operations.UpdateChunkEnabledRequest,
     options?: RequestOptions,
-  ): Promise<void> {
-    return unwrapAsync(knowledgeDeleteChunk(
+  ): Promise<components.KnowledgeChunk> {
+    return unwrapAsync(knowledgeToggleChunk(
       this,
       request,
       options,
@@ -297,13 +354,50 @@ export class Knowledge extends ClientSDK {
   }
 
   /**
-   * Retrieve a chunk
+   * Retrieve datasource processing status
+   *
+   * @remarks
+   * Returns aggregate queued, completed, passed, and failed chunk counts together with the datasource and chunk processing attempts.
    */
-  async retrieveChunk(
-    request: operations.GetOneChunkRequest,
+  async retrieveProcessingStatus(
+    request: operations.GetOneDatasourceProcessingStatusRequest,
     options?: RequestOptions,
-  ): Promise<operations.GetOneChunkResponseBody> {
-    return unwrapAsync(knowledgeRetrieveChunk(
+  ): Promise<components.DatasourcesServiceGetProcessingStatusResponse> {
+    return unwrapAsync(knowledgeRetrieveProcessingStatus(
+      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<components.SearchKnowledgeResponse> {
+    return unwrapAsync(knowledgeSearch(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a file upload URL
+   *
+   * @remarks
+   * Creates a presigned upload policy for a file that will be attached to a knowledge-base datasource. Submit the returned form fields and file directly to the returned URL.
+   */
+  async retrieveFileUrl(
+    request: operations.GetOneFileUploadUrlRequest,
+    options?: RequestOptions,
+  ): Promise<components.GetUploadFileUrlResponse> {
+    return unwrapAsync(knowledgeRetrieveFileUrl(
       this,
       request,
       options,