RDBC-926 Refactor AI agent operations to simplify request creation, improve serialization, and enhance response parsing.

M4xymm · M4xymm · commit 3adacf16efd5 · 2025-08-26T12:45:13.000+02:00
diff --git a/src/Documents/Operations/AI/Agents/AddOrUpdateAiAgentOperation.ts b/src/Documents/Operations/AI/Agents/AddOrUpdateAiAgentOperation.ts
@@ -9,8 +9,6 @@ import { ServerNode } from "../../../../Http/ServerNode.js";
 import { HttpRequestParameters } from "../../../../Primitives/Http.js";
 import { RaftIdGenerator } from "../../../../Utility/RaftIdGenerator.js";
 import { throwError } from "../../../../Exceptions/index.js";
-import { ObjectUtil } from "../../../../Utility/ObjectUtil.js";
-import { JsonSerializer } from "../../../../Mapping/Json/Serializer.js";
 import { HeadersBuilder } from "../../../../Utility/HttpUtil.js";
 
 function hasNoSampleObjectOrSchema(configuration: AiAgentConfiguration) {
@@ -54,7 +52,7 @@ class AddOrUpdateAiAgentCommand extends RavenCommand<AiAgentConfigurationResult>
     public constructor(configuration: AiAgentConfiguration, sampleSchema: any, conventions: DocumentConventions) {
         super();
         if (hasNoSampleObjectOrSchema(configuration)) {
-            throw new Error("Please provide a non-empty value for either outputSchema or sampleObject.");
+            throwError("InvalidArgumentException", "Please provide a non-empty value for either outputSchema or sampleObject.");
         }
         this._configuration = configuration;
         this._sampleSchema = sampleSchema;
@@ -71,29 +69,18 @@ class AddOrUpdateAiAgentCommand extends RavenCommand<AiAgentConfigurationResult>
 
     createRequest(node: ServerNode): HttpRequestParameters {
         const uri = node.url + "/databases/" + node.database + "/admin/ai/agent";
-        const configToSend = {...this._configuration};
 
-        if (!configToSend.sampleObject && this._sampleSchema) {
-            configToSend.sampleObject = this._sampleSchema;
+        if (!this._configuration && this._sampleSchema) {
+            this._configuration.sampleObject = this._sampleSchema;
         }
 
-        const bodyToSerialize = {
-            ...configToSend,
-            parameters: configToSend.parameters ? Array.from(configToSend.parameters) : []
-        };
-
-        const bodyJson = ObjectUtil.transformObjectKeys(bodyToSerialize, {
-            defaultTransform: ObjectUtil.pascal
-        });
-
-        const body = JsonSerializer.getDefault().serialize(bodyJson);
+        const body = this._serializer.serialize(this._configuration);
 
         const headers = HeadersBuilder
             .create()
             .typeAppJson()
             .build();
 
-        console.log(uri);
         return {
             method: "PUT",
             uri,
diff --git a/src/Documents/Operations/AI/Agents/DeleteAiAgentOperation.ts b/src/Documents/Operations/AI/Agents/DeleteAiAgentOperation.ts
@@ -55,21 +55,6 @@ class DeleteAiAgentCommand extends RavenCommand<AiAgentConfigurationResult> {
             this._throwInvalidResponse();
         }
 
-        let body: string = "";
-        const result = await this._defaultPipeline()
-            .collectBody(b => body = b)
-            .process(bodyStream);
-
-        this.result = result as AiAgentConfigurationResult;
-        return body;
-        // let body = "";
-        // const data = await this._defaultPipeline<any>(_ => body = _).process(bodyStream);
-        //
-        // this.result = {
-        //     identifier: data?.Identifier ?? data?.identifier,
-        //     raftCommandIndex: data?.RaftCommandIndex ?? data?.raftCommandIndex
-        // } as AiAgentConfigurationResult;
-        //
-        // return body;
+        return this._parseResponseDefaultAsync(bodyStream)
     }
 }
diff --git a/src/Documents/Operations/AI/Agents/GetAiAgentsOperation.ts b/src/Documents/Operations/AI/Agents/GetAiAgentsOperation.ts
@@ -32,32 +32,28 @@ class GetAiAgentsCommand extends RavenCommand<GetAiAgentsResponse> {
         this._conventions = conventions;
     }
 
+    get isReadRequest(): boolean {
+        return true;
+    }
+
     createRequest(node: ServerNode): HttpRequestParameters {
         let uri = `${node.url}/databases/${node.database}/admin/ai/agent`;
+
         if (this._agentId) {
             uri += `?agentId=${encodeURIComponent(this._agentId)}`;
         }
+
         return {
             method: "GET",
             uri
         };
     }
 
-    get isReadRequest(): boolean {
-        return true;
-    }
-
     async setResponseAsync(bodyStream: Stream, fromCache: boolean): Promise<string> {
         if (!bodyStream) {
             this._throwInvalidResponse();
         }
 
-        let body: string = "";
-        const result = await this._defaultPipeline()
-            .collectBody(b => body = b)
-            .process(bodyStream);
-
-        this.result = result as GetAiAgentsResponse;
-        return body;
+        return this._parseResponseDefaultAsync(bodyStream);
     }
 }
diff --git a/src/Documents/Operations/AI/Agents/RunConversationOperation.ts b/src/Documents/Operations/AI/Agents/RunConversationOperation.ts
@@ -3,8 +3,6 @@ import { Stream } from "node:stream";
 import type { AiAgentActionResponse } from "./AiAgentActionResponse.js";
 import type { AiConversationCreationOptions } from "./AiConversationCreationOptions.js";
 import type { ConversationResult } from "./ConversationResult.js";
-import type { AiUsage } from "./AiUsage.js";
-import type { AiAgentActionRequest } from "./AiAgentActionRequest.js";
 import { RavenCommand } from "../../../../Http/RavenCommand.js";
 import { DocumentConventions } from "../../../Conventions/DocumentConventions.js";
 import { IRaftCommand } from "../../../../Http/IRaftCommand.js";
@@ -90,7 +88,6 @@ class RunConversationCommand<TAnswer>
         this._options = options;
         this._changeVector = changeVector;
 
-        // For new conversation IDs (ending with '|'), we need a raft id
         if (this._conversationId && this._conversationId.endsWith("|")) {
             this._raftId = RaftIdGenerator.newId();
         }
@@ -104,80 +101,48 @@ class RunConversationCommand<TAnswer>
         return this._raftId;
     }
 
-createRequest(node: ServerNode): HttpRequestParameters {
-    const uriParams = new URLSearchParams({
-        conversationId: this._conversationId,
-        agentId: this._agentId,
-    });
+    createRequest(node: ServerNode): HttpRequestParameters {
+        const uriParams = new URLSearchParams({
+            conversationId: this._conversationId,
+            agentId: this._agentId,
+        });
 
-    if (this._changeVector) {
-        uriParams.append("changeVector", this._changeVector);
-    }
+        if (this._changeVector) {
+            uriParams.append("changeVector", this._changeVector);
+        }
 
-    const uri = `${node.url}/databases/${node.database}/ai/agent?${uriParams}`;
+        const uri = `${node.url}/databases/${node.database}/ai/agent?${uriParams}`;
 
-    const bodyObj = {
-        ActionResponses: this._actionResponses,
-        UserPrompt: this._prompt,
-        CreationOptions: this._options
-    };
+        const bodyObj = {
+            ActionResponses: this._actionResponses,
+            UserPrompt: this._prompt,
+            CreationOptions: this._options
+        };
 
-    const headers = this._headers().typeAppJson().build();
+        const headers = this._headers().typeAppJson().build();
 
-    // Serialize to PascalCase but ignore the parameters property in CreationOptions
-    const serialized = ObjectUtil.transformObjectKeys(bodyObj, {
-        defaultTransform: ObjectUtil.pascalCase,
-        ignorePaths: [
-            new RegExp("^CreationOptions\\.Parameters\\..*$")
-        ]
-    });
+        // Serialize properties to PascalCase, except "parameters" in CreationOptions, which must keep user-provided, case-sensitive keys unchanged.
+        const serialized = ObjectUtil.transformObjectKeys(bodyObj, {
+            defaultTransform: ObjectUtil.pascalCase,
+            ignorePaths: [
+                new RegExp("^CreationOptions\\.Parameters\\..*$")
+            ]
+        });
 
 
-    return {
-        method: "POST",
-        uri,
-        headers,
-        body: JSON.stringify(serialized)
-    };
-}
+        return {
+            method: "POST",
+            uri,
+            headers,
+            body: JsonSerializer.getDefault().serialize(serialized)
+        };
+    }
 
     async setResponseAsync(bodyStream: Stream, fromCache: boolean): Promise<string> {
         if (!bodyStream) {
             this._throwInvalidResponse();
         }
 
-        let body = "";
-        const raw = await this._defaultPipeline<any>(_ => body = _).process(bodyStream);
-
-        // Normalize server PascalCase payload to our camelCase TS interface
-        const result: ConversationResult<TAnswer> = {
-            conversationId: raw?.ConversationId ?? raw?.conversationId,
-            changeVector: raw?.ChangeVector ?? raw?.changeVector,
-            response: (raw?.Response ?? raw?.response) as TAnswer,
-            totalUsage: normalizeUsage(raw?.TotalUsage ?? raw?.totalUsage),
-            actionRequests: normalizeActionRequests(raw?.ActionRequests ?? raw?.actionRequests)
-        };
-
-        this.result = result;
-        return body;
+        return this._parseResponseDefaultAsync(bodyStream)
     }
-}
-
-function normalizeUsage(u: any): AiUsage {
-    if (!u) return null;
-    return {
-        promptTokens: u.PromptTokens ?? u.promptTokens,
-        completionTokens: u.CompletionTokens ?? u.completionTokens,
-        totalTokens: u.TotalTokens ?? u.totalTokens,
-        cachedTokens: u.CachedTokens ?? u.cachedTokens
-    } as AiUsage;
-}
-
-function normalizeActionRequests(list: any[]): AiAgentActionRequest[] {
-    if (!Array.isArray(list)) return [];
-    return list.map(x => ({
-        name: x.Name ?? x.name,
-        toolId: x.ToolId ?? x.toolId,
-        arguments: x.Arguments ?? x.arguments
-    } as AiAgentActionRequest));
-}
+}
