@orq-ai/node 4.13.13 → 4.13.16

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

@@ -0,0 +1,47 @@
+/*
+ * 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";
+import {
+  EvaluationResult,
+  EvaluationResult$inboundSchema,
+} from "./evaluationresult.js";
+
+/**
+ * Response wrappers keep each RPC's response type distinct, so a future field
+ *
+ * @remarks
+ *  can be added to one without touching the other.
+ */
+export type InvokeEvaluatorResponse = {
+  /**
+   * The verdict. Shaped to match WorkflowRunMinifiedEvalSchema, the body the
+   *
+   * @remarks
+   *  TypeScript route returned, so existing consumers read the same JSON.
+   */
+  result?: EvaluationResult | undefined;
+};
+
+/** @internal */
+export const InvokeEvaluatorResponse$inboundSchema: z.ZodType<
+  InvokeEvaluatorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  result: EvaluationResult$inboundSchema.optional(),
+});
+
+export function invokeEvaluatorResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<InvokeEvaluatorResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InvokeEvaluatorResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvokeEvaluatorResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,558 @@
+/*
+ * 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";
+import {
+  KnowledgeMetadata,
+  KnowledgeMetadata$inboundSchema,
+} from "./knowledgemetadata.js";
+import {
+  KnowledgeSettings,
+  KnowledgeSettings$inboundSchema,
+} from "./knowledgesettings.js";
+
+export const Knowledge2Type = {
+  External: "external",
+} as const;
+export type Knowledge2Type = ClosedEnum<typeof Knowledge2Type>;
+
+/**
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
+ */
+export type Knowledge2RerankConfig = {
+  /**
+   * The number of results to return by the reranking model
+   */
+  topK: number;
+  /**
+   * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
+   */
+  rerankThreshold: number;
+  /**
+   * The rerank model to use for the knowledge base.
+   */
+  rerankModel: string;
+};
+
+/**
+ * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
+ */
+export type Knowledge2AgenticRagConfig = {
+  /**
+   * The model to use for the Agentic RAG
+   */
+  model: string;
+};
+
+/**
+ * The retrieval settings for the knowledge base.
+ */
+export type KnowledgeRetrievalSettings = {
+  /**
+   * The number of results to return from the search.
+   */
+  topK: number;
+  /**
+   * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
+   */
+  threshold: number;
+  /**
+   * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
+   */
+  rerankConfig?: Knowledge2RerankConfig | null | undefined;
+  /**
+   * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
+   */
+  agenticRagConfig?: Knowledge2AgenticRagConfig | null | undefined;
+};
+
+export type ExternalConfig = {
+  /**
+   * The name of the external knowledge base.
+   */
+  name: string;
+  /**
+   * The API URL of the external knowledge base.
+   */
+  apiUrl: string;
+};
+
+export type Knowledge2 = {
+  /**
+   * The unique identifier of the knowledge base.
+   */
+  id: string;
+  /**
+   * The creation date of the knowledge base.
+   */
+  created: string;
+  /**
+   * The description of the knowledge base.
+   */
+  description?: string | null | undefined;
+  /**
+   * The unique key of the knowledge base.
+   */
+  key: string;
+  /**
+   * The project/domain ID of the knowledge base.
+   */
+  domainId: string;
+  /**
+   * Entity storage path.
+   *
+   * @remarks
+   *
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
+   *
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
+   */
+  path?: string | undefined;
+  createdById?: string | null | undefined;
+  updatedById?: string | null | undefined;
+  /**
+   * The last update date of the knowledge base.
+   */
+  updated: string;
+  type: Knowledge2Type;
+  /**
+   * The retrieval settings for the knowledge base.
+   */
+  retrievalSettings?: KnowledgeRetrievalSettings | undefined;
+  externalConfig: ExternalConfig;
+  /**
+   * Additive compatibility fields formerly available only from private internal endpoints.
+   */
+  settings?: KnowledgeSettings | undefined;
+  metadata?: KnowledgeMetadata | undefined;
+};
+
+export const KnowledgeType = {
+  Internal: "internal",
+} as const;
+export type KnowledgeType = ClosedEnum<typeof KnowledgeType>;
+
+/**
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
+ */
+export const RetrievalType = {
+  VectorSearch: "vector_search",
+  KeywordSearch: "keyword_search",
+  HybridSearch: "hybrid_search",
+} as const;
+/**
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
+ */
+export type RetrievalType = ClosedEnum<typeof RetrievalType>;
+
+/**
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
+ */
+export type KnowledgeRerankConfig = {
+  /**
+   * The number of results to return by the reranking model
+   */
+  topK: number;
+  /**
+   * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
+   */
+  rerankThreshold: number;
+  /**
+   * The rerank model to use for the knowledge base.
+   */
+  rerankModel: string;
+};
+
+/**
+ * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
+ */
+export type KnowledgeAgenticRagConfig = {
+  /**
+   * The model to use for the Agentic RAG
+   */
+  model: string;
+};
+
+/**
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
+ */
+export type RetrievalSettings = {
+  /**
+   * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
+   */
+  retrievalType: RetrievalType;
+  /**
+   * The number of results to return from the search.
+   */
+  topK: number;
+  /**
+   * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
+   */
+  threshold: number;
+  /**
+   * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
+   */
+  rerankConfig?: KnowledgeRerankConfig | null | undefined;
+  /**
+   * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
+   */
+  agenticRagConfig?: KnowledgeAgenticRagConfig | null | undefined;
+};
+
+export type Knowledge1 = {
+  /**
+   * The unique identifier of the knowledge base.
+   */
+  id: string;
+  /**
+   * The creation date of the knowledge base.
+   */
+  created: string;
+  /**
+   * The description of the knowledge base.
+   */
+  description?: string | null | undefined;
+  /**
+   * The unique key of the knowledge base.
+   */
+  key: string;
+  /**
+   * The project/domain ID of the knowledge base.
+   */
+  domainId: string;
+  /**
+   * Entity storage path.
+   *
+   * @remarks
+   *
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
+   *
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
+   */
+  path?: string | undefined;
+  createdById?: string | null | undefined;
+  updatedById?: string | null | undefined;
+  /**
+   * The last update date of the knowledge base.
+   */
+  updated: string;
+  type: KnowledgeType;
+  /**
+   * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
+   */
+  retrievalSettings?: RetrievalSettings | undefined;
+  /**
+   * The embeddings model used for the knowledge base.
+   */
+  model: string;
+  /**
+   * Additive compatibility fields formerly available only from private internal endpoints.
+   */
+  settings?: KnowledgeSettings | undefined;
+  metadata?: KnowledgeMetadata | undefined;
+};
+
+export type Knowledge = Knowledge1 | Knowledge2;
+
+/** @internal */
+export const Knowledge2Type$inboundSchema: z.ZodNativeEnum<
+  typeof Knowledge2Type
+> = z.nativeEnum(Knowledge2Type);
+
+/** @internal */
+export const Knowledge2RerankConfig$inboundSchema: z.ZodType<
+  Knowledge2RerankConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  top_k: z.number().int().default(5),
+  rerank_threshold: z.number().default(0.5),
+  rerank_model: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "top_k": "topK",
+    "rerank_threshold": "rerankThreshold",
+    "rerank_model": "rerankModel",
+  });
+});
+
+export function knowledge2RerankConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<Knowledge2RerankConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Knowledge2RerankConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Knowledge2RerankConfig' from JSON`,
+  );
+}
+
+/** @internal */
+export const Knowledge2AgenticRagConfig$inboundSchema: z.ZodType<
+  Knowledge2AgenticRagConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model: z.string(),
+});
+
+export function knowledge2AgenticRagConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<Knowledge2AgenticRagConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Knowledge2AgenticRagConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Knowledge2AgenticRagConfig' from JSON`,
+  );
+}
+
+/** @internal */
+export const KnowledgeRetrievalSettings$inboundSchema: z.ZodType<
+  KnowledgeRetrievalSettings,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  top_k: z.number().int().default(5),
+  threshold: z.number().default(0),
+  rerank_config: z.nullable(z.lazy(() => Knowledge2RerankConfig$inboundSchema))
+    .optional(),
+  agentic_rag_config: z.nullable(
+    z.lazy(() => Knowledge2AgenticRagConfig$inboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "top_k": "topK",
+    "rerank_config": "rerankConfig",
+    "agentic_rag_config": "agenticRagConfig",
+  });
+});
+
+export function knowledgeRetrievalSettingsFromJSON(
+  jsonString: string,
+): SafeParseResult<KnowledgeRetrievalSettings, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => KnowledgeRetrievalSettings$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'KnowledgeRetrievalSettings' from JSON`,
+  );
+}
+
+/** @internal */
+export const ExternalConfig$inboundSchema: z.ZodType<
+  ExternalConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  api_url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "api_url": "apiUrl",
+  });
+});
+
+export function externalConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<ExternalConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExternalConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExternalConfig' from JSON`,
+  );
+}
+
+/** @internal */
+export const Knowledge2$inboundSchema: z.ZodType<
+  Knowledge2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  created: z.string(),
+  description: z.nullable(z.string()).optional(),
+  key: z.string(),
+  domain_id: z.string(),
+  path: z.string().optional(),
+  created_by_id: z.nullable(z.string()).optional(),
+  updated_by_id: z.nullable(z.string()).optional(),
+  updated: z.string(),
+  type: Knowledge2Type$inboundSchema.default("external"),
+  retrieval_settings: z.lazy(() => KnowledgeRetrievalSettings$inboundSchema)
+    .optional(),
+  external_config: z.lazy(() => ExternalConfig$inboundSchema),
+  settings: KnowledgeSettings$inboundSchema.optional(),
+  metadata: KnowledgeMetadata$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "domain_id": "domainId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "retrieval_settings": "retrievalSettings",
+    "external_config": "externalConfig",
+  });
+});
+
+export function knowledge2FromJSON(
+  jsonString: string,
+): SafeParseResult<Knowledge2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Knowledge2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Knowledge2' from JSON`,
+  );
+}
+
+/** @internal */
+export const KnowledgeType$inboundSchema: z.ZodNativeEnum<
+  typeof KnowledgeType
+> = z.nativeEnum(KnowledgeType);
+
+/** @internal */
+export const RetrievalType$inboundSchema: z.ZodNativeEnum<
+  typeof RetrievalType
+> = z.nativeEnum(RetrievalType);
+
+/** @internal */
+export const KnowledgeRerankConfig$inboundSchema: z.ZodType<
+  KnowledgeRerankConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  top_k: z.number().int().default(5),
+  rerank_threshold: z.number().default(0.5),
+  rerank_model: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "top_k": "topK",
+    "rerank_threshold": "rerankThreshold",
+    "rerank_model": "rerankModel",
+  });
+});
+
+export function knowledgeRerankConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<KnowledgeRerankConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => KnowledgeRerankConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'KnowledgeRerankConfig' from JSON`,
+  );
+}
+
+/** @internal */
+export const KnowledgeAgenticRagConfig$inboundSchema: z.ZodType<
+  KnowledgeAgenticRagConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model: z.string(),
+});
+
+export function knowledgeAgenticRagConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<KnowledgeAgenticRagConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => KnowledgeAgenticRagConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'KnowledgeAgenticRagConfig' from JSON`,
+  );
+}
+
+/** @internal */
+export const RetrievalSettings$inboundSchema: z.ZodType<
+  RetrievalSettings,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  retrieval_type: RetrievalType$inboundSchema.default("hybrid_search"),
+  top_k: z.number().int().default(5),
+  threshold: z.number().default(0),
+  rerank_config: z.nullable(z.lazy(() => KnowledgeRerankConfig$inboundSchema))
+    .optional(),
+  agentic_rag_config: z.nullable(
+    z.lazy(() => KnowledgeAgenticRagConfig$inboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "retrieval_type": "retrievalType",
+    "top_k": "topK",
+    "rerank_config": "rerankConfig",
+    "agentic_rag_config": "agenticRagConfig",
+  });
+});
+
+export function retrievalSettingsFromJSON(
+  jsonString: string,
+): SafeParseResult<RetrievalSettings, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RetrievalSettings$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetrievalSettings' from JSON`,
+  );
+}
+
+/** @internal */
+export const Knowledge1$inboundSchema: z.ZodType<
+  Knowledge1,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  created: z.string(),
+  description: z.nullable(z.string()).optional(),
+  key: z.string(),
+  domain_id: z.string(),
+  path: z.string().optional(),
+  created_by_id: z.nullable(z.string()).optional(),
+  updated_by_id: z.nullable(z.string()).optional(),
+  updated: z.string(),
+  type: KnowledgeType$inboundSchema.default("internal"),
+  retrieval_settings: z.lazy(() => RetrievalSettings$inboundSchema).optional(),
+  model: z.string(),
+  settings: KnowledgeSettings$inboundSchema.optional(),
+  metadata: KnowledgeMetadata$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "domain_id": "domainId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "retrieval_settings": "retrievalSettings",
+  });
+});
+
+export function knowledge1FromJSON(
+  jsonString: string,
+): SafeParseResult<Knowledge1, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Knowledge1$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Knowledge1' from JSON`,
+  );
+}
+
+/** @internal */
+export const Knowledge$inboundSchema: z.ZodType<
+  Knowledge,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => Knowledge1$inboundSchema),
+  z.lazy(() => Knowledge2$inboundSchema),
+]);
+
+export function knowledgeFromJSON(
+  jsonString: string,
+): SafeParseResult<Knowledge, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Knowledge$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Knowledge' from JSON`,
+  );
+}