@orq-ai/node 4.6.0-rc.8 → 4.6.3

package/src/models/operations/getv2humanevalsid.ts

@@ -0,0 +1,707 @@
+/*
+ * 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";
+
+export type GetV2HumanEvalsIdRequest = {
+  /**
+   * The id of the resource
+   */
+  id: string;
+};
+
+export type GetV2HumanEvalsIdResponseBody6 = {
+  type: "text";
+  /**
+   * The id of the resource
+   */
+  id: string;
+  /**
+   * Unique key for the feedback. It is autogenerated by the system always
+   */
+  key: string;
+  /**
+   * Display name of the feedback item.
+   */
+  displayName: string;
+  /**
+   * Detailed description of the feedback.
+   */
+  description: string;
+  /**
+   * The id of the resource
+   */
+  domainId?: string | undefined;
+  /**
+   * The id of the user who created the resource
+   */
+  createdById?: string | undefined;
+  /**
+   * The id of the user who last updated the resource
+   */
+  updatedById?: string | undefined;
+  /**
+   * The id of the resource
+   */
+  workspaceId: string;
+  /**
+   * Optional project ID to scope this human review to a specific project
+   */
+  projectId?: string | undefined;
+};
+
+export const GetV2HumanEvalsIdResponseBodyResponseSentiment = {
+  Neutral: "neutral",
+  Positive: "positive",
+  Negative: "negative",
+} as const;
+export type GetV2HumanEvalsIdResponseBodyResponseSentiment = ClosedEnum<
+  typeof GetV2HumanEvalsIdResponseBodyResponseSentiment
+>;
+
+/**
+ * Model representing specific values and attributes of feedback.
+ */
+export type GetV2HumanEvalsIdResponseBodyResponseOptions = {
+  /**
+   * The id of the resource
+   */
+  id: string;
+  /**
+   * The value or content of the feedback.
+   */
+  value: string;
+  sentiment: GetV2HumanEvalsIdResponseBodyResponseSentiment;
+  /**
+   * Description of the feedback option.
+   */
+  description: string;
+  icon: string;
+};
+
+export type GetV2HumanEvalsIdResponseBody5 = {
+  type: "single_select";
+  options: Array<GetV2HumanEvalsIdResponseBodyResponseOptions>;
+  /**
+   * The id of the resource
+   */
+  id: string;
+  /**
+   * Unique key for the feedback. It is autogenerated by the system always
+   */
+  key: string;
+  /**
+   * Display name of the feedback item.
+   */
+  displayName: string;
+  /**
+   * Detailed description of the feedback.
+   */
+  description: string;
+  /**
+   * The id of the resource
+   */
+  domainId?: string | undefined;
+  /**
+   * The id of the user who created the resource
+   */
+  createdById?: string | undefined;
+  /**
+   * The id of the user who last updated the resource
+   */
+  updatedById?: string | undefined;
+  /**
+   * The id of the resource
+   */
+  workspaceId: string;
+  /**
+   * Optional project ID to scope this human review to a specific project
+   */
+  projectId?: string | undefined;
+};
+
+export const GetV2HumanEvalsIdResponseBodySentiment = {
+  Neutral: "neutral",
+  Positive: "positive",
+  Negative: "negative",
+} as const;
+export type GetV2HumanEvalsIdResponseBodySentiment = ClosedEnum<
+  typeof GetV2HumanEvalsIdResponseBodySentiment
+>;
+
+/**
+ * Model representing specific values and attributes of feedback.
+ */
+export type GetV2HumanEvalsIdResponseBodyOptions = {
+  /**
+   * The id of the resource
+   */
+  id: string;
+  /**
+   * The value or content of the feedback.
+   */
+  value: string;
+  sentiment: GetV2HumanEvalsIdResponseBodySentiment;
+  /**
+   * Description of the feedback option.
+   */
+  description: string;
+  icon: string;
+};
+
+export type GetV2HumanEvalsIdResponseBody4 = {
+  type: "multi_select";
+  options: Array<GetV2HumanEvalsIdResponseBodyOptions>;
+  /**
+   * The id of the resource
+   */
+  id: string;
+  /**
+   * Unique key for the feedback. It is autogenerated by the system always
+   */
+  key: string;
+  /**
+   * Display name of the feedback item.
+   */
+  displayName: string;
+  /**
+   * Detailed description of the feedback.
+   */
+  description: string;
+  /**
+   * The id of the resource
+   */
+  domainId?: string | undefined;
+  /**
+   * The id of the user who created the resource
+   */
+  createdById?: string | undefined;
+  /**
+   * The id of the user who last updated the resource
+   */
+  updatedById?: string | undefined;
+  /**
+   * The id of the resource
+   */
+  workspaceId: string;
+  /**
+   * Optional project ID to scope this human review to a specific project
+   */
+  projectId?: string | undefined;
+};
+
+/**
+ * The configuration for a range human review
+ */
+export type GetV2HumanEvalsIdResponseBodyConfig = {
+  /**
+   * The minimum value for the range
+   */
+  min: number;
+  /**
+   * The maximum value for the range
+   */
+  max: number;
+};
+
+export type GetV2HumanEvalsIdResponseBody3 = {
+  type: "range";
+  /**
+   * The configuration for a range human review
+   */
+  config: GetV2HumanEvalsIdResponseBodyConfig;
+  /**
+   * The id of the resource
+   */
+  id: string;
+  /**
+   * Unique key for the feedback. It is autogenerated by the system always
+   */
+  key: string;
+  /**
+   * Display name of the feedback item.
+   */
+  displayName: string;
+  /**
+   * Detailed description of the feedback.
+   */
+  description: string;
+  /**
+   * The id of the resource
+   */
+  domainId?: string | undefined;
+  /**
+   * The id of the user who created the resource
+   */
+  createdById?: string | undefined;
+  /**
+   * The id of the user who last updated the resource
+   */
+  updatedById?: string | undefined;
+  /**
+   * The id of the resource
+   */
+  workspaceId: string;
+  /**
+   * Optional project ID to scope this human review to a specific project
+   */
+  projectId?: string | undefined;
+};
+
+export type GetV2HumanEvalsIdResponseBody2 = {
+  type: "correction";
+  /**
+   * The id of the resource
+   */
+  id: string;
+  /**
+   * Unique key for the feedback. It is autogenerated by the system always
+   */
+  key: string;
+  /**
+   * Display name of the feedback item.
+   */
+  displayName: string;
+  /**
+   * Detailed description of the feedback.
+   */
+  description: string;
+  /**
+   * The id of the resource
+   */
+  domainId?: string | undefined;
+  /**
+   * The id of the user who created the resource
+   */
+  createdById?: string | undefined;
+  /**
+   * The id of the user who last updated the resource
+   */
+  updatedById?: string | undefined;
+  /**
+   * The id of the resource
+   */
+  workspaceId: string;
+  /**
+   * Optional project ID to scope this human review to a specific project
+   */
+  projectId?: string | undefined;
+};
+
+export type GetV2HumanEvalsIdResponseBody1 = {
+  type: "boolean";
+  /**
+   * The id of the resource
+   */
+  id: string;
+  /**
+   * Unique key for the feedback. It is autogenerated by the system always
+   */
+  key: string;
+  /**
+   * Display name of the feedback item.
+   */
+  displayName: string;
+  /**
+   * Detailed description of the feedback.
+   */
+  description: string;
+  /**
+   * The id of the resource
+   */
+  domainId?: string | undefined;
+  /**
+   * The id of the user who created the resource
+   */
+  createdById?: string | undefined;
+  /**
+   * The id of the user who last updated the resource
+   */
+  updatedById?: string | undefined;
+  /**
+   * The id of the resource
+   */
+  workspaceId: string;
+  /**
+   * Optional project ID to scope this human review to a specific project
+   */
+  projectId?: string | undefined;
+};
+
+/**
+ * Returns a single human review
+ */
+export type GetV2HumanEvalsIdResponseBody =
+  | GetV2HumanEvalsIdResponseBody1
+  | GetV2HumanEvalsIdResponseBody2
+  | GetV2HumanEvalsIdResponseBody3
+  | GetV2HumanEvalsIdResponseBody4
+  | GetV2HumanEvalsIdResponseBody5
+  | GetV2HumanEvalsIdResponseBody6;
+
+/** @internal */
+export type GetV2HumanEvalsIdRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetV2HumanEvalsIdRequest$outboundSchema: z.ZodType<
+  GetV2HumanEvalsIdRequest$Outbound,
+  z.ZodTypeDef,
+  GetV2HumanEvalsIdRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getV2HumanEvalsIdRequestToJSON(
+  getV2HumanEvalsIdRequest: GetV2HumanEvalsIdRequest,
+): string {
+  return JSON.stringify(
+    GetV2HumanEvalsIdRequest$outboundSchema.parse(getV2HumanEvalsIdRequest),
+  );
+}
+
+/** @internal */
+export const GetV2HumanEvalsIdResponseBody6$inboundSchema: z.ZodType<
+  GetV2HumanEvalsIdResponseBody6,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("text"),
+  id: z.string(),
+  key: z.string().default("orq_01kmjy31ba"),
+  display_name: z.string(),
+  description: z.string(),
+  domain_id: z.string().optional(),
+  created_by_id: z.string().optional(),
+  updated_by_id: z.string().optional(),
+  workspace_id: z.string(),
+  project_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "domain_id": "domainId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "workspace_id": "workspaceId",
+    "project_id": "projectId",
+  });
+});
+
+export function getV2HumanEvalsIdResponseBody6FromJSON(
+  jsonString: string,
+): SafeParseResult<GetV2HumanEvalsIdResponseBody6, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV2HumanEvalsIdResponseBody6$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV2HumanEvalsIdResponseBody6' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV2HumanEvalsIdResponseBodyResponseSentiment$inboundSchema:
+  z.ZodNativeEnum<typeof GetV2HumanEvalsIdResponseBodyResponseSentiment> = z
+    .nativeEnum(GetV2HumanEvalsIdResponseBodyResponseSentiment);
+
+/** @internal */
+export const GetV2HumanEvalsIdResponseBodyResponseOptions$inboundSchema:
+  z.ZodType<
+    GetV2HumanEvalsIdResponseBodyResponseOptions,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    id: z.string(),
+    value: z.string(),
+    sentiment: GetV2HumanEvalsIdResponseBodyResponseSentiment$inboundSchema,
+    description: z.string(),
+    icon: z.string(),
+  });
+
+export function getV2HumanEvalsIdResponseBodyResponseOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetV2HumanEvalsIdResponseBodyResponseOptions,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV2HumanEvalsIdResponseBodyResponseOptions$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetV2HumanEvalsIdResponseBodyResponseOptions' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV2HumanEvalsIdResponseBody5$inboundSchema: z.ZodType<
+  GetV2HumanEvalsIdResponseBody5,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("single_select"),
+  options: z.array(
+    z.lazy(() => GetV2HumanEvalsIdResponseBodyResponseOptions$inboundSchema),
+  ),
+  id: z.string(),
+  key: z.string().default("orq_01kmjy31b8"),
+  display_name: z.string(),
+  description: z.string(),
+  domain_id: z.string().optional(),
+  created_by_id: z.string().optional(),
+  updated_by_id: z.string().optional(),
+  workspace_id: z.string(),
+  project_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "domain_id": "domainId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "workspace_id": "workspaceId",
+    "project_id": "projectId",
+  });
+});
+
+export function getV2HumanEvalsIdResponseBody5FromJSON(
+  jsonString: string,
+): SafeParseResult<GetV2HumanEvalsIdResponseBody5, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV2HumanEvalsIdResponseBody5$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV2HumanEvalsIdResponseBody5' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV2HumanEvalsIdResponseBodySentiment$inboundSchema:
+  z.ZodNativeEnum<typeof GetV2HumanEvalsIdResponseBodySentiment> = z.nativeEnum(
+    GetV2HumanEvalsIdResponseBodySentiment,
+  );
+
+/** @internal */
+export const GetV2HumanEvalsIdResponseBodyOptions$inboundSchema: z.ZodType<
+  GetV2HumanEvalsIdResponseBodyOptions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  value: z.string(),
+  sentiment: GetV2HumanEvalsIdResponseBodySentiment$inboundSchema,
+  description: z.string(),
+  icon: z.string(),
+});
+
+export function getV2HumanEvalsIdResponseBodyOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV2HumanEvalsIdResponseBodyOptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV2HumanEvalsIdResponseBodyOptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV2HumanEvalsIdResponseBodyOptions' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV2HumanEvalsIdResponseBody4$inboundSchema: z.ZodType<
+  GetV2HumanEvalsIdResponseBody4,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("multi_select"),
+  options: z.array(
+    z.lazy(() => GetV2HumanEvalsIdResponseBodyOptions$inboundSchema),
+  ),
+  id: z.string(),
+  key: z.string().default("orq_01kmjy31b6"),
+  display_name: z.string(),
+  description: z.string(),
+  domain_id: z.string().optional(),
+  created_by_id: z.string().optional(),
+  updated_by_id: z.string().optional(),
+  workspace_id: z.string(),
+  project_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "domain_id": "domainId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "workspace_id": "workspaceId",
+    "project_id": "projectId",
+  });
+});
+
+export function getV2HumanEvalsIdResponseBody4FromJSON(
+  jsonString: string,
+): SafeParseResult<GetV2HumanEvalsIdResponseBody4, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV2HumanEvalsIdResponseBody4$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV2HumanEvalsIdResponseBody4' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV2HumanEvalsIdResponseBodyConfig$inboundSchema: z.ZodType<
+  GetV2HumanEvalsIdResponseBodyConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  min: z.number().int(),
+  max: z.number().int(),
+});
+
+export function getV2HumanEvalsIdResponseBodyConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV2HumanEvalsIdResponseBodyConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV2HumanEvalsIdResponseBodyConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV2HumanEvalsIdResponseBodyConfig' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV2HumanEvalsIdResponseBody3$inboundSchema: z.ZodType<
+  GetV2HumanEvalsIdResponseBody3,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("range"),
+  config: z.lazy(() => GetV2HumanEvalsIdResponseBodyConfig$inboundSchema),
+  id: z.string(),
+  key: z.string().default("orq_01kmjy31b4"),
+  display_name: z.string(),
+  description: z.string(),
+  domain_id: z.string().optional(),
+  created_by_id: z.string().optional(),
+  updated_by_id: z.string().optional(),
+  workspace_id: z.string(),
+  project_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "domain_id": "domainId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "workspace_id": "workspaceId",
+    "project_id": "projectId",
+  });
+});
+
+export function getV2HumanEvalsIdResponseBody3FromJSON(
+  jsonString: string,
+): SafeParseResult<GetV2HumanEvalsIdResponseBody3, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV2HumanEvalsIdResponseBody3$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV2HumanEvalsIdResponseBody3' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV2HumanEvalsIdResponseBody2$inboundSchema: z.ZodType<
+  GetV2HumanEvalsIdResponseBody2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("correction"),
+  id: z.string(),
+  key: z.string().default("orq_01kmjy31b2"),
+  display_name: z.string(),
+  description: z.string(),
+  domain_id: z.string().optional(),
+  created_by_id: z.string().optional(),
+  updated_by_id: z.string().optional(),
+  workspace_id: z.string(),
+  project_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "domain_id": "domainId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "workspace_id": "workspaceId",
+    "project_id": "projectId",
+  });
+});
+
+export function getV2HumanEvalsIdResponseBody2FromJSON(
+  jsonString: string,
+): SafeParseResult<GetV2HumanEvalsIdResponseBody2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV2HumanEvalsIdResponseBody2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV2HumanEvalsIdResponseBody2' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV2HumanEvalsIdResponseBody1$inboundSchema: z.ZodType<
+  GetV2HumanEvalsIdResponseBody1,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("boolean"),
+  id: z.string(),
+  key: z.string().default("orq_01kmjy31b1"),
+  display_name: z.string(),
+  description: z.string(),
+  domain_id: z.string().optional(),
+  created_by_id: z.string().optional(),
+  updated_by_id: z.string().optional(),
+  workspace_id: z.string(),
+  project_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "domain_id": "domainId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "workspace_id": "workspaceId",
+    "project_id": "projectId",
+  });
+});
+
+export function getV2HumanEvalsIdResponseBody1FromJSON(
+  jsonString: string,
+): SafeParseResult<GetV2HumanEvalsIdResponseBody1, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV2HumanEvalsIdResponseBody1$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV2HumanEvalsIdResponseBody1' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV2HumanEvalsIdResponseBody$inboundSchema: z.ZodType<
+  GetV2HumanEvalsIdResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => GetV2HumanEvalsIdResponseBody1$inboundSchema),
+  z.lazy(() => GetV2HumanEvalsIdResponseBody2$inboundSchema),
+  z.lazy(() => GetV2HumanEvalsIdResponseBody3$inboundSchema),
+  z.lazy(() => GetV2HumanEvalsIdResponseBody4$inboundSchema),
+  z.lazy(() => GetV2HumanEvalsIdResponseBody5$inboundSchema),
+  z.lazy(() => GetV2HumanEvalsIdResponseBody6$inboundSchema),
+]);
+
+export function getV2HumanEvalsIdResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV2HumanEvalsIdResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetV2HumanEvalsIdResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV2HumanEvalsIdResponseBody' from JSON`,
+  );
+}