@orq-ai/node 4.9.16 → 4.9.18

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

@@ -12,7 +12,6 @@ export type FileT = {
   fileId?: string | undefined;
   purpose?: number | undefined;
   fileName?: string | undefined;
-  workspaceId?: string | undefined;
   bytes?: string | undefined;
   createdAt?: Date | undefined;
 };
@@ -23,7 +22,6 @@ export const FileT$inboundSchema: z.ZodType<FileT, z.ZodTypeDef, unknown> = z
     file_id: z.string().optional(),
     purpose: z.number().int().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)
@@ -32,7 +30,6 @@ export const FileT$inboundSchema: z.ZodType<FileT, z.ZodTypeDef, unknown> = z
     return remap$(v, {
       "file_id": "fileId",
       "file_name": "fileName",
-      "workspace_id": "workspaceId",
       "created_at": "createdAt",
     });
   });

package/packages/orq-rc/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/packages/orq-rc/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/packages/orq-rc/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/packages/orq-rc/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/packages/orq-rc/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`,
+  );
+}

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

@@ -18,12 +18,16 @@ export * from "./conversationparam.js";
 export * from "./createagentresponse.js";
 export * from "./createfilerequest.js";
 export * from "./createfileresponse.js";
+export * from "./createidentityrequest.js";
+export * from "./createidentityresponse.js";
 export * from "./createprojectrequest.js";
 export * from "./createprojectresponse.js";
 export * from "./createskillrequest.js";
 export * from "./createskillresponse.js";
 export * from "./datapart.js";
+export * from "./datapoint.js";
 export * from "./deletefileresponse.js";
+export * from "./deleteidentityresponse.js";
 export * from "./deleteprojectresponse.js";
 export * from "./deleteskillresponse.js";
 export * from "./errorpart.js";
@@ -39,6 +43,7 @@ export * from "./fallbackconfig.js";
 export * from "./file.js";
 export * from "./filecontentpartschema.js";
 export * from "./filepart.js";
+export * from "./filter.js";
 export * from "./getagentresponse.js";
 export * from "./getfilecontentresponse.js";
 export * from "./getfileresponse.js";
@@ -46,12 +51,15 @@ export * from "./getprojectresponse.js";
 export * from "./getskillresponse.js";
 export * from "./guardrailref.js";
 export * from "./guardrailrule.js";
+export * from "./identity.js";
+export * from "./identitymetrics.js";
 export * from "./imagecontentpartschema.js";
 export * from "./incompletedetails.js";
 export * from "./inputtokensdetails.js";
 export * from "./invokedeploymentrequest.js";
 export * from "./limits.js";
 export * from "./listfilesresponse.js";
+export * from "./listidentitiesresponse.js";
 export * from "./listprojectsresponse.js";
 export * from "./listskillsresponse.js";
 export * from "./memoryparam.js";
@@ -66,10 +74,13 @@ export * from "./policyretryconfig.js";
 export * from "./project.js";
 export * from "./publiccontact.js";
 export * from "./publicidentity.js";
+export * from "./publicmodelentry.js";
 export * from "./publicschedule.js";
 export * from "./publicscheduleerrordetail.js";
 export * from "./publicschedulepayload.js";
 export * from "./publicusage.js";
+export * from "./queryreportrequest.js";
+export * from "./queryreportresponse.js";
 export * from "./reasoning.js";
 export * from "./reasoningparam.js";
 export * from "./reasoningpart.js";
@@ -82,10 +93,12 @@ export * from "./responseerror.js";
 export * from "./responseexecutionlimits.js";
 export * from "./responsefailedevent.js";
 export * from "./responseidentity.js";
+export * from "./responsemeta.js";
 export * from "./responseretryconfig.js";
 export * from "./responsestartedevent.js";
 export * from "./responsestreamingevent.js";
 export * from "./responsethread.js";
+export * from "./retrieveidentityresponse.js";
 export * from "./reviewoutcome.js";
 export * from "./routingrule.js";
 export * from "./security.js";
@@ -109,8 +122,11 @@ export * from "./toolresultpart.js";
 export * from "./toolreviewdoneevent.js";
 export * from "./toolreviewrequestedevent.js";
 export * from "./toolstartedevent.js";
+export * from "./totals.js";
 export * from "./updatefilerequest.js";
 export * from "./updatefileresponse.js";
+export * from "./updateidentityrequest.js";
+export * from "./updateidentityresponse.js";
 export * from "./updateprojectrequest.js";
 export * from "./updateprojectresponse.js";
 export * from "./updateskillrequest.js";

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

@@ -739,7 +739,7 @@ export type Messages =
 /**
  * Metadata about the document
  */
-export type Metadata = {
+export type InvokeDeploymentRequestMetadata = {
   /**
    * Name of the file the text is from.
    */
@@ -762,7 +762,7 @@ export type Documents = {
   /**
    * Metadata about the document
    */
-  metadata?: Metadata | undefined;
+  metadata?: InvokeDeploymentRequestMetadata | undefined;
 };
 
 export type InvokeOptions = {
@@ -2342,17 +2342,17 @@ export function messagesToJSON(messages: Messages): string {
 }
 
 /** @internal */
-export type Metadata$Outbound = {
+export type InvokeDeploymentRequestMetadata$Outbound = {
   file_name?: string | undefined;
   file_type?: string | undefined;
   page_number?: number | undefined;
 };
 
 /** @internal */
-export const Metadata$outboundSchema: z.ZodType<
-  Metadata$Outbound,
+export const InvokeDeploymentRequestMetadata$outboundSchema: z.ZodType<
+  InvokeDeploymentRequestMetadata$Outbound,
   z.ZodTypeDef,
-  Metadata
+  InvokeDeploymentRequestMetadata
 > = z.object({
   fileName: z.string().optional(),
   fileType: z.string().optional(),
@@ -2365,14 +2365,20 @@ export const Metadata$outboundSchema: z.ZodType<
   });
 });
 
-export function metadataToJSON(metadata: Metadata): string {
-  return JSON.stringify(Metadata$outboundSchema.parse(metadata));
+export function invokeDeploymentRequestMetadataToJSON(
+  invokeDeploymentRequestMetadata: InvokeDeploymentRequestMetadata,
+): string {
+  return JSON.stringify(
+    InvokeDeploymentRequestMetadata$outboundSchema.parse(
+      invokeDeploymentRequestMetadata,
+    ),
+  );
 }
 
 /** @internal */
 export type Documents$Outbound = {
   text: string;
-  metadata?: Metadata$Outbound | undefined;
+  metadata?: InvokeDeploymentRequestMetadata$Outbound | undefined;
 };
 
 /** @internal */
@@ -2382,7 +2388,8 @@ export const Documents$outboundSchema: z.ZodType<
   Documents
 > = z.object({
   text: z.string(),
-  metadata: z.lazy(() => Metadata$outboundSchema).optional(),
+  metadata: z.lazy(() => InvokeDeploymentRequestMetadata$outboundSchema)
+    .optional(),
 });
 
 export function documentsToJSON(documents: Documents): string {

package/packages/orq-rc/src/models/components/listidentitiesresponse.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";
+import { Identity, Identity$inboundSchema } from "./identity.js";
+
+export type ListIdentitiesResponse = {
+  object?: string | undefined;
+  data?: Array<Identity> | undefined;
+  hasMore?: boolean | undefined;
+};
+
+/** @internal */
+export const ListIdentitiesResponse$inboundSchema: z.ZodType<
+  ListIdentitiesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string().optional(),
+  data: z.array(Identity$inboundSchema).optional(),
+  has_more: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listIdentitiesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListIdentitiesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListIdentitiesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListIdentitiesResponse' from JSON`,
+  );
+}

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

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

package/packages/orq-rc/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/packages/orq-rc/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/packages/orq-rc/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",