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

package/src/models/components/searchknowledgeresponse.ts

@@ -0,0 +1,38 @@
+/*
+ * 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 {
+  SearchKnowledgeMatch,
+  SearchKnowledgeMatch$inboundSchema,
+} from "./searchknowledgematch.js";
+
+export type SearchKnowledgeResponse = {
+  /**
+   * Matching chunks. The response codec must emit this field even when empty.
+   */
+  matches: Array<SearchKnowledgeMatch>;
+};
+
+/** @internal */
+export const SearchKnowledgeResponse$inboundSchema: z.ZodType<
+  SearchKnowledgeResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  matches: z.array(SearchKnowledgeMatch$inboundSchema),
+});
+
+export function searchKnowledgeResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchKnowledgeResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchKnowledgeResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchKnowledgeResponse' from JSON`,
+  );
+}

package/src/models/components/searchknowledgescores.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SearchKnowledgeScores = {
+  rerankScore?: number | undefined;
+  searchScore?: number | undefined;
+};
+
+/** @internal */
+export const SearchKnowledgeScores$inboundSchema: z.ZodType<
+  SearchKnowledgeScores,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  rerank_score: z.number().optional(),
+  search_score: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "rerank_score": "rerankScore",
+    "search_score": "searchScore",
+  });
+});
+
+export function searchKnowledgeScoresFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchKnowledgeScores, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchKnowledgeScores$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchKnowledgeScores' from JSON`,
+  );
+}

package/src/models/components/searchoptions.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 SearchOptions = {
+  /**
+   * Whether to include the vector in the chunk
+   */
+  includeVectors?: boolean | undefined;
+  /**
+   * Whether to include the metadata in the chunk
+   */
+  includeMetadata?: boolean | undefined;
+  /**
+   * Whether to include the scores in the chunk
+   */
+  includeScores?: boolean | undefined;
+};
+
+/** @internal */
+export type SearchOptions$Outbound = {
+  include_vectors?: boolean | undefined;
+  include_metadata?: boolean | undefined;
+  include_scores?: boolean | undefined;
+};
+
+/** @internal */
+export const SearchOptions$outboundSchema: z.ZodType<
+  SearchOptions$Outbound,
+  z.ZodTypeDef,
+  SearchOptions
+> = z.object({
+  includeVectors: z.boolean().optional(),
+  includeMetadata: z.boolean().optional(),
+  includeScores: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    includeVectors: "include_vectors",
+    includeMetadata: "include_metadata",
+    includeScores: "include_scores",
+  });
+});
+
+export function searchOptionsToJSON(searchOptions: SearchOptions): string {
+  return JSON.stringify(SearchOptions$outboundSchema.parse(searchOptions));
+}

package/src/models/components/searchrerankconfig.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";
+
+export type SearchRerankConfig = {
+  /**
+   * The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/rerank-models).
+   */
+  model: string;
+  /**
+   * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
+   */
+  threshold?: number | undefined;
+  /**
+   * The number of top results to return after reranking. If not provided, will default to the knowledge base configured `top_k`.
+   */
+  topK?: number | undefined;
+};
+
+/** @internal */
+export type SearchRerankConfig$Outbound = {
+  model: string;
+  threshold: number;
+  top_k: number;
+};
+
+/** @internal */
+export const SearchRerankConfig$outboundSchema: z.ZodType<
+  SearchRerankConfig$Outbound,
+  z.ZodTypeDef,
+  SearchRerankConfig
+> = z.object({
+  model: z.string(),
+  threshold: z.number().default(0),
+  topK: z.number().int().default(10),
+}).transform((v) => {
+  return remap$(v, {
+    topK: "top_k",
+  });
+});
+
+export function searchRerankConfigToJSON(
+  searchRerankConfig: SearchRerankConfig,
+): string {
+  return JSON.stringify(
+    SearchRerankConfig$outboundSchema.parse(searchRerankConfig),
+  );
+}

package/src/models/components/searchretrievalconfig.ts

