@orq-ai/node 4.13.13 → 4.13.16

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

@@ -0,0 +1,186 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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 * as components from "../models/components/index.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";
+
+/**
+ * List model catalog offerings
+ *
+ * @remarks
+ * Returns catalog entries as a flat list of offerings. Pass `model` to narrow the list to every provider offering of one base model reference (for example `anthropic/claude-opus`).
+ */
+export function modelCatalogListOfferings(
+  client: OrqCore,
+  request?: operations.ModelCatalogListOfferingsRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.ListModelCatalogOfferingsResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  request?: operations.ModelCatalogListOfferingsRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.ListModelCatalogOfferingsResponse,
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ModelCatalogListOfferingsRequest$outboundSchema.optional()
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v2/model-catalog/offerings")();
+
+  const query = encodeFormQuery({
+    "deprecated": payload?.deprecated,
+    "ending_before": payload?.ending_before,
+    "endpoint": payload?.endpoint,
+    "input_modality": payload?.input_modality,
+    "limit": payload?.limit,
+    "location": payload?.location,
+    "model": payload?.model,
+    "offering_of": payload?.offering_of,
+    "order": payload?.order,
+    "output_modality": payload?.output_modality,
+    "provider": payload?.provider,
+    "search": payload?.search,
+    "sort_by": payload?.sort_by,
+    "starting_after": payload?.starting_after,
+    "status": payload?.status,
+    "supported_parameter": payload?.supported_parameter,
+    "tier": payload?.tier,
+    "type": payload?.type,
+  });
+
+  const headers = new Headers(compactMap({
+    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: "ModelCatalogListOfferings",
+    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: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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<
+    components.ListModelCatalogOfferingsResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.ListModelCatalogOfferingsResponse$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 }];
+}

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

@@ -27,6 +27,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Create a prompt
+ *
+ * @remarks
+ * Create a new prompt in the workspace.
  */
 export function promptsCreate(
   client: OrqCore,

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

@@ -29,6 +29,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Delete a prompt
+ *
+ * @remarks
+ * Delete a prompt and all its versions by ID.
  */
 export function promptsDelete(
   client: OrqCore,

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

@@ -28,6 +28,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Update a prompt
+ *
+ * @remarks
+ * Update a prompt by ID with the provided fields.
  */
 export function promptsUpdate(
   client: OrqCore,

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

@@ -35,6 +35,9 @@ import { isReadableStream } from "../types/streams.js";
 
 /**
  * Create transcription
+ *
+ * @remarks
+ * Transcribe audio input into text using the configured transcription model and return the result.
  */
 export function routerAudioTranscriptionsCreate(
   client: OrqCore,

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

@@ -35,6 +35,9 @@ import { isReadableStream } from "../types/streams.js";
 
 /**
  * Create translation
+ *
+ * @remarks
+ * Translate audio input into English text using the configured translation model and return the result.
  */
 export function routerAudioTranslationsCreate(
   client: OrqCore,

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

@@ -28,6 +28,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Create moderation
+ *
+ * @remarks
+ * Analyze text for content policy violations using the moderation model and return classification results.
  */
 export function routerModerationsCreate(
   client: OrqCore,

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

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * List tools
  *
  * @remarks
- * Lists all workspace tools. By default, returns all tools in a single response. Set `limit` to enable cursor-based pagination with `starting_after` and `ending_before`.
+ * List all workspace tools. By default returns all tools in one response. Set `limit` for cursor-based pagination.
  */
 export function toolsList(
   client: OrqCore,

package/packages/orq-rc/src/lib/config.ts

@@ -58,7 +58,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "2.0",
-  sdkVersion: "4.14.0-rc.20",
-  genVersion: "2.930.0",
-  userAgent: "speakeasy-sdk/typescript 4.14.0-rc.20 2.930.0 2.0 @orq-ai/node",
+  sdkVersion: "4.14.0-rc.43",
+  genVersion: "2.931.0",
+  userAgent: "speakeasy-sdk/typescript 4.14.0-rc.43 2.931.0 2.0 @orq-ai/node",
 } as const;

package/packages/orq-rc/src/models/components/agenticragconfig.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AgenticRagConfig = {
+  modelDbId?: string | undefined;
+  provider?: string | undefined;
+  integrationId?: string | undefined;
+  model?: string | undefined;
+};
+
+/** @internal */
+export const AgenticRagConfig$inboundSchema: z.ZodType<
+  AgenticRagConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model_db_id: z.string().optional(),
+  provider: z.string().optional(),
+  integration_id: z.string().optional(),
+  model: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "model_db_id": "modelDbId",
+    "integration_id": "integrationId",
+  });
+});
+
+export function agenticRagConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<AgenticRagConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AgenticRagConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AgenticRagConfig' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/agentresponserequest.ts

@@ -159,7 +159,7 @@ export type AgentResponseRequestThread = {
 /**
  * Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions.
  */
-export type Memory = {
+export type AgentResponseRequestMemory = {
   /**
    * An entity ID used to link memory stores to a specific user, session, or conversation. This ID is used to isolate and retrieve memories specific to the entity across agent executions.
    */
@@ -232,7 +232,7 @@ export type AgentResponseRequest = {
   /**
    * Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions.
    */
-  memory?: Memory | undefined;
+  memory?: AgentResponseRequestMemory | undefined;
   /**
    * Optional metadata for the agent invocation as key-value pairs that will be included in traces
    */
@@ -448,15 +448,15 @@ export function agentResponseRequestThreadToJSON(
 }
 
 /** @internal */
-export type Memory$Outbound = {
+export type AgentResponseRequestMemory$Outbound = {
   entity_id: string;
 };
 
 /** @internal */
-export const Memory$outboundSchema: z.ZodType<
-  Memory$Outbound,
+export const AgentResponseRequestMemory$outboundSchema: z.ZodType<
+  AgentResponseRequestMemory$Outbound,
   z.ZodTypeDef,
-  Memory
+  AgentResponseRequestMemory
 > = z.object({
   entityId: z.string(),
 }).transform((v) => {
@@ -465,8 +465,12 @@ export const Memory$outboundSchema: z.ZodType<
   });
 });
 
-export function memoryToJSON(memory: Memory): string {
-  return JSON.stringify(Memory$outboundSchema.parse(memory));
+export function agentResponseRequestMemoryToJSON(
+  agentResponseRequestMemory: AgentResponseRequestMemory,
+): string {
+  return JSON.stringify(
+    AgentResponseRequestMemory$outboundSchema.parse(agentResponseRequestMemory),
+  );
 }
 
 /** @internal */
@@ -521,7 +525,7 @@ export type AgentResponseRequest$Outbound = {
   identity?: AgentResponseRequestIdentity$Outbound | undefined;
   contact?: Contact$Outbound | undefined;
   thread?: AgentResponseRequestThread$Outbound | undefined;
-  memory?: Memory$Outbound | undefined;
+  memory?: AgentResponseRequestMemory$Outbound | undefined;
   metadata?: { [k: string]: any } | undefined;
   engine?: string | undefined;
   configuration?: Configuration$Outbound | undefined;
@@ -543,7 +547,7 @@ export const AgentResponseRequest$outboundSchema: z.ZodType<
     .optional(),
   contact: z.lazy(() => Contact$outboundSchema).optional(),
   thread: z.lazy(() => AgentResponseRequestThread$outboundSchema).optional(),
-  memory: z.lazy(() => Memory$outboundSchema).optional(),
+  memory: z.lazy(() => AgentResponseRequestMemory$outboundSchema).optional(),
   metadata: z.record(z.any()).optional(),
   engine: Engine$outboundSchema.optional(),
   configuration: z.lazy(() => Configuration$outboundSchema).optional(),

package/packages/orq-rc/src/models/components/alertcondition.ts

@@ -41,17 +41,16 @@ export const Window = {
 export type Window = ClosedEnum<typeof Window>;
 
 /**
- * How often the alert is evaluated. `30s` is a testing cadence.
+ * How often the alert is evaluated. Plan limits may enforce a minimum.
  */
 export const Interval = {
-  Thirtys: "30s",
   Fivem: "5m",
   Fifteenm: "15m",
   Oneh: "1h",
   Oned: "1d",
 } as const;
 /**
- * How often the alert is evaluated. `30s` is a testing cadence.
+ * How often the alert is evaluated. Plan limits may enforce a minimum.
  */
 export type Interval = ClosedEnum<typeof Interval>;
 
@@ -105,7 +104,7 @@ export type AlertCondition = {
    */
   window: Window;
   /**
-   * How often the alert is evaluated. `30s` is a testing cadence.
+   * How often the alert is evaluated. Plan limits may enforce a minimum.
    */
   interval: Interval;
   /**

package/packages/orq-rc/src/models/components/chunk.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { ChunkMetadata, ChunkMetadata$inboundSchema } from "./chunkmetadata.js";
+
+export type Chunk = {
+  id: string;
+  text: string;
+  index: number;
+  metadata?: ChunkMetadata | undefined;
+};
+
+/** @internal */
+export const Chunk$inboundSchema: z.ZodType<Chunk, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string(),
+    text: z.string(),
+    index: z.number().int(),
+    metadata: ChunkMetadata$inboundSchema.optional(),
+  });
+
+export function chunkFromJSON(
+  jsonString: string,
+): SafeParseResult<Chunk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Chunk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Chunk' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/chunkingcleanupoptions.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type ChunkingCleanupOptions = {
+  deleteEmails?: boolean | undefined;
+  deleteCreditCards?: boolean | undefined;
+  deletePhoneNumbers?: boolean | undefined;
+  cleanBulletPoints?: boolean | undefined;
+  cleanNumberedList?: boolean | undefined;
+  cleanUnicode?: boolean | undefined;
+  cleanDashes?: boolean | undefined;
+  cleanWhitespaces?: boolean | undefined;
+};
+
+/** @internal */
+export type ChunkingCleanupOptions$Outbound = {
+  delete_emails?: boolean | undefined;
+  delete_credit_cards?: boolean | undefined;
+  delete_phone_numbers?: boolean | undefined;
+  clean_bullet_points?: boolean | undefined;
+  clean_numbered_list?: boolean | undefined;
+  clean_unicode?: boolean | undefined;
+  clean_dashes?: boolean | undefined;
+  clean_whitespaces?: boolean | undefined;
+};
+
+/** @internal */
+export const ChunkingCleanupOptions$outboundSchema: z.ZodType<
+  ChunkingCleanupOptions$Outbound,
+  z.ZodTypeDef,
+  ChunkingCleanupOptions
+> = z.object({
+  deleteEmails: z.boolean().optional(),
+  deleteCreditCards: z.boolean().optional(),
+  deletePhoneNumbers: z.boolean().optional(),
+  cleanBulletPoints: z.boolean().optional(),
+  cleanNumberedList: z.boolean().optional(),
+  cleanUnicode: z.boolean().optional(),
+  cleanDashes: z.boolean().optional(),
+  cleanWhitespaces: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    deleteEmails: "delete_emails",
+    deleteCreditCards: "delete_credit_cards",
+    deletePhoneNumbers: "delete_phone_numbers",
+    cleanBulletPoints: "clean_bullet_points",
+    cleanNumberedList: "clean_numbered_list",
+    cleanUnicode: "clean_unicode",
+    cleanDashes: "clean_dashes",
+    cleanWhitespaces: "clean_whitespaces",
+  });
+});
+
+export function chunkingCleanupOptionsToJSON(
+  chunkingCleanupOptions: ChunkingCleanupOptions,
+): string {
+  return JSON.stringify(
+    ChunkingCleanupOptions$outboundSchema.parse(chunkingCleanupOptions),
+  );
+}

package/packages/orq-rc/src/models/components/chunkingconfiguration.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * Provides advanced settings for customizing chunking behavior, enabling fine-grained control to better meet specific data processing needs.
+ */
+export type ChunkingConfiguration2 = {
+  type: "advanced";
+  /**
+   * Defines the absolute maximum character length per chunk. Text elements exceeding this size will be automatically split into multiple chunks.
+   */
+  chunkMaxCharacters?: number | undefined;
+  /**
+   * Specifies the number of characters to overlap between consecutive chunks. This overlap helps maintain semantic continuity when splitting large text elements.
+   */
+  chunkOverlap?: number | undefined;
+};
+
+/**
+ * Optimized chunking strategy focusing on speed and avoiding duplication of content chunks.
+ */
+export type ChunkingConfiguration1 = {
+  type: "default";
+};
+
+/**
+ * The chunking configuration settings for the datasource. Defaults to the system's standard chunking configuration if not specified.
+ */
+export type ChunkingConfiguration =
+  | ChunkingConfiguration1
+  | ChunkingConfiguration2;
+
+/** @internal */
+export type ChunkingConfiguration2$Outbound = {
+  type: "advanced";
+  chunk_max_characters: number;
+  chunk_overlap: number;
+};
+
+/** @internal */
+export const ChunkingConfiguration2$outboundSchema: z.ZodType<
+  ChunkingConfiguration2$Outbound,
+  z.ZodTypeDef,
+  ChunkingConfiguration2
+> = z.object({
+  type: z.literal("advanced"),
+  chunkMaxCharacters: z.number().default(500),
+  chunkOverlap: z.number().default(0),
+}).transform((v) => {
+  return remap$(v, {
+    chunkMaxCharacters: "chunk_max_characters",
+    chunkOverlap: "chunk_overlap",
+  });
+});
+
+export function chunkingConfiguration2ToJSON(
+  chunkingConfiguration2: ChunkingConfiguration2,
+): string {
+  return JSON.stringify(
+    ChunkingConfiguration2$outboundSchema.parse(chunkingConfiguration2),
+  );
+}
+
+/** @internal */
+export type ChunkingConfiguration1$Outbound = {
+  type: "default";
+};
+
+/** @internal */
+export const ChunkingConfiguration1$outboundSchema: z.ZodType<
+  ChunkingConfiguration1$Outbound,
+  z.ZodTypeDef,
+  ChunkingConfiguration1
+> = z.object({
+  type: z.literal("default"),
+});
+
+export function chunkingConfiguration1ToJSON(
+  chunkingConfiguration1: ChunkingConfiguration1,
+): string {
+  return JSON.stringify(
+    ChunkingConfiguration1$outboundSchema.parse(chunkingConfiguration1),
+  );
+}
+
+/** @internal */
+export type ChunkingConfiguration$Outbound =
+  | ChunkingConfiguration1$Outbound
+  | ChunkingConfiguration2$Outbound;
+
+/** @internal */
+export const ChunkingConfiguration$outboundSchema: z.ZodType<
+  ChunkingConfiguration$Outbound,
+  z.ZodTypeDef,
+  ChunkingConfiguration
+> = z.union([
+  z.lazy(() => ChunkingConfiguration1$outboundSchema),
+  z.lazy(() => ChunkingConfiguration2$outboundSchema),
+]);
+
+export function chunkingConfigurationToJSON(
+  chunkingConfiguration: ChunkingConfiguration,
+): string {
+  return JSON.stringify(
+    ChunkingConfiguration$outboundSchema.parse(chunkingConfiguration),
+  );
+}

package/packages/orq-rc/src/models/components/chunkmetadata.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ChunkMetadata = {
+  startIndex: number;
+  endIndex: number;
+  tokenCount: number;
+};
+
+/** @internal */
+export const ChunkMetadata$inboundSchema: z.ZodType<
+  ChunkMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  start_index: z.number().int(),
+  end_index: z.number().int(),
+  token_count: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "start_index": "startIndex",
+    "end_index": "endIndex",
+    "token_count": "tokenCount",
+  });
+});
+
+export function chunkMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<ChunkMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChunkMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChunkMetadata' from JSON`,
+  );
+}