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

package/src/models/operations/postv2feedback.ts

@@ -0,0 +1,207 @@
+/*
+ * 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";
+
+/**
+ * The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string.
+ */
+export type Value = string | number | Array<string>;
+
+export const Product = {
+  Remoteconfigs: "remoteconfigs",
+  Deployments: "deployments",
+  Experiments: "experiments",
+  Playgrounds: "playgrounds",
+  Spreadsheets: "spreadsheets",
+  SpreadsheetRun: "spreadsheet_run",
+  LlmEvaluator: "llm_evaluator",
+  Knowledge: "knowledge",
+  Router: "router",
+  Workflows: "workflows",
+  ExternalEvents: "external_events",
+  Agents: "agents",
+  MemoryStores: "memory-stores",
+  Generic: "generic",
+  Evaluators: "evaluators",
+  Otel: "otel",
+  AiChat: "ai-chat",
+} as const;
+export type Product = ClosedEnum<typeof Product>;
+
+export type PostV2FeedbackRequestBody = {
+  /**
+   * Unique identifier for the feedback
+   */
+  id?: string | undefined;
+  /**
+   * A string describing the specific property or aspect rated.
+   */
+  field: string;
+  /**
+   * The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string.
+   */
+  value: string | number | Array<string>;
+  /**
+   * The id returned by the [`get_config`](https://docs.orq.ai/reference/deployments/get-config) or [`invoke`](https://docs.orq.ai/reference/deployments/invoke) endpoints
+   */
+  traceId: string;
+  product?: Product | undefined;
+};
+
+/**
+ * The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string.
+ */
+export type PostV2FeedbackValue = string | number | Array<string>;
+
+export const PostV2FeedbackProduct = {
+  Remoteconfigs: "remoteconfigs",
+  Deployments: "deployments",
+  Experiments: "experiments",
+  Playgrounds: "playgrounds",
+  Spreadsheets: "spreadsheets",
+  SpreadsheetRun: "spreadsheet_run",
+  LlmEvaluator: "llm_evaluator",
+  Knowledge: "knowledge",
+  Router: "router",
+  Workflows: "workflows",
+  ExternalEvents: "external_events",
+  Agents: "agents",
+  MemoryStores: "memory-stores",
+  Generic: "generic",
+  Evaluators: "evaluators",
+  Otel: "otel",
+  AiChat: "ai-chat",
+} as const;
+export type PostV2FeedbackProduct = ClosedEnum<typeof PostV2FeedbackProduct>;
+
+/**
+ * Event has been dispatched to delete the feedback
+ */
+export type PostV2FeedbackResponseBody = {
+  /**
+   * Unique identifier for the feedback
+   */
+  id?: string | undefined;
+  /**
+   * A string describing the specific property or aspect rated.
+   */
+  property: string;
+  /**
+   * The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string.
+   */
+  value: string | number | Array<string>;
+  /**
+   * The id returned by the [`get_config`](https://docs.orq.ai/reference/deployments/get-config) or [`invoke`](https://docs.orq.ai/reference/deployments/invoke) endpoints
+   */
+  traceId: string;
+  product: PostV2FeedbackProduct;
+};
+
+/** @internal */
+export type Value$Outbound = string | number | Array<string>;
+
+/** @internal */
+export const Value$outboundSchema: z.ZodType<
+  Value$Outbound,
+  z.ZodTypeDef,
+  Value
+> = z.union([z.string(), z.number(), z.array(z.string())]);
+
+export function valueToJSON(value: Value): string {
+  return JSON.stringify(Value$outboundSchema.parse(value));
+}
+
+/** @internal */
+export const Product$outboundSchema: z.ZodNativeEnum<typeof Product> = z
+  .nativeEnum(Product);
+
+/** @internal */
+export type PostV2FeedbackRequestBody$Outbound = {
+  id?: string | undefined;
+  property: string;
+  value: string | number | Array<string>;
+  trace_id: string;
+  product: string;
+};
+
+/** @internal */
+export const PostV2FeedbackRequestBody$outboundSchema: z.ZodType<
+  PostV2FeedbackRequestBody$Outbound,
+  z.ZodTypeDef,
+  PostV2FeedbackRequestBody
+> = z.object({
+  id: z.string().optional(),
+  field: z.string(),
+  value: z.union([z.string(), z.number(), z.array(z.string())]),
+  traceId: z.string(),
+  product: Product$outboundSchema.default("deployments"),
+}).transform((v) => {
+  return remap$(v, {
+    field: "property",
+    traceId: "trace_id",
+  });
+});
+
+export function postV2FeedbackRequestBodyToJSON(
+  postV2FeedbackRequestBody: PostV2FeedbackRequestBody,
+): string {
+  return JSON.stringify(
+    PostV2FeedbackRequestBody$outboundSchema.parse(postV2FeedbackRequestBody),
+  );
+}
+
+/** @internal */
+export const PostV2FeedbackValue$inboundSchema: z.ZodType<
+  PostV2FeedbackValue,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number(), z.array(z.string())]);
+
+export function postV2FeedbackValueFromJSON(
+  jsonString: string,
+): SafeParseResult<PostV2FeedbackValue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PostV2FeedbackValue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostV2FeedbackValue' from JSON`,
+  );
+}
+
+/** @internal */
+export const PostV2FeedbackProduct$inboundSchema: z.ZodNativeEnum<
+  typeof PostV2FeedbackProduct
+> = z.nativeEnum(PostV2FeedbackProduct);
+
+/** @internal */
+export const PostV2FeedbackResponseBody$inboundSchema: z.ZodType<
+  PostV2FeedbackResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  property: z.string(),
+  value: z.union([z.string(), z.number(), z.array(z.string())]),
+  trace_id: z.string(),
+  product: PostV2FeedbackProduct$inboundSchema.default("deployments"),
+}).transform((v) => {
+  return remap$(v, {
+    "trace_id": "traceId",
+  });
+});
+
+export function postV2FeedbackResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<PostV2FeedbackResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PostV2FeedbackResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostV2FeedbackResponseBody' from JSON`,
+  );
+}

