@fonoster/sdk 0.15.0 → 0.15.2

package/README.md

@@ -711,6 +711,7 @@ Note that an active Fonoster deployment is required.
     * [.updateApplication(request)](#Applications+updateApplication) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
     * [.listApplications(request)](#Applications+listApplications) ⇒ <code>Promise.&lt;ListApplicationsResponse&gt;</code>
     * [.deleteApplication(ref)](#Applications+deleteApplication) ⇒ <code>Promise.&lt;BaseApiObject&gt;</code>
+    * [.evaluateIntelligence(request)](#Applications+evaluateIntelligence) ⇒ <code>Promise.&lt;ScenarioEvaluationReport&gt;</code>
 
 <a name="new_Applications_new"></a>
 
@@ -930,6 +931,75 @@ apps
   .then(console.log) // successful response
   .catch(console.error); // an error occurred
 ```
+<a name="Applications+evaluateIntelligence"></a>
+
+### applications.evaluateIntelligence(request) ⇒ <code>Promise.&lt;ScenarioEvaluationReport&gt;</code>
+Evaluates the intelligence of an application.
+
+**Kind**: instance method of [<code>Applications</code>](#Applications)  
+**Returns**: <code>Promise.&lt;ScenarioEvaluationReport&gt;</code> - - The response object that contains the evaluation report  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>EvaluateIntelligenceRequest</code> | The request object that contains the necessary information to evaluate the intelligence of an application |
+| request.intelligence.productRef | <code>string</code> | The product reference of the intelligence engine (e.g., llm.groq) |
+| request.intelligence.config | <code>object</code> | The configuration object for the intelligence engine |
+
+**Example**  
+```js
+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
+```
 
 <a name="Calls"></a>
 

package/dist/node/Applications.d.ts

@@ -18,6 +18,7 @@
  */
 import { Application, BaseApiObject, CreateApplicationRequest, EvaluateIntelligenceRequest, EvaluateIntelligenceResponse, ListApplicationsRequest, ListApplicationsResponse, UpdateApplicationRequest } from "@fonoster/types";
 import { FonosterClient } from "./client/types";
+import { TestTokenResponse } from "./generated/node/applications_pb";
 /**
  * @classdesc Fonoster Applications, part of the Fonoster Voice Subsystem,
  * allow you to create, update, retrieve, and delete Voice Applications.
@@ -268,5 +269,15 @@ declare class Applications {
      *   .catch(console.error); // an error occurred
      */
     evaluateIntelligence(request: EvaluateIntelligenceRequest): Promise<EvaluateIntelligenceResponse>;
+    /**
+     * Creates an Ephemeral Agent token for test calls.
+     *
+     * @return {Promise<TestTokenResponse>} - The response object containing the ephemeral agent token and related info
+     * @example
+     * const apps = new SDK.Applications(client);
+     * const response = await apps.createTestToken();
+     * console.log(response.token); // JWT token for test call
+     */
+    createTestToken(): Promise<TestTokenResponse.AsObject>;
 }
 export { Applications };

package/dist/node/Applications.js

@@ -20,6 +20,7 @@ exports.Applications = void 0;
  * limitations under the License.
  */
 const types_1 = require("@fonoster/types");
+const empty_pb_1 = require("google-protobuf/google/protobuf/empty_pb");
 const struct_pb_1 = require("google-protobuf/google/protobuf/struct_pb");
 const makeRpcRequest_1 = require("./client/makeRpcRequest");
 const applications_pb_1 = require("./generated/node/applications_pb");
@@ -368,5 +369,24 @@ class Applications {
         });
         return response;
     }
+    /**
+     * Creates an Ephemeral Agent token for test calls.
+     *
+     * @return {Promise<TestTokenResponse>} - The response object containing the ephemeral agent token and related info
+     * @example
+     * const apps = new SDK.Applications(client);
+     * const response = await apps.createTestToken();
+     * console.log(response.token); // JWT token for test call
+     */
+    async createTestToken() {
+        const applicationsClient = this.client.getApplicationsClient();
+        const response = await (0, makeRpcRequest_1.makeRpcRequest)({
+            method: applicationsClient.createTestToken.bind(applicationsClient),
+            requestPBObjectConstructor: empty_pb_1.Empty,
+            metadata: this.client.getMetadata(),
+            request: {}
+        });
+        return response;
+    }
 }
 exports.Applications = Applications;

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

@@ -16,7 +16,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Application, CreateApplicationRequest, CreateApplicationResponse, DeleteApplicationRequest, DeleteApplicationResponse, EvaluateIntelligenceRequest, EvaluateIntelligenceResponse, GetApplicationRequest, ListApplicationsRequest, ListApplicationsResponse, UpdateApplicationRequest, UpdateApplicationResponse } from "../../generated/web/applications_pb";
+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 { ClientFunction } from "./common";
 type ApplicationsClient = {
     createApplication: ClientFunction<CreateApplicationRequest, CreateApplicationResponse>;
@@ -25,5 +26,6 @@ type ApplicationsClient = {
     listApplications: ClientFunction<ListApplicationsRequest, ListApplicationsResponse>;
     deleteApplication: ClientFunction<DeleteApplicationRequest, DeleteApplicationResponse>;
     evaluateIntelligence: ClientFunction<EvaluateIntelligenceRequest, EvaluateIntelligenceResponse>;
+    createTestToken: ClientFunction<Empty, TestTokenResponse>;
 };
 export { ApplicationsClient };