@orq-ai/node 4.10.0-rc.88 → 4.10.0

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

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { promptsCreate } from "../funcs/promptsCreate.js";
+import { promptsDelete } from "../funcs/promptsDelete.js";
+import { promptsGetVersion } from "../funcs/promptsGetVersion.js";
+import { promptsList } from "../funcs/promptsList.js";
+import { promptsListVersions } from "../funcs/promptsListVersions.js";
+import { promptsRetrieve } from "../funcs/promptsRetrieve.js";
+import { promptsUpdate } from "../funcs/promptsUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Prompts extends ClientSDK {
+  /**
+   * List all prompts
+   *
+   * @remarks
+   * Returns a list of your prompts. The prompts are returned sorted by creation date, with the most recent prompts appearing first
+   */
+  async list(
+    request?: operations.GetAllPromptsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.GetAllPromptsResponseBody> {
+    return unwrapAsync(promptsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a prompt
+   */
+  async create(
+    request?: operations.CreatePromptRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreatePromptPrompt> {
+    return unwrapAsync(promptsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a prompt
+   *
+   * @remarks
+   * Retrieves a prompt object
+   */
+  async retrieve(
+    request: operations.GetOnePromptRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetOnePromptPrompt> {
+    return unwrapAsync(promptsRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a prompt
+   */
+  async update(
+    request: operations.UpdatePromptRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdatePromptPrompt> {
+    return unwrapAsync(promptsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a prompt
+   */
+  async delete(
+    request: operations.DeletePromptRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(promptsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all prompt versions
+   *
+   * @remarks
+   * Returns a list of your prompt versions. The prompt versions are returned sorted by creation date, with the most recent prompt versions appearing first
+   */
+  async listVersions(
+    request: operations.ListPromptVersionsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListPromptVersionsResponseBody> {
+    return unwrapAsync(promptsListVersions(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a prompt version
+   *
+   * @remarks
+   * Retrieves a specific version of a prompt by its ID and version ID.
+   */
+  async getVersion(
+    request: operations.GetPromptVersionRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetPromptVersionResponseBody> {
+    return unwrapAsync(promptsGetVersion(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { reportingQuery } from "../funcs/reportingQuery.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Reporting extends ClientSDK {
+  /**
+   * Query reporting metrics
+   *
+   * @remarks
+   * Returns time-series analytics for AI usage, cost, latency, evaluator results, and guardrail outcomes. Select a metric and time range, break results down by supported dimensions, apply filters, and optionally include totals for the full range.
+   */
+  async query(
+    request: components.QueryReportRequest,
+    options?: RequestOptions,
+  ): Promise<components.QueryReportResponse> {
+    return unwrapAsync(reportingQuery(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { routerRerankCreate } from "../funcs/routerRerankCreate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Rerank extends ClientSDK {
+  /**
+   * Create rerank
+   *
+   * @remarks
+   * Rerank a list of documents based on their relevance to a query.
+   */
+  async create(
+    request: operations.CreateRerankRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.CreateRerankResponseBody> {
+    return unwrapAsync(routerRerankCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CreateAcceptEnum, responsesCreate } from "../funcs/responsesCreate.js";
+import { responsesGet } from "../funcs/responsesGet.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export { CreateAcceptEnum } from "../funcs/responsesCreate.js";
+
+export class Responses extends ClientSDK {
+  /**
+   * Create response
+   *
+   * @remarks
+   * Creates a model response for the given input. Returns a response object or a stream of server-sent events.
+   */
+  async create(
+    request: operations.CreateRouterResponseRequestBody,
+    options?: RequestOptions & { acceptHeaderOverride?: CreateAcceptEnum },
+  ): Promise<operations.CreateRouterResponseResponse> {
+    return unwrapAsync(responsesCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve response
+   *
+   * @remarks
+   * Retrieves a previously created response by its ID.
+   */
+  async get(
+    request: operations.RetrieveResponseRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveResponseResponseBody> {
+    return unwrapAsync(responsesGet(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { routerOcr } from "../funcs/routerOcr.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { Audio } from "./audio.js";
+import { Chat } from "./chat.js";
+import { Completions } from "./completions.js";
+import { Embeddings } from "./embeddings.js";
+import { Images } from "./images.js";
+import { Moderations } from "./moderations.js";
+import { Rerank } from "./rerank.js";
+
+export class Router extends ClientSDK {
+  private _chat?: Chat;
+  get chat(): Chat {
+    return (this._chat ??= new Chat(this._options));
+  }
+
+  private _moderations?: Moderations;
+  get moderations(): Moderations {
+    return (this._moderations ??= new Moderations(this._options));
+  }
+
+  private _rerank?: Rerank;
+  get rerank(): Rerank {
+    return (this._rerank ??= new Rerank(this._options));
+  }
+
+  private _audio?: Audio;
+  get audio(): Audio {
+    return (this._audio ??= new Audio(this._options));
+  }
+
+  private _completions?: Completions;
+  get completions(): Completions {
+    return (this._completions ??= new Completions(this._options));
+  }
+
+  private _images?: Images;
+  get images(): Images {
+    return (this._images ??= new Images(this._options));
+  }
+
+  private _embeddings?: Embeddings;
+  get embeddings(): Embeddings {
+    return (this._embeddings ??= new Embeddings(this._options));
+  }
+
+  /**
+   * Extracts text content while maintaining document structure and hierarchy
+   */
+  async ocr(
+    request: operations.PostV2RouterOcrRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostV2RouterOcrResponseBody> {
+    return unwrapAsync(routerOcr(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { routingRulesCreate } from "../funcs/routingRulesCreate.js";
+import { routingRulesDelete } from "../funcs/routingRulesDelete.js";
+import { routingRulesList } from "../funcs/routingRulesList.js";
+import { routingRulesRetrieve } from "../funcs/routingRulesRetrieve.js";
+import { routingRulesUpdate } from "../funcs/routingRulesUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class RoutingRules extends ClientSDK {
+  /**
+   * List routing rules
+   *
+   * @remarks
+   * Returns a paginated list of routing rules for the current project, ordered by priority ascending.
+   */
+  async list(
+    request?: operations.RoutingRuleListRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.RoutingRuleListResponseBody> {
+    return unwrapAsync(routingRulesList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create routing rule
+   *
+   * @remarks
+   * Creates a new routing rule with expression, models configuration, and priority settings.
+   */
+  async create(
+    request: operations.RoutingRuleCreateRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.RoutingRuleCreateResponseBody> {
+    return unwrapAsync(routingRulesCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete routing rule
+   *
+   * @remarks
+   * Deletes an existing routing rule by ID.
+   */
+  async delete(
+    request: operations.RoutingRuleDeleteRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(routingRulesDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get routing rule
+   *
+   * @remarks
+   * Retrieves the details of an existing routing rule by ID.
+   */
+  async retrieve(
+    request: operations.RoutingRuleGetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RoutingRuleGetResponseBody> {
+    return unwrapAsync(routingRulesRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update routing rule
+   *
+   * @remarks
+   * Partially updates an existing routing rule. Only provided fields are updated.
+   */
+  async update(
+    request: operations.RoutingRuleUpdateRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RoutingRuleUpdateResponseBody> {
+    return unwrapAsync(routingRulesUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,117 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { schedulesCreate } from "../funcs/schedulesCreate.js";
+import { schedulesDelete } from "../funcs/schedulesDelete.js";
+import { schedulesList } from "../funcs/schedulesList.js";
+import { schedulesRetrieve } from "../funcs/schedulesRetrieve.js";
+import { schedulesTrigger } from "../funcs/schedulesTrigger.js";
+import { schedulesUpdate } from "../funcs/schedulesUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Schedules extends ClientSDK {
+  /**
+   * List schedules
+   *
+   * @remarks
+   * Lists all schedules attached to the specified agent, most recent first.
+   */
+  async list(
+    request: operations.ListAgentSchedulesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListAgentSchedulesResponseBody> {
+    return unwrapAsync(schedulesList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create schedule
+   *
+   * @remarks
+   * Creates a schedule that runs the agent on a recurring or one-off cadence. The minimum firing interval is 1 hour for `cron` and `interval`; `once` schedules are exempt.
+   */
+  async create(
+    request: operations.CreateAgentScheduleRequest,
+    options?: RequestOptions,
+  ): Promise<operations.CreateAgentScheduleResponseBody> {
+    return unwrapAsync(schedulesCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete schedule
+   *
+   * @remarks
+   * Permanently removes a schedule from NATS, Mongo, and the Redis cache.
+   */
+  async delete(
+    request: operations.DeleteAgentScheduleRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(schedulesDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve schedule
+   *
+   * @remarks
+   * Retrieves a single schedule by ID.
+   */
+  async retrieve(
+    request: operations.RetrieveAgentScheduleRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveAgentScheduleResponseBody> {
+    return unwrapAsync(schedulesRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update schedule
+   *
+   * @remarks
+   * Partially updates a schedule. Any omitted field is left unchanged. Changing `expression` or `type` (or reactivating from inactive) re-publishes the NATS schedule and bumps `generation`; payload-only and `agent_tag`-only changes leave the firing cadence in place.
+   */
+  async update(
+    request: operations.UpdateAgentScheduleRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateAgentScheduleResponseBody> {
+    return unwrapAsync(schedulesUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Trigger schedule execution
+   *
+   * @remarks
+   * Runs the schedule's payload immediately (≈10 seconds after the request, to stay above the NATS scheduler's minimum deliver-at margin). The schedule's regular cadence is unaffected. Inactive schedules return 400.
+   */
+  async trigger(
+    request: operations.TriggerAgentScheduleRequest,
+    options?: RequestOptions,
+  ): Promise<operations.TriggerAgentScheduleResponseBody> {
+    return unwrapAsync(schedulesTrigger(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -0,0 +1,189 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { postV2FeedbackEvaluation } from "../funcs/postV2FeedbackEvaluation.js";
+import { postV2FeedbackEvaluationRemove } from "../funcs/postV2FeedbackEvaluationRemove.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { Agents } from "./agents.js";
+import { Annotations } from "./annotations.js";
+import { ApiKeys } from "./apikeys.js";
+import { Chunking } from "./chunking.js";
+import { Datasets } from "./datasets.js";
+import { Deployments } from "./deployments.js";
+import { Evals } from "./evals.js";
+import { Feedback } from "./feedback.js";
+import { Files } from "./files.js";
+import { GuardrailRules } from "./guardrailrules.js";
+import { HumanReviewSets } from "./humanreviewsets.js";
+import { Identities } from "./identities.js";
+import { Knowledge } from "./knowledge.js";
+import { MemoryStores } from "./memorystores.js";
+import { Models } from "./models.js";
+import { Pii } from "./pii.js";
+import { Policies } from "./policies.js";
+import { Projects } from "./projects.js";
+import { Prompts } from "./prompts.js";
+import { Reporting } from "./reporting.js";
+import { Responses } from "./responses.js";
+import { Router } from "./router.js";
+import { RoutingRules } from "./routingrules.js";
+import { Schedules } from "./schedules.js";
+import { Skills } from "./skills.js";
+import { Tools } from "./tools.js";
+
+export class Orq extends ClientSDK {
+  private _evals?: Evals;
+  get evals(): Evals {
+    return (this._evals ??= new Evals(this._options));
+  }
+
+  private _deployments?: Deployments;
+  get deployments(): Deployments {
+    return (this._deployments ??= new Deployments(this._options));
+  }
+
+  private _agents?: Agents;
+  get agents(): Agents {
+    return (this._agents ??= new Agents(this._options));
+  }
+
+  private _prompts?: Prompts;
+  get prompts(): Prompts {
+    return (this._prompts ??= new Prompts(this._options));
+  }
+
+  private _tools?: Tools;
+  get tools(): Tools {
+    return (this._tools ??= new Tools(this._options));
+  }
+
+  private _knowledge?: Knowledge;
+  get knowledge(): Knowledge {
+    return (this._knowledge ??= new Knowledge(this._options));
+  }
+
+  private _chunking?: Chunking;
+  get chunking(): Chunking {
+    return (this._chunking ??= new Chunking(this._options));
+  }
+
+  private _memoryStores?: MemoryStores;
+  get memoryStores(): MemoryStores {
+    return (this._memoryStores ??= new MemoryStores(this._options));
+  }
+
+  private _datasets?: Datasets;
+  get datasets(): Datasets {
+    return (this._datasets ??= new Datasets(this._options));
+  }
+
+  private _router?: Router;
+  get router(): Router {
+    return (this._router ??= new Router(this._options));
+  }
+
+  private _annotations?: Annotations;
+  get annotations(): Annotations {
+    return (this._annotations ??= new Annotations(this._options));
+  }
+
+  private _feedback?: Feedback;
+  get feedback(): Feedback {
+    return (this._feedback ??= new Feedback(this._options));
+  }
+
+  private _humanReviewSets?: HumanReviewSets;
+  get humanReviewSets(): HumanReviewSets {
+    return (this._humanReviewSets ??= new HumanReviewSets(this._options));
+  }
+
+  private _pii?: Pii;
+  get pii(): Pii {
+    return (this._pii ??= new Pii(this._options));
+  }
+
+  private _guardrailRules?: GuardrailRules;
+  get guardrailRules(): GuardrailRules {
+    return (this._guardrailRules ??= new GuardrailRules(this._options));
+  }
+
+  private _models?: Models;
+  get models(): Models {
+    return (this._models ??= new Models(this._options));
+  }
+
+  private _policies?: Policies;
+  get policies(): Policies {
+    return (this._policies ??= new Policies(this._options));
+  }
+
+  private _routingRules?: RoutingRules;
+  get routingRules(): RoutingRules {
+    return (this._routingRules ??= new RoutingRules(this._options));
+  }
+
+  private _apiKeys?: ApiKeys;
+  get apiKeys(): ApiKeys {
+    return (this._apiKeys ??= new ApiKeys(this._options));
+  }
+
+  private _files?: Files;
+  get files(): Files {
+    return (this._files ??= new Files(this._options));
+  }
+
+  private _identities?: Identities;
+  get identities(): Identities {
+    return (this._identities ??= new Identities(this._options));
+  }
+
+  private _projects?: Projects;
+  get projects(): Projects {
+    return (this._projects ??= new Projects(this._options));
+  }
+
+  private _skills?: Skills;
+  get skills(): Skills {
+    return (this._skills ??= new Skills(this._options));
+  }
+
+  private _schedules?: Schedules;
+  get schedules(): Schedules {
+    return (this._schedules ??= new Schedules(this._options));
+  }
+
+  private _responses?: Responses;
+  get responses(): Responses {
+    return (this._responses ??= new Responses(this._options));
+  }
+
+  private _reporting?: Reporting;
+  get reporting(): Reporting {
+    return (this._reporting ??= new Reporting(this._options));
+  }
+
+  async postV2FeedbackEvaluationRemove(
+    request?: operations.PostV2FeedbackEvaluationRemoveRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(postV2FeedbackEvaluationRemove(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  async postV2FeedbackEvaluation(
+    request?: operations.PostV2FeedbackEvaluationRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(postV2FeedbackEvaluation(
+      this,
+      request,
+      options,
+    ));
+  }
+}