@fonoster/sdk 0.17.4 → 0.18.0

package/dist/node/Applications.d.ts

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Application, BaseApiObject, CreateApplicationRequest, EvaluateIntelligenceRequest, EvaluateIntelligenceResponse, ListApplicationsRequest, ListApplicationsResponse, UpdateApplicationRequest } from "@fonoster/types";
+import { Application, BaseApiObject, CreateApplicationRequest, EvaluateIntelligenceEvent, EvaluateIntelligenceRequest, ListApplicationsRequest, ListApplicationsResponse, UpdateApplicationRequest } from "@fonoster/types";
 import { FonosterClient } from "./client/types";
 import { TestTokenResponse } from "./generated/node/applications_pb";
 /**
@@ -213,62 +213,18 @@ declare class Applications {
      * @param {EvaluateIntelligenceRequest} request - The request object that contains the necessary information to evaluate the intelligence of an application
      * @param {string} request.intelligence.productRef - The product reference of the intelligence engine (e.g., llm.groq)
      * @param {object} request.intelligence.config - The configuration object for the intelligence engine
-     * @return {Promise<ScenarioEvaluationReport>} - The response object that contains the evaluation report
+     * @return {AsyncGenerator<EvaluateIntelligenceEvent>} - Stream of evaluation events (step results, scenario summaries, or errors)
      * @example
-     * const apps = new SDK.Applications(client); // Existing client object
-     *
-     * const request = {
-     *   intelligence: {
-     *     productRef: "llm.groq",
-     *     config: {
-     *       conversationSettings: {
-     *         firstMessage: "Hello, how can I help you today?",
-     *         systemPrompt: "You are a helpful assistant.",
-     *         systemErrorMessage: "I'm sorry, I didn't catch that. Can you say that again?",
-     *         goodbyeMessage: "Thank you for calling. Have a great day!",
-     *         languageModel: {
-     *           provider: "openai",
-     *           model: "gpt-4o"
-     *         },
-     *         testCases: {
-     *           evalsLanguageModel: {
-     *             provider: "openai",
-     *             model: "gpt-4o"
-     *           },
-     *           scenarios: [
-     *             {
-     *               ref: "Scenario 1",
-     *               description: "Scenario 1 description",
-     *               telephonyContext: {
-     *                 callDirection: "FROM_PSTN",
-     *                 ingressNumber: "1234567890",
-     *                 callerNumber: "1234567890"
-     *               },
-     *               conversation: [
-     *                 {
-     *                   userInput: "Hello, how can I help you today?",
-     *                   expected: {
-     *                     text: {
-     *                       type: "EXACT",
-     *                       response: "Hello, how can I help you today?"
-     *                     }
-     *                   }
-     *                 }
-     *               ]
-     *             }
-     *           ]
-     *         }
-     *       }
-     *     }
-     *   }
-     * };
-     *
-     * apps
-     *   .evaluateIntelligence(request)
-     *   .then(console.log) // successful response
-     *   .catch(console.error); // an error occurred
+     * const apps = new SDK.Applications(client);
+     * for await (const event of apps.evaluateIntelligence(request)) {
+     *   if (event.type === "stepResult") console.log(event.stepResult);
+     *   if (event.type === "scenarioSummary") console.log(event.scenarioRef, event.overallPassed);
+     *   if (event.type === "evalError") console.error(event.message);
+     * }
      */
