@orq-ai/node 4.13.13 → 4.13.16

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

@@ -0,0 +1,649 @@
+/*
+ * 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";
+import {
+  KnowledgeUpdateSettings,
+  KnowledgeUpdateSettings$Outbound,
+  KnowledgeUpdateSettings$outboundSchema,
+} from "./knowledgeupdatesettings.js";
+
+/**
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
+ */
+export const KnowledgeBasesServiceUpdateRequestRetrievalType = {
+  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 KnowledgeBasesServiceUpdateRequestRetrievalType = ClosedEnum<
+  typeof KnowledgeBasesServiceUpdateRequestRetrievalType
+>;
+
+/**
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
+ */
+export type KnowledgeBasesServiceUpdateRequest2RerankConfig = {
+  /**
+   * The number of results to return by the reranking model
+   */
+  topK?: number | undefined;
+  /**
+   * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
+   */
+  rerankThreshold?: number | undefined;
+  /**
+   * 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 KnowledgeBasesServiceUpdateRequest2AgenticRagConfig = {
+  /**
+   * 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 KnowledgeBasesServiceUpdateRequest2RetrievalSettings = {
+  /**
+   * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
+   */
+  retrievalType?: KnowledgeBasesServiceUpdateRequestRetrievalType | undefined;
+  /**
+   * The number of results to return from the search.
+   */
+  topK?: number | undefined;
+  /**
+   * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
+   */
+  threshold?: number | undefined;
+  /**
+   * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
+   */
+  rerankConfig?:
+    | KnowledgeBasesServiceUpdateRequest2RerankConfig
+    | null
+    | undefined;
+  /**
+   * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
+   */
+  agenticRagConfig?:
+    | KnowledgeBasesServiceUpdateRequest2AgenticRagConfig
+    | null
+    | undefined;
+};
+
+export const KnowledgeBasesServiceUpdateRequest2Type = {
+  Internal: "internal",
+} as const;
+export type KnowledgeBasesServiceUpdateRequest2Type = ClosedEnum<
+  typeof KnowledgeBasesServiceUpdateRequest2Type
+>;
+
+export type KnowledgeBasesServiceUpdateRequest2 = {
+  /**
+   * The description of the knowledge base.
+   */
+  description?: string | null | undefined;
+  /**
+   * The embeddings model used for the knowledge base. If the models is provided and is different than the previous set model, all the datasources in the knowledge base will be re-embedded.
+   */
+  embeddingModel?: string | undefined;
+  /**
+   * 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;
+  /**
+   * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
+   */
+  retrievalSettings?:
+    | KnowledgeBasesServiceUpdateRequest2RetrievalSettings
+    | undefined;
+  type?: KnowledgeBasesServiceUpdateRequest2Type | undefined;
+  settings?: KnowledgeUpdateSettings | undefined;
+  domainId?: string | undefined;
+};
+
+/**
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
+ */
+export type KnowledgeBasesServiceUpdateRequestRerankConfig = {
+  /**
+   * The number of results to return by the reranking model
+   */
+  topK?: number | undefined;
+  /**
+   * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
+   */
+  rerankThreshold?: number | undefined;
+  /**
+   * 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 KnowledgeBasesServiceUpdateRequestAgenticRagConfig = {
+  /**
+   * The model to use for the Agentic RAG
+   */
+  model: string;
+};
+
+/**
+ * The retrieval settings for the knowledge base.
+ */
+export type KnowledgeBasesServiceUpdateRequestRetrievalSettings = {
+  /**
+   * The number of results to return from the search.
+   */
+  topK?: number | undefined;
+  /**
+   * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
+   */
+  threshold?: number | undefined;
+  /**
+   * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
+   */
+  rerankConfig?:
+    | KnowledgeBasesServiceUpdateRequestRerankConfig
+    | null
+    | undefined;
+  /**
+   * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
+   */
+  agenticRagConfig?:
+    | KnowledgeBasesServiceUpdateRequestAgenticRagConfig
+    | null
+    | undefined;
+};
+
+/**
+ * Configuration for the external knowledge base.
+ */
+export type KnowledgeBasesServiceUpdateRequestExternalConfig = {
+  /**
+   * The name of the external knowledge base.
+   */
+  name?: string | undefined;
+  /**
+   * The API URL for the external knowledge base.
+   */
+  apiUrl?: string | undefined;
+  /**
+   * The API key for the external knowledge base.
+   */
+  apiKey?: string | undefined;
+};
+
+export const KnowledgeBasesServiceUpdateRequestType = {
+  External: "external",
+} as const;
+export type KnowledgeBasesServiceUpdateRequestType = ClosedEnum<
+  typeof KnowledgeBasesServiceUpdateRequestType
+>;
+
+export type KnowledgeBasesServiceUpdateRequest1 = {
+  /**
+   * The description of the knowledge base.
+   */
+  description?: string | null | undefined;
+  /**
+   * 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;
+  /**
+   * The retrieval settings for the knowledge base.
+   */
+  retrievalSettings?:
+    | KnowledgeBasesServiceUpdateRequestRetrievalSettings
+    | undefined;
+  /**
+   * Configuration for the external knowledge base.
+   */
+  externalConfig?: KnowledgeBasesServiceUpdateRequestExternalConfig | undefined;
+  type?: KnowledgeBasesServiceUpdateRequestType | undefined;
+  settings?: KnowledgeUpdateSettings | undefined;
+  domainId?: string | undefined;
+};
+
+export type KnowledgeBasesServiceUpdateRequest =
+  | KnowledgeBasesServiceUpdateRequest1
+  | KnowledgeBasesServiceUpdateRequest2;
+
+/** @internal */
+export const KnowledgeBasesServiceUpdateRequestRetrievalType$outboundSchema:
+  z.ZodNativeEnum<typeof KnowledgeBasesServiceUpdateRequestRetrievalType> = z
+    .nativeEnum(KnowledgeBasesServiceUpdateRequestRetrievalType);
+
+/** @internal */
+export type KnowledgeBasesServiceUpdateRequest2RerankConfig$Outbound = {
+  top_k: number;
+  rerank_threshold: number;
+  rerank_model: string;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceUpdateRequest2RerankConfig$outboundSchema:
+  z.ZodType<
+    KnowledgeBasesServiceUpdateRequest2RerankConfig$Outbound,
+    z.ZodTypeDef,
+    KnowledgeBasesServiceUpdateRequest2RerankConfig
+  > = z.object({
+    topK: z.number().int().default(5),
+    rerankThreshold: z.number().default(0.5),
+    rerankModel: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      topK: "top_k",
+      rerankThreshold: "rerank_threshold",
+      rerankModel: "rerank_model",
+    });
+  });
+
+export function knowledgeBasesServiceUpdateRequest2RerankConfigToJSON(
+  knowledgeBasesServiceUpdateRequest2RerankConfig:
+    KnowledgeBasesServiceUpdateRequest2RerankConfig,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceUpdateRequest2RerankConfig$outboundSchema.parse(
+      knowledgeBasesServiceUpdateRequest2RerankConfig,
+    ),
+  );
+}
+
+/** @internal */
+export type KnowledgeBasesServiceUpdateRequest2AgenticRagConfig$Outbound = {
+  model: string;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceUpdateRequest2AgenticRagConfig$outboundSchema:
+  z.ZodType<
+    KnowledgeBasesServiceUpdateRequest2AgenticRagConfig$Outbound,
+    z.ZodTypeDef,
+    KnowledgeBasesServiceUpdateRequest2AgenticRagConfig
+  > = z.object({
+    model: z.string(),
+  });
+
+export function knowledgeBasesServiceUpdateRequest2AgenticRagConfigToJSON(
+  knowledgeBasesServiceUpdateRequest2AgenticRagConfig:
+    KnowledgeBasesServiceUpdateRequest2AgenticRagConfig,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceUpdateRequest2AgenticRagConfig$outboundSchema.parse(
+      knowledgeBasesServiceUpdateRequest2AgenticRagConfig,
+    ),
+  );
+}
+
+/** @internal */
+export type KnowledgeBasesServiceUpdateRequest2RetrievalSettings$Outbound = {
+  retrieval_type: string;
+  top_k: number;
+  threshold: number;
+  rerank_config?:
+    | KnowledgeBasesServiceUpdateRequest2RerankConfig$Outbound
+    | null
+    | undefined;
+  agentic_rag_config?:
+    | KnowledgeBasesServiceUpdateRequest2AgenticRagConfig$Outbound
+    | null
+    | undefined;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceUpdateRequest2RetrievalSettings$outboundSchema:
+  z.ZodType<
+    KnowledgeBasesServiceUpdateRequest2RetrievalSettings$Outbound,
+    z.ZodTypeDef,
+    KnowledgeBasesServiceUpdateRequest2RetrievalSettings
+  > = z.object({
+    retrievalType:
+      KnowledgeBasesServiceUpdateRequestRetrievalType$outboundSchema.default(
+        "hybrid_search",
+      ),
+    topK: z.number().int().default(5),
+    threshold: z.number().default(0),
+    rerankConfig: z.nullable(
+      z.lazy(() =>
+        KnowledgeBasesServiceUpdateRequest2RerankConfig$outboundSchema
+      ),
+    ).optional(),
+    agenticRagConfig: z.nullable(
+      z.lazy(() =>
+        KnowledgeBasesServiceUpdateRequest2AgenticRagConfig$outboundSchema
+      ),
+    ).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      retrievalType: "retrieval_type",
+      topK: "top_k",
+      rerankConfig: "rerank_config",
+      agenticRagConfig: "agentic_rag_config",
+    });
+  });
+
+export function knowledgeBasesServiceUpdateRequest2RetrievalSettingsToJSON(
+  knowledgeBasesServiceUpdateRequest2RetrievalSettings:
+    KnowledgeBasesServiceUpdateRequest2RetrievalSettings,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceUpdateRequest2RetrievalSettings$outboundSchema.parse(
+      knowledgeBasesServiceUpdateRequest2RetrievalSettings,
+    ),
+  );
+}
+
+/** @internal */
+export const KnowledgeBasesServiceUpdateRequest2Type$outboundSchema:
+  z.ZodNativeEnum<typeof KnowledgeBasesServiceUpdateRequest2Type> = z
+    .nativeEnum(KnowledgeBasesServiceUpdateRequest2Type);
+
+/** @internal */
+export type KnowledgeBasesServiceUpdateRequest2$Outbound = {
+  description?: string | null | undefined;
+  embedding_model?: string | undefined;
+  path?: string | undefined;
+  retrieval_settings?:
+    | KnowledgeBasesServiceUpdateRequest2RetrievalSettings$Outbound
+    | undefined;
+  type: string;
+  settings?: KnowledgeUpdateSettings$Outbound | undefined;
+  domain_id?: string | undefined;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceUpdateRequest2$outboundSchema: z.ZodType<
+  KnowledgeBasesServiceUpdateRequest2$Outbound,
+  z.ZodTypeDef,
+  KnowledgeBasesServiceUpdateRequest2
+> = z.object({
+  description: z.nullable(z.string()).optional(),
+  embeddingModel: z.string().optional(),
+  path: z.string().optional(),
+  retrievalSettings: z.lazy(() =>
+    KnowledgeBasesServiceUpdateRequest2RetrievalSettings$outboundSchema
+  ).optional(),
+  type: KnowledgeBasesServiceUpdateRequest2Type$outboundSchema.default(
+    "internal",
+  ),
+  settings: KnowledgeUpdateSettings$outboundSchema.optional(),
+  domainId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    embeddingModel: "embedding_model",
+    retrievalSettings: "retrieval_settings",
+    domainId: "domain_id",
+  });
+});
+
+export function knowledgeBasesServiceUpdateRequest2ToJSON(
+  knowledgeBasesServiceUpdateRequest2: KnowledgeBasesServiceUpdateRequest2,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceUpdateRequest2$outboundSchema.parse(
+      knowledgeBasesServiceUpdateRequest2,
+    ),
+  );
+}
+
+/** @internal */
+export type KnowledgeBasesServiceUpdateRequestRerankConfig$Outbound = {
+  top_k: number;
+  rerank_threshold: number;
+  rerank_model: string;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceUpdateRequestRerankConfig$outboundSchema:
+  z.ZodType<
+    KnowledgeBasesServiceUpdateRequestRerankConfig$Outbound,
+    z.ZodTypeDef,
+    KnowledgeBasesServiceUpdateRequestRerankConfig
+  > = z.object({
+    topK: z.number().int().default(5),
+    rerankThreshold: z.number().default(0.5),
+    rerankModel: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      topK: "top_k",
+      rerankThreshold: "rerank_threshold",
+      rerankModel: "rerank_model",
+    });
+  });
+
+export function knowledgeBasesServiceUpdateRequestRerankConfigToJSON(
+  knowledgeBasesServiceUpdateRequestRerankConfig:
+    KnowledgeBasesServiceUpdateRequestRerankConfig,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceUpdateRequestRerankConfig$outboundSchema.parse(
+      knowledgeBasesServiceUpdateRequestRerankConfig,
+    ),
+  );
+}
+
+/** @internal */
+export type KnowledgeBasesServiceUpdateRequestAgenticRagConfig$Outbound = {
+  model: string;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceUpdateRequestAgenticRagConfig$outboundSchema:
+  z.ZodType<
+    KnowledgeBasesServiceUpdateRequestAgenticRagConfig$Outbound,
+    z.ZodTypeDef,
+    KnowledgeBasesServiceUpdateRequestAgenticRagConfig
+  > = z.object({
+    model: z.string(),
+  });
+
+export function knowledgeBasesServiceUpdateRequestAgenticRagConfigToJSON(
+  knowledgeBasesServiceUpdateRequestAgenticRagConfig:
+    KnowledgeBasesServiceUpdateRequestAgenticRagConfig,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceUpdateRequestAgenticRagConfig$outboundSchema.parse(
+      knowledgeBasesServiceUpdateRequestAgenticRagConfig,
+    ),
+  );
+}
+
+/** @internal */
+export type KnowledgeBasesServiceUpdateRequestRetrievalSettings$Outbound = {
+  top_k: number;
+  threshold: number;
+  rerank_config?:
+    | KnowledgeBasesServiceUpdateRequestRerankConfig$Outbound
+    | null
+    | undefined;
+  agentic_rag_config?:
+    | KnowledgeBasesServiceUpdateRequestAgenticRagConfig$Outbound
+    | null
+    | undefined;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceUpdateRequestRetrievalSettings$outboundSchema:
+  z.ZodType<
+    KnowledgeBasesServiceUpdateRequestRetrievalSettings$Outbound,
+    z.ZodTypeDef,
+    KnowledgeBasesServiceUpdateRequestRetrievalSettings
+  > = z.object({
+    topK: z.number().int().default(5),
+    threshold: z.number().default(0),
+    rerankConfig: z.nullable(
+      z.lazy(() =>
+        KnowledgeBasesServiceUpdateRequestRerankConfig$outboundSchema
+      ),
+    ).optional(),
+    agenticRagConfig: z.nullable(
+      z.lazy(() =>
+        KnowledgeBasesServiceUpdateRequestAgenticRagConfig$outboundSchema
+      ),
+    ).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      topK: "top_k",
+      rerankConfig: "rerank_config",
+      agenticRagConfig: "agentic_rag_config",
+    });
+  });
+
+export function knowledgeBasesServiceUpdateRequestRetrievalSettingsToJSON(
+  knowledgeBasesServiceUpdateRequestRetrievalSettings:
+    KnowledgeBasesServiceUpdateRequestRetrievalSettings,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceUpdateRequestRetrievalSettings$outboundSchema.parse(
+      knowledgeBasesServiceUpdateRequestRetrievalSettings,
+    ),
+  );
+}
+
+/** @internal */
+export type KnowledgeBasesServiceUpdateRequestExternalConfig$Outbound = {
+  name?: string | undefined;
+  api_url?: string | undefined;
+  api_key?: string | undefined;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceUpdateRequestExternalConfig$outboundSchema:
+  z.ZodType<
+    KnowledgeBasesServiceUpdateRequestExternalConfig$Outbound,
+    z.ZodTypeDef,
+    KnowledgeBasesServiceUpdateRequestExternalConfig
+  > = z.object({
+    name: z.string().optional(),
+    apiUrl: z.string().optional(),
+    apiKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      apiUrl: "api_url",
+      apiKey: "api_key",
+    });
+  });
+
+export function knowledgeBasesServiceUpdateRequestExternalConfigToJSON(
+  knowledgeBasesServiceUpdateRequestExternalConfig:
+    KnowledgeBasesServiceUpdateRequestExternalConfig,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceUpdateRequestExternalConfig$outboundSchema.parse(
+      knowledgeBasesServiceUpdateRequestExternalConfig,
+    ),
+  );
+}
+
+/** @internal */
+export const KnowledgeBasesServiceUpdateRequestType$outboundSchema:
+  z.ZodNativeEnum<typeof KnowledgeBasesServiceUpdateRequestType> = z.nativeEnum(
+    KnowledgeBasesServiceUpdateRequestType,
+  );
+
+/** @internal */
+export type KnowledgeBasesServiceUpdateRequest1$Outbound = {
+  description?: string | null | undefined;
+  path?: string | undefined;
+  retrieval_settings?:
+    | KnowledgeBasesServiceUpdateRequestRetrievalSettings$Outbound
+    | undefined;
+  external_config?:
+    | KnowledgeBasesServiceUpdateRequestExternalConfig$Outbound
+    | undefined;
+  type: string;
+  settings?: KnowledgeUpdateSettings$Outbound | undefined;
+  domain_id?: string | undefined;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceUpdateRequest1$outboundSchema: z.ZodType<
+  KnowledgeBasesServiceUpdateRequest1$Outbound,
+  z.ZodTypeDef,
+  KnowledgeBasesServiceUpdateRequest1
+> = z.object({
+  description: z.nullable(z.string()).optional(),
+  path: z.string().optional(),
+  retrievalSettings: z.lazy(() =>
+    KnowledgeBasesServiceUpdateRequestRetrievalSettings$outboundSchema
+  ).optional(),
+  externalConfig: z.lazy(() =>
+    KnowledgeBasesServiceUpdateRequestExternalConfig$outboundSchema
+  ).optional(),
+  type: KnowledgeBasesServiceUpdateRequestType$outboundSchema.default(
+    "external",
+  ),
+  settings: KnowledgeUpdateSettings$outboundSchema.optional(),
+  domainId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    retrievalSettings: "retrieval_settings",
+    externalConfig: "external_config",
+    domainId: "domain_id",
+  });
+});
+
+export function knowledgeBasesServiceUpdateRequest1ToJSON(
+  knowledgeBasesServiceUpdateRequest1: KnowledgeBasesServiceUpdateRequest1,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceUpdateRequest1$outboundSchema.parse(
+      knowledgeBasesServiceUpdateRequest1,
+    ),
+  );
+}
+
+/** @internal */
+export type KnowledgeBasesServiceUpdateRequest$Outbound =
+  | KnowledgeBasesServiceUpdateRequest1$Outbound
+  | KnowledgeBasesServiceUpdateRequest2$Outbound;
+
+/** @internal */
+export const KnowledgeBasesServiceUpdateRequest$outboundSchema: z.ZodType<
+  KnowledgeBasesServiceUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  KnowledgeBasesServiceUpdateRequest
+> = z.union([
+  z.lazy(() => KnowledgeBasesServiceUpdateRequest1$outboundSchema),
+  z.lazy(() => KnowledgeBasesServiceUpdateRequest2$outboundSchema),
+]);
+
+export function knowledgeBasesServiceUpdateRequestToJSON(
+  knowledgeBasesServiceUpdateRequest: KnowledgeBasesServiceUpdateRequest,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceUpdateRequest$outboundSchema.parse(
+      knowledgeBasesServiceUpdateRequest,
+    ),
+  );
+}