@orq-ai/node 4.11.0-rc.9 → 4.12.0-rc.1

package/models/operations/createagentrequest.d.ts

@@ -157,6 +157,7 @@ export type Guardrails = {
      */
     executeOn: ExecuteOn;
 };
+export type Plugins = components.PIIRedactionPluginEn | components.PIIRedactionPluginNl | components.PIIRedactionPluginAuto;
 export type ModelConfigurationFallbacks = {
     /**
      * Fallback model identifier
@@ -349,6 +350,10 @@ export type ParametersT = {
      * A list of guardrails to apply to the request.
      */
     guardrails?: Array<Guardrails> | undefined;
+    /**
+     * Request-scoped transforms applied to the text exchanged with the model. Currently supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response.
+     */
+    plugins?: Array<components.PIIRedactionPluginEn | components.PIIRedactionPluginNl | components.PIIRedactionPluginAuto> | undefined;
     /**
      * Array of fallback models to use if primary model fails
      */
@@ -564,6 +569,7 @@ export type FallbackModelConfigurationGuardrails = {
      */
     executeOn: FallbackModelConfigurationExecuteOn;
 };
+export type FallbackModelConfigurationPlugins = components.PIIRedactionPluginEn | components.PIIRedactionPluginNl | components.PIIRedactionPluginAuto;
 export type FallbackModelConfigurationFallbacks = {
     /**
      * Fallback model identifier
@@ -756,6 +762,10 @@ export type FallbackModelConfigurationParameters = {
      * A list of guardrails to apply to the request.
      */
     guardrails?: Array<FallbackModelConfigurationGuardrails> | undefined;
+    /**
+     * Request-scoped transforms applied to the text exchanged with the model. Currently supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response.
+     */
+    plugins?: Array<components.PIIRedactionPluginEn | components.PIIRedactionPluginNl | components.PIIRedactionPluginAuto> | undefined;
     /**
      * Array of fallback models to use if primary model fails
      */
@@ -839,6 +849,12 @@ export type ProviderBuiltInTool = {
      * Whether this tool requires approval before execution
      */
     requiresApproval?: boolean | undefined;
+    /**
+     * Static tool configuration set at design time. Merged over LLM-provided arguments at execution time.
+     */
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /**
  * MCP tool type
@@ -1012,6 +1028,12 @@ export type CurrentDateTool = {
      * Whether this tool requires approval before execution
      */
     requiresApproval?: boolean | undefined;
+    /**
+     * Static tool configuration set at design time. Merged over LLM-provided arguments at execution time.
+     */
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestRequestBodySettingsTools10Type: {
     readonly QueryKnowledgeBase: "query_knowledge_base";
@@ -1026,6 +1048,12 @@ export type QueryKnowledgeBaseTool = {
      * Whether this tool requires approval before execution
      */
     requiresApproval?: boolean | undefined;
+    /**
+     * Static tool configuration set at design time. Merged over LLM-provided arguments at execution time.
+     */
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestRequestBodySettingsTools9Type: {
     readonly RetrieveKnowledgeBases: "retrieve_knowledge_bases";
@@ -1040,6 +1068,12 @@ export type RetrieveKnowledgeBasesTool = {
      * Whether this tool requires approval before execution
      */
     requiresApproval?: boolean | undefined;
+    /**
+     * Static tool configuration set at design time. Merged over LLM-provided arguments at execution time.
+     */
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestRequestBodySettingsTools8Type: {
     readonly DeleteMemoryDocument: "delete_memory_document";
@@ -1054,6 +1088,12 @@ export type DeleteMemoryDocumentTool = {
      * Whether this tool requires approval before execution
      */
     requiresApproval?: boolean | undefined;
+    /**
+     * Static tool configuration set at design time. Merged over LLM-provided arguments at execution time.
+     */
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestRequestBodySettingsToolsType: {
     readonly RetrieveMemoryStores: "retrieve_memory_stores";
@@ -1068,6 +1108,12 @@ export type RetrieveMemoryStoresTool = {
      * Whether this tool requires approval before execution
      */
     requiresApproval?: boolean | undefined;
+    /**
+     * Static tool configuration set at design time. Merged over LLM-provided arguments at execution time.
+     */
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestRequestBodySettingsType: {
     readonly WriteMemoryStore: "write_memory_store";
@@ -1082,6 +1128,12 @@ export type WriteMemoryStoreTool = {
      * Whether this tool requires approval before execution
      */
     requiresApproval?: boolean | undefined;
+    /**
+     * Static tool configuration set at design time. Merged over LLM-provided arguments at execution time.
+     */
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestRequestBodyType: {
     readonly QueryMemoryStore: "query_memory_store";
@@ -1096,6 +1148,12 @@ export type QueryMemoryStoreTool = {
      * Whether this tool requires approval before execution
      */
     requiresApproval?: boolean | undefined;
+    /**
+     * Static tool configuration set at design time. Merged over LLM-provided arguments at execution time.
+     */
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestType: {
     readonly RetrieveAgents: "retrieve_agents";
@@ -1110,6 +1168,12 @@ export type RetrieveAgentsTool = {
      * Whether this tool requires approval before execution
      */
     requiresApproval?: boolean | undefined;
+    /**
+     * Static tool configuration set at design time. Merged over LLM-provided arguments at execution time.
+     */
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 export declare const CreateAgentRequestAgentToolInputCRUDAgentsType: {
     readonly CallSubAgent: "call_sub_agent";
@@ -1124,6 +1188,12 @@ export type CallSubAgentTool = {
      * Whether this tool requires approval before execution
      */
     requiresApproval?: boolean | undefined;
+    /**
+     * Static tool configuration set at design time. Merged over LLM-provided arguments at execution time.
+     */
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 export declare const CreateAgentRequestAgentToolInputCRUDType: {
     readonly WebScraper: "web_scraper";
@@ -1138,6 +1208,12 @@ export type WebScraperTool = {
      * Whether this tool requires approval before execution
      */
     requiresApproval?: boolean | undefined;
+    /**
+     * Static tool configuration set at design time. Merged over LLM-provided arguments at execution time.
+     */
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 export declare const AgentToolInputCRUDType: {
     readonly GoogleSearch: "google_search";
@@ -1152,6 +1228,12 @@ export type GoogleSearchTool = {
      * Whether this tool requires approval before execution
      */
     requiresApproval?: boolean | undefined;
+    /**
+     * Static tool configuration set at design time. Merged over LLM-provided arguments at execution time.
+     */
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /**
  * Tool configuration for agent create/update operations. Built-in tools only require a type, while custom tools (HTTP, Code, Function, JSON Schema, MCP) must reference pre-created tools by key or id. Provider-prefixed tools (e.g., openai:web_search) are passed through to the provider.
@@ -1431,6 +1513,12 @@ export type CreateAgentRequestTools = {
      * Optional tool description
      */
     description?: string | undefined;
+    /**
+     * Static tool configuration set at design time. Merged over LLM-provided arguments at execution time.
+     */
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
     requiresApproval: boolean;
     /**
      * Nested tool ID for MCP tools (identifies specific tool within MCP server)
@@ -1673,6 +1761,7 @@ export type CreateAgentRequestAgentsResponseGuardrails = {
      */
     executeOn: CreateAgentRequestAgentsResponse201ApplicationJSONExecuteOn;
 };
+export type CreateAgentRequestPlugins = components.PIIRedactionPluginEn | components.PIIRedactionPluginNl | components.PIIRedactionPluginAuto;
 export type CreateAgentRequestFallbacks = {
     /**
      * Fallback model identifier
@@ -1865,6 +1954,10 @@ export type CreateAgentRequestParameters = {
      * A list of guardrails to apply to the request.
      */
     guardrails?: Array<CreateAgentRequestAgentsResponseGuardrails> | undefined;
+    /**
+     * Request-scoped transforms applied to the text exchanged with the model. Currently supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response.
+     */
+    plugins?: Array<components.PIIRedactionPluginEn | components.PIIRedactionPluginNl | components.PIIRedactionPluginAuto> | undefined;
     /**
      * Array of fallback models to use if primary model fails
      */
@@ -2057,6 +2150,7 @@ export type CreateAgentRequestFallbackModelConfigurationGuardrails = {
      */
     executeOn: CreateAgentRequestFallbackModelConfigurationExecuteOn;
 };
+export type CreateAgentRequestFallbackModelConfigurationPlugins = components.PIIRedactionPluginEn | components.PIIRedactionPluginNl | components.PIIRedactionPluginAuto;
 export type CreateAgentRequestFallbackModelConfigurationFallbacks = {
     /**
      * Fallback model identifier
@@ -2249,6 +2343,10 @@ export type CreateAgentRequestFallbackModelConfigurationParameters = {
      * A list of guardrails to apply to the request.
      */
     guardrails?: Array<CreateAgentRequestFallbackModelConfigurationGuardrails> | undefined;
+    /**
+     * Request-scoped transforms applied to the text exchanged with the model. Currently supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response.
+     */
+    plugins?: Array<components.PIIRedactionPluginEn | components.PIIRedactionPluginNl | components.PIIRedactionPluginAuto> | undefined;
     /**
      * Array of fallback models to use if primary model fails
      */
@@ -2492,6 +2590,11 @@ export type Guardrails$Outbound = {
 export declare const Guardrails$outboundSchema: z.ZodType<Guardrails$Outbound, z.ZodTypeDef, Guardrails>;
 export declare function guardrailsToJSON(guardrails: Guardrails): string;
 /** @internal */
+export type Plugins$Outbound = components.PIIRedactionPluginEn$Outbound | components.PIIRedactionPluginNl$Outbound | components.PIIRedactionPluginAuto$Outbound;
+/** @internal */
+export declare const Plugins$outboundSchema: z.ZodType<Plugins$Outbound, z.ZodTypeDef, Plugins>;
+export declare function pluginsToJSON(plugins: Plugins): string;
+/** @internal */
 export type ModelConfigurationFallbacks$Outbound = {
     model: string;
 };
@@ -2570,6 +2673,7 @@ export type ParametersT$Outbound = {
     parallel_tool_calls?: boolean | undefined;
     modalities?: Array<string> | null | undefined;
     guardrails?: Array<Guardrails$Outbound> | undefined;
+    plugins?: Array<components.PIIRedactionPluginEn$Outbound | components.PIIRedactionPluginNl$Outbound | components.PIIRedactionPluginAuto$Outbound> | undefined;
     fallbacks?: Array<ModelConfigurationFallbacks$Outbound> | undefined;
     cache?: Cache$Outbound | undefined;
     load_balancer?: LoadBalancer1$Outbound | undefined;
@@ -2695,6 +2799,11 @@ export type FallbackModelConfigurationGuardrails$Outbound = {
 export declare const FallbackModelConfigurationGuardrails$outboundSchema: z.ZodType<FallbackModelConfigurationGuardrails$Outbound, z.ZodTypeDef, FallbackModelConfigurationGuardrails>;
 export declare function fallbackModelConfigurationGuardrailsToJSON(fallbackModelConfigurationGuardrails: FallbackModelConfigurationGuardrails): string;
 /** @internal */
+export type FallbackModelConfigurationPlugins$Outbound = components.PIIRedactionPluginEn$Outbound | components.PIIRedactionPluginNl$Outbound | components.PIIRedactionPluginAuto$Outbound;
+/** @internal */
+export declare const FallbackModelConfigurationPlugins$outboundSchema: z.ZodType<FallbackModelConfigurationPlugins$Outbound, z.ZodTypeDef, FallbackModelConfigurationPlugins>;
+export declare function fallbackModelConfigurationPluginsToJSON(fallbackModelConfigurationPlugins: FallbackModelConfigurationPlugins): string;
+/** @internal */
 export type FallbackModelConfigurationFallbacks$Outbound = {
     model: string;
 };
@@ -2773,6 +2882,7 @@ export type FallbackModelConfigurationParameters$Outbound = {
     parallel_tool_calls?: boolean | undefined;
     modalities?: Array<string> | null | undefined;
     guardrails?: Array<FallbackModelConfigurationGuardrails$Outbound> | undefined;
+    plugins?: Array<components.PIIRedactionPluginEn$Outbound | components.PIIRedactionPluginNl$Outbound | components.PIIRedactionPluginAuto$Outbound> | undefined;
     fallbacks?: Array<FallbackModelConfigurationFallbacks$Outbound> | undefined;
     cache?: FallbackModelConfigurationCache$Outbound | undefined;
     load_balancer?: CreateAgentRequestLoadBalancer1$Outbound | undefined;
@@ -2811,6 +2921,9 @@ export declare const ToolApprovalRequired$outboundSchema: z.ZodNativeEnum<typeof
 export type ProviderBuiltInTool$Outbound = {
     type: string;
     requires_approval?: boolean | undefined;
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /** @internal */
 export declare const ProviderBuiltInTool$outboundSchema: z.ZodType<ProviderBuiltInTool$Outbound, z.ZodTypeDef, ProviderBuiltInTool>;
@@ -2882,6 +2995,9 @@ export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestRequestBod
 export type CurrentDateTool$Outbound = {
     type: string;
     requires_approval?: boolean | undefined;
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /** @internal */
 export declare const CurrentDateTool$outboundSchema: z.ZodType<CurrentDateTool$Outbound, z.ZodTypeDef, CurrentDateTool>;
@@ -2892,6 +3008,9 @@ export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestRequestBod
 export type QueryKnowledgeBaseTool$Outbound = {
     type: string;
     requires_approval?: boolean | undefined;
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /** @internal */
 export declare const QueryKnowledgeBaseTool$outboundSchema: z.ZodType<QueryKnowledgeBaseTool$Outbound, z.ZodTypeDef, QueryKnowledgeBaseTool>;
@@ -2902,6 +3021,9 @@ export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestRequestBod
 export type RetrieveKnowledgeBasesTool$Outbound = {
     type: string;
     requires_approval?: boolean | undefined;
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /** @internal */
 export declare const RetrieveKnowledgeBasesTool$outboundSchema: z.ZodType<RetrieveKnowledgeBasesTool$Outbound, z.ZodTypeDef, RetrieveKnowledgeBasesTool>;
@@ -2912,6 +3034,9 @@ export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestRequestBod
 export type DeleteMemoryDocumentTool$Outbound = {
     type: string;
     requires_approval?: boolean | undefined;
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /** @internal */
 export declare const DeleteMemoryDocumentTool$outboundSchema: z.ZodType<DeleteMemoryDocumentTool$Outbound, z.ZodTypeDef, DeleteMemoryDocumentTool>;
@@ -2922,6 +3047,9 @@ export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestRequestBod
 export type RetrieveMemoryStoresTool$Outbound = {
     type: string;
     requires_approval?: boolean | undefined;
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /** @internal */
 export declare const RetrieveMemoryStoresTool$outboundSchema: z.ZodType<RetrieveMemoryStoresTool$Outbound, z.ZodTypeDef, RetrieveMemoryStoresTool>;
@@ -2932,6 +3060,9 @@ export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestRequestBod
 export type WriteMemoryStoreTool$Outbound = {
     type: string;
     requires_approval?: boolean | undefined;
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /** @internal */
 export declare const WriteMemoryStoreTool$outboundSchema: z.ZodType<WriteMemoryStoreTool$Outbound, z.ZodTypeDef, WriteMemoryStoreTool>;
@@ -2942,6 +3073,9 @@ export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestRequestBod
 export type QueryMemoryStoreTool$Outbound = {
     type: string;
     requires_approval?: boolean | undefined;
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /** @internal */
 export declare const QueryMemoryStoreTool$outboundSchema: z.ZodType<QueryMemoryStoreTool$Outbound, z.ZodTypeDef, QueryMemoryStoreTool>;
@@ -2952,6 +3086,9 @@ export declare const CreateAgentRequestAgentToolInputCRUDAgentsRequestType$outbo
 export type RetrieveAgentsTool$Outbound = {
     type: string;
     requires_approval?: boolean | undefined;
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /** @internal */
 export declare const RetrieveAgentsTool$outboundSchema: z.ZodType<RetrieveAgentsTool$Outbound, z.ZodTypeDef, RetrieveAgentsTool>;
@@ -2962,6 +3099,9 @@ export declare const CreateAgentRequestAgentToolInputCRUDAgentsType$outboundSche
 export type CallSubAgentTool$Outbound = {
     type: string;
     requires_approval?: boolean | undefined;
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /** @internal */
 export declare const CallSubAgentTool$outboundSchema: z.ZodType<CallSubAgentTool$Outbound, z.ZodTypeDef, CallSubAgentTool>;
@@ -2972,6 +3112,9 @@ export declare const CreateAgentRequestAgentToolInputCRUDType$outboundSchema: z.
 export type WebScraperTool$Outbound = {
     type: string;
     requires_approval?: boolean | undefined;
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /** @internal */
 export declare const WebScraperTool$outboundSchema: z.ZodType<WebScraperTool$Outbound, z.ZodTypeDef, WebScraperTool>;
@@ -2982,6 +3125,9 @@ export declare const AgentToolInputCRUDType$outboundSchema: z.ZodNativeEnum<type
 export type GoogleSearchTool$Outbound = {
     type: string;
     requires_approval?: boolean | undefined;
+    configuration?: {
+        [k: string]: any;
+    } | undefined;
 };
 /** @internal */
 export declare const GoogleSearchTool$outboundSchema: z.ZodType<GoogleSearchTool$Outbound, z.ZodTypeDef, GoogleSearchTool>;
@@ -3157,6 +3303,9 @@ export declare const CreateAgentRequestAgentsResponse201ApplicationJSONExecuteOn
 export declare const CreateAgentRequestAgentsResponseGuardrails$inboundSchema: z.ZodType<CreateAgentRequestAgentsResponseGuardrails, z.ZodTypeDef, unknown>;
 export declare function createAgentRequestAgentsResponseGuardrailsFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestAgentsResponseGuardrails, SDKValidationError>;
 /** @internal */
+export declare const CreateAgentRequestPlugins$inboundSchema: z.ZodType<CreateAgentRequestPlugins, z.ZodTypeDef, unknown>;
+export declare function createAgentRequestPluginsFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestPlugins, SDKValidationError>;
+/** @internal */
 export declare const CreateAgentRequestFallbacks$inboundSchema: z.ZodType<CreateAgentRequestFallbacks, z.ZodTypeDef, unknown>;
 export declare function createAgentRequestFallbacksFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestFallbacks, SDKValidationError>;
 /** @internal */
@@ -3240,6 +3389,9 @@ export declare const CreateAgentRequestFallbackModelConfigurationExecuteOn$inbou
 export declare const CreateAgentRequestFallbackModelConfigurationGuardrails$inboundSchema: z.ZodType<CreateAgentRequestFallbackModelConfigurationGuardrails, z.ZodTypeDef, unknown>;
 export declare function createAgentRequestFallbackModelConfigurationGuardrailsFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestFallbackModelConfigurationGuardrails, SDKValidationError>;
 /** @internal */
+export declare const CreateAgentRequestFallbackModelConfigurationPlugins$inboundSchema: z.ZodType<CreateAgentRequestFallbackModelConfigurationPlugins, z.ZodTypeDef, unknown>;
+export declare function createAgentRequestFallbackModelConfigurationPluginsFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestFallbackModelConfigurationPlugins, SDKValidationError>;
+/** @internal */
 export declare const CreateAgentRequestFallbackModelConfigurationFallbacks$inboundSchema: z.ZodType<CreateAgentRequestFallbackModelConfigurationFallbacks, z.ZodTypeDef, unknown>;
 export declare function createAgentRequestFallbackModelConfigurationFallbacksFromJSON(jsonString: string): SafeParseResult<CreateAgentRequestFallbackModelConfigurationFallbacks, SDKValidationError>;
 /** @internal */