@orq-ai/node 4.10.0-rc.6 → 4.10.0-rc.64

package/src/models/components/detectrequest.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * The workspace is resolved from the API key, never sent in the body.
+ */
+export type DetectRequest = {
+  /**
+   * Text to analyse.
+   */
+  text?: string | undefined;
+  /**
+   * BCP-47 language code. Unset means auto-detect.
+   */
+  language?: string | undefined;
+  /**
+   * Global minimum recognizer score (0.0-1.0). Unset uses the provider default.
+   */
+  threshold?: number | undefined;
+  /**
+   * When true, the response includes a per-type entity breakdown.
+   */
+  includeEntities?: boolean | undefined;
+};
+
+/** @internal */
+export type DetectRequest$Outbound = {
+  text?: string | undefined;
+  language?: string | undefined;
+  threshold?: number | undefined;
+  include_entities?: boolean | undefined;
+};
+
+/** @internal */
+export const DetectRequest$outboundSchema: z.ZodType<
+  DetectRequest$Outbound,
+  z.ZodTypeDef,
+  DetectRequest
+> = z.object({
+  text: z.string().optional(),
+  language: z.string().optional(),
+  threshold: z.number().optional(),
+  includeEntities: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    includeEntities: "include_entities",
+  });
+});
+
+export function detectRequestToJSON(detectRequest: DetectRequest): string {
+  return JSON.stringify(DetectRequest$outboundSchema.parse(detectRequest));
+}

package/src/models/components/detectresponse.ts

@@ -0,0 +1,41 @@
+/*
+ * 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 DetectResponse = {
+  hasPii?: boolean | undefined;
+  /**
+   * Per-entity-type counts. Populated only when include_entities was set.
+   */
+  entities?: { [k: string]: number } | undefined;
+};
+
+/** @internal */
+export const DetectResponse$inboundSchema: z.ZodType<
+  DetectResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  has_pii: z.boolean().optional(),
+  entities: z.record(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_pii": "hasPii",
+  });
+});
+
+export function detectResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DetectResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DetectResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DetectResponse' from JSON`,
+  );
+}

package/src/models/components/domain.ts

@@ -0,0 +1,75 @@
+/*
+ * 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";
+
+/**
+ * Domain describes a permission domain that can be granted to an
+ *
+ * @remarks
+ *  API key. Verbs are derived from id + group + readable/writable.
+ */
+export type Domain = {
+  /**
+   * Stable domain identifier (e.g. "agent", "chat_completions"). Used
+   *
+   * @remarks
+   *  as the key in ApiKey.access and as the verb prefix in resolved
+   *  permissions (e.g. agent.list, agent.view, agent.create).
+   */
+  id?: string | undefined;
+  /**
+   * Human-readable label for the dashboard.
+   */
+  displayName?: string | undefined;
+  /**
+   * Logical group used by the UI to render this entry.
+   */
+  group?: number | undefined;
+  /**
+   * Project scopes this domain may be granted under. A workspace-
+   *
+   * @remarks
+   *  admin domain like `member` is typically SCOPE_MODE_ALL only.
+   */
+  allowedScopes?: Array<number> | undefined;
+  /**
+   * Whether this domain can be granted read access.
+   */
+  readable?: boolean | undefined;
+  /**
+   * Whether this domain can be granted write access.
+   */
+  writable?: boolean | undefined;
+};
+
+/** @internal */
+export const Domain$inboundSchema: z.ZodType<Domain, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string().optional(),
+    display_name: z.string().optional(),
+    group: z.number().int().optional(),
+    allowed_scopes: z.array(z.number().int()).optional(),
+    readable: z.boolean().optional(),
+    writable: z.boolean().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "display_name": "displayName",
+      "allowed_scopes": "allowedScopes",
+    });
+  });
+
+export function domainFromJSON(
+  jsonString: string,
+): SafeParseResult<Domain, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Domain$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Domain' from JSON`,
+  );
+}

package/src/models/components/evaluatorref.ts

@@ -20,6 +20,7 @@ export type EvaluatorRef = {
   executeOn: EvaluatorRefExecuteOn;
   id: string;
   isGuardrail?: boolean | undefined;
+  options?: { [k: string]: any } | undefined;
   sampleRate?: number | undefined;
 };
 
@@ -41,6 +42,7 @@ export const EvaluatorRef$inboundSchema: z.ZodType<
   execute_on: EvaluatorRefExecuteOn$inboundSchema,
   id: z.string(),
   is_guardrail: z.boolean().optional(),
+  options: z.record(z.any()).optional(),
   sample_rate: z.number().optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -54,6 +56,7 @@ export type EvaluatorRef$Outbound = {
   execute_on: string;
   id: string;
   is_guardrail?: boolean | undefined;
+  options?: { [k: string]: any } | undefined;
   sample_rate?: number | undefined;
 };
 
@@ -66,6 +69,7 @@ export const EvaluatorRef$outboundSchema: z.ZodType<
   executeOn: EvaluatorRefExecuteOn$outboundSchema,
   id: z.string(),
   isGuardrail: z.boolean().optional(),
