@orq-ai/node 4.14.0-rc.20 → 4.14.0-rc.37

package/src/models/components/knowledgebasesservicecreaterequest.ts

@@ -0,0 +1,439 @@
+/*
+ * 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";
+
+export const KnowledgeBasesServiceCreateRequest2Type = {
+  External: "external",
+} as const;
+export type KnowledgeBasesServiceCreateRequest2Type = ClosedEnum<
+  typeof KnowledgeBasesServiceCreateRequest2Type
+>;
+
+export type KnowledgeBasesServiceCreateRequestExternalConfig = {
+  /**
+   * The name of the external knowledge base.
+   */
+  name: string;
+  /**
+   * The API URL of the external knowledge base.
+   */
+  apiUrl: string;
+  /**
+   * The API key to access the external knowledge base.
+   */
+  apiKey: string;
+};
+
+export type KnowledgeBasesServiceCreateRequest2 = {
+  type?: KnowledgeBasesServiceCreateRequest2Type | undefined;
+  key: string;
+  description?: string | null | undefined;
+  externalConfig: KnowledgeBasesServiceCreateRequestExternalConfig;
+  /**
+   * 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;
+};
+
+export const KnowledgeBasesServiceCreateRequestType = {
+  Internal: "internal",
+} as const;
+export type KnowledgeBasesServiceCreateRequestType = ClosedEnum<
+  typeof KnowledgeBasesServiceCreateRequestType
+>;
+
+/**
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
+ */
+export const KnowledgeBasesServiceCreateRequestRetrievalType = {
+  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 KnowledgeBasesServiceCreateRequestRetrievalType = ClosedEnum<
+  typeof KnowledgeBasesServiceCreateRequestRetrievalType
+>;
+
+/**
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
+ */
+export type KnowledgeBasesServiceCreateRequestRerankConfig = {
+  /**
+   * 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 KnowledgeBasesServiceCreateRequestAgenticRagConfig = {
+  /**
+   * 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 KnowledgeBasesServiceCreateRequestRetrievalSettings = {
+  /**
+   * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
+   */
+  retrievalType?: KnowledgeBasesServiceCreateRequestRetrievalType | 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?:
+    | KnowledgeBasesServiceCreateRequestRerankConfig
+    | null
+    | undefined;
+  /**
+   * The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled.
+   */
+  agenticRagConfig?:
+    | KnowledgeBasesServiceCreateRequestAgenticRagConfig
+    | null
+    | undefined;
+};
+
+export type KnowledgeBasesServiceCreateRequest1 = {
+  type?: KnowledgeBasesServiceCreateRequestType | undefined;
+  key: string;
+  description?: string | null | undefined;
+  /**
+   * The embeddings model to use for the knowledge base in the format "provider/model" for public models or "workspaceKey@provider/model" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base.
+   */
+  embeddingModel: string;
+  /**
+   * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
+   */
+  retrievalSettings?:
+    | KnowledgeBasesServiceCreateRequestRetrievalSettings
+    | 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;
+};
+
+export type KnowledgeBasesServiceCreateRequest =
+  | KnowledgeBasesServiceCreateRequest1
+  | KnowledgeBasesServiceCreateRequest2;
+
+/** @internal */
+export const KnowledgeBasesServiceCreateRequest2Type$outboundSchema:
+  z.ZodNativeEnum<typeof KnowledgeBasesServiceCreateRequest2Type> = z
+    .nativeEnum(KnowledgeBasesServiceCreateRequest2Type);
+
+/** @internal */
+export type KnowledgeBasesServiceCreateRequestExternalConfig$Outbound = {
+  name: string;
+  api_url: string;
+  api_key: string;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceCreateRequestExternalConfig$outboundSchema:
+  z.ZodType<
+    KnowledgeBasesServiceCreateRequestExternalConfig$Outbound,
+    z.ZodTypeDef,
+    KnowledgeBasesServiceCreateRequestExternalConfig
+  > = z.object({
+    name: z.string(),
+    apiUrl: z.string(),
+    apiKey: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      apiUrl: "api_url",
+      apiKey: "api_key",
+    });
+  });
+
+export function knowledgeBasesServiceCreateRequestExternalConfigToJSON(
+  knowledgeBasesServiceCreateRequestExternalConfig:
+    KnowledgeBasesServiceCreateRequestExternalConfig,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceCreateRequestExternalConfig$outboundSchema.parse(
+      knowledgeBasesServiceCreateRequestExternalConfig,
+    ),
+  );
+}
+
+/** @internal */
+export type KnowledgeBasesServiceCreateRequest2$Outbound = {
+  type: string;
+  key: string;
+  description?: string | null | undefined;
+  external_config: KnowledgeBasesServiceCreateRequestExternalConfig$Outbound;
+  path: string;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceCreateRequest2$outboundSchema: z.ZodType<
+  KnowledgeBasesServiceCreateRequest2$Outbound,
+  z.ZodTypeDef,
+  KnowledgeBasesServiceCreateRequest2
+> = z.object({
+  type: KnowledgeBasesServiceCreateRequest2Type$outboundSchema.default(
+    "external",
+  ),
+  key: z.string(),
+  description: z.nullable(z.string()).optional(),
+  externalConfig: z.lazy(() =>
+    KnowledgeBasesServiceCreateRequestExternalConfig$outboundSchema
+  ),
+  path: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    externalConfig: "external_config",
+  });
+});
+
+export function knowledgeBasesServiceCreateRequest2ToJSON(
+  knowledgeBasesServiceCreateRequest2: KnowledgeBasesServiceCreateRequest2,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceCreateRequest2$outboundSchema.parse(
+      knowledgeBasesServiceCreateRequest2,
+    ),
+  );
+}
+
+/** @internal */
+export const KnowledgeBasesServiceCreateRequestType$outboundSchema:
+  z.ZodNativeEnum<typeof KnowledgeBasesServiceCreateRequestType> = z.nativeEnum(
+    KnowledgeBasesServiceCreateRequestType,
+  );
+
+/** @internal */
+export const KnowledgeBasesServiceCreateRequestRetrievalType$outboundSchema:
+  z.ZodNativeEnum<typeof KnowledgeBasesServiceCreateRequestRetrievalType> = z
+    .nativeEnum(KnowledgeBasesServiceCreateRequestRetrievalType);
+
+/** @internal */
+export type KnowledgeBasesServiceCreateRequestRerankConfig$Outbound = {
+  top_k: number;
+  rerank_threshold: number;
+  rerank_model: string;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceCreateRequestRerankConfig$outboundSchema:
+  z.ZodType<
+    KnowledgeBasesServiceCreateRequestRerankConfig$Outbound,
+    z.ZodTypeDef,
+    KnowledgeBasesServiceCreateRequestRerankConfig
+  > = 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 knowledgeBasesServiceCreateRequestRerankConfigToJSON(
+  knowledgeBasesServiceCreateRequestRerankConfig:
+    KnowledgeBasesServiceCreateRequestRerankConfig,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceCreateRequestRerankConfig$outboundSchema.parse(
+      knowledgeBasesServiceCreateRequestRerankConfig,
+    ),
+  );
+}
+
+/** @internal */
+export type KnowledgeBasesServiceCreateRequestAgenticRagConfig$Outbound = {
+  model: string;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceCreateRequestAgenticRagConfig$outboundSchema:
+  z.ZodType<
+    KnowledgeBasesServiceCreateRequestAgenticRagConfig$Outbound,
+    z.ZodTypeDef,
+    KnowledgeBasesServiceCreateRequestAgenticRagConfig
+  > = z.object({
+    model: z.string(),
+  });
+
+export function knowledgeBasesServiceCreateRequestAgenticRagConfigToJSON(
+  knowledgeBasesServiceCreateRequestAgenticRagConfig:
+    KnowledgeBasesServiceCreateRequestAgenticRagConfig,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceCreateRequestAgenticRagConfig$outboundSchema.parse(
+      knowledgeBasesServiceCreateRequestAgenticRagConfig,
+    ),
+  );
+}
+
+/** @internal */
+export type KnowledgeBasesServiceCreateRequestRetrievalSettings$Outbound = {
+  retrieval_type: string;
+  top_k: number;
+  threshold: number;
+  rerank_config?:
+    | KnowledgeBasesServiceCreateRequestRerankConfig$Outbound
+    | null
+    | undefined;
+  agentic_rag_config?:
+    | KnowledgeBasesServiceCreateRequestAgenticRagConfig$Outbound
+    | null
+    | undefined;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceCreateRequestRetrievalSettings$outboundSchema:
+  z.ZodType<
+    KnowledgeBasesServiceCreateRequestRetrievalSettings$Outbound,
+    z.ZodTypeDef,
+    KnowledgeBasesServiceCreateRequestRetrievalSettings
+  > = z.object({
+    retrievalType:
+      KnowledgeBasesServiceCreateRequestRetrievalType$outboundSchema.default(
+        "hybrid_search",
+      ),
+    topK: z.number().int().default(5),
+    threshold: z.number().default(0),
+    rerankConfig: z.nullable(
+      z.lazy(() =>
+        KnowledgeBasesServiceCreateRequestRerankConfig$outboundSchema
+      ),
+    ).optional(),
+    agenticRagConfig: z.nullable(
+      z.lazy(() =>
+        KnowledgeBasesServiceCreateRequestAgenticRagConfig$outboundSchema
+      ),
+    ).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      retrievalType: "retrieval_type",
+      topK: "top_k",
+      rerankConfig: "rerank_config",
+      agenticRagConfig: "agentic_rag_config",
+    });
+  });
+
+export function knowledgeBasesServiceCreateRequestRetrievalSettingsToJSON(
+  knowledgeBasesServiceCreateRequestRetrievalSettings:
+    KnowledgeBasesServiceCreateRequestRetrievalSettings,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceCreateRequestRetrievalSettings$outboundSchema.parse(
+      knowledgeBasesServiceCreateRequestRetrievalSettings,
+    ),
+  );
+}
+
+/** @internal */
+export type KnowledgeBasesServiceCreateRequest1$Outbound = {
+  type: string;
+  key: string;
+  description?: string | null | undefined;
+  embedding_model: string;
+  retrieval_settings?:
+    | KnowledgeBasesServiceCreateRequestRetrievalSettings$Outbound
+    | undefined;
+  path: string;
+};
+
+/** @internal */
+export const KnowledgeBasesServiceCreateRequest1$outboundSchema: z.ZodType<
+  KnowledgeBasesServiceCreateRequest1$Outbound,
+  z.ZodTypeDef,
+  KnowledgeBasesServiceCreateRequest1
+> = z.object({
+  type: KnowledgeBasesServiceCreateRequestType$outboundSchema.default(
+    "internal",
+  ),
+  key: z.string(),
+  description: z.nullable(z.string()).optional(),
+  embeddingModel: z.string(),
+  retrievalSettings: z.lazy(() =>
+    KnowledgeBasesServiceCreateRequestRetrievalSettings$outboundSchema
+  ).optional(),
+  path: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    embeddingModel: "embedding_model",
+    retrievalSettings: "retrieval_settings",
+  });
+});
+
+export function knowledgeBasesServiceCreateRequest1ToJSON(
+  knowledgeBasesServiceCreateRequest1: KnowledgeBasesServiceCreateRequest1,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceCreateRequest1$outboundSchema.parse(
+      knowledgeBasesServiceCreateRequest1,
+    ),
+  );
+}
+
+/** @internal */
+export type KnowledgeBasesServiceCreateRequest$Outbound =
+  | KnowledgeBasesServiceCreateRequest1$Outbound
+  | KnowledgeBasesServiceCreateRequest2$Outbound;
+
+/** @internal */
+export const KnowledgeBasesServiceCreateRequest$outboundSchema: z.ZodType<
+  KnowledgeBasesServiceCreateRequest$Outbound,
+  z.ZodTypeDef,
+  KnowledgeBasesServiceCreateRequest
+> = z.union([
+  z.lazy(() => KnowledgeBasesServiceCreateRequest1$outboundSchema),
+  z.lazy(() => KnowledgeBasesServiceCreateRequest2$outboundSchema),
+]);
+
+export function knowledgeBasesServiceCreateRequestToJSON(
+  knowledgeBasesServiceCreateRequest: KnowledgeBasesServiceCreateRequest,
+): string {
+  return JSON.stringify(
+    KnowledgeBasesServiceCreateRequest$outboundSchema.parse(
+      knowledgeBasesServiceCreateRequest,
+    ),
+  );
+}

package/src/models/components/knowledgebasesservicelistresponse.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 { Knowledge, Knowledge$inboundSchema } from "./knowledge.js";
+
+export const ObjectT = {
+  List: "list",
+} as const;
+export type ObjectT = ClosedEnum<typeof ObjectT>;
+
+export type KnowledgeBasesServiceListResponse = {
+  object: ObjectT;
+  data: Array<Knowledge>;
+  hasMore: boolean;
+};
+
+/** @internal */
+export const ObjectT$inboundSchema: z.ZodNativeEnum<typeof ObjectT> = z
+  .nativeEnum(ObjectT);
+
+/** @internal */
+export const KnowledgeBasesServiceListResponse$inboundSchema: z.ZodType<
+  KnowledgeBasesServiceListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ObjectT$inboundSchema,
+  data: z.array(Knowledge$inboundSchema),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function knowledgeBasesServiceListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<KnowledgeBasesServiceListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => KnowledgeBasesServiceListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'KnowledgeBasesServiceListResponse' from JSON`,
+  );
+}