@orq-ai/node 4.10.0-rc.1 → 4.10.0-rc.10

package/src/models/components/listskillsresponse.ts

@@ -10,8 +10,20 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Skill, Skill$inboundSchema } from "./skill.js";
 
 export type ListSkillsResponse = {
+  /**
+   * Object discriminator for list responses; always `list`.
+   */
   object?: string | undefined;
+  /**
+   * Page of skills, ordered newest first.
+   */
   data?: Array<Skill> | undefined;
+  /**
+   * Whether more skills are available in the selected pagination
+   *
+   * @remarks
+   *  direction.
+   */
   hasMore?: boolean | undefined;
 };
 

package/src/models/components/modelref.ts

@@ -9,6 +9,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ModelRef = {
+  displayName?: string | undefined;
   integrationId?: string | undefined;
   model: string;
   weight?: number | undefined;
@@ -20,16 +21,19 @@ export const ModelRef$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  display_name: z.string().optional(),
   integration_id: z.string().optional(),
   model: z.string(),
   weight: z.number().optional(),
 }).transform((v) => {
   return remap$(v, {
+    "display_name": "displayName",
     "integration_id": "integrationId",
   });
 });
 /** @internal */
 export type ModelRef$Outbound = {
+  display_name?: string | undefined;
   integration_id?: string | undefined;
   model: string;
   weight?: number | undefined;
@@ -41,11 +45,13 @@ export const ModelRef$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ModelRef
 > = z.object({
+  displayName: z.string().optional(),
   integrationId: z.string().optional(),
   model: z.string(),
   weight: z.number().optional(),
 }).transform((v) => {
   return remap$(v, {
+    displayName: "display_name",
     integrationId: "integration_id",
   });
 });

package/src/models/components/project.ts

@@ -9,16 +9,57 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type Project = {
+  /**
+   * Unique project identifier assigned by ORQ. Use this value in
+   *
+   * @remarks
+   *  retrieve, update, and delete requests.
+   */
   projectId?: string | undefined;
+  /**
+   * Human-readable project name.
+   */
   name?: string | undefined;
+  /**
+   * Stable project key generated from the name and used by internal
+   *
+   * @remarks
+   *  workspace navigation.
+   */
   key?: string | undefined;
-  workspaceId?: string | undefined;
+  /**
+   * Whether the project is archived and hidden from normal active
+   *
+   * @remarks
+   *  project lists.
+   */
   isArchived?: boolean | undefined;
+  /**
+   * Whether this is the workspace default project.
+   */
   isDefault?: boolean | undefined;
+  /**
+   * Team identifiers associated with the project for access and
+   *
+   * @remarks
+   *  organization.
+   */
   teams?: Array<string> | undefined;
+  /**
+   * Time when the project was created.
+   */
   createdAt?: Date | undefined;
+  /**
+   * Time when the project was last updated.
+   */
   updatedAt?: Date | undefined;
+  /**
+   * User ID that created the project.
+   */
   createdById?: string | undefined;
+  /**
+   * User ID that last updated the project.
+   */
   updatedById?: string | undefined;
 };
 
@@ -28,7 +69,6 @@ export const Project$inboundSchema: z.ZodType<Project, z.ZodTypeDef, unknown> =
     project_id: z.string().optional(),
     name: z.string().optional(),
     key: z.string().optional(),
-    workspace_id: z.string().optional(),
     is_archived: z.boolean().optional(),
     is_default: z.boolean().optional(),
     teams: z.array(z.string()).optional(),
@@ -43,7 +83,6 @@ export const Project$inboundSchema: z.ZodType<Project, z.ZodTypeDef, unknown> =
   }).transform((v) => {
     return remap$(v, {
       "project_id": "projectId",
-      "workspace_id": "workspaceId",
       "is_archived": "isArchived",
       "is_default": "isDefault",
       "created_at": "createdAt",

package/src/models/components/queryreportrequest.ts

@@ -0,0 +1,237 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Filter,
+  Filter$inboundSchema,
+  Filter$Outbound,
+  Filter$outboundSchema,
+} from "./filter.js";
+
+/**
+ * Catalogue metric to query.
+ */
+export const Metric = {
+  GenaiRequests: "genai.requests",
+  GenaiTokens: "genai.tokens",
+  GenaiCost: "genai.cost",
+  GenaiErrors: "genai.errors",
+  GenaiLatencyP50: "genai.latency.p50",
+  GenaiLatencyP95: "genai.latency.p95",
+  GenaiLatencyP99: "genai.latency.p99",
+  GenaiEvaluatorRuns: "genai.evaluator.runs",
+  GenaiEvaluatorPassRate: "genai.evaluator.pass_rate",
+  GenaiEvaluatorScoreAvg: "genai.evaluator.score.avg",
+  GenaiGuardrailRuns: "genai.guardrail.runs",
+  GenaiGuardrailBlockRate: "genai.guardrail.block_rate",
+  GenaiGuardrailTriggered: "genai.guardrail.triggered",
+  GenaiUsage: "genai.usage",
+} as const;
+/**
+ * Catalogue metric to query.
+ */
+export type Metric = ClosedEnum<typeof Metric>;
+
+/**
+ * Requested bucket grain. Use `auto` or omit the field to let the server choose based on the requested range.
+ */
+export const Grain = {
+  Auto: "auto",
+  Minute: "minute",
+  Hour: "hour",
+  Day: "day",
+} as const;
+/**
+ * Requested bucket grain. Use `auto` or omit the field to let the server choose based on the requested range.
+ */
+export type Grain = ClosedEnum<typeof Grain>;
+
+export const GroupBy = {
+  Project: "project",
+  Identity: "identity",
+  Provider: "provider",
+  Model: "model",
+  Product: "product",
+  ApiKey: "api_key",
+  StatusCode: "status_code",
+  HttpStatusCode: "http_status_code",
+  CredentialType: "credential_type",
+  Dimension: "dimension",
+  DimensionType: "dimension_type",
+  Tag: "tag",
+  Agent: "agent",
+  Tool: "tool",
+  Deployment: "deployment",
+  Evaluator: "evaluator",
+  Dataset: "dataset",
+  Prompt: "prompt",
+  Policy: "policy",
+  Conversation: "conversation",
+  Thread: "thread",
+  MemoryStore: "memory_store",
+  Knowledge: "knowledge",
+  Sheet: "sheet",
+  GuardrailOrigin: "guardrail_origin",
+  EvaluatorName: "evaluator_name",
+  EvaluatorType: "evaluator_type",
+  EvaluatorVersion: "evaluator_version",
+  ResultType: "result_type",
+  EvaluationStage: "evaluation_stage",
+  GuardrailStage: "guardrail_stage",
+  EvaluatorStage: "evaluator_stage",
+  GuardrailAction: "guardrail_action",
+  ResultLabel: "result_label",
+} as const;
+export type GroupBy = ClosedEnum<typeof GroupBy>;
+
+export type QueryReportRequest = {
+  /**
+   * Catalogue metric to query.
+   */
+  metric: Metric;
+  /**
+   * Inclusive lower bound for the report window (RFC 3339, UTC).
+   */
+  from: Date;
+  /**
+   * Exclusive upper bound for the report window (RFC 3339, UTC).
+   */
+  to: Date;
+  /**
+   * Requested bucket grain. Use `auto` or omit the field to let the server choose based on the requested range.
+   */
+  grain?: Grain | undefined;
+  /**
+   * Reporting dimensions to break down by. Valid dimensions depend on the selected metric.
+   */
+  groupBy?: Array<GroupBy> | undefined;
+  /**
+   * Up to 20 allowlisted predicates combined with AND.
+   */
+  filters?: Array<Filter> | undefined;
+  /**
+   * Maximum bucket rows returned. Defaults to 1000 and is capped at
+   *
+   * @remarks
+   *  5000.
+   */
+  limit?: number | undefined;
+  /**
+   * IANA time zone applied to bucket boundaries, for example
+   *
+   * @remarks
+   *  `America/New_York`. Response timestamps remain UTC. Empty means UTC.
+   */
+  timeZone?: string | undefined;
+  /**
+   * When true, include a `totals` block aggregated across the full
+   *
+   * @remarks
+   *  report window.
+   */
+  includeTotals?: boolean | undefined;
+};
+
+/** @internal */
+export const Metric$inboundSchema: z.ZodNativeEnum<typeof Metric> = z
+  .nativeEnum(Metric);
+/** @internal */
+export const Metric$outboundSchema: z.ZodNativeEnum<typeof Metric> =
+  Metric$inboundSchema;
+
+/** @internal */
+export const Grain$inboundSchema: z.ZodNativeEnum<typeof Grain> = z.nativeEnum(
+  Grain,
+);
+/** @internal */
+export const Grain$outboundSchema: z.ZodNativeEnum<typeof Grain> =
+  Grain$inboundSchema;
+
+/** @internal */
+export const GroupBy$inboundSchema: z.ZodNativeEnum<typeof GroupBy> = z
+  .nativeEnum(GroupBy);
+/** @internal */
+export const GroupBy$outboundSchema: z.ZodNativeEnum<typeof GroupBy> =
+  GroupBy$inboundSchema;
+
+/** @internal */
+export const QueryReportRequest$inboundSchema: z.ZodType<
+  QueryReportRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  metric: Metric$inboundSchema,
+  from: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  to: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  grain: Grain$inboundSchema.optional(),
+  group_by: z.array(GroupBy$inboundSchema).optional(),
+  filters: z.array(Filter$inboundSchema).optional(),
+  limit: z.number().int().optional(),
+  time_zone: z.string().optional(),
+  include_totals: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "group_by": "groupBy",
+    "time_zone": "timeZone",
+    "include_totals": "includeTotals",
+  });
+});
+/** @internal */
+export type QueryReportRequest$Outbound = {
+  metric: string;
+  from: string;
+  to: string;
+  grain?: string | undefined;
+  group_by?: Array<string> | undefined;
+  filters?: Array<Filter$Outbound> | undefined;
+  limit?: number | undefined;
+  time_zone?: string | undefined;
+  include_totals?: boolean | undefined;
+};
+
+/** @internal */
+export const QueryReportRequest$outboundSchema: z.ZodType<
+  QueryReportRequest$Outbound,
+  z.ZodTypeDef,
+  QueryReportRequest
+> = z.object({
+  metric: Metric$outboundSchema,
+  from: z.date().transform(v => v.toISOString()),
+  to: z.date().transform(v => v.toISOString()),
+  grain: Grain$outboundSchema.optional(),
+  groupBy: z.array(GroupBy$outboundSchema).optional(),
+  filters: z.array(Filter$outboundSchema).optional(),
+  limit: z.number().int().optional(),
+  timeZone: z.string().optional(),
+  includeTotals: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    groupBy: "group_by",
+    timeZone: "time_zone",
+    includeTotals: "include_totals",
+  });
+});
+
+export function queryReportRequestToJSON(
+  queryReportRequest: QueryReportRequest,
+): string {
+  return JSON.stringify(
+    QueryReportRequest$outboundSchema.parse(queryReportRequest),
+  );
+}
+export function queryReportRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryReportRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QueryReportRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryReportRequest' from JSON`,
+  );
+}

