@orq-ai/node 4.13.13 → 4.13.16

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

@@ -0,0 +1,80 @@
+/*
+ * 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";
+import {
+  MemoryStoreEmbeddingConfig,
+  MemoryStoreEmbeddingConfig$inboundSchema,
+} from "./memorystoreembeddingconfig.js";
+
+export type MemoryStore = {
+  /**
+   * The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace.
+   */
+  key: string;
+  /**
+   * The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store.
+   */
+  description: string;
+  /**
+   * The user ID of the creator
+   */
+  createdById?: string | null | undefined;
+  /**
+   * The user ID of the last updater
+   */
+  updatedById?: string | null | undefined;
+  /**
+   * The creation date of the memory store
+   */
+  created: string;
+  /**
+   * The last update date of the memory store
+   */
+  updated: string;
+  ttl?: number | null | undefined;
+  embeddingConfig: MemoryStoreEmbeddingConfig;
+  /**
+   * The unique identifier of the memory store
+   */
+  id: string;
+};
+
+/** @internal */
+export const MemoryStore$inboundSchema: z.ZodType<
+  MemoryStore,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  description: z.string(),
+  created_by_id: z.nullable(z.string()).optional(),
+  updated_by_id: z.nullable(z.string()).optional(),
+  created: z.string(),
+  updated: z.string(),
+  ttl: z.nullable(z.number()).optional(),
+  embedding_config: MemoryStoreEmbeddingConfig$inboundSchema,
+  _id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "embedding_config": "embeddingConfig",
+    "_id": "id",
+  });
+});
+
+export function memoryStoreFromJSON(
+  jsonString: string,
+): SafeParseResult<MemoryStore, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MemoryStore$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MemoryStore' from JSON`,
+  );
+}

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

@@ -0,0 +1,54 @@
+/*
+ * 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";
+
+export type MemoryStoreEmbeddingConfig = {
+  /**
+   * The embeddings model to use for the knowledge base in the format "provider/model" for public models or "workspaceKey@provider/model" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base. Refer to the (Supported models)[/docs/proxy/supported-models] to browse available models.
+   */
+  model: string;
+};
+
+/** @internal */
+export const MemoryStoreEmbeddingConfig$inboundSchema: z.ZodType<
+  MemoryStoreEmbeddingConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model: z.string(),
+});
+/** @internal */
+export type MemoryStoreEmbeddingConfig$Outbound = {
+  model: string;
+};
+
+/** @internal */
+export const MemoryStoreEmbeddingConfig$outboundSchema: z.ZodType<
+  MemoryStoreEmbeddingConfig$Outbound,
+  z.ZodTypeDef,
+  MemoryStoreEmbeddingConfig
+> = z.object({
+  model: z.string(),
+});
+
+export function memoryStoreEmbeddingConfigToJSON(
+  memoryStoreEmbeddingConfig: MemoryStoreEmbeddingConfig,
+): string {
+  return JSON.stringify(
+    MemoryStoreEmbeddingConfig$outboundSchema.parse(memoryStoreEmbeddingConfig),
+  );
+}
+export function memoryStoreEmbeddingConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<MemoryStoreEmbeddingConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MemoryStoreEmbeddingConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MemoryStoreEmbeddingConfig' from JSON`,
+  );
+}

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

