@orq-ai/node 3.13.2 → 3.13.4

package/packages/orq-rc/docs/sdks/knowledge/README.md

@@ -18,6 +18,9 @@
 * [updateDatasource](#updatedatasource) - Update a datasource
 * [createChunks](#createchunks) - Create chunks for a datasource
 * [listChunks](#listchunks) - List all chunks for a datasource
+* [deleteChunks](#deletechunks) - Delete multiple chunks
+* [listChunksPaginated](#listchunkspaginated) - List chunks with offset-based pagination
+* [getChunksCount](#getchunkscount) - Get chunks total count
 * [updateChunk](#updatechunk) - Update a chunk
 * [deleteChunk](#deletechunk) - Delete a chunk
 * [retrieveChunk](#retrievechunk) - Retrieve a chunk
@@ -1023,6 +1026,231 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |
 
+## deleteChunks
+
+Delete multiple chunks
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="DeleteChunks" method="delete" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks" -->
+```typescript
+import { Orq } from "@orq-ai/node";
+
+const orq = new Orq({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await orq.knowledge.deleteChunks({
+    knowledgeId: "<id>",
+    datasourceId: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OrqCore } from "@orq-ai/node/core.js";
+import { knowledgeDeleteChunks } from "@orq-ai/node/funcs/knowledgeDeleteChunks.js";
+
+// Use `OrqCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const orq = new OrqCore({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await knowledgeDeleteChunks(orq, {
+    knowledgeId: "<id>",
+    datasourceId: "<id>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("knowledgeDeleteChunks failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.DeleteChunksRequest](../../models/operations/deletechunksrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.DeleteChunksResponseBody](../../models/operations/deletechunksresponsebody.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
+
+## listChunksPaginated
+
+List chunks with offset-based pagination
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="ListChunksPaginated" method="post" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/list" -->
+```typescript
+import { Orq } from "@orq-ai/node";
+
+const orq = new Orq({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await orq.knowledge.listChunksPaginated({
+    knowledgeId: "<id>",
+    datasourceId: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OrqCore } from "@orq-ai/node/core.js";
+import { knowledgeListChunksPaginated } from "@orq-ai/node/funcs/knowledgeListChunksPaginated.js";
+
+// Use `OrqCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const orq = new OrqCore({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await knowledgeListChunksPaginated(orq, {
+    knowledgeId: "<id>",
+    datasourceId: "<id>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("knowledgeListChunksPaginated failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.ListChunksPaginatedRequest](../../models/operations/listchunkspaginatedrequest.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.ListChunksPaginatedResponseBody](../../models/operations/listchunkspaginatedresponsebody.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
+
+## getChunksCount
+
+Get chunks total count
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="GetChunksCount" method="post" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/count" -->
+```typescript
+import { Orq } from "@orq-ai/node";
+
+const orq = new Orq({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await orq.knowledge.getChunksCount({
+    knowledgeId: "<id>",
+    datasourceId: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OrqCore } from "@orq-ai/node/core.js";
+import { knowledgeGetChunksCount } from "@orq-ai/node/funcs/knowledgeGetChunksCount.js";
+
+// Use `OrqCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const orq = new OrqCore({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await knowledgeGetChunksCount(orq, {
+    knowledgeId: "<id>",
+    datasourceId: "<id>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("knowledgeGetChunksCount failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetChunksCountRequest](../../models/operations/getchunkscountrequest.md)                                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.GetChunksCountResponseBody](../../models/operations/getchunkscountresponsebody.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
+
 ## updateChunk
 
 Update a chunk

package/packages/orq-rc/docs/sdks/tools/README.md

@@ -98,7 +98,6 @@ const orq = new Orq({
 
 async function run() {
   const result = await orq.tools.create({
-    id: "01K5ZT3CYBDREF06WS7W7BX3Y2",
     path: "Default",
     key: "<key>",
     displayName: "Ellie78",
@@ -137,7 +136,6 @@ const orq = new OrqCore({
 
 async function run() {
   const res = await toolsCreate(orq, {
-    id: "01K5ZT3CYBDREF06WS7W7BX3Y2",
     path: "Default",
     key: "<key>",
     displayName: "Ellie78",
@@ -189,7 +187,7 @@ Updates a tool in the workspace.
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="UpdateTool" method="patch" path="/v2/tools/{tool_key}" -->
+<!-- UsageSnippet language="typescript" operationID="UpdateTool" method="patch" path="/v2/tools/{tool_id}" -->
 ```typescript
 import { Orq } from "@orq-ai/node";
 
@@ -199,7 +197,7 @@ const orq = new Orq({
 
 async function run() {
   const result = await orq.tools.update({
-    toolKey: "<value>",
+    toolId: "<id>",
     requestBody: {
       path: "Default",
       status: "live",
@@ -229,7 +227,7 @@ const orq = new OrqCore({
 
 async function run() {
   const res = await toolsUpdate(orq, {
-    toolKey: "<value>",
+    toolId: "<id>",
     requestBody: {
       path: "Default",
       status: "live",
@@ -273,7 +271,7 @@ Deletes a tool by key.
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="DeleteTool" method="delete" path="/v2/tools/{tool_key}" -->
+<!-- UsageSnippet language="typescript" operationID="DeleteTool" method="delete" path="/v2/tools/{tool_id}" -->
 ```typescript
 import { Orq } from "@orq-ai/node";
 
@@ -283,7 +281,7 @@ const orq = new Orq({
 
 async function run() {
   await orq.tools.delete({
-    toolKey: "<value>",
+    toolId: "<id>",
   });
 
 
@@ -308,7 +306,7 @@ const orq = new OrqCore({
 
 async function run() {
   const res = await toolsDelete(orq, {
-    toolKey: "<value>",
+    toolId: "<id>",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -342,11 +340,11 @@ run();
 
 ## retrieve
 
-Retrieves a tool by key.
+Retrieves a tool by id.
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="RetrieveTool" method="get" path="/v2/tools/{tool_key}" -->
+<!-- UsageSnippet language="typescript" operationID="RetrieveTool" method="get" path="/v2/tools/{tool_id}" -->
 ```typescript
 import { Orq } from "@orq-ai/node";
 
@@ -356,7 +354,7 @@ const orq = new Orq({
 
 async function run() {
   const result = await orq.tools.retrieve({
-    toolKey: "<value>",
+    toolId: "<id>",
   });
 
   console.log(result);
@@ -381,7 +379,7 @@ const orq = new OrqCore({
 
 async function run() {
   const res = await toolsRetrieve(orq, {
-    toolKey: "<value>",
+    toolId: "<id>",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -415,11 +413,11 @@ run();
 
 ## duplicate
 
-Creates a copy of an existing tool with a new key and ID.
+Creates a copy of an existing tool with a new id and ID.
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="DuplicateTool" method="post" path="/v2/tools/{key}/duplicate" -->
+<!-- UsageSnippet language="typescript" operationID="DuplicateTool" method="post" path="/v2/tools/{tool_id}/duplicate" -->
 ```typescript
 import { Orq } from "@orq-ai/node";
 
@@ -429,7 +427,7 @@ const orq = new Orq({
 
 async function run() {
   const result = await orq.tools.duplicate({
-    key: "<key>",
+    toolId: "<id>",
   });
 
   console.log(result);
@@ -454,7 +452,7 @@ const orq = new OrqCore({
 
 async function run() {
   const res = await toolsDuplicate(orq, {
-    key: "<key>",
+    toolId: "<id>",
   });
   if (res.ok) {
     const { value: result } = res;

package/packages/orq-rc/examples/package-lock.json

@@ -18,7 +18,7 @@
     },
     "..": {
       "name": "@orq-ai/node",
-      "version": "3.14.0-rc.1",
+      "version": "3.14.0-rc.6",
       "dependencies": {
         "zod": "^3.20.0"
       },

package/packages/orq-rc/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@orq-ai/node",
-  "version": "3.14.0-rc.1",
+  "version": "3.14.0-rc.6",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/packages/orq-rc/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@orq-ai/node",
-  "version": "3.14.0-rc.1",
+  "version": "3.14.0-rc.6",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@orq-ai/node",
-      "version": "3.14.0-rc.1",
+      "version": "3.14.0-rc.6",
       "dependencies": {
         "zod": "^3.20.0"
       },

package/packages/orq-rc/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orq-ai/node",
-  "version": "3.14.0-rc.1",
+  "version": "3.14.0-rc.6",
   "author": "Orq",
   "bin": {
     "mcp": "bin/mcp-server.js"

package/packages/orq-rc/src/funcs/agentsRetrieveTask.ts

@@ -89,7 +89,7 @@ async function $do(
   const body = null;
 
   const pathParams = {
-    id: encodeSimple("id", payload.id, {
+    agent_key: encodeSimple("agent_key", payload.agent_key, {
       explode: false,
       charEncoding: "percent",
     }),
@@ -99,7 +99,7 @@ async function $do(
     }),
   };
 
-  const path = pathToFunc("/v2/agents/{id}/tasks/{task_id}")(pathParams);
+  const path = pathToFunc("/v2/agents/{agent_key}/tasks/{task_id}")(pathParams);
 
   const headers = new Headers(compactMap({
     Accept: "application/json",

package/packages/orq-rc/src/funcs/knowledgeDeleteChunks.ts

@@ -0,0 +1,170 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { OrqError } from "../models/errors/orqerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Delete multiple chunks
+ */
+export function knowledgeDeleteChunks(
+  client: OrqCore,
+  request: operations.DeleteChunksRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.DeleteChunksResponseBody,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  request: operations.DeleteChunksRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.DeleteChunksResponseBody,
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.DeleteChunksRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+
+  const pathParams = {
+    datasource_id: encodeSimple("datasource_id", payload.datasource_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    knowledge_id: encodeSimple("knowledge_id", payload.knowledge_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc(
+    "/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "DeleteChunks",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "DELETE",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    operations.DeleteChunksResponseBody,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.DeleteChunksResponseBody$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}