@@ -0,0 +1,153 @@
+/*
+ * 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 { SearchType, SearchType$outboundSchema } from "./searchtype.js";
+
+export const ModelType = {
+  Rerank: "rerank",
+} as const;
+export type ModelType = ClosedEnum<typeof ModelType>;
+
+export type ModelParameters = {
+  threshold?: number | undefined;
+};
+
+/**
+ * Override reranking for this retrieval configuration. Omit to inherit stored settings or set to null to disable reranking.
+ */
+export type SearchRetrievalConfigRerankConfig = {
+  enabled?: boolean | undefined;
+  provider?: string | undefined;
+  topK?: number | undefined;
+  model?: string | undefined;
+  modelDbId?: string | undefined;
+  modelType?: ModelType | undefined;
+  modelParameters?: ModelParameters | undefined;
+  integrationId?: string | null | undefined;
+};
+
+/**
+ * SearchRetrievalConfig mirrors RetrievalConfigInDatabaseSchema. Type remains
+ *
+ * @remarks
+ *  optional because external knowledge bases use the same base configuration
+ *  without a retrieval strategy discriminator.
+ */
+export type SearchRetrievalConfig = {
+  type?: SearchType | undefined;
+  topK?: number | undefined;
+  threshold?: number | undefined;
+  /**
+   * Override reranking for this retrieval configuration. Omit to inherit stored settings or set to null to disable reranking.
+   */
+  rerankConfig?: SearchRetrievalConfigRerankConfig | null | undefined;
+};
+
+/** @internal */
+export const ModelType$outboundSchema: z.ZodNativeEnum<typeof ModelType> = z
+  .nativeEnum(ModelType);
+
+/** @internal */
+export type ModelParameters$Outbound = {
+  threshold?: number | undefined;
+};
+
+/** @internal */
+export const ModelParameters$outboundSchema: z.ZodType<
+  ModelParameters$Outbound,
+  z.ZodTypeDef,
+  ModelParameters
+> = z.object({
+  threshold: z.number().optional(),
+});
+
+export function modelParametersToJSON(
+  modelParameters: ModelParameters,
+): string {
+  return JSON.stringify(ModelParameters$outboundSchema.parse(modelParameters));
+}
+
+/** @internal */
+export type SearchRetrievalConfigRerankConfig$Outbound = {
+  enabled?: boolean | undefined;
+  provider?: string | undefined;
+  top_k?: number | undefined;
+  model?: string | undefined;
+  model_db_id?: string | undefined;
+  model_type?: string | undefined;
+  model_parameters?: ModelParameters$Outbound | undefined;
+  integration_id?: string | null | undefined;
+};
+
+/** @internal */
+export const SearchRetrievalConfigRerankConfig$outboundSchema: z.ZodType<
+  SearchRetrievalConfigRerankConfig$Outbound,
+  z.ZodTypeDef,
+  SearchRetrievalConfigRerankConfig
+> = z.object({
+  enabled: z.boolean().optional(),
+  provider: z.string().optional(),
+  topK: z.number().int().optional(),
+  model: z.string().optional(),
+  modelDbId: z.string().optional(),
+  modelType: ModelType$outboundSchema.optional(),
+  modelParameters: z.lazy(() => ModelParameters$outboundSchema).optional(),
+  integrationId: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    topK: "top_k",
+    modelDbId: "model_db_id",
+    modelType: "model_type",
+    modelParameters: "model_parameters",
+    integrationId: "integration_id",
+  });
+});
+
+export function searchRetrievalConfigRerankConfigToJSON(
+  searchRetrievalConfigRerankConfig: SearchRetrievalConfigRerankConfig,
+): string {
+  return JSON.stringify(
+    SearchRetrievalConfigRerankConfig$outboundSchema.parse(
+      searchRetrievalConfigRerankConfig,
+    ),
+  );
+}
+
+/** @internal */
+export type SearchRetrievalConfig$Outbound = {
+  type?: string | undefined;
+  top_k?: number | undefined;
+  threshold?: number | undefined;
+  rerank_config?: SearchRetrievalConfigRerankConfig$Outbound | null | undefined;
+};
+
+/** @internal */
+export const SearchRetrievalConfig$outboundSchema: z.ZodType<
+  SearchRetrievalConfig$Outbound,
+  z.ZodTypeDef,
+  SearchRetrievalConfig
+> = z.object({
+  type: SearchType$outboundSchema.optional(),
+  topK: z.number().int().optional(),
+  threshold: z.number().optional(),
+  rerankConfig: z.nullable(
+    z.lazy(() => SearchRetrievalConfigRerankConfig$outboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    topK: "top_k",
+    rerankConfig: "rerank_config",
+  });
+});
+
+export function searchRetrievalConfigToJSON(
+  searchRetrievalConfig: SearchRetrievalConfig,
+): string {
+  return JSON.stringify(
+    SearchRetrievalConfig$outboundSchema.parse(searchRetrievalConfig),
+  );
+}

