Skip to content

Commit 2ac2c08

Browse files
authored
Merge pull request #825 from watson-developer-cloud/regenerate-sdk-release-1-2019
Regenerate sdk release 1 2019
2 parents 93a152e + 10f5e5f commit 2ac2c08

File tree

21 files changed

+2799
-752
lines changed

21 files changed

+2799
-752
lines changed

assistant/v1.ts

Lines changed: 198 additions & 100 deletions
Large diffs are not rendered by default.

assistant/v2.ts

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ namespace AssistantV2 {
324324

325325
/** An object defining the message input to be sent to the assistant if the user selects the corresponding option. */
326326
export interface DialogNodeOutputOptionsElementValue {
327-
/** The user input. */
327+
/** An input object that includes the input text. */
328328
input?: MessageInput;
329329
}
330330

@@ -378,7 +378,7 @@ namespace AssistantV2 {
378378

379379
/** An object defining the message input to be sent to the assistant if the user selects the corresponding disambiguation option. */
380380
export interface DialogSuggestionValue {
381-
/** The user input. */
381+
/** An input object that includes the input text. */
382382
input?: MessageInput;
383383
}
384384

@@ -392,33 +392,39 @@ namespace AssistantV2 {
392392

393393
/** Contains information that can be shared by all skills within the Assistant. */
394394
export interface MessageContextGlobal {
395-
/** Properties interpreted by the Assistant that are shared across all skills within the Assistant. */
395+
/** Properties that are shared by all skills used by the assistant. */
396396
system?: MessageContextGlobalSystem;
397397
}
398398

399399
/** Properties that are shared by all skills used by the assistant. */
400400
export interface MessageContextGlobalSystem {
401401
/** The user time zone. The assistant uses the time zone to correctly resolve relative time references. */
402402
timezone?: string;
403-
/** A string value that identifies the user who is interacting with the assistant. The client must provide a unique identifier for each individual end user who accesses the application. This user ID may be used for billing and other purposes. */
403+
/** A string value that identifies the user who is interacting with the assistant. The client must provide a unique identifier for each individual end user who accesses the application. For Plus and Premium plans, this user ID is used to identify unique users for billing purposes. This string cannot contain carriage return, newline, or tab characters. */
404404
user_id?: string;
405405
/** A counter that is automatically incremented with each turn of the conversation. A value of 1 indicates that this is the the first turn of a new conversation, which can affect the behavior of some skills. */
406406
turn_count?: number;
407407
}
408408

409+
/** Contains information specific to a particular skill within the Assistant. */
410+
export interface MessageContextSkill {
411+
/** Arbitrary variables that can be read and written to by a particular skill within the Assistant. */
412+
user_defined?: string;
413+
}
414+
409415
/** Contains information specific to particular skills within the Assistant. */
410416
export interface MessageContextSkills {
411417
/** MessageContextSkills accepts additional properties. */
412418
[propName: string]: any;
413419
}
414420

415-
/** The user input. */
421+
/** An input object that includes the input text. */
416422
export interface MessageInput {
417423
/** The type of user input. Currently, only text input is supported. */
418424
message_type?: string;
419425
/** The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters. */
420426
text?: string;
421-
/** Properties that control how the assistant responds. */
427+
/** Optional properties that control how the assistant responds. */
422428
options?: MessageInputOptions;
423429
/** Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input. */
424430
intents?: RuntimeIntent[];
@@ -432,7 +438,7 @@ namespace AssistantV2 {
432438
export interface MessageInputOptions {
433439
/** Whether to return additional diagnostic information. Set to `true` to return additional information under the `output.debug` key. */
434440
debug?: boolean;
435-
/** Whether to start a new conversation with this user input. Specify `true` to clear the state information stored by the session. */
441+
/** Whether to restart dialog processing at the root of the dialog, regardless of any previously visited nodes. **Note:** This does not affect `turn_count` or any other context variables. */
436442
restart?: boolean;
437443
/** Whether to return more than one intent. Set to `true` to return all matching intents. */
438444
alternate_intents?: boolean;
@@ -472,7 +478,7 @@ namespace AssistantV2 {
472478
export interface MessageResponse {
473479
/** Assistant output to be rendered or processed by the client. */
474480
output: MessageOutput;
475-
/** The current session context. Included in the response if the `return_context` property of the message input was set to `true`. */
481+
/** State information for the conversation. */
476482
context?: MessageContext;
477483
}
478484

0 commit comments

Comments
 (0)