@orq-ai/node 3.14.5-rc.1 → 3.14.6

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

@@ -0,0 +1,238 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { agentsCreate } from "../funcs/agentsCreate.js";
+import { agentsDelete } from "../funcs/agentsDelete.js";
+import { agentsInvoke } from "../funcs/agentsInvoke.js";
+import { agentsList } from "../funcs/agentsList.js";
+import { agentsListActions } from "../funcs/agentsListActions.js";
+import { agentsListTasks } from "../funcs/agentsListTasks.js";
+import { agentsRetrieve } from "../funcs/agentsRetrieve.js";
+import { agentsRetrieveAction } from "../funcs/agentsRetrieveAction.js";
+import { agentsRetrieveTask } from "../funcs/agentsRetrieveTask.js";
+import { agentsRun } from "../funcs/agentsRun.js";
+import { agentsStream } from "../funcs/agentsStream.js";
+import { agentsStreamRun } from "../funcs/agentsStreamRun.js";
+import { agentsUpdate } from "../funcs/agentsUpdate.js";
+import { EventStream } from "../lib/event-streams.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Agents extends ClientSDK {
+  /**
+   * Retrieve a specific agent task
+   *
+   * @remarks
+   * Retrieves detailed information about a specific task for a given agent, including execution status and results.
+   */
+  async retrieveTask(
+    request: operations.GetAgentTaskRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetAgentTaskResponseBody> {
+    return unwrapAsync(agentsRetrieveTask(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async create(
+    request?: operations.CreateAgentRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreateAgentResponseBody> {
+    return unwrapAsync(agentsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all agents
+   *
+   * @remarks
+   * Retrieves a paginated list of all agents in your workspace. Each agent includes its configuration, primary model, and optional fallback model settings.
+   */
+  async list(
+    request?: operations.ListAgentsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.ListAgentsResponseBody> {
+    return unwrapAsync(agentsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete an agent
+   *
+   * @remarks
+   * Permanently deletes an agent and all its configuration, including primary and fallback model settings.
+   */
+  async delete(
+    request: operations.DeleteAgentRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(agentsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get an agent
+   *
+   * @remarks
+   * Retrieves a single agent by its unique key, including its full configuration with primary and fallback model settings.
+   */
+  async retrieve(
+    request: operations.GetAgentRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetAgentResponseBody> {
+    return unwrapAsync(agentsRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update an agent
+   *
+   * @remarks
+   * Updates an existing agent's configuration. You can update various fields including the model configuration and fallback model settings.
+   */
+  async update(
+    request: operations.UpdateAgentRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateAgentResponseBody> {
+    return unwrapAsync(agentsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Invoke an agent
+   *
+   * @remarks
+   * 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.
+   */
+  async invoke(
+    request: operations.InvokeAgentRequest,
+    options?: RequestOptions,
+  ): Promise<operations.InvokeAgentResponseBody> {
+    return unwrapAsync(agentsInvoke(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all tasks for an agent
+   *
+   * @remarks
+   * Retrieves a paginated list of all tasks associated with a specific agent, optionally filtered by status.
+   */
+  async listTasks(
+    request: operations.ListAgentTasksRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListAgentTasksResponseBody> {
+    return unwrapAsync(agentsListTasks(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Run an agent
+   *
+   * @remarks
+   * Executes an agent with the provided configuration using A2A message format. If the agent already exists with the same configuration, it will be reused. If the configuration differs, a new version is created. The fallback model is configured at the agent level and will be used automatically if the primary model fails during execution.
+   */
+  async run(
+    request?: operations.RunAgentRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.RunAgentResponseBody> {
+    return unwrapAsync(agentsRun(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Run and stream agent execution
+   *
+   * @remarks
+   * Creates or updates an agent with the provided configuration, then streams execution events via Server-Sent Events (SSE). If the agent already exists with the same configuration, it will be reused. If the configuration differs, a new version is created. The stream will continue until the agent completes, errors, or reaches the configured timeout.
+   */
+  async streamRun(
+    request?: operations.StreamRunAgentRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<EventStream<operations.StreamRunAgentResponseBody>> {
+    return unwrapAsync(agentsStreamRun(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Stream agent execution events
+   *
+   * @remarks
+   * Executes an agent and streams events via Server-Sent Events (SSE). The stream will continue until the agent completes, errors, or reaches the configured timeout.
+   */
+  async stream(
+    request: operations.StreamAgentRequest,
+    options?: RequestOptions,
+  ): Promise<EventStream<operations.StreamAgentResponseBody>> {
+    return unwrapAsync(agentsStream(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all actions
+   */
+  async listActions(
+    request: operations.ListActionsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListActionsResponseBody> {
+    return unwrapAsync(agentsListActions(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve an action executed by an agent task.
+   */
+  async retrieveAction(
+    request: operations.RetrieveActionRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveActionResponseBody> {
+    return unwrapAsync(agentsRetrieveAction(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { budgetsCreate } from "../funcs/budgetsCreate.js";
+import { budgetsDelete } from "../funcs/budgetsDelete.js";
+import { budgetsGet } from "../funcs/budgetsGet.js";
+import { budgetsList } from "../funcs/budgetsList.js";
+import { budgetsUpdate } from "../funcs/budgetsUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Budgets extends ClientSDK {
+  /**
+   * List budget configurations
+   *
+   * @remarks
+   * Retrieves a paginated list of budget configurations in your workspace. Supports filtering by type (contact or workspace). For workspace budgets, only one budget can exist per workspace.
+   */
+  async list(
+    request?: operations.ListBudgetsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.ListBudgetsResponseBody> {
+    return unwrapAsync(budgetsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create budget configuration
+   *
+   * @remarks
+   * Create a new budget configuration for a contact or workspace. For contacts, provide the external ID in entity_id field. For workspaces, only the type field is required (entity_id is not needed). Only one budget can exist per workspace.
+   */
+  async create(
+    request: operations.CreateBudgetRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.CreateBudgetResponseBody> {
+    return unwrapAsync(budgetsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get budget configuration
+   *
+   * @remarks
+   * Get budget configuration by ID.
+   */
+  async get(
+    request: operations.GetBudgetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetBudgetResponseBody> {
+    return unwrapAsync(budgetsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update budget configuration
+   *
+   * @remarks
+   * Update budget configuration by ID
+   */
+  async update(
+    request: operations.UpdateBudgetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateBudgetResponseBody> {
+    return unwrapAsync(budgetsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete budget configuration
+   *
+   * @remarks
+   * Delete budget configuration by ID
+   */
+  async delete(
+    request: operations.DeleteBudgetRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(budgetsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { chunkingParse } from "../funcs/chunkingParse.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Chunking extends ClientSDK {
+  /**
+   * Parse text
+   *
+   * @remarks
+   * Split large text documents into smaller, manageable chunks using different chunking strategies optimized for RAG (Retrieval-Augmented Generation) workflows. This endpoint supports multiple chunking algorithms including token-based, sentence-based, recursive, semantic, and specialized strategies.
+   */
+  async parse(
+    request: operations.ParseChunkingRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ParseResponseBody> {
+    return unwrapAsync(chunkingParse(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { contactsCreate } from "../funcs/contactsCreate.js";
+import { contactsDelete } from "../funcs/contactsDelete.js";
+import { contactsList } from "../funcs/contactsList.js";
+import { contactsRetrieve } from "../funcs/contactsRetrieve.js";
+import { contactsUpdate } from "../funcs/contactsUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Contacts extends ClientSDK {
+  /**
+   * Create a contact
+   *
+   * @remarks
+   * Creates a new contact with a unique external_id. If a contact with the same external_id already exists, the operation will fail. Use this endpoint to add users from your system to orq.ai for tracking their usage and engagement.
+   */
+  async create(
+    request?: operations.CreateContactRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreateContactResponseBody> {
+    return unwrapAsync(contactsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List contacts
+   *
+   * @remarks
+   * Retrieves a paginated list of contacts in your workspace. Use pagination parameters to navigate through large contact lists efficiently.
+   */
+  async list(
+    request?: operations.ListContactsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.ListContactsResponseBody> {
+    return unwrapAsync(contactsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a contact
+   *
+   * @remarks
+   * Retrieves detailed information about a specific contact using their contact ID or external ID from your system.
+   */
+  async retrieve(
+    request: operations.RetrieveContactRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveContactResponseBody> {
+    return unwrapAsync(contactsRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a contact
+   *
+   * @remarks
+   * Updates specific fields of an existing contact. Only the fields provided in the request body will be updated.
+   */
+  async update(
+    request: operations.UpdateContactRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateContactResponseBody> {
+    return unwrapAsync(contactsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a contact
+   *
+   * @remarks
+   * Permanently deletes a contact from your workspace and cleans up associated budget configurations. This action cannot be undone.
+   */
+  async delete(
+    request: operations.DeleteContactRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(contactsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,204 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { datasetsClear } from "../funcs/datasetsClear.js";
+import { datasetsCreate } from "../funcs/datasetsCreate.js";
+import { datasetsCreateDatapoint } from "../funcs/datasetsCreateDatapoint.js";
+import { datasetsDelete } from "../funcs/datasetsDelete.js";
+import { datasetsDeleteDatapoint } from "../funcs/datasetsDeleteDatapoint.js";
+import { datasetsList } from "../funcs/datasetsList.js";
+import { datasetsListDatapoints } from "../funcs/datasetsListDatapoints.js";
+import { datasetsRetrieve } from "../funcs/datasetsRetrieve.js";
+import { datasetsRetrieveDatapoint } from "../funcs/datasetsRetrieveDatapoint.js";
+import { datasetsUpdate } from "../funcs/datasetsUpdate.js";
+import { datasetsUpdateDatapoint } from "../funcs/datasetsUpdateDatapoint.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Datasets extends ClientSDK {
+  /**
+   * List datasets
+   *
+   * @remarks
+   * Retrieves a paginated list of datasets for the current workspace. Results can be paginated using cursor-based pagination.
+   */
+  async list(
+    request?: operations.ListDatasetsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.ListDatasetsResponseBody> {
+    return unwrapAsync(datasetsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a dataset
+   *
+   * @remarks
+   * Creates a new dataset in the specified project.
+   */
+  async create(
+    request?: operations.CreateDatasetRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreateDatasetResponseBody> {
+    return unwrapAsync(datasetsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a dataset
+   *
+   * @remarks
+   * Retrieves a specific dataset by its unique identifier
+   */
+  async retrieve(
+    request: operations.RetrieveDatasetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveDatasetResponseBody> {
+    return unwrapAsync(datasetsRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a dataset
+   *
+   * @remarks
+   * Update a dataset
+   */
+  async update(
+    request: operations.UpdateDatasetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateDatasetResponseBody> {
+    return unwrapAsync(datasetsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a dataset
+   *
+   * @remarks
+   * Permanently deletes a dataset and all its datapoints. This action is irreversible.
+   */
+  async delete(
+    request: operations.DeleteDatasetRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(datasetsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List datapoints
+   *
+   * @remarks
+   * Retrieves a paginated list of datapoints from a specific dataset.
+   */
+  async listDatapoints(
+    request: operations.ListDatasetDatapointsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListDatasetDatapointsResponseBody> {
+    return unwrapAsync(datasetsListDatapoints(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a datapoint
+   *
+   * @remarks
+   * Creates a new datapoint in the specified dataset.
+   */
+  async createDatapoint(
+    request: operations.CreateDatasetItemRequest,
+    options?: RequestOptions,
+  ): Promise<Array<operations.CreateDatasetItemResponseBody>> {
+    return unwrapAsync(datasetsCreateDatapoint(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a datapoint
+   *
+   * @remarks
+   * Retrieves a datapoint object
+   */
+  async retrieveDatapoint(
+    request: operations.RetrieveDatapointRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveDatapointResponseBody> {
+    return unwrapAsync(datasetsRetrieveDatapoint(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a datapoint
+   */
+  async updateDatapoint(
+    request: operations.UpdateDatapointRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateDatapointResponseBody> {
+    return unwrapAsync(datasetsUpdateDatapoint(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a datapoint
+   *
+   * @remarks
+   * Permanently deletes a specific datapoint from a dataset.
+   */
+  async deleteDatapoint(
+    request: operations.DeleteDatapointRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(datasetsDeleteDatapoint(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete all datapoints
+   *
+   * @remarks
+   * Delete all datapoints from a dataset. This action is irreversible.
+   */
+  async clear(
+    request: operations.ClearDatasetRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(datasetsClear(
+      this,
+      request,
+      options,
+    ));
+  }
+}