@@ -0,0 +1,203 @@
+/*
+ * 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";
+import {
+  ModelArtificialAnalysis,
+  ModelArtificialAnalysis$inboundSchema,
+} from "./modelartificialanalysis.js";
+import {
+  ModelModalities,
+  ModelModalities$inboundSchema,
+} from "./modelmodalities.js";
+import {
+  ModelParameter,
+  ModelParameter$inboundSchema,
+} from "./modelparameter.js";
+import { ModelProvider, ModelProvider$inboundSchema } from "./modelprovider.js";
+
+/**
+ * Resolved commercial pricing, including service-tier variants. Each
+ *
+ * @remarks
+ *  variant carries a `when` CEL condition string evaluated against
+ *  `input_tokens`, `output_tokens`, `total_tokens` and `tier`; all
+ *  variants whose condition is true are merged onto the base pricing in
+ *  order, later variants winning per field. Absent when this offering has
+ *  no representable token-based pricing.
+ */
+export type ModelPricing = {};
+
+export type Model = {
+  /**
+   * Catalog identifier, `<provider>/<model>` (for example `openai/gpt-4o`).
+   */
+  id: string;
+  /**
+   * When orq listed this offering, Unix seconds (string-encoded int64 in
+   *
+   * @remarks
+   *  JSON).
+   */
+  created: string;
+  /**
+   * When this offering stops being served, Unix seconds (string-encoded
+   *
+   * @remarks
+   *  int64 in JSON): orq's own sunset date if one is set, otherwise the
+   *  developer's announced deprecation date. Absent when neither is set.
+   */
+  deprecation?: string | undefined;
+  /**
+   * Display name shown in the orq model garden.
+   */
+  name: string;
+  /**
+   * Short model description.
+   */
+  description: string;
+  /**
+   * Provider that serves this offering.
+   */
+  provider: ModelProvider;
+  /**
+   * API endpoints this offering exposes (chat, batch, ...).
+   */
+  endpoints: Array<string>;
+  /**
+   * Content modalities this offering consumes and produces.
+   */
+  modalities: ModelModalities;
+  /**
+   * Provider-independent model reference this offering serves, `<developer>/<stem>`.
+   */
+  offeringOf: string;
+  /**
+   * Resolved commercial pricing, including service-tier variants. Each
+   *
+   * @remarks
+   *  variant carries a `when` CEL condition string evaluated against
+   *  `input_tokens`, `output_tokens`, `total_tokens` and `tier`; all
+   *  variants whose condition is true are merged onto the base pricing in
+   *  order, later variants winning per field. Absent when this offering has
+   *  no representable token-based pricing.
+   */
+  pricing?: ModelPricing | undefined;
+  /**
+   * Playground and API parameters this offering exposes.
+   */
+  supportedParameters: Array<ModelParameter>;
+  /**
+   * Paid service tier names available to this offering.
+   */
+  supportedTiers: Array<string>;
+  /**
+   * Maximum input context size in tokens (string-encoded int64 in JSON).
+   *
+   * @remarks
+   *  Absent when not applicable.
+   */
+  contextWindow?: string | undefined;
+  /**
+   * Maximum output size in tokens (string-encoded int64 in JSON). Absent
+   *
+   * @remarks
+   *  when not applicable.
+   */
+  maxOutputTokens?: string | undefined;
+  /**
+   * Regions this offering routes to, lowercased.
+   */
+  location: Array<string>;
+  /**
+   * Artificial Analysis benchmark data. Absent when unavailable for this
+   *
+   * @remarks
+   *  offering.
+   */
+  artificialIntelligence?: ModelArtificialAnalysis | undefined;
+  /**
+   * Catalog lifecycle: active, preview or deprecated.
+   */
+  status: string;
+  /**
+   * Task type: chat, completion, embedding, image, ...
+   */
+  type: string;
+  /**
+   * Training-data cutoff (YYYY-MM). Empty when unset.
+   */
+  knowledgeCutoff: string;
+  /**
+   * Public release date (YYYY-MM-DD). Empty when unset.
+   */
+  releaseDate: string;
+};
+
+/** @internal */
+export const ModelPricing$inboundSchema: z.ZodType<
+  ModelPricing,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function modelPricingFromJSON(
+  jsonString: string,
+): SafeParseResult<ModelPricing, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ModelPricing$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ModelPricing' from JSON`,
+  );
+}
+
+/** @internal */
+export const Model$inboundSchema: z.ZodType<Model, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string(),
+    created: z.string(),
+    deprecation: z.string().optional(),
+    name: z.string(),
+    description: z.string(),
+    provider: ModelProvider$inboundSchema,
+    endpoints: z.array(z.string()),
+    modalities: ModelModalities$inboundSchema,
+    offering_of: z.string(),
+    pricing: z.lazy(() => ModelPricing$inboundSchema).optional(),
+    supported_parameters: z.array(ModelParameter$inboundSchema),
+    supported_tiers: z.array(z.string()),
+    context_window: z.string().optional(),
+    max_output_tokens: z.string().optional(),
+    location: z.array(z.string()),
+    artificial_intelligence: ModelArtificialAnalysis$inboundSchema.optional(),
+    status: z.string(),
+    type: z.string(),
+    knowledge_cutoff: z.string(),
+    release_date: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      "offering_of": "offeringOf",
+      "supported_parameters": "supportedParameters",
+      "supported_tiers": "supportedTiers",
+      "context_window": "contextWindow",
+      "max_output_tokens": "maxOutputTokens",
+      "artificial_intelligence": "artificialIntelligence",
+      "knowledge_cutoff": "knowledgeCutoff",
+      "release_date": "releaseDate",
+    });
+  });
+
+export function modelFromJSON(
+  jsonString: string,
+): SafeParseResult<Model, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Model$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Model' from JSON`,
+  );
+}

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