package/src/models/components/queryreportresponse.ts

@@ -0,0 +1,96 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { DataPoint, DataPoint$inboundSchema } from "./datapoint.js";
+import {
+  QueryReportRequest,
+  QueryReportRequest$inboundSchema,
+} from "./queryreportrequest.js";
+import { ResponseMeta, ResponseMeta$inboundSchema } from "./responsemeta.js";
+import { Totals, Totals$inboundSchema } from "./totals.js";
+
+/**
+ * Object discriminator for typed SDKs and JSON parsers; always `report`.
+ */
+export const ObjectT = {
+  Report: "report",
+} as const;
+/**
+ * Object discriminator for typed SDKs and JSON parsers; always `report`.
+ */
+export type ObjectT = ClosedEnum<typeof ObjectT>;
+
+export type QueryReportResponse = {
+  /**
+   * Object discriminator for typed SDKs and JSON parsers; always `report`.
+   */
+  object?: ObjectT | undefined;
+  /**
+   * The request that produced this response, parroted back so caller
+   *
+   * @remarks
+   *  code never has to remember its own payload to interpret the result.
+   */
+  request?: QueryReportRequest | undefined;
+  /**
+   * Time-ordered buckets.
+   */
+  data?: Array<DataPoint> | undefined;
+  /**
+   * Totals across the whole window. Present only when
+   *
+   * @remarks
+   *  `include_totals=true` on the request.
+   */
+  totals?: Totals | undefined;
+  /**
+   * Pagination contract. Always populated; currently false because the
+   *
+   * @remarks
+   *  server caps the response at `limit` instead of issuing cursors.
+   */
+  hasMore?: boolean | undefined;
+  /**
+   * Diagnostic metadata.
+   */
+  meta?: ResponseMeta | undefined;
+};
+
+/** @internal */
+export const ObjectT$inboundSchema: z.ZodNativeEnum<typeof ObjectT> = z
+  .nativeEnum(ObjectT);
+
+/** @internal */
+export const QueryReportResponse$inboundSchema: z.ZodType<
+  QueryReportResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ObjectT$inboundSchema.optional(),
+  request: QueryReportRequest$inboundSchema.optional(),
+  data: z.array(DataPoint$inboundSchema).optional(),
+  totals: Totals$inboundSchema.optional(),
+  has_more: z.boolean().optional(),
+  meta: ResponseMeta$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function queryReportResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryReportResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QueryReportResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryReportResponse' from JSON`,
+  );
+}

