@orq-ai/node 4.10.0-rc.88 → 4.10.0

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

@@ -0,0 +1,223 @@
+/*
+ * 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";
+
+/**
+ * File in URI format. Check in the model's documentation for the supported mime types for the URI format
+ */
+export type FileInURIFormat = {
+  /**
+   * URL for the File content
+   */
+  uri: string;
+  /**
+   * Optional mimeType for the file
+   */
+  mimeType?: string | undefined;
+  /**
+   * Optional name for the file
+   */
+  name?: string | undefined;
+};
+
+/**
+ * Binary in base64 format. Check in the model's documentation for the supported mime types for the binary format.
+ */
+export type BinaryFormat = {
+  /**
+   * base64 encoded content of the file
+   */
+  bytes: string;
+  /**
+   * Optional mimeType for the file
+   */
+  mimeType?: string | undefined;
+  /**
+   * Optional name for the file
+   */
+  name?: string | undefined;
+};
+
+export type FilePartFile = BinaryFormat | FileInURIFormat;
+
+/**
+ * File attachment part. Use this to send files (images, documents, etc.) to the agent for processing.
+ */
+export type FilePart = {
+  kind: "file";
+  file: BinaryFormat | FileInURIFormat;
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const FileInURIFormat$inboundSchema: z.ZodType<
+  FileInURIFormat,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  uri: z.string(),
+  mimeType: z.string().optional(),
+  name: z.string().optional(),
+});
+/** @internal */
+export type FileInURIFormat$Outbound = {
+  uri: string;
+  mimeType?: string | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const FileInURIFormat$outboundSchema: z.ZodType<
+  FileInURIFormat$Outbound,
+  z.ZodTypeDef,
+  FileInURIFormat
+> = z.object({
+  uri: z.string(),
+  mimeType: z.string().optional(),
+  name: z.string().optional(),
+});
+
+export function fileInURIFormatToJSON(
+  fileInURIFormat: FileInURIFormat,
+): string {
+  return JSON.stringify(FileInURIFormat$outboundSchema.parse(fileInURIFormat));
+}
+export function fileInURIFormatFromJSON(
+  jsonString: string,
+): SafeParseResult<FileInURIFormat, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FileInURIFormat$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FileInURIFormat' from JSON`,
+  );
+}
+
+/** @internal */
+export const BinaryFormat$inboundSchema: z.ZodType<
+  BinaryFormat,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bytes: z.string(),
+  mimeType: z.string().optional(),
+  name: z.string().optional(),
+});
+/** @internal */
+export type BinaryFormat$Outbound = {
+  bytes: string;
+  mimeType?: string | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const BinaryFormat$outboundSchema: z.ZodType<
+  BinaryFormat$Outbound,
+  z.ZodTypeDef,
+  BinaryFormat
+> = z.object({
+  bytes: z.string(),
+  mimeType: z.string().optional(),
+  name: z.string().optional(),
+});
+
+export function binaryFormatToJSON(binaryFormat: BinaryFormat): string {
+  return JSON.stringify(BinaryFormat$outboundSchema.parse(binaryFormat));
+}
+export function binaryFormatFromJSON(
+  jsonString: string,
+): SafeParseResult<BinaryFormat, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BinaryFormat$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BinaryFormat' from JSON`,
+  );
+}
+
+/** @internal */
+export const FilePartFile$inboundSchema: z.ZodType<
+  FilePartFile,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => BinaryFormat$inboundSchema),
+  z.lazy(() => FileInURIFormat$inboundSchema),
+]);
+/** @internal */
+export type FilePartFile$Outbound =
+  | BinaryFormat$Outbound
+  | FileInURIFormat$Outbound;
+
+/** @internal */
+export const FilePartFile$outboundSchema: z.ZodType<
+  FilePartFile$Outbound,
+  z.ZodTypeDef,
+  FilePartFile
+> = z.union([
+  z.lazy(() => BinaryFormat$outboundSchema),
+  z.lazy(() => FileInURIFormat$outboundSchema),
+]);
+
+export function filePartFileToJSON(filePartFile: FilePartFile): string {
+  return JSON.stringify(FilePartFile$outboundSchema.parse(filePartFile));
+}
+export function filePartFileFromJSON(
+  jsonString: string,
+): SafeParseResult<FilePartFile, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FilePartFile$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FilePartFile' from JSON`,
+  );
+}
+
+/** @internal */
+export const FilePart$inboundSchema: z.ZodType<
+  FilePart,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  kind: z.literal("file"),
+  file: z.union([
+    z.lazy(() => BinaryFormat$inboundSchema),
+    z.lazy(() => FileInURIFormat$inboundSchema),
+  ]),
+  metadata: z.record(z.any()).optional(),
+});
+/** @internal */
+export type FilePart$Outbound = {
+  kind: "file";
+  file: BinaryFormat$Outbound | FileInURIFormat$Outbound;
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const FilePart$outboundSchema: z.ZodType<
+  FilePart$Outbound,
+  z.ZodTypeDef,
+  FilePart
+> = z.object({
+  kind: z.literal("file"),
+  file: z.union([
+    z.lazy(() => BinaryFormat$outboundSchema),
+    z.lazy(() => FileInURIFormat$outboundSchema),
+  ]),
+  metadata: z.record(z.any()).optional(),
+});
+
+export function filePartToJSON(filePart: FilePart): string {
+  return JSON.stringify(FilePart$outboundSchema.parse(filePart));
+}
+export function filePartFromJSON(
+  jsonString: string,
+): SafeParseResult<FilePart, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FilePart$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FilePart' from JSON`,
+  );
+}

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