+  options: z.record(z.any()).optional(),
   sampleRate: z.number().optional(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/file.ts

@@ -7,33 +7,37 @@ 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 { FilePurpose, FilePurpose$inboundSchema } from "./filepurpose.js";
 
 export type FileT = {
   fileId?: string | undefined;
-  purpose?: number | undefined;
+  purpose?: FilePurpose | undefined;
   fileName?: string | undefined;
-  workspaceId?: string | undefined;
   bytes?: string | undefined;
   createdAt?: Date | undefined;
+  /**
+   * Identifier of the project the file belongs to. Files are project-scoped; an API key may only access files in projects it is authorized for.
+   */
+  projectId?: string | undefined;
 };
 
 /** @internal */
 export const FileT$inboundSchema: z.ZodType<FileT, z.ZodTypeDef, unknown> = z
   .object({
     file_id: z.string().optional(),
-    purpose: z.number().int().optional(),
+    purpose: FilePurpose$inboundSchema.optional(),
     file_name: z.string().optional(),
-    workspace_id: z.string().optional(),
     bytes: z.string().optional(),
     created_at: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ).optional(),
+    project_id: z.string().optional(),
   }).transform((v) => {
     return remap$(v, {
       "file_id": "fileId",
       "file_name": "fileName",
-      "workspace_id": "workspaceId",
       "created_at": "createdAt",
+      "project_id": "projectId",
     });
   });
 

package/src/models/components/filepurpose.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const FilePurpose = {
+  FilePurposeUnspecified: "FILE_PURPOSE_UNSPECIFIED",
+  FilePurposeRetrieval: "FILE_PURPOSE_RETRIEVAL",
+  FilePurposeKnowledgeDatasource: "FILE_PURPOSE_KNOWLEDGE_DATASOURCE",
+  FilePurposeBatch: "FILE_PURPOSE_BATCH",
+} as const;
+export type FilePurpose = ClosedEnum<typeof FilePurpose>;
+
+/** @internal */
+export const FilePurpose$inboundSchema: z.ZodNativeEnum<typeof FilePurpose> = z
+  .nativeEnum(FilePurpose);
+/** @internal */
+export const FilePurpose$outboundSchema: z.ZodNativeEnum<typeof FilePurpose> =
+  FilePurpose$inboundSchema;

package/src/models/components/filter.ts

@@ -0,0 +1,137 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Public reporting dimension to filter on. Valid fields depend on the selected metric.
+ */
+export const Field = {
+  Project: "project",
+  Identity: "identity",
+  Provider: "provider",
+  Model: "model",
+  Product: "product",
+  ApiKey: "api_key",
+  StatusCode: "status_code",
+  HttpStatusCode: "http_status_code",
+  CredentialType: "credential_type",
+  BillingBillable: "billing_billable",
+  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;
+/**
+ * Public reporting dimension to filter on. Valid fields depend on the selected metric.
+ */
+export type Field = ClosedEnum<typeof Field>;
+
+/**
+ * Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values.
+ */
+export const Op = {
+  Eq: "eq",
+  Neq: "neq",
+  In: "in",
+  NotIn: "not_in",
+} as const;
+/**
+ * Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values.
+ */
+export type Op = ClosedEnum<typeof Op>;
+
+export type Filter = {
+  /**
+   * Public reporting dimension to filter on. Valid fields depend on the selected metric.
+   */
+  field?: Field | undefined;
+  /**
+   * Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values.
+   */
+  op?: Op | undefined;
+  /**
+   * Values compared against the selected field. Values are interpreted
+   *
+   * @remarks
+   *  as public API strings, not SQL fragments.
+   */
+  values?: Array<string> | undefined;
+};
+
+/** @internal */
+export const Field$inboundSchema: z.ZodNativeEnum<typeof Field> = z.nativeEnum(
+  Field,
+);
+/** @internal */
+export const Field$outboundSchema: z.ZodNativeEnum<typeof Field> =
+  Field$inboundSchema;
+
+/** @internal */
+export const Op$inboundSchema: z.ZodNativeEnum<typeof Op> = z.nativeEnum(Op);
+/** @internal */
+export const Op$outboundSchema: z.ZodNativeEnum<typeof Op> = Op$inboundSchema;
+
+/** @internal */
+export const Filter$inboundSchema: z.ZodType<Filter, z.ZodTypeDef, unknown> = z
+  .object({
+    field: Field$inboundSchema.optional(),
+    op: Op$inboundSchema.optional(),
+    values: z.array(z.string()).optional(),
+  });
+/** @internal */
+export type Filter$Outbound = {
+  field?: string | undefined;
+  op?: string | undefined;
+  values?: Array<string> | undefined;
+};
+
+/** @internal */
+export const Filter$outboundSchema: z.ZodType<
+  Filter$Outbound,
+  z.ZodTypeDef,
+  Filter
+> = z.object({
+  field: Field$outboundSchema.optional(),
+  op: Op$outboundSchema.optional(),
+  values: z.array(z.string()).optional(),
+});
+
+export function filterToJSON(filter: Filter): string {
+  return JSON.stringify(Filter$outboundSchema.parse(filter));
+}
+export function filterFromJSON(
+  jsonString: string,
+): SafeParseResult<Filter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Filter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Filter' from JSON`,
+  );
+}