-    evaluateIntelligence(request: EvaluateIntelligenceRequest): Promise<EvaluateIntelligenceResponse>;
+    evaluateIntelligence(request: EvaluateIntelligenceRequest): AsyncGenerator<EvaluateIntelligenceEvent>;
+    private evaluateIntelligenceStreamGenerator;
+    private mapEvalEventFromPb;
     /**
      * Creates an Ephemeral Agent token for test calls.
      *

package/dist/node/Applications.js

@@ -293,81 +293,95 @@ class Applications {
      * @param {EvaluateIntelligenceRequest} request - The request object that contains the necessary information to evaluate the intelligence of an application
      * @param {string} request.intelligence.productRef - The product reference of the intelligence engine (e.g., llm.groq)
      * @param {object} request.intelligence.config - The configuration object for the intelligence engine
-     * @return {Promise<ScenarioEvaluationReport>} - The response object that contains the evaluation report
+     * @return {AsyncGenerator<EvaluateIntelligenceEvent>} - Stream of evaluation events (step results, scenario summaries, or errors)
      * @example
-     * const apps = new SDK.Applications(client); // Existing client object
-     *
-     * const request = {
-     *   intelligence: {
-     *     productRef: "llm.groq",
-     *     config: {
-     *       conversationSettings: {
-     *         firstMessage: "Hello, how can I help you today?",
-     *         systemPrompt: "You are a helpful assistant.",
-     *         systemErrorMessage: "I'm sorry, I didn't catch that. Can you say that again?",
-     *         goodbyeMessage: "Thank you for calling. Have a great day!",
-     *         languageModel: {
-     *           provider: "openai",
-     *           model: "gpt-4o"
-     *         },
-     *         testCases: {
-     *           evalsLanguageModel: {
-     *             provider: "openai",
-     *             model: "gpt-4o"
-     *           },
-     *           scenarios: [
-     *             {
-     *               ref: "Scenario 1",
-     *               description: "Scenario 1 description",
-     *               telephonyContext: {
-     *                 callDirection: "FROM_PSTN",
-     *                 ingressNumber: "1234567890",
-     *                 callerNumber: "1234567890"
-     *               },
-     *               conversation: [
-     *                 {
-     *                   userInput: "Hello, how can I help you today?",
-     *                   expected: {
-     *                     text: {
-     *                       type: "EXACT",
-     *                       response: "Hello, how can I help you today?"
-     *                     }
-     *                   }
-     *                 }
-     *               ]
-     *             }
-     *           ]
-     *         }
-     *       }
-     *     }
-     *   }
-     * };
-     *
-     * apps
-     *   .evaluateIntelligence(request)
-     *   .then(console.log) // successful response
-     *   .catch(console.error); // an error occurred
+     * const apps = new SDK.Applications(client);
+     * for await (const event of apps.evaluateIntelligence(request)) {
+     *   if (event.type === "stepResult") console.log(event.stepResult);
+     *   if (event.type === "scenarioSummary") console.log(event.scenarioRef, event.overallPassed);
+     *   if (event.type === "evalError") console.error(event.message);
+     * }
      */