@@ -0,0 +1,95 @@
+/*
+ * 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";
+
+/**
+ * Benchmark scores by evaluation key. A `null` value means the
+ *
+ * @remarks
+ *  evaluation exists but is unmeasured for this model.
+ */
+export type Evaluations = {};
+
+export type ModelArtificialAnalysis = {
+  /**
+   * Artificial Analysis model slug.
+   */
+  slug: string;
+  /**
+   * Artificial Analysis intelligence index. Absent when unmeasured.
+   */
+  intelligenceIndex?: number | undefined;
+  /**
+   * Benchmark scores by evaluation key. A `null` value means the
+   *
+   * @remarks
+   *  evaluation exists but is unmeasured for this model.
+   */
+  evaluations?: Evaluations | undefined;
+  /**
+   * Artificial Analysis recorded release date. Empty when unknown.
+   */
+  releaseDate?: string | undefined;
+  /**
+   * Measured output throughput, tokens per second. Absent when unmeasured.
+   */
+  medianOutputTokensPerSecond?: number | undefined;
+  /**
+   * Measured time to first token, seconds. Absent when unmeasured.
+   */
+  medianTimeToFirstTokenSeconds?: number | undefined;
+};
+
+/** @internal */
+export const Evaluations$inboundSchema: z.ZodType<
+  Evaluations,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function evaluationsFromJSON(
+  jsonString: string,
+): SafeParseResult<Evaluations, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Evaluations$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Evaluations' from JSON`,
+  );
+}
+
+/** @internal */
+export const ModelArtificialAnalysis$inboundSchema: z.ZodType<
+  ModelArtificialAnalysis,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  slug: z.string(),
+  intelligence_index: z.number().optional(),
+  evaluations: z.lazy(() => Evaluations$inboundSchema).optional(),
+  release_date: z.string().optional(),
+  median_output_tokens_per_second: z.number().optional(),
+  median_time_to_first_token_seconds: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "intelligence_index": "intelligenceIndex",
+    "release_date": "releaseDate",
+    "median_output_tokens_per_second": "medianOutputTokensPerSecond",
+    "median_time_to_first_token_seconds": "medianTimeToFirstTokenSeconds",
+  });
+});
+
+export function modelArtificialAnalysisFromJSON(
+  jsonString: string,
+): SafeParseResult<ModelArtificialAnalysis, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ModelArtificialAnalysis$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ModelArtificialAnalysis' from JSON`,
+  );
+}

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

@@ -0,0 +1,39 @@
+/*
+ * 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";
+
+export type ModelModalities = {
+  /**
+   * Modalities this offering accepts as input.
+   */
+  input: Array<string>;
+  /**
+   * Modalities this offering produces as output.
+   */
+  output: Array<string>;
+};
+
+/** @internal */
+export const ModelModalities$inboundSchema: z.ZodType<
+  ModelModalities,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  input: z.array(z.string()),
+  output: z.array(z.string()),
+});
+
+export function modelModalitiesFromJSON(
+  jsonString: string,
+): SafeParseResult<ModelModalities, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ModelModalities$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ModelModalities' from JSON`,
+  );
+}

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