package/src/models/operations/postv2feedbackevaluation.ts

@@ -0,0 +1,321 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The type of evaluation
+ */
+export const PostV2FeedbackEvaluationRequestBodyEvaluationType = {
+  HumanReview: "human_review",
+} as const;
+/**
+ * The type of evaluation
+ */
+export type PostV2FeedbackEvaluationRequestBodyEvaluationType = ClosedEnum<
+  typeof PostV2FeedbackEvaluationRequestBodyEvaluationType
+>;
+
+export const PostV2FeedbackEvaluationRequestBodyRequestSource = {
+  Orq: "orq",
+  External: "external",
+} as const;
+export type PostV2FeedbackEvaluationRequestBodyRequestSource = ClosedEnum<
+  typeof PostV2FeedbackEvaluationRequestBodyRequestSource
+>;
+
+export type RequestBody3 = {
+  /**
+   * The unique identifier of the human evaluation
+   */
+  id: string;
+  /**
+   * The type of evaluation
+   */
+  evaluationType: PostV2FeedbackEvaluationRequestBodyEvaluationType;
+  /**
+   * The unique identifier of the human review
+   */
+  humanReviewId: string;
+  source?: PostV2FeedbackEvaluationRequestBodyRequestSource | undefined;
+  /**
+   * The date and time the item was reviewed
+   */
+  reviewedAt?: Date | undefined;
+  type: "string_array";
+  values: Array<string>;
+  traceId: string;
+};
+
+/**
+ * The type of evaluation
+ */
+export const RequestBodyEvaluationType = {
+  HumanReview: "human_review",
+} as const;
+/**
+ * The type of evaluation
+ */
+export type RequestBodyEvaluationType = ClosedEnum<
+  typeof RequestBodyEvaluationType
+>;
+
+export const PostV2FeedbackEvaluationRequestBodySource = {
+  Orq: "orq",
+  External: "external",
+} as const;
+export type PostV2FeedbackEvaluationRequestBodySource = ClosedEnum<
+  typeof PostV2FeedbackEvaluationRequestBodySource
+>;
+
+export type RequestBody2 = {
+  /**
+   * The unique identifier of the human evaluation
+   */
+  id: string;
+  /**
+   * The type of evaluation
+   */
+  evaluationType: RequestBodyEvaluationType;
+  /**
+   * The unique identifier of the human review
+   */
+  humanReviewId: string;
+  source?: PostV2FeedbackEvaluationRequestBodySource | undefined;
+  /**
+   * The date and time the item was reviewed
+   */
+  reviewedAt?: Date | undefined;
+  type: "number";
+  value: number;
+  traceId: string;
+};
+
+/**
+ * The type of evaluation
+ */
+export const EvaluationType = {
+  HumanReview: "human_review",
+} as const;
+/**
+ * The type of evaluation
+ */
+export type EvaluationType = ClosedEnum<typeof EvaluationType>;
+
+export const RequestBodySource = {
+  Orq: "orq",
+  External: "external",
+} as const;
+export type RequestBodySource = ClosedEnum<typeof RequestBodySource>;
+
+export type RequestBody1 = {
+  /**
+   * The unique identifier of the human evaluation
+   */
+  id: string;
+  /**
+   * The type of evaluation
+   */
+  evaluationType: EvaluationType;
+  /**
+   * The unique identifier of the human review
+   */
+  humanReviewId: string;
+  source?: RequestBodySource | undefined;
+  /**
+   * The date and time the item was reviewed
+   */
+  reviewedAt?: Date | undefined;
+  type: "string";
+  value: string;
+  traceId: string;
+};
+
+export type PostV2FeedbackEvaluationRequestBody =
+  | RequestBody1
+  | RequestBody2
+  | RequestBody3;
+
+/** @internal */
+export const PostV2FeedbackEvaluationRequestBodyEvaluationType$outboundSchema:
+  z.ZodNativeEnum<typeof PostV2FeedbackEvaluationRequestBodyEvaluationType> = z
+    .nativeEnum(PostV2FeedbackEvaluationRequestBodyEvaluationType);
+
+/** @internal */
+export const PostV2FeedbackEvaluationRequestBodyRequestSource$outboundSchema:
+  z.ZodNativeEnum<typeof PostV2FeedbackEvaluationRequestBodyRequestSource> = z
+    .nativeEnum(PostV2FeedbackEvaluationRequestBodyRequestSource);
+
+/** @internal */
+export type RequestBody3$Outbound = {
+  id: string;
+  evaluation_type: string;
+  human_review_id: string;
+  source: string;
+  reviewed_at: string;
+  type: "string_array";
+  values: Array<string>;
+  trace_id: string;
+};
+
+/** @internal */
+export const RequestBody3$outboundSchema: z.ZodType<
+  RequestBody3$Outbound,
+  z.ZodTypeDef,
+  RequestBody3
+> = z.object({
+  id: z.string(),
+  evaluationType:
+    PostV2FeedbackEvaluationRequestBodyEvaluationType$outboundSchema,
+  humanReviewId: z.string(),
+  source: PostV2FeedbackEvaluationRequestBodyRequestSource$outboundSchema
+    .default("orq"),
+  reviewedAt: z.date().default(() => new Date("2026-03-24T08:41:02.099Z"))
+    .transform(v => v.toISOString()),
+  type: z.literal("string_array"),
+  values: z.array(z.string()),
+  traceId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    evaluationType: "evaluation_type",
+    humanReviewId: "human_review_id",
+    reviewedAt: "reviewed_at",
+    traceId: "trace_id",
+  });
+});
+
+export function requestBody3ToJSON(requestBody3: RequestBody3): string {
+  return JSON.stringify(RequestBody3$outboundSchema.parse(requestBody3));
+}
+
+/** @internal */
+export const RequestBodyEvaluationType$outboundSchema: z.ZodNativeEnum<
+  typeof RequestBodyEvaluationType
+> = z.nativeEnum(RequestBodyEvaluationType);
+
+/** @internal */
+export const PostV2FeedbackEvaluationRequestBodySource$outboundSchema:
+  z.ZodNativeEnum<typeof PostV2FeedbackEvaluationRequestBodySource> = z
+    .nativeEnum(PostV2FeedbackEvaluationRequestBodySource);
+
+/** @internal */
+export type RequestBody2$Outbound = {
+  id: string;
+  evaluation_type: string;
+  human_review_id: string;
+  source: string;
+  reviewed_at: string;
+  type: "number";
+  value: number;
+  trace_id: string;
+};
+
+/** @internal */
+export const RequestBody2$outboundSchema: z.ZodType<
+  RequestBody2$Outbound,
+  z.ZodTypeDef,
+  RequestBody2
+> = z.object({
+  id: z.string(),
+  evaluationType: RequestBodyEvaluationType$outboundSchema,
+  humanReviewId: z.string(),
+  source: PostV2FeedbackEvaluationRequestBodySource$outboundSchema.default(
+    "orq",
+  ),
+  reviewedAt: z.date().default(() => new Date("2026-03-24T08:41:02.099Z"))
+    .transform(v => v.toISOString()),
+  type: z.literal("number"),
+  value: z.number(),
+  traceId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    evaluationType: "evaluation_type",
+    humanReviewId: "human_review_id",
+    reviewedAt: "reviewed_at",
+    traceId: "trace_id",
+  });
+});
+
+export function requestBody2ToJSON(requestBody2: RequestBody2): string {
+  return JSON.stringify(RequestBody2$outboundSchema.parse(requestBody2));
+}
+
+/** @internal */
+export const EvaluationType$outboundSchema: z.ZodNativeEnum<
+  typeof EvaluationType
+> = z.nativeEnum(EvaluationType);
+
+/** @internal */
+export const RequestBodySource$outboundSchema: z.ZodNativeEnum<
+  typeof RequestBodySource
+> = z.nativeEnum(RequestBodySource);
+
+/** @internal */
+export type RequestBody1$Outbound = {
+  id: string;
+  evaluation_type: string;
+  human_review_id: string;
+  source: string;
+  reviewed_at: string;
+  type: "string";
+  value: string;
+  trace_id: string;
+};
+
+/** @internal */
+export const RequestBody1$outboundSchema: z.ZodType<
+  RequestBody1$Outbound,
+  z.ZodTypeDef,
+  RequestBody1
+> = z.object({
+  id: z.string(),
+  evaluationType: EvaluationType$outboundSchema,
+  humanReviewId: z.string(),
+  source: RequestBodySource$outboundSchema.default("orq"),
+  reviewedAt: z.date().default(() => new Date("2026-03-24T08:41:02.098Z"))
+    .transform(v => v.toISOString()),
+  type: z.literal("string"),
+  value: z.string(),
+  traceId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    evaluationType: "evaluation_type",
+    humanReviewId: "human_review_id",
+    reviewedAt: "reviewed_at",
+    traceId: "trace_id",
+  });
+});
+
+export function requestBody1ToJSON(requestBody1: RequestBody1): string {
+  return JSON.stringify(RequestBody1$outboundSchema.parse(requestBody1));
+}
+
+/** @internal */
+export type PostV2FeedbackEvaluationRequestBody$Outbound =
+  | RequestBody1$Outbound
+  | RequestBody2$Outbound
+  | RequestBody3$Outbound;
+
+/** @internal */
+export const PostV2FeedbackEvaluationRequestBody$outboundSchema: z.ZodType<
+  PostV2FeedbackEvaluationRequestBody$Outbound,
+  z.ZodTypeDef,
+  PostV2FeedbackEvaluationRequestBody
+> = z.union([
+  z.lazy(() => RequestBody1$outboundSchema),
+  z.lazy(() => RequestBody2$outboundSchema),
+  z.lazy(() => RequestBody3$outboundSchema),
+]);
+
+export function postV2FeedbackEvaluationRequestBodyToJSON(
+  postV2FeedbackEvaluationRequestBody: PostV2FeedbackEvaluationRequestBody,
+): string {
+  return JSON.stringify(
+    PostV2FeedbackEvaluationRequestBody$outboundSchema.parse(
+      postV2FeedbackEvaluationRequestBody,
+    ),
+  );
+}

