@nuancelabs/js-sdk 0.4.0 → 0.5.0

package/index.d.ts

@@ -318,6 +318,26 @@ export declare interface CreateNuanceConversationOptions {
      * ```
      */
     token?: () => Promise<string>;
+    /**
+     * Who the avatar is in the conversation, such as your own
+     * {@link SessionPersonality.system_prompt}. Left out, it is the default
+     * personality.
+     *
+     * Only for a conversation the SDK creates with your API key (see
+     * {@link CreateNuanceConversationOptions.headers}). With a
+     * {@link CreateNuanceConversationOptions.token}, set it when your server
+     * mints the token instead: the token fixes it, and a conversation that sets
+     * its own is refused.
+     *
+     * @example
+     * ```ts
+     * createNuanceConversation({
+     *   headers: () => ({ Authorization: `Bearer ${process.env.NUANCE_API_KEY}` }),
+     *   personality: { system_prompt: "You are Sam, at Acme Bank..." },
+     * });
+     * ```
+     */
+    personality?: PersonalityChoice;
     /**
      * Capture constraints for the user's camera.
      *
@@ -402,6 +422,12 @@ export declare type MediaErrorReason = "permission-denied" | "device-not-found"
  */
 export declare type NetworkQuality = "good" | "poor" | "lost";
 
+/**
+ * Who the avatar is in a conversation created with
+ * {@link CreateNuanceConversationOptions.personality}.
+ */
+export declare interface PersonalityChoice extends SessionPersonality {
+}
 
 /**
  * Raised by {@link Conversation.connect} when the server refuses a new session
@@ -424,6 +450,34 @@ export declare type SessionEndReason = "time-limit" | "ended" | "policy-violatio
 
 
 
+/** Who the avatar is in a conversation. */
+export declare interface SessionPersonality {
+    /**
+     * Your own prompt: who the avatar is, where it works, and what it knows
+     * about the person and the situation, written as you would brief a person
+     * before a call, in plain text.
+     */
+    system_prompt?: string;
+}
+
+/**
+ * What your server sends to `POST /session-tokens` with its API key. Every
+ * field is fixed for the conversation the token starts; send `{}` for the
+ * defaults.
+ */
+export declare interface SessionTokenRequest {
+    /** Who the avatar is in the conversation. Leave it out for the default personality. */
+    personality?: SessionPersonality;
+}
+
+/** What `POST /session-tokens` returns. */
+export declare interface SessionTokenResponse {
+    /** The session token, `st_…`: pass it to {@link CreateNuanceConversationOptions.token}. */
+    token: string;
+    /** When the token stops being able to start a conversation (UTC, ISO 8601). */
+    expires_at: string;
+}
+
 /** When the avatar starts speaking: see {@link CreateNuanceConversationOptions.startOn}. */
 export declare type StartOn = "first-frame" | "full-quality";
 

package/index.js

@@ -4,7 +4,7 @@ function isRecord(value) {
 }
 
 // src/core/sdk-version.ts
-var SDK_HEADER = `js/${"0.4.0"}`;
+var SDK_HEADER = `js/${"0.5.0"}`;
 
 // src/utils.ts
 function normalizeHost(host) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuancelabs/js-sdk",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "JavaScript SDK for Nuance Labs conversation video AI avatar",
   "license": "UNLICENSED",
   "repository": {