package/src/models/components/searchtype.ts

@@ -0,0 +1,17 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const SearchType = {
+  VectorSearch: "vector_search",
+  KeywordSearch: "keyword_search",
+  HybridSearch: "hybrid_search",
+} as const;
+export type SearchType = ClosedEnum<typeof SearchType>;
+
+/** @internal */
+export const SearchType$outboundSchema: z.ZodNativeEnum<typeof SearchType> = z
+  .nativeEnum(SearchType);

package/src/models/components/structuredinput.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";
+
+/**
+ * StructuredInput names its fields after the template variables they feed, so
+ *
+ * @remarks
+ *  input.user_query in a prompt is user_query here.
+ */
+export type StructuredInput = {
+  systemInstructions?: string | undefined;
+  userQuery?: string | undefined;
+  retrievals?: Array<string> | undefined;
+  expectedOutput?: string | undefined;
+};
+
+/** @internal */
+export type StructuredInput$Outbound = {
+  system_instructions?: string | undefined;
+  user_query?: string | undefined;
+  retrievals?: Array<string> | undefined;
+  expected_output?: string | undefined;
+};
+
+/** @internal */
+export const StructuredInput$outboundSchema: z.ZodType<
+  StructuredInput$Outbound,
+  z.ZodTypeDef,
+  StructuredInput
+> = z.object({
+  systemInstructions: z.string().optional(),
+  userQuery: z.string().optional(),
+  retrievals: z.array(z.string()).optional(),
+  expectedOutput: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    systemInstructions: "system_instructions",
+    userQuery: "user_query",
+    expectedOutput: "expected_output",
+  });
+});
+
+export function structuredInputToJSON(
+  structuredInput: StructuredInput,
+): string {
+  return JSON.stringify(StructuredInput$outboundSchema.parse(structuredInput));
+}

package/src/models/components/structuredoutput.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 {
+  StructuredToolCall,
+  StructuredToolCall$Outbound,
+  StructuredToolCall$outboundSchema,
+} from "./structuredtoolcall.js";
+
+export type StructuredOutput = {
+  response?: string | undefined;
+  toolsCalled?: Array<StructuredToolCall> | undefined;
+};
+
+/** @internal */
+export type StructuredOutput$Outbound = {
+  response?: string | undefined;
+  tools_called?: Array<StructuredToolCall$Outbound> | undefined;
+};
+
+/** @internal */
+export const StructuredOutput$outboundSchema: z.ZodType<
+  StructuredOutput$Outbound,
+  z.ZodTypeDef,
+  StructuredOutput
+> = z.object({
+  response: z.string().optional(),
+  toolsCalled: z.array(StructuredToolCall$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    toolsCalled: "tools_called",
+  });
+});
+
+export function structuredOutputToJSON(
+  structuredOutput: StructuredOutput,
+): string {
+  return JSON.stringify(
+    StructuredOutput$outboundSchema.parse(structuredOutput),
+  );
+}