package/src/models/operations/postv2feedbackevaluationremove.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 PostV2FeedbackEvaluationRemoveRequestBody = {
+  id: string;
+  traceId: string;
+};
+
+/** @internal */
+export type PostV2FeedbackEvaluationRemoveRequestBody$Outbound = {
+  id: string;
+  trace_id: string;
+};
+
+/** @internal */
+export const PostV2FeedbackEvaluationRemoveRequestBody$outboundSchema:
+  z.ZodType<
+    PostV2FeedbackEvaluationRemoveRequestBody$Outbound,
+    z.ZodTypeDef,
+    PostV2FeedbackEvaluationRemoveRequestBody
+  > = z.object({
+    id: z.string(),
+    traceId: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      traceId: "trace_id",
+    });
+  });
+
+export function postV2FeedbackEvaluationRemoveRequestBodyToJSON(
+  postV2FeedbackEvaluationRemoveRequestBody:
+    PostV2FeedbackEvaluationRemoveRequestBody,
+): string {
+  return JSON.stringify(
+    PostV2FeedbackEvaluationRemoveRequestBody$outboundSchema.parse(
+      postV2FeedbackEvaluationRemoveRequestBody,
+    ),
+  );
+}

package/src/models/operations/postv2feedbackremove.ts

@@ -0,0 +1,138 @@
+/*
+ * 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 const PostV2FeedbackRemoveProduct = {
+  Remoteconfigs: "remoteconfigs",
+  Deployments: "deployments",
+  Experiments: "experiments",
+  Playgrounds: "playgrounds",
+  Spreadsheets: "spreadsheets",
+  SpreadsheetRun: "spreadsheet_run",
+  LlmEvaluator: "llm_evaluator",
+  Knowledge: "knowledge",
+  Router: "router",
+  Workflows: "workflows",
+  ExternalEvents: "external_events",
+  Agents: "agents",
+  MemoryStores: "memory-stores",
+  Generic: "generic",
+  Evaluators: "evaluators",
+  Otel: "otel",
+  AiChat: "ai-chat",
+} as const;
+export type PostV2FeedbackRemoveProduct = ClosedEnum<
+  typeof PostV2FeedbackRemoveProduct
+>;
+
+export type PostV2FeedbackRemoveRequestBody = {
+  id: string;
+  traceId: string;
+  product: PostV2FeedbackRemoveProduct;
+};
+
+export const PostV2FeedbackRemoveResponseProduct = {
+  Remoteconfigs: "remoteconfigs",
+  Deployments: "deployments",
+  Experiments: "experiments",
+  Playgrounds: "playgrounds",
+  Spreadsheets: "spreadsheets",
+  SpreadsheetRun: "spreadsheet_run",
+  LlmEvaluator: "llm_evaluator",
+  Knowledge: "knowledge",
+  Router: "router",
+  Workflows: "workflows",
+  ExternalEvents: "external_events",
+  Agents: "agents",
+  MemoryStores: "memory-stores",
+  Generic: "generic",
+  Evaluators: "evaluators",
+  Otel: "otel",
+  AiChat: "ai-chat",
+} as const;
+export type PostV2FeedbackRemoveResponseProduct = ClosedEnum<
+  typeof PostV2FeedbackRemoveResponseProduct
+>;
+
+/**
+ * Event has been dispatched to delete the feedback
+ */
+export type PostV2FeedbackRemoveResponseBody = {
+  id: string;
+  traceId: string;
+  product: PostV2FeedbackRemoveResponseProduct;
+};
+
+/** @internal */
+export const PostV2FeedbackRemoveProduct$outboundSchema: z.ZodNativeEnum<
+  typeof PostV2FeedbackRemoveProduct
+> = z.nativeEnum(PostV2FeedbackRemoveProduct);
+
+/** @internal */
+export type PostV2FeedbackRemoveRequestBody$Outbound = {
+  id: string;
+  trace_id: string;
+  product: string;
+};
+
+/** @internal */
+export const PostV2FeedbackRemoveRequestBody$outboundSchema: z.ZodType<
+  PostV2FeedbackRemoveRequestBody$Outbound,
+  z.ZodTypeDef,
+  PostV2FeedbackRemoveRequestBody
+> = z.object({
+  id: z.string(),
+  traceId: z.string(),
+  product: PostV2FeedbackRemoveProduct$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    traceId: "trace_id",
+  });
+});
+
+export function postV2FeedbackRemoveRequestBodyToJSON(
+  postV2FeedbackRemoveRequestBody: PostV2FeedbackRemoveRequestBody,
+): string {
+  return JSON.stringify(
+    PostV2FeedbackRemoveRequestBody$outboundSchema.parse(
+      postV2FeedbackRemoveRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export const PostV2FeedbackRemoveResponseProduct$inboundSchema: z.ZodNativeEnum<
+  typeof PostV2FeedbackRemoveResponseProduct
+> = z.nativeEnum(PostV2FeedbackRemoveResponseProduct);
+
+/** @internal */
+export const PostV2FeedbackRemoveResponseBody$inboundSchema: z.ZodType<
+  PostV2FeedbackRemoveResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  trace_id: z.string(),
+  product: PostV2FeedbackRemoveResponseProduct$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "trace_id": "traceId",
+  });
+});
+
+export function postV2FeedbackRemoveResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<PostV2FeedbackRemoveResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PostV2FeedbackRemoveResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostV2FeedbackRemoveResponseBody' from JSON`,
+  );
+}