-    async evaluateIntelligence(request) {
+    evaluateIntelligence(request) {
         const applicationsClient = this.client.getApplicationsClient();
-        const response = await (0, makeRpcRequest_1.makeRpcRequest)({
-            method: applicationsClient.evaluateIntelligence.bind(applicationsClient),
-            requestPBObjectConstructor: applications_pb_1.EvaluateIntelligenceRequest,
-            metadata: this.client.getMetadata(),
-            request: {
-                intelligence: {
-                    productRef: request.intelligence.productRef,
-                    config: struct_pb_1.Struct.fromJavaScript(request.intelligence.config)
-                }
-            },
-            enumMapping: [["ExpectedTextType", types_1.ExpectedTextType]],
-            objectMapping: [["intelligence", applications_pb_1.ProductContainer]],
-            repeatableObjectMapping: [
-                ["resultsList", applications_pb_1.ScenarioEvaluationReport],
-                ["stepsList", applications_pb_1.StepEvaluationReport]
-            ]
+        const requestPB = new applications_pb_1.EvaluateIntelligenceRequest();
+        const productContainer = new applications_pb_1.ProductContainer();
+        productContainer.setProductRef(request.intelligence.productRef);
+        productContainer.setConfig(struct_pb_1.Struct.fromJavaScript(request.intelligence.config));
+        requestPB.setIntelligence(productContainer);
+        const metadata = this.client.getMetadata();
+        const call = applicationsClient.evaluateIntelligence(requestPB, metadata);
+        return this.evaluateIntelligenceStreamGenerator(call);
+    }
+    async *evaluateIntelligenceStreamGenerator(call) {
+        const queue = [];
+        let done = false;
+        let streamError = null;
+        call.on("data", (chunk) => {
+            const event = this.mapEvalEventFromPb(chunk);
+            if (event)
+                queue.push(event);
         });
-        return response;
+        call.on("end", () => {
+            done = true;
+        });
+        call.on("error", (err) => {
+            streamError = err instanceof Error ? err : new Error(String(err));
+            done = true;
+        });
+        while (!done || queue.length > 0) {
+            if (streamError)
+                throw streamError;
+            if (queue.length > 0) {
+                const next = queue.shift();
+                yield next;
+            }
+            else {
+                await new Promise((r) => setTimeout(r, 50));
+            }
+        }
+    }
+    mapEvalEventFromPb(msg) {
+        if (msg.getStepResult?.()) {
+            const sr = msg.getStepResult();
+            const report = sr.getReport();
+            const toolList = report.getToolEvaluationsList?.() ?? [];
+            return {
+                type: "stepResult",
+                scenarioRef: sr.getScenarioRef(),
+                stepResult: {
+                    humanInput: report.getHumanInput(),
+                    expectedResponse: report.getExpectedResponse(),
+                    aiResponse: report.getAiResponse(),
+                    evaluationType: report.getEvaluationType() === 0
+                        ? types_1.ExpectedTextType.EXACT
+                        : types_1.ExpectedTextType.SIMILAR,
+                    passed: report.getPassed(),
+                    errorMessage: report.getErrorMessage() || undefined,
+                    toolEvaluations: toolList.map((t) => ({
+                        expectedTool: t.getExpectedTool(),
+                        actualTool: t.getActualTool(),
+                        passed: t.getPassed(),
+                        expectedParameters: t.getExpectedParameters?.()?.toJavaScript() ?? undefined,
+                        actualParameters: t.getActualParameters?.()?.toJavaScript() ?? undefined,
+                        errorMessage: t.getErrorMessage?.() || undefined
+                    }))
+                }
+            };
+        }
+        if (msg.getScenarioSummary?.()) {
+            const ss = msg.getScenarioSummary();
+            return {
+                type: "scenarioSummary",
+                scenarioRef: ss.getScenarioRef(),
+                overallPassed: ss.getOverallPassed()
+            };
+        }
+        if (msg.getEvalError?.()) {
+            const e = msg.getEvalError();
+            return { type: "evalError", message: e.getMessage() };
+        }
+        return null;
     }
     /**
      * Creates an Ephemeral Agent token for test calls.

package/dist/node/client/types/ApplicationsClient.d.ts

@@ -17,15 +17,16 @@
  * limitations under the License.
  */
 import { Empty } from "google-protobuf/google/protobuf/empty_pb";
-import { Application, CreateApplicationRequest, CreateApplicationResponse, DeleteApplicationRequest, DeleteApplicationResponse, EvaluateIntelligenceRequest, EvaluateIntelligenceResponse, GetApplicationRequest, ListApplicationsRequest, ListApplicationsResponse, TestTokenResponse, UpdateApplicationRequest, UpdateApplicationResponse } from "../../generated/web/applications_pb";
+import { Application, CreateApplicationRequest, CreateApplicationResponse, DeleteApplicationRequest, DeleteApplicationResponse, EvaluateIntelligenceEvent, EvaluateIntelligenceRequest, GetApplicationRequest, ListApplicationsRequest, ListApplicationsResponse, TestTokenResponse, UpdateApplicationRequest, UpdateApplicationResponse } from "../../generated/web/applications_pb";
 import { ClientFunction } from "./common";
+import type { ClientReadableStream } from "grpc-web";
 type ApplicationsClient = {
     createApplication: ClientFunction<CreateApplicationRequest, CreateApplicationResponse>;
     getApplication: ClientFunction<GetApplicationRequest, Application>;
     updateApplication: ClientFunction<UpdateApplicationRequest, UpdateApplicationResponse>;
     listApplications: ClientFunction<ListApplicationsRequest, ListApplicationsResponse>;
     deleteApplication: ClientFunction<DeleteApplicationRequest, DeleteApplicationResponse>;
-    evaluateIntelligence: ClientFunction<EvaluateIntelligenceRequest, EvaluateIntelligenceResponse>;
+    evaluateIntelligence: (request: EvaluateIntelligenceRequest, metadata?: Record<string, string> | null) => ClientReadableStream<EvaluateIntelligenceEvent>;
     createTestToken: ClientFunction<Empty, TestTokenResponse>;
 };
 export { ApplicationsClient };

package/dist/node/generated/node/applications_grpc_pb.js

@@ -79,26 +79,26 @@ function deserialize_fonoster_applications_v1beta2_DeleteApplicationResponse(buf
   return applications_pb.DeleteApplicationResponse.deserializeBinary(new Uint8Array(buffer_arg));
 }
 
-function serialize_fonoster_applications_v1beta2_EvaluateIntelligenceRequest(arg) {
-  if (!(arg instanceof applications_pb.EvaluateIntelligenceRequest)) {
-    throw new Error('Expected argument of type fonoster.applications.v1beta2.EvaluateIntelligenceRequest');
+function serialize_fonoster_applications_v1beta2_EvaluateIntelligenceEvent(arg) {
+  if (!(arg instanceof applications_pb.EvaluateIntelligenceEvent)) {
+    throw new Error('Expected argument of type fonoster.applications.v1beta2.EvaluateIntelligenceEvent');
   }
   return Buffer.from(arg.serializeBinary());
 }
 
-function deserialize_fonoster_applications_v1beta2_EvaluateIntelligenceRequest(buffer_arg) {
-  return applications_pb.EvaluateIntelligenceRequest.deserializeBinary(new Uint8Array(buffer_arg));
+function deserialize_fonoster_applications_v1beta2_EvaluateIntelligenceEvent(buffer_arg) {
+  return applications_pb.EvaluateIntelligenceEvent.deserializeBinary(new Uint8Array(buffer_arg));
 }
 
-function serialize_fonoster_applications_v1beta2_EvaluateIntelligenceResponse(arg) {
-  if (!(arg instanceof applications_pb.EvaluateIntelligenceResponse)) {
-    throw new Error('Expected argument of type fonoster.applications.v1beta2.EvaluateIntelligenceResponse');
+function serialize_fonoster_applications_v1beta2_EvaluateIntelligenceRequest(arg) {
+  if (!(arg instanceof applications_pb.EvaluateIntelligenceRequest)) {
+    throw new Error('Expected argument of type fonoster.applications.v1beta2.EvaluateIntelligenceRequest');
   }
   return Buffer.from(arg.serializeBinary());
 }
 
-function deserialize_fonoster_applications_v1beta2_EvaluateIntelligenceResponse(buffer_arg) {
-  return applications_pb.EvaluateIntelligenceResponse.deserializeBinary(new Uint8Array(buffer_arg));
+function deserialize_fonoster_applications_v1beta2_EvaluateIntelligenceRequest(buffer_arg) {
+  return applications_pb.EvaluateIntelligenceRequest.deserializeBinary(new Uint8Array(buffer_arg));
 }
 
 function serialize_fonoster_applications_v1beta2_GetApplicationRequest(arg) {
@@ -241,17 +241,17 @@ deleteApplication: {
     responseSerialize: serialize_fonoster_applications_v1beta2_DeleteApplicationResponse,
     responseDeserialize: deserialize_fonoster_applications_v1beta2_DeleteApplicationResponse,
   },
-  // Evaluate the intelligence for an Autopilot application
+  // Evaluate the intelligence for an Autopilot application (server streaming)
 evaluateIntelligence: {
     path: '/fonoster.applications.v1beta2.Applications/EvaluateIntelligence',
     requestStream: false,
-    responseStream: false,
+    responseStream: true,
     requestType: applications_pb.EvaluateIntelligenceRequest,
-    responseType: applications_pb.EvaluateIntelligenceResponse,
+    responseType: applications_pb.EvaluateIntelligenceEvent,
     requestSerialize: serialize_fonoster_applications_v1beta2_EvaluateIntelligenceRequest,
     requestDeserialize: deserialize_fonoster_applications_v1beta2_EvaluateIntelligenceRequest,
-    responseSerialize: serialize_fonoster_applications_v1beta2_EvaluateIntelligenceResponse,
-    responseDeserialize: deserialize_fonoster_applications_v1beta2_EvaluateIntelligenceResponse,
+    responseSerialize: serialize_fonoster_applications_v1beta2_EvaluateIntelligenceEvent,
+    responseDeserialize: deserialize_fonoster_applications_v1beta2_EvaluateIntelligenceEvent,
   },
   // Create an Ephemeral Agent to perform test calls to an application
 createTestToken: {