@orq-ai/node 4.9.11 → 4.9.13

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

@@ -1,237 +0,0 @@
-/*
- * 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/packages/orq-rc/src/models/components/queryreportresponse.ts

@@ -1,96 +0,0 @@
-/*
- * 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/packages/orq-rc/src/models/components/responsemeta.ts

@@ -1,103 +0,0 @@
-/*
- * 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/packages/orq-rc/src/models/components/retrieveidentityresponse.ts

@@ -1,32 +0,0 @@
-/*
- * 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/packages/orq-rc/src/models/components/totals.ts

@@ -1,34 +0,0 @@
-/*
- * 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 Totals = {
-  /**
-   * Same shape and rules as `DataPoint.metrics`, aggregated across the
-   *
-   * @remarks
-   *  whole window.
-   */
-  metrics?: { [k: string]: number } | undefined;
-};
-
-/** @internal */
-export const Totals$inboundSchema: z.ZodType<Totals, z.ZodTypeDef, unknown> = z
-  .object({
-    metrics: z.record(z.number()).optional(),
-  });
-
-export function totalsFromJSON(
-  jsonString: string,
-): SafeParseResult<Totals, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Totals$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Totals' from JSON`,
-  );
-}

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

@@ -1,75 +0,0 @@
-/*
- * 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 UpdateIdentityRequestMetadata = {};
-
-export type UpdateIdentityRequest = {
-  id?: string | undefined;
-  displayName?: string | undefined;
-  email?: string | undefined;
-  avatarUrl?: string | undefined;
-  tags?: Array<string> | undefined;
-  metadata?: UpdateIdentityRequestMetadata | undefined;
-};
-
-/** @internal */
-export type UpdateIdentityRequestMetadata$Outbound = {};
-
-/** @internal */
-export const UpdateIdentityRequestMetadata$outboundSchema: z.ZodType<
-  UpdateIdentityRequestMetadata$Outbound,
-  z.ZodTypeDef,
-  UpdateIdentityRequestMetadata
-> = z.object({});
-
-export function updateIdentityRequestMetadataToJSON(
-  updateIdentityRequestMetadata: UpdateIdentityRequestMetadata,
-): string {
-  return JSON.stringify(
-    UpdateIdentityRequestMetadata$outboundSchema.parse(
-      updateIdentityRequestMetadata,
-    ),
-  );
-}
-
-/** @internal */
-export type UpdateIdentityRequest$Outbound = {
-  id?: string | undefined;
-  display_name?: string | undefined;
-  email?: string | undefined;
-  avatar_url?: string | undefined;
-  tags?: Array<string> | undefined;
-  metadata?: UpdateIdentityRequestMetadata$Outbound | undefined;
-};
-
-/** @internal */
-export const UpdateIdentityRequest$outboundSchema: z.ZodType<
-  UpdateIdentityRequest$Outbound,
-  z.ZodTypeDef,
-  UpdateIdentityRequest
-> = z.object({
-  id: z.string().optional(),
-  displayName: z.string().optional(),
-  email: z.string().optional(),
-  avatarUrl: z.string().optional(),
-  tags: z.array(z.string()).optional(),
-  metadata: z.lazy(() => UpdateIdentityRequestMetadata$outboundSchema)
-    .optional(),
-}).transform((v) => {
-  return remap$(v, {
-    displayName: "display_name",
-    avatarUrl: "avatar_url",
-  });
-});
-
-export function updateIdentityRequestToJSON(
-  updateIdentityRequest: UpdateIdentityRequest,
-): string {
-  return JSON.stringify(
-    UpdateIdentityRequest$outboundSchema.parse(updateIdentityRequest),
-  );
-}

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

@@ -1,32 +0,0 @@
-/*
- * 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 UpdateIdentityResponse = {
-  identity?: Identity | undefined;
-};
-
-/** @internal */
-export const UpdateIdentityResponse$inboundSchema: z.ZodType<
-  UpdateIdentityResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  identity: Identity$inboundSchema.optional(),
-});
-
-export function updateIdentityResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<UpdateIdentityResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => UpdateIdentityResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'UpdateIdentityResponse' from JSON`,
-  );
-}

package/packages/orq-rc/src/sdk/reporting.ts

@@ -1,27 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { reportingQuery } from "../funcs/reportingQuery.js";
-import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import * as components from "../models/components/index.js";
-import { unwrapAsync } from "../types/fp.js";
-
-export class Reporting extends ClientSDK {
-  /**
-   * Query reporting metrics
-   *
-   * @remarks
-   * Returns time-series analytics for AI usage, cost, latency, evaluator results, and guardrail outcomes. Select a metric and time range, break results down by supported dimensions, apply filters, and optionally include totals for the full range.
-   */
-  async query(
-    request: components.QueryReportRequest,
-    options?: RequestOptions,
-  ): Promise<components.QueryReportResponse> {
-    return unwrapAsync(reportingQuery(
-      this,
-      request,
-      options,
-    ));
-  }
-}