@orq-ai/node 3.13.9 → 3.13.11

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

@@ -6,8 +6,11 @@
 ### Available Operations
 
 * [retrieveTask](#retrievetask) - Retrieve a specific agent task
+* [create](#create) - Create a new agent
 * [list](#list) - List all agents
+* [delete](#delete) - Delete an agent
 * [retrieve](#retrieve) - Get an agent
+* [update](#update) - Update an agent
 * [invoke](#invoke) - Invoke an agent
 * [listTasks](#listtasks) - List all tasks for an agent
 * [run](#run) - Run an agent
@@ -92,6 +95,116 @@ run();
 | errors.GetAgentTaskResponseBody | 404                             | application/json                |
 | errors.APIError                 | 4XX, 5XX                        | \*/\*                           |
 
+## create
+
+Creates a new AI agent with specified configuration. Agents can be configured with a primary model and an optional fallback model that will be used automatically if the primary model fails.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="CreateAgent" method="post" path="/v2/agents/" -->
+```typescript
+import { Orq } from "@orq-ai/node";
+
+const orq = new Orq({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await orq.agents.create({
+    path: "Default",
+    key: "<key>",
+    role: "<value>",
+    description: "neatly unless refine aside platter alarmed shampoo shakily yippee",
+    instructions: "<value>",
+    model: "Camaro",
+    settings: {
+      tools: [
+        {
+          type: "http",
+          requiresApproval: false,
+        },
+      ],
+    },
+    knowledgeBases: [
+      {
+        knowledgeId: "customer-knowledge-base",
+      },
+    ],
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OrqCore } from "@orq-ai/node/core.js";
+import { agentsCreate } from "@orq-ai/node/funcs/agentsCreate.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 agentsCreate(orq, {
+    path: "Default",
+    key: "<key>",
+    role: "<value>",
+    description: "neatly unless refine aside platter alarmed shampoo shakily yippee",
+    instructions: "<value>",
+    model: "Camaro",
+    settings: {
+      tools: [
+        {
+          type: "http",
+          requiresApproval: false,
+        },
+      ],
+    },
+    knowledgeBases: [
+      {
+        knowledgeId: "customer-knowledge-base",
+      },
+    ],
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("agentsCreate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CreateAgentRequestBody](../../models/operations/createagentrequestbody.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.CreateAgentResponseBody](../../models/operations/createagentresponsebody.md)\>**
+
+### Errors
+
+| Error Type                     | Status Code                    | Content Type                   |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| errors.CreateAgentResponseBody | 409                            | application/json               |
+| errors.APIError                | 4XX, 5XX                       | \*/\*                          |
+
 ## list
 
 Retrieves a paginated list of all agents in your workspace. Each agent includes its configuration, primary model, and optional fallback model settings.
@@ -161,6 +274,80 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |
 
+## delete
+
+Permanently deletes an agent and all its configuration, including primary and fallback model settings.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="DeleteAgent" method="delete" path="/v2/agents/{agent_key}" -->
+```typescript
+import { Orq } from "@orq-ai/node";
+
+const orq = new Orq({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  await orq.agents.delete({
+    agentKey: "<value>",
+  });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OrqCore } from "@orq-ai/node/core.js";
+import { agentsDelete } from "@orq-ai/node/funcs/agentsDelete.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 agentsDelete(orq, {
+    agentKey: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("agentsDelete failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.DeleteAgentRequest](../../models/operations/deleteagentrequest.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\<void\>**
+
+### Errors
+
+| Error Type                     | Status Code                    | Content Type                   |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| errors.DeleteAgentResponseBody | 404                            | application/json               |
+| errors.APIError                | 4XX, 5XX                       | \*/\*                          |
+
 ## retrieve
 
 Retrieves a single agent by its unique key, including its full configuration with primary and fallback model settings.
@@ -235,6 +422,96 @@ run();
 | errors.GetAgentResponseBody | 404                         | application/json            |
 | errors.APIError             | 4XX, 5XX                    | \*/\*                       |
 
+## update
+
+Updates an existing agent's configuration. You can update various fields including the model configuration and fallback model settings.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="UpdateAgent" method="patch" path="/v2/agents/{agent_key}" -->
+```typescript
+import { Orq } from "@orq-ai/node";
+
+const orq = new Orq({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await orq.agents.update({
+    agentKey: "<value>",
+    requestBody: {
+      path: "Default",
+      knowledgeBases: [
+        {
+          knowledgeId: "customer-knowledge-base",
+        },
+      ],
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OrqCore } from "@orq-ai/node/core.js";
+import { agentsUpdate } from "@orq-ai/node/funcs/agentsUpdate.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 agentsUpdate(orq, {
+    agentKey: "<value>",
+    requestBody: {
+      path: "Default",
+      knowledgeBases: [
+        {
+          knowledgeId: "customer-knowledge-base",
+        },
+      ],
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("agentsUpdate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.UpdateAgentRequest](../../models/operations/updateagentrequest.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.UpdateAgentResponseBody](../../models/operations/updateagentresponsebody.md)\>**
+
+### Errors
+
+| Error Type                     | Status Code                    | Content Type                   |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| errors.UpdateAgentResponseBody | 404                            | application/json               |
+| errors.APIError                | 4XX, 5XX                       | \*/\*                          |
+
 ## invoke
 
 Executes an existing agent with the provided input. The agent uses its pre-configured primary model and will automatically fall back to its configured fallback model if the primary model fails. Fallback models are configured at the agent level, not during execution.
@@ -495,6 +772,11 @@ async function run() {
       ],
     },
     path: "Default",
+    knowledgeBases: [
+      {
+        knowledgeId: "customer-knowledge-base",
+      },
+    ],
     settings: {
       tools: [
         {
@@ -566,6 +848,11 @@ async function run() {
       ],
     },
     path: "Default",
+    knowledgeBases: [
+      {
+        knowledgeId: "customer-knowledge-base",
+      },
+    ],
     settings: {
       tools: [
         {
@@ -660,6 +947,11 @@ async function run() {
       ],
     },
     path: "Default",
+    knowledgeBases: [
+      {
+        knowledgeId: "customer-knowledge-base",
+      },
+    ],
     settings: {
       tools: [
         {
@@ -733,6 +1025,11 @@ async function run() {
       ],
     },
     path: "Default",
+    knowledgeBases: [
+      {
+        knowledgeId: "customer-knowledge-base",
+      },
+    ],
     settings: {
       tools: [
         {

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

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

package/packages/orq-rc/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@orq-ai/node",
-  "version": "3.14.0-rc.26",
+  "version": "3.14.0-rc.32",
   "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.26",
+  "version": "3.14.0-rc.32",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@orq-ai/node",
-      "version": "3.14.0-rc.26",
+      "version": "3.14.0-rc.32",
       "dependencies": {
         "zod": "^3.20.0"
       },

package/packages/orq-rc/package.json

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

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

@@ -0,0 +1,172 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { encodeJSON } 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 * as errors from "../models/errors/index.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";
+
+/**
+ * Create a new agent
+ *
+ * @remarks
+ * Creates a new AI agent with specified configuration. Agents can be configured with a primary model and an optional fallback model that will be used automatically if the primary model fails.
+ */
+export function agentsCreate(
+  client: OrqCore,
+  request?: operations.CreateAgentRequestBody | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.CreateAgentResponseBody,
+    | errors.CreateAgentResponseBody
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  request?: operations.CreateAgentRequestBody | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.CreateAgentResponseBody,
+      | errors.CreateAgentResponseBody
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.CreateAgentRequestBody$outboundSchema.optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = payload === undefined
+    ? null
+    : encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/agents/")();
+
+  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: "CreateAgent",
+    oAuth2Scopes: null,
+
+    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: "POST",
+    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: ["409", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.CreateAgentResponseBody,
+    | errors.CreateAgentResponseBody
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(201, operations.CreateAgentResponseBody$inboundSchema),
+    M.jsonErr(409, errors.CreateAgentResponseBody$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}