package/src/models/components/structuredtoolcall.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * StructuredToolCall mirrors one tool invocation and its result. Name is the
+ *
+ * @remarks
+ *  only field the grader requires; a call without one is dropped.
+ */
+export type StructuredToolCall = {
+  name?: string | undefined;
+  arguments?: string | undefined;
+  output?: string | undefined;
+};
+
+/** @internal */
+export type StructuredToolCall$Outbound = {
+  name?: string | undefined;
+  arguments?: string | undefined;
+  output?: string | undefined;
+};
+
+/** @internal */
+export const StructuredToolCall$outboundSchema: z.ZodType<
+  StructuredToolCall$Outbound,
+  z.ZodTypeDef,
+  StructuredToolCall
+> = z.object({
+  name: z.string().optional(),
+  arguments: z.string().optional(),
+  output: z.string().optional(),
+});
+
+export function structuredToolCallToJSON(
+  structuredToolCall: StructuredToolCall,
+): string {
+  return JSON.stringify(
+    StructuredToolCall$outboundSchema.parse(structuredToolCall),
+  );
+}

package/src/models/components/updateguardrailrulerequest.ts

@@ -27,7 +27,6 @@ export type UpdateGuardrailRuleRequest = {
   expression?: GuardrailRuleExpression | undefined;
   guardrails?: Array<GuardrailRuleGuardrail> | undefined;
   plugins?: Array<GuardrailRulePlugin> | undefined;
-  timeout?: number | undefined;
 };
 
 /** @internal */
@@ -38,7 +37,6 @@ export type UpdateGuardrailRuleRequest$Outbound = {
   expression?: GuardrailRuleExpression$Outbound | undefined;
   guardrails?: Array<GuardrailRuleGuardrail$Outbound> | undefined;
   plugins?: Array<GuardrailRulePlugin$Outbound> | undefined;
-  timeout?: number | undefined;
 };
 
 /** @internal */
@@ -53,7 +51,6 @@ export const UpdateGuardrailRuleRequest$outboundSchema: z.ZodType<
   expression: GuardrailRuleExpression$outboundSchema.optional(),
   guardrails: z.array(GuardrailRuleGuardrail$outboundSchema).optional(),
   plugins: z.array(GuardrailRulePlugin$outboundSchema).optional(),