package/src/models/components/reasoningpart.ts

@@ -40,7 +40,7 @@ export const ReasoningPart$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("reasoning_01krgc9r3nn4cg67p9cm6b4bt5"),
+  _id: z.string().default("reasoning_01krtzz2q8b9q7j2px9fnwjqjz"),
   metadata: z.record(z.any()).optional(),
   kind: z.literal("reasoning"),
   reasoning: z.string(),

package/src/models/components/responsemeta.ts

@@ -0,0 +1,103 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Bucket grain actually applied by the planner.
+ */
+export const EffectiveGrain = {
+  Minute: "minute",
+  Hour: "hour",
+  Day: "day",
+} as const;
+/**
+ * Bucket grain actually applied by the planner.
+ */
+export type EffectiveGrain = ClosedEnum<typeof EffectiveGrain>;
+
+/**
+ * ISO 4217 currency code for cost fields. Always `USD` today.
+ */
+export const ResponseMetaCurrency = {
+  Usd: "USD",
+} as const;
+/**
+ * ISO 4217 currency code for cost fields. Always `USD` today.
+ */
+export type ResponseMetaCurrency = ClosedEnum<typeof ResponseMetaCurrency>;
+
+export type ResponseMeta = {
+  /**
+   * Bucket grain actually applied by the planner.
+   */
+  effectiveGrain?: EffectiveGrain | undefined;
+  /**
+   * Number of rows in `data`. Cheap hint for clients that paginate
+   *
+   * @remarks
+   *  client-side; mirrors `len(data)`.
+   */
+  rowCount?: number | undefined;
+  /**
+   * Stable identifier for this query. Forward in support tickets so
+   *
+   * @remarks
+   *  server logs can be correlated. Also returned in the
+   *  `X-Request-Id` response header.
+   */
+  requestId?: string | undefined;
+  /**
+   * ISO 4217 currency code for cost fields. Always `USD` today.
+   */
+  currency?: ResponseMetaCurrency | undefined;
+  /**
+   * Non-fatal warnings about the response. May contain `totals_unavailable` when totals were requested but failed.
+   */
+  warnings?: Array<string> | undefined;
+};
+
+/** @internal */
+export const EffectiveGrain$inboundSchema: z.ZodNativeEnum<
+  typeof EffectiveGrain
+> = z.nativeEnum(EffectiveGrain);
+
+/** @internal */
+export const ResponseMetaCurrency$inboundSchema: z.ZodNativeEnum<
+  typeof ResponseMetaCurrency
+> = z.nativeEnum(ResponseMetaCurrency);
+
+/** @internal */
+export const ResponseMeta$inboundSchema: z.ZodType<
+  ResponseMeta,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  effective_grain: EffectiveGrain$inboundSchema.optional(),
+  row_count: z.number().int().optional(),
+  request_id: z.string().optional(),
+  currency: ResponseMetaCurrency$inboundSchema.optional(),
+  warnings: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "effective_grain": "effectiveGrain",
+    "row_count": "rowCount",
+    "request_id": "requestId",
+  });
+});
+
+export function responseMetaFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseMeta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseMeta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseMeta' from JSON`,
+  );
+}

package/src/models/components/retrieveidentityresponse.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 { Identity, Identity$inboundSchema } from "./identity.js";
+
+export type RetrieveIdentityResponse = {
+  identity?: Identity | undefined;
+};
+
+/** @internal */
+export const RetrieveIdentityResponse$inboundSchema: z.ZodType<
+  RetrieveIdentityResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  identity: Identity$inboundSchema.optional(),
+});
+
+export function retrieveIdentityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RetrieveIdentityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RetrieveIdentityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetrieveIdentityResponse' from JSON`,
+  );
+}

package/src/models/components/skill.ts

@@ -9,17 +9,53 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type Skill = {
+  /**
+   * Unique skill identifier assigned by ORQ, for example
+   *
+   * @remarks
+   *  `skill_01H...`. Use this value in retrieve, update, and delete
+   *  requests.
+   */
   skillId?: string | undefined;
+  /**
+   * Workspace-unique display name. Must start with a letter and may contain letters, numbers, underscores, and hyphens.
+   */
   displayName?: string | undefined;
+  /**
+   * Short human-readable summary of what the skill is for.
+   */
   description?: string | undefined;
+  /**
+   * Free-form labels used for organization and filtering in clients.
+   */
   tags?: Array<string> | undefined;
+  /**
+   * Project that owns or contains the skill.
+   */
   projectId?: string | undefined;
+  /**
+   * Project path where the skill is stored in the workspace.
+   */
   path?: string | undefined;
-  workspaceId?: string | undefined;
+  /**
+   * Time when the skill was created.
+   */
   createdAt?: Date | undefined;
+  /**
+   * Time when the skill was last updated.
+   */
   updatedAt?: Date | undefined;
+  /**
+   * User ID that created the skill.
+   */
   createdById?: string | undefined;
+  /**
+   * User ID that last updated the skill.
+   */
   updatedById?: string | undefined;
+  /**
+   * Instruction body executed or reused by clients that load this skill.
+   */
   instructions?: string | undefined;
   /**
    * Latest semver assigned by the activity log. Stamped on the document
@@ -40,7 +76,6 @@ export const Skill$inboundSchema: z.ZodType<Skill, z.ZodTypeDef, unknown> = z
     tags: z.array(z.string()).optional(),
     project_id: z.string().optional(),
     path: z.string().optional(),
-    workspace_id: z.string().optional(),
     created_at: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ).optional(),
@@ -56,7 +91,6 @@ export const Skill$inboundSchema: z.ZodType<Skill, z.ZodTypeDef, unknown> = z
       "skill_id": "skillId",
       "display_name": "displayName",
       "project_id": "projectId",
-      "workspace_id": "workspaceId",
       "created_at": "createdAt",
       "updated_at": "updatedAt",
       "created_by_id": "createdById",