@@ -0,0 +1,49 @@
+/*
+ * 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";
+
+export type ModelParameter = {
+  /**
+   * Display name shown in the playground.
+   */
+  name: string;
+  /**
+   * API parameter key (e.g. `temperature`, `maxTokens`).
+   */
+  parameter: string;
+  /**
+   * Widget type: slider, select, toggle or text.
+   */
+  type: string;
+  /**
+   * Help text shown to playground users.
+   */
+  description: string;
+};
+
+/** @internal */
+export const ModelParameter$inboundSchema: z.ZodType<
+  ModelParameter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  parameter: z.string(),
+  type: z.string(),
+  description: z.string(),
+});
+
+export function modelParameterFromJSON(
+  jsonString: string,
+): SafeParseResult<ModelParameter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ModelParameter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ModelParameter' from JSON`,
+  );
+}

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

@@ -0,0 +1,60 @@
+/*
+ * 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 ModelProvider = {
+  /**
+   * Catalog provider key (openai, anthropic, aws, ...).
+   */
+  id: string;
+  /**
+   * Provider display name.
+   */
+  name: string;
+  /**
+   * Absolute URL of the provider logo. Empty when no logo is known.
+   */
+  logo: string;
+  /**
+   * Provider documentation URL.
+   */
+  docsUrl: string;
+  /**
+   * Provider pricing page URL.
+   */
+  pricingUrl: string;
+};
+
+/** @internal */
+export const ModelProvider$inboundSchema: z.ZodType<
+  ModelProvider,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  name: z.string(),
+  logo: z.string(),
+  docs_url: z.string(),
+  pricing_url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "docs_url": "docsUrl",
+    "pricing_url": "pricingUrl",
+  });
+});
+
+export function modelProviderFromJSON(
+  jsonString: string,
+): SafeParseResult<ModelProvider, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ModelProvider$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ModelProvider' from JSON`,
+  );
+}

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

@@ -0,0 +1,32 @@
+/*
+ * 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 { Chunk, Chunk$inboundSchema } from "./chunk.js";
+
+export type ParseResponse = {
+  chunks: Array<Chunk>;
+};
+
+/** @internal */
+export const ParseResponse$inboundSchema: z.ZodType<
+  ParseResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chunks: z.array(Chunk$inboundSchema),
+});
+
+export function parseResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ParseResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ParseResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ParseResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,52 @@
+/*
+ * 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";
+import {
+  ProcessingError,
+  ProcessingError$inboundSchema,
+} from "./processingerror.js";
+
+export type ProcessingAttempt = {
+  id: string;
+  startedAt: string;
+  queuedAt?: string | undefined;
+  completedAt?: string | undefined;
+  errors?: Array<ProcessingError> | undefined;
+  retryable?: boolean | undefined;
+};
+
+/** @internal */
+export const ProcessingAttempt$inboundSchema: z.ZodType<
+  ProcessingAttempt,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  started_at: z.string(),
+  queued_at: z.string().optional(),
+  completed_at: z.string().optional(),
+  errors: z.array(ProcessingError$inboundSchema).optional(),
+  retryable: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "started_at": "startedAt",
+    "queued_at": "queuedAt",
+    "completed_at": "completedAt",
+  });
+});
+
+export function processingAttemptFromJSON(
+  jsonString: string,
+): SafeParseResult<ProcessingAttempt, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProcessingAttempt$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProcessingAttempt' from JSON`,
+  );
+}

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

@@ -0,0 +1,33 @@
+/*
+ * 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";
+
+export type ProcessingError = {
+  code?: number | undefined;
+  message?: string | undefined;
+};
+
+/** @internal */
+export const ProcessingError$inboundSchema: z.ZodType<
+  ProcessingError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.number().int().optional(),
+  message: z.string().optional(),
+});
+
+export function processingErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ProcessingError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProcessingError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProcessingError' from JSON`,
+  );
+}