-  timeout: z.number().int().optional(),
 }).transform((v) => {
   return remap$(v, {
     displayName: "display_name",

package/src/models/components/updatememorydocumentrequest.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type UpdateMemoryDocumentRequest = {
+  /**
+   * The content of the memory document (whitespace trimmed).
+   */
+  text?: string | undefined;
+  /**
+   * Flexible key-value pairs for custom filtering and categorization. Clients can add arbitrary string metadata to enable future filtering of memory documents based on their specific needs.
+   */
+  metadata?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export type UpdateMemoryDocumentRequest$Outbound = {
+  text?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const UpdateMemoryDocumentRequest$outboundSchema: z.ZodType<
+  UpdateMemoryDocumentRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateMemoryDocumentRequest
+> = z.object({
+  text: z.string().optional(),
+  metadata: z.record(z.string()).optional(),
+});
+
+export function updateMemoryDocumentRequestToJSON(
+  updateMemoryDocumentRequest: UpdateMemoryDocumentRequest,
+): string {
+  return JSON.stringify(
+    UpdateMemoryDocumentRequest$outboundSchema.parse(
+      updateMemoryDocumentRequest,
+    ),
+  );
+}

package/src/models/components/updatememoryrequest.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type UpdateMemoryRequest = {
+  metadata?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export type UpdateMemoryRequest$Outbound = {
+  metadata?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const UpdateMemoryRequest$outboundSchema: z.ZodType<
+  UpdateMemoryRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateMemoryRequest
+> = z.object({
+  metadata: z.record(z.string()).optional(),
+});
+
+export function updateMemoryRequestToJSON(
+  updateMemoryRequest: UpdateMemoryRequest,
+): string {
+  return JSON.stringify(
+    UpdateMemoryRequest$outboundSchema.parse(updateMemoryRequest),
+  );
+}

package/src/models/components/updatememorystorerequest.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type UpdateMemoryStoreRequest = {
+  description?: string | undefined;
+  ttl?: number | null | undefined;
+  path?: string | undefined;
+};
+
+/** @internal */
+export type UpdateMemoryStoreRequest$Outbound = {
+  description?: string | undefined;
+  ttl?: number | null | undefined;
+  path?: string | undefined;
+};
+
+/** @internal */
+export const UpdateMemoryStoreRequest$outboundSchema: z.ZodType<
+  UpdateMemoryStoreRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateMemoryStoreRequest
+> = z.object({
+  description: z.string().optional(),
+  ttl: z.nullable(z.number()).optional(),
+  path: z.string().optional(),
+});
+
+export function updateMemoryStoreRequestToJSON(
+  updateMemoryStoreRequest: UpdateMemoryStoreRequest,
+): string {
+  return JSON.stringify(
+    UpdateMemoryStoreRequest$outboundSchema.parse(updateMemoryStoreRequest),
+  );
+}

package/src/models/components/updatenotifierrequest.ts

@@ -9,7 +9,7 @@ import { NotifierType, NotifierType$outboundSchema } from "./notifiertype.js";
 /**
  * Optional. Replacement custom JSON metadata.
  */
-export type Metadata = {};
+export type UpdateNotifierRequestMetadata = {};
 
 /**
  * Optional replacement generic webhook headers. Secret header values returned by GET or LIST are masked as an empty string; omit those entries or replace them with the real value when updating.
@@ -31,7 +31,7 @@ export type UpdateNotifierRequest = {
   /**
    * Optional. Replacement custom JSON metadata.
    */
-  metadata?: Metadata | undefined;
+  metadata?: UpdateNotifierRequestMetadata | undefined;
   type?: NotifierType | undefined;
   /**
    * Optional replacement email recipients. Required when changing `type` to `NOTIFIER_TYPE_EMAIL`.
@@ -52,17 +52,23 @@ export type UpdateNotifierRequest = {
 };
 
 /** @internal */
-export type Metadata$Outbound = {};
+export type UpdateNotifierRequestMetadata$Outbound = {};
 
 /** @internal */
-export const Metadata$outboundSchema: z.ZodType<
-  Metadata$Outbound,
+export const UpdateNotifierRequestMetadata$outboundSchema: z.ZodType<
+  UpdateNotifierRequestMetadata$Outbound,
   z.ZodTypeDef,
-  Metadata
+  UpdateNotifierRequestMetadata
 > = z.object({});
 
-export function metadataToJSON(metadata: Metadata): string {
-  return JSON.stringify(Metadata$outboundSchema.parse(metadata));
+export function updateNotifierRequestMetadataToJSON(
+  updateNotifierRequestMetadata: UpdateNotifierRequestMetadata,
+): string {
+  return JSON.stringify(
+    UpdateNotifierRequestMetadata$outboundSchema.parse(
+      updateNotifierRequestMetadata,
+    ),
+  );
 }
 
 /** @internal */
@@ -83,7 +89,7 @@ export function headersToJSON(headers: Headers): string {
 export type UpdateNotifierRequest$Outbound = {
   project_id?: string | undefined;
   display_name?: string | undefined;
-  metadata?: Metadata$Outbound | undefined;
+  metadata?: UpdateNotifierRequestMetadata$Outbound | undefined;
   type?: string | undefined;
   emails?: Array<string> | undefined;
   incoming_webhook_url?: string | undefined;
@@ -99,7 +105,8 @@ export const UpdateNotifierRequest$outboundSchema: z.ZodType<
 > = z.object({
   projectId: z.string().optional(),
   displayName: z.string().optional(),
-  metadata: z.lazy(() => Metadata$outboundSchema).optional(),
+  metadata: z.lazy(() => UpdateNotifierRequestMetadata$outboundSchema)
+    .optional(),
   type: NotifierType$outboundSchema.optional(),
   emails: z.array(z.string()).optional(),
   incomingWebhookUrl: z.string().optional(),