package/src/models/components/getapikeyresponse.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 { ApiKey, ApiKey$inboundSchema } from "./apikey.js";
+
+export type GetApiKeyResponse = {
+  /**
+   * Requested api-key. Raw token never included.
+   */
+  apiKey?: ApiKey | undefined;
+};
+
+/** @internal */
+export const GetApiKeyResponse$inboundSchema: z.ZodType<
+  GetApiKeyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  api_key: ApiKey$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "api_key": "apiKey",
+  });
+});
+
+export function getApiKeyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetApiKeyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetApiKeyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetApiKeyResponse' from JSON`,
+  );
+}

package/src/models/components/getprojectresponse.ts

@@ -9,6 +9,9 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Project, Project$inboundSchema } from "./project.js";
 
 export type GetProjectResponse = {
+  /**
+   * Requested project.
+   */
   project?: Project | undefined;
 };
 

package/src/models/components/getskillresponse.ts

@@ -9,6 +9,9 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Skill, Skill$inboundSchema } from "./skill.js";
 
 export type GetSkillResponse = {
+  /**
+   * Requested skill.
+   */
   skill?: Skill | undefined;
 };
 

package/src/models/components/guardrailref.ts

@@ -20,6 +20,7 @@ export type GuardrailRef = {
   executeOn: ExecuteOn;
   id: string;
   isGuardrail?: boolean | undefined;
+  options?: { [k: string]: any } | undefined;
   sampleRate?: number | undefined;
 };
 
@@ -39,6 +40,7 @@ export const GuardrailRef$inboundSchema: z.ZodType<
   execute_on: ExecuteOn$inboundSchema,
   id: z.string(),
   is_guardrail: z.boolean().optional(),
+  options: z.record(z.any()).optional(),
   sample_rate: z.number().optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -52,6 +54,7 @@ export type GuardrailRef$Outbound = {
   execute_on: string;
   id: string;
   is_guardrail?: boolean | undefined;
+  options?: { [k: string]: any } | undefined;
   sample_rate?: number | undefined;
 };
 
@@ -64,6 +67,7 @@ export const GuardrailRef$outboundSchema: z.ZodType<
   executeOn: ExecuteOn$outboundSchema,
   id: z.string(),
   isGuardrail: z.boolean().optional(),
+  options: z.record(z.any()).optional(),
   sampleRate: z.number().optional(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/identity.ts

@@ -0,0 +1,83 @@
+/*
+ * 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 {
+  IdentityMetrics,
+  IdentityMetrics$inboundSchema,
+} from "./identitymetrics.js";
+
+export type Metadata = {};
+
+export type Identity = {
+  id?: string | undefined;
+  externalId?: string | undefined;
+  workspaceId?: string | undefined;
+  displayName?: string | undefined;
+  email?: string | undefined;
+  avatarUrl?: string | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: Metadata | undefined;
+  created?: string | undefined;
+  updated?: string | undefined;
+  metrics?: IdentityMetrics | undefined;
+};
+
+/** @internal */
+export const Metadata$inboundSchema: z.ZodType<
+  Metadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function metadataFromJSON(
+  jsonString: string,
+): SafeParseResult<Metadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Metadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const Identity$inboundSchema: z.ZodType<
+  Identity,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  external_id: z.string().optional(),
+  workspace_id: z.string().optional(),
+  display_name: z.string().optional(),
+  email: z.string().optional(),
+  avatar_url: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+  metadata: z.lazy(() => Metadata$inboundSchema).optional(),
+  created: z.string().optional(),
+  updated: z.string().optional(),
+  metrics: IdentityMetrics$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "external_id": "externalId",
+    "workspace_id": "workspaceId",
+    "display_name": "displayName",
+    "avatar_url": "avatarUrl",
+  });
+});
+
+export function identityFromJSON(
+  jsonString: string,
+): SafeParseResult<Identity, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Identity$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Identity' from JSON`,
+  );
+}

package/src/models/components/identitymetrics.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 IdentityMetrics = {
+  totalTokens?: number | undefined;
+  totalCost?: number | undefined;
+  totalRequests?: number | undefined;
+  errorRate?: number | undefined;
+};
+
+/** @internal */
+export const IdentityMetrics$inboundSchema: z.ZodType<
+  IdentityMetrics,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total_tokens: z.number().optional(),
+  total_cost: z.number().optional(),
+  total_requests: z.number().optional(),
+  error_rate: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_tokens": "totalTokens",
+    "total_cost": "totalCost",
+    "total_requests": "totalRequests",
+    "error_rate": "errorRate",
+  });
+});
+
+export function identityMetricsFromJSON(
+  jsonString: string,
+): SafeParseResult<IdentityMetrics, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IdentityMetrics$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IdentityMetrics' from JSON`,
+  );
+}