@orq-ai/node 3.9.0-rc.8 → 3.9.0

package/packages/orq-rc/src/models/operations/evalsragascontextprecision.ts

@@ -0,0 +1,166 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EvalsRagasContextPrecisionRequestBody = {
+  /**
+   * Latest user message
+   */
+  query: string;
+  /**
+   * The generated response from the model
+   */
+  output: string;
+  model: string;
+  /**
+   * The reference used to compare the output
+   */
+  reference?: string | undefined;
+  /**
+   * Knowledge base retrievals
+   */
+  retrievals?: Array<string> | undefined;
+};
+
+/**
+ * Returns the context precision evaluation result
+ */
+export type EvalsRagasContextPrecisionResponseBody = {
+  value: number | null;
+};
+
+/** @internal */
+export const EvalsRagasContextPrecisionRequestBody$inboundSchema: z.ZodType<
+  EvalsRagasContextPrecisionRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  query: z.string(),
+  output: z.string(),
+  model: z.string(),
+  reference: z.string().optional(),
+  retrievals: z.array(z.string()).optional(),
+});
+
+/** @internal */
+export type EvalsRagasContextPrecisionRequestBody$Outbound = {
+  query: string;
+  output: string;
+  model: string;
+  reference?: string | undefined;
+  retrievals?: Array<string> | undefined;
+};
+
+/** @internal */
+export const EvalsRagasContextPrecisionRequestBody$outboundSchema: z.ZodType<
+  EvalsRagasContextPrecisionRequestBody$Outbound,
+  z.ZodTypeDef,
+  EvalsRagasContextPrecisionRequestBody
+> = z.object({
+  query: z.string(),
+  output: z.string(),
+  model: z.string(),
+  reference: z.string().optional(),
+  retrievals: z.array(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EvalsRagasContextPrecisionRequestBody$ {
+  /** @deprecated use `EvalsRagasContextPrecisionRequestBody$inboundSchema` instead. */
+  export const inboundSchema =
+    EvalsRagasContextPrecisionRequestBody$inboundSchema;
+  /** @deprecated use `EvalsRagasContextPrecisionRequestBody$outboundSchema` instead. */
+  export const outboundSchema =
+    EvalsRagasContextPrecisionRequestBody$outboundSchema;
+  /** @deprecated use `EvalsRagasContextPrecisionRequestBody$Outbound` instead. */
+  export type Outbound = EvalsRagasContextPrecisionRequestBody$Outbound;
+}
+
+export function evalsRagasContextPrecisionRequestBodyToJSON(
+  evalsRagasContextPrecisionRequestBody: EvalsRagasContextPrecisionRequestBody,
+): string {
+  return JSON.stringify(
+    EvalsRagasContextPrecisionRequestBody$outboundSchema.parse(
+      evalsRagasContextPrecisionRequestBody,
+    ),
+  );
+}
+
+export function evalsRagasContextPrecisionRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<EvalsRagasContextPrecisionRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EvalsRagasContextPrecisionRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvalsRagasContextPrecisionRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const EvalsRagasContextPrecisionResponseBody$inboundSchema: z.ZodType<
+  EvalsRagasContextPrecisionResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  value: z.nullable(z.number()),
+});
+
+/** @internal */
+export type EvalsRagasContextPrecisionResponseBody$Outbound = {
+  value: number | null;
+};
+
+/** @internal */
+export const EvalsRagasContextPrecisionResponseBody$outboundSchema: z.ZodType<
+  EvalsRagasContextPrecisionResponseBody$Outbound,
+  z.ZodTypeDef,
+  EvalsRagasContextPrecisionResponseBody
+> = z.object({
+  value: z.nullable(z.number()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EvalsRagasContextPrecisionResponseBody$ {
+  /** @deprecated use `EvalsRagasContextPrecisionResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    EvalsRagasContextPrecisionResponseBody$inboundSchema;
+  /** @deprecated use `EvalsRagasContextPrecisionResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    EvalsRagasContextPrecisionResponseBody$outboundSchema;
+  /** @deprecated use `EvalsRagasContextPrecisionResponseBody$Outbound` instead. */
+  export type Outbound = EvalsRagasContextPrecisionResponseBody$Outbound;
+}
+
+export function evalsRagasContextPrecisionResponseBodyToJSON(
+  evalsRagasContextPrecisionResponseBody:
+    EvalsRagasContextPrecisionResponseBody,
+): string {
+  return JSON.stringify(
+    EvalsRagasContextPrecisionResponseBody$outboundSchema.parse(
+      evalsRagasContextPrecisionResponseBody,
+    ),
+  );
+}
+
+export function evalsRagasContextPrecisionResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<EvalsRagasContextPrecisionResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EvalsRagasContextPrecisionResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvalsRagasContextPrecisionResponseBody' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/operations/evalsragascontextrecall.ts

@@ -0,0 +1,164 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EvalsRagasContextRecallRequestBody = {
+  /**
+   * Latest user message
+   */
+  query?: string | undefined;
+  /**
+   * The generated response from the model
+   */
+  output?: string | undefined;
+  model: string;
+  /**
+   * The ground truth answer to evaluate context recall against
+   */
+  reference: string;
+  /**
+   * Knowledge base retrievals
+   */
+  retrievals?: Array<string> | undefined;
+};
+
+/**
+ * Returns the context recall evaluation result
+ */
+export type EvalsRagasContextRecallResponseBody = {
+  value: number | null;
+};
+
+/** @internal */
+export const EvalsRagasContextRecallRequestBody$inboundSchema: z.ZodType<
+  EvalsRagasContextRecallRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  query: z.string().optional(),
+  output: z.string().optional(),
+  model: z.string(),
+  reference: z.string(),
+  retrievals: z.array(z.string()).optional(),
+});
+
+/** @internal */
+export type EvalsRagasContextRecallRequestBody$Outbound = {
+  query?: string | undefined;
+  output?: string | undefined;
+  model: string;
+  reference: string;
+  retrievals?: Array<string> | undefined;
+};
+
+/** @internal */
+export const EvalsRagasContextRecallRequestBody$outboundSchema: z.ZodType<
+  EvalsRagasContextRecallRequestBody$Outbound,
+  z.ZodTypeDef,
+  EvalsRagasContextRecallRequestBody
+> = z.object({
+  query: z.string().optional(),
+  output: z.string().optional(),
+  model: z.string(),
+  reference: z.string(),
+  retrievals: z.array(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EvalsRagasContextRecallRequestBody$ {
+  /** @deprecated use `EvalsRagasContextRecallRequestBody$inboundSchema` instead. */
+  export const inboundSchema = EvalsRagasContextRecallRequestBody$inboundSchema;
+  /** @deprecated use `EvalsRagasContextRecallRequestBody$outboundSchema` instead. */
+  export const outboundSchema =
+    EvalsRagasContextRecallRequestBody$outboundSchema;
+  /** @deprecated use `EvalsRagasContextRecallRequestBody$Outbound` instead. */
+  export type Outbound = EvalsRagasContextRecallRequestBody$Outbound;
+}
+
+export function evalsRagasContextRecallRequestBodyToJSON(
+  evalsRagasContextRecallRequestBody: EvalsRagasContextRecallRequestBody,
+): string {
+  return JSON.stringify(
+    EvalsRagasContextRecallRequestBody$outboundSchema.parse(
+      evalsRagasContextRecallRequestBody,
+    ),
+  );
+}
+
+export function evalsRagasContextRecallRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<EvalsRagasContextRecallRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EvalsRagasContextRecallRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvalsRagasContextRecallRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const EvalsRagasContextRecallResponseBody$inboundSchema: z.ZodType<
+  EvalsRagasContextRecallResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  value: z.nullable(z.number()),
+});
+
+/** @internal */
+export type EvalsRagasContextRecallResponseBody$Outbound = {
+  value: number | null;
+};
+
+/** @internal */
+export const EvalsRagasContextRecallResponseBody$outboundSchema: z.ZodType<
+  EvalsRagasContextRecallResponseBody$Outbound,
+  z.ZodTypeDef,
+  EvalsRagasContextRecallResponseBody
+> = z.object({
+  value: z.nullable(z.number()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EvalsRagasContextRecallResponseBody$ {
+  /** @deprecated use `EvalsRagasContextRecallResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    EvalsRagasContextRecallResponseBody$inboundSchema;
+  /** @deprecated use `EvalsRagasContextRecallResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    EvalsRagasContextRecallResponseBody$outboundSchema;
+  /** @deprecated use `EvalsRagasContextRecallResponseBody$Outbound` instead. */
+  export type Outbound = EvalsRagasContextRecallResponseBody$Outbound;
+}
+
+export function evalsRagasContextRecallResponseBodyToJSON(
+  evalsRagasContextRecallResponseBody: EvalsRagasContextRecallResponseBody,
+): string {
+  return JSON.stringify(
+    EvalsRagasContextRecallResponseBody$outboundSchema.parse(
+      evalsRagasContextRecallResponseBody,
+    ),
+  );
+}
+
+export function evalsRagasContextRecallResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<EvalsRagasContextRecallResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EvalsRagasContextRecallResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvalsRagasContextRecallResponseBody' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/operations/evalsragascorrectness.ts

@@ -0,0 +1,153 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EvalsRagasCorrectnessRequestBody = {
+  /**
+   * Latest user message
+   */
+  query: string;
+  /**
+   * The generated response from the model
+   */
+  output: string;
+  model: string;
+  /**
+   * The reference used to compare the output
+   */
+  reference?: string | undefined;
+};
+
+/**
+ * Returns the correctness evaluation result
+ */
+export type EvalsRagasCorrectnessResponseBody = {
+  value: number | null;
+};
+
+/** @internal */
+export const EvalsRagasCorrectnessRequestBody$inboundSchema: z.ZodType<
+  EvalsRagasCorrectnessRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  query: z.string(),
+  output: z.string(),
+  model: z.string(),
+  reference: z.string().optional(),
+});
+
+/** @internal */
+export type EvalsRagasCorrectnessRequestBody$Outbound = {
+  query: string;
+  output: string;
+  model: string;
+  reference?: string | undefined;
+};
+
+/** @internal */
+export const EvalsRagasCorrectnessRequestBody$outboundSchema: z.ZodType<
+  EvalsRagasCorrectnessRequestBody$Outbound,
+  z.ZodTypeDef,
+  EvalsRagasCorrectnessRequestBody
+> = z.object({
+  query: z.string(),
+  output: z.string(),
+  model: z.string(),
+  reference: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EvalsRagasCorrectnessRequestBody$ {
+  /** @deprecated use `EvalsRagasCorrectnessRequestBody$inboundSchema` instead. */
+  export const inboundSchema = EvalsRagasCorrectnessRequestBody$inboundSchema;
+  /** @deprecated use `EvalsRagasCorrectnessRequestBody$outboundSchema` instead. */
+  export const outboundSchema = EvalsRagasCorrectnessRequestBody$outboundSchema;
+  /** @deprecated use `EvalsRagasCorrectnessRequestBody$Outbound` instead. */
+  export type Outbound = EvalsRagasCorrectnessRequestBody$Outbound;
+}
+
+export function evalsRagasCorrectnessRequestBodyToJSON(
+  evalsRagasCorrectnessRequestBody: EvalsRagasCorrectnessRequestBody,
+): string {
+  return JSON.stringify(
+    EvalsRagasCorrectnessRequestBody$outboundSchema.parse(
+      evalsRagasCorrectnessRequestBody,
+    ),
+  );
+}
+
+export function evalsRagasCorrectnessRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<EvalsRagasCorrectnessRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvalsRagasCorrectnessRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvalsRagasCorrectnessRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const EvalsRagasCorrectnessResponseBody$inboundSchema: z.ZodType<
+  EvalsRagasCorrectnessResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  value: z.nullable(z.number()),
+});
+
+/** @internal */
+export type EvalsRagasCorrectnessResponseBody$Outbound = {
+  value: number | null;
+};
+
+/** @internal */
+export const EvalsRagasCorrectnessResponseBody$outboundSchema: z.ZodType<
+  EvalsRagasCorrectnessResponseBody$Outbound,
+  z.ZodTypeDef,
+  EvalsRagasCorrectnessResponseBody
+> = z.object({
+  value: z.nullable(z.number()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EvalsRagasCorrectnessResponseBody$ {
+  /** @deprecated use `EvalsRagasCorrectnessResponseBody$inboundSchema` instead. */
+  export const inboundSchema = EvalsRagasCorrectnessResponseBody$inboundSchema;
+  /** @deprecated use `EvalsRagasCorrectnessResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    EvalsRagasCorrectnessResponseBody$outboundSchema;
+  /** @deprecated use `EvalsRagasCorrectnessResponseBody$Outbound` instead. */
+  export type Outbound = EvalsRagasCorrectnessResponseBody$Outbound;
+}
+
+export function evalsRagasCorrectnessResponseBodyToJSON(
+  evalsRagasCorrectnessResponseBody: EvalsRagasCorrectnessResponseBody,
+): string {
+  return JSON.stringify(
+    EvalsRagasCorrectnessResponseBody$outboundSchema.parse(
+      evalsRagasCorrectnessResponseBody,
+    ),
+  );
+}
+
+export function evalsRagasCorrectnessResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<EvalsRagasCorrectnessResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvalsRagasCorrectnessResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvalsRagasCorrectnessResponseBody' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/operations/evalsragasfaithfulness.ts

@@ -0,0 +1,155 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EvalsRagasFaithfulnessRequestBody = {
+  /**
+   * Latest user message
+   */
+  query: string;
+  /**
+   * The generated response from the model
+   */
+  output: string;
+  model: string;
+  /**
+   * Knowledge base retrievals
+   */
+  retrievals?: Array<string> | undefined;
+};
+
+/**
+ * Returns the faithfulness evaluation result
+ */
+export type EvalsRagasFaithfulnessResponseBody = {
+  value: number | null;
+};
+
+/** @internal */
+export const EvalsRagasFaithfulnessRequestBody$inboundSchema: z.ZodType<
+  EvalsRagasFaithfulnessRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  query: z.string(),
+  output: z.string(),
+  model: z.string(),
+  retrievals: z.array(z.string()).optional(),
+});
+
+/** @internal */
+export type EvalsRagasFaithfulnessRequestBody$Outbound = {
+  query: string;
+  output: string;
+  model: string;
+  retrievals?: Array<string> | undefined;
+};
+
+/** @internal */
+export const EvalsRagasFaithfulnessRequestBody$outboundSchema: z.ZodType<
+  EvalsRagasFaithfulnessRequestBody$Outbound,
+  z.ZodTypeDef,
+  EvalsRagasFaithfulnessRequestBody
+> = z.object({
+  query: z.string(),
+  output: z.string(),
+  model: z.string(),
+  retrievals: z.array(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EvalsRagasFaithfulnessRequestBody$ {
+  /** @deprecated use `EvalsRagasFaithfulnessRequestBody$inboundSchema` instead. */
+  export const inboundSchema = EvalsRagasFaithfulnessRequestBody$inboundSchema;
+  /** @deprecated use `EvalsRagasFaithfulnessRequestBody$outboundSchema` instead. */
+  export const outboundSchema =
+    EvalsRagasFaithfulnessRequestBody$outboundSchema;
+  /** @deprecated use `EvalsRagasFaithfulnessRequestBody$Outbound` instead. */
+  export type Outbound = EvalsRagasFaithfulnessRequestBody$Outbound;
+}
+
+export function evalsRagasFaithfulnessRequestBodyToJSON(
+  evalsRagasFaithfulnessRequestBody: EvalsRagasFaithfulnessRequestBody,
+): string {
+  return JSON.stringify(
+    EvalsRagasFaithfulnessRequestBody$outboundSchema.parse(
+      evalsRagasFaithfulnessRequestBody,
+    ),
+  );
+}
+
+export function evalsRagasFaithfulnessRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<EvalsRagasFaithfulnessRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvalsRagasFaithfulnessRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvalsRagasFaithfulnessRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const EvalsRagasFaithfulnessResponseBody$inboundSchema: z.ZodType<
+  EvalsRagasFaithfulnessResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  value: z.nullable(z.number()),
+});
+
+/** @internal */
+export type EvalsRagasFaithfulnessResponseBody$Outbound = {
+  value: number | null;
+};
+
+/** @internal */
+export const EvalsRagasFaithfulnessResponseBody$outboundSchema: z.ZodType<
+  EvalsRagasFaithfulnessResponseBody$Outbound,
+  z.ZodTypeDef,
+  EvalsRagasFaithfulnessResponseBody
+> = z.object({
+  value: z.nullable(z.number()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EvalsRagasFaithfulnessResponseBody$ {
+  /** @deprecated use `EvalsRagasFaithfulnessResponseBody$inboundSchema` instead. */
+  export const inboundSchema = EvalsRagasFaithfulnessResponseBody$inboundSchema;
+  /** @deprecated use `EvalsRagasFaithfulnessResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    EvalsRagasFaithfulnessResponseBody$outboundSchema;
+  /** @deprecated use `EvalsRagasFaithfulnessResponseBody$Outbound` instead. */
+  export type Outbound = EvalsRagasFaithfulnessResponseBody$Outbound;
+}
+
+export function evalsRagasFaithfulnessResponseBodyToJSON(
+  evalsRagasFaithfulnessResponseBody: EvalsRagasFaithfulnessResponseBody,
+): string {
+  return JSON.stringify(
+    EvalsRagasFaithfulnessResponseBody$outboundSchema.parse(
+      evalsRagasFaithfulnessResponseBody,
+    ),
+  );
+}
+
+export function evalsRagasFaithfulnessResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<EvalsRagasFaithfulnessResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EvalsRagasFaithfulnessResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvalsRagasFaithfulnessResponseBody' from JSON`,
+  );
+}