@orq-ai/node 4.6.0-rc.8 → 4.7.0-rc.15

package/src/models/operations/getv2humanevals.ts

@@ -0,0 +1,696 @@
+/*
+ * 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 GetV2HumanEvalsRequest = {
+  /**
+   * Optional project ID to filter human reviews by project
+   */
+  projectId?: string | undefined;
+};
+
+export type ResponseBody6 = {
+  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 ResponseBodySentiment = {
+  Neutral: "neutral",
+  Positive: "positive",
+  Negative: "negative",
+} as const;
+export type ResponseBodySentiment = ClosedEnum<typeof ResponseBodySentiment>;
+
+/**
+ * Model representing specific values and attributes of feedback.
+ */
+export type ResponseBodyOptions = {
+  /**
+   * The id of the resource
+   */
+  id: string;
+  /**
+   * The value or content of the feedback.
+   */
+  value: string;
+  sentiment: ResponseBodySentiment;
+  /**
+   * Description of the feedback option.
+   */
+  description: string;
+  icon: string;
+};
+
+export type ResponseBody5 = {
+  type: "single_select";
+  options: Array<ResponseBodyOptions>;
+  /**
+   * 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 GetV2HumanEvalsResponseBodySentiment = {
+  Neutral: "neutral",
+  Positive: "positive",
+  Negative: "negative",
+} as const;
+export type GetV2HumanEvalsResponseBodySentiment = ClosedEnum<
+  typeof GetV2HumanEvalsResponseBodySentiment
+>;
+
+/**
+ * Model representing specific values and attributes of feedback.
+ */
+export type GetV2HumanEvalsResponseBodyOptions = {
+  /**
+   * The id of the resource
+   */
+  id: string;
+  /**
+   * The value or content of the feedback.
+   */
+  value: string;
+  sentiment: GetV2HumanEvalsResponseBodySentiment;
+  /**
+   * Description of the feedback option.
+   */
+  description: string;
+  icon: string;
+};
+
+export type ResponseBody4 = {
+  type: "multi_select";
+  options: Array<GetV2HumanEvalsResponseBodyOptions>;
+  /**
+   * 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 ResponseBodyConfig = {
+  /**
+   * The minimum value for the range
+   */
+  min: number;
+  /**
+   * The maximum value for the range
+   */
+  max: number;
+};
+
+export type ResponseBody3 = {
+  type: "range";
+  /**
+   * The configuration for a range human review
+   */
+  config: ResponseBodyConfig;
+  /**
+   * 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 ResponseBody2 = {
+  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 ResponseBody1 = {
+  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;
+};
+
+export type ResponseBody =
+  | ResponseBody1
+  | ResponseBody2
+  | ResponseBody3
+  | ResponseBody4
+  | ResponseBody5
+  | ResponseBody6;
+
+/** @internal */
+export type GetV2HumanEvalsRequest$Outbound = {
+  project_id?: string | undefined;
+};
+
+/** @internal */
+export const GetV2HumanEvalsRequest$outboundSchema: z.ZodType<
+  GetV2HumanEvalsRequest$Outbound,
+  z.ZodTypeDef,
+  GetV2HumanEvalsRequest
+> = z.object({
+  projectId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    projectId: "project_id",
+  });
+});
+
+export function getV2HumanEvalsRequestToJSON(
+  getV2HumanEvalsRequest: GetV2HumanEvalsRequest,
+): string {
+  return JSON.stringify(
+    GetV2HumanEvalsRequest$outboundSchema.parse(getV2HumanEvalsRequest),
+  );
+}
+
+/** @internal */
+export const ResponseBody6$inboundSchema: z.ZodType<
+  ResponseBody6,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("text"),
+  id: z.string(),
+  key: z.string().default("orq_01kmfjpndg"),
+  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 responseBody6FromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseBody6, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseBody6$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseBody6' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseBodySentiment$inboundSchema: z.ZodNativeEnum<
+  typeof ResponseBodySentiment
+> = z.nativeEnum(ResponseBodySentiment);
+
+/** @internal */
+export const ResponseBodyOptions$inboundSchema: z.ZodType<
+  ResponseBodyOptions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  value: z.string(),
+  sentiment: ResponseBodySentiment$inboundSchema,
+  description: z.string(),
+  icon: z.string(),
+});
+
+export function responseBodyOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseBodyOptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseBodyOptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseBodyOptions' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseBody5$inboundSchema: z.ZodType<
+  ResponseBody5,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("single_select"),
+  options: z.array(z.lazy(() => ResponseBodyOptions$inboundSchema)),
+  id: z.string(),
+  key: z.string().default("orq_01kmfjpndf"),
+  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 responseBody5FromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseBody5, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseBody5$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseBody5' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV2HumanEvalsResponseBodySentiment$inboundSchema:
+  z.ZodNativeEnum<typeof GetV2HumanEvalsResponseBodySentiment> = z.nativeEnum(
+    GetV2HumanEvalsResponseBodySentiment,
+  );
+
+/** @internal */
+export const GetV2HumanEvalsResponseBodyOptions$inboundSchema: z.ZodType<
+  GetV2HumanEvalsResponseBodyOptions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  value: z.string(),
+  sentiment: GetV2HumanEvalsResponseBodySentiment$inboundSchema,
+  description: z.string(),
+  icon: z.string(),
+});
+
+export function getV2HumanEvalsResponseBodyOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetV2HumanEvalsResponseBodyOptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV2HumanEvalsResponseBodyOptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetV2HumanEvalsResponseBodyOptions' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseBody4$inboundSchema: z.ZodType<
+  ResponseBody4,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("multi_select"),
+  options: z.array(
+    z.lazy(() => GetV2HumanEvalsResponseBodyOptions$inboundSchema),
+  ),
+  id: z.string(),
+  key: z.string().default("orq_01kmfjpnde"),
+  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 responseBody4FromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseBody4, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseBody4$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseBody4' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseBodyConfig$inboundSchema: z.ZodType<
+  ResponseBodyConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  min: z.number().int(),
+  max: z.number().int(),
+});
+
+export function responseBodyConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseBodyConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseBodyConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseBodyConfig' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseBody3$inboundSchema: z.ZodType<
+  ResponseBody3,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("range"),
+  config: z.lazy(() => ResponseBodyConfig$inboundSchema),
+  id: z.string(),
+  key: z.string().default("orq_01kmfjpndd"),
+  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 responseBody3FromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseBody3, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseBody3$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseBody3' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseBody2$inboundSchema: z.ZodType<
+  ResponseBody2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("correction"),
+  id: z.string(),
+  key: z.string().default("orq_01kmfjpndc"),
+  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 responseBody2FromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseBody2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseBody2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseBody2' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseBody1$inboundSchema: z.ZodType<
+  ResponseBody1,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("boolean"),
+  id: z.string(),
+  key: z.string().default("orq_01kmfjpndb"),
+  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 responseBody1FromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseBody1, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseBody1$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseBody1' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResponseBody$inboundSchema: z.ZodType<
+  ResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => ResponseBody1$inboundSchema),
+  z.lazy(() => ResponseBody2$inboundSchema),
+  z.lazy(() => ResponseBody3$inboundSchema),
+  z.lazy(() => ResponseBody4$inboundSchema),
+  z.lazy(() => ResponseBody5$inboundSchema),
+  z.lazy(() => ResponseBody6$inboundSchema),
+]);
+
+export function responseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseBody' from JSON`,
+  );
+}