public class MessageOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
MessageOptions.Builder
Builder.
|
Modifier and Type | Method and Description |
---|---|
Boolean |
alternateIntents()
Gets the alternateIntents.
|
Context |
context()
Gets the context.
|
List<RuntimeEntity> |
entities()
Gets the entities.
|
MessageInput |
input()
Gets the input.
|
List<RuntimeIntent> |
intents()
Gets the intents.
|
MessageOptions.Builder |
newBuilder()
New builder.
|
Boolean |
nodesVisitedDetails()
Gets the nodesVisitedDetails.
|
OutputData |
output()
Gets the output.
|
String |
userId()
Gets the userId.
|
String |
workspaceId()
Gets the workspaceId.
|
public MessageOptions.Builder newBuilder()
public String workspaceId()
Unique identifier of the workspace.
public MessageInput input()
An input object that includes the input text.
public List<RuntimeIntent> intents()
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.
public List<RuntimeEntity> entities()
Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.
public Boolean alternateIntents()
Whether to return more than one intent. A value of `true` indicates that all matching intents are returned.
public Context context()
State information for the conversation. To maintain state, include the context from the previous response.
public OutputData output()
An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the log.
public String userId()
A string value that identifies the user who is interacting with the workspace. The client must provide a unique identifier for each individual end user who accesses the application. For user-based plans, this user ID is used to identify unique users for billing purposes. This string cannot contain carriage return, newline, or tab characters. If no value is specified in the input, **user_id** is automatically set to the value of **context.conversation_id**.
**Note:** This property is the same as the **user_id** property in the context metadata. If **user_id** is specified in both locations in a message request, the value specified at the root is used.
public Boolean nodesVisitedDetails()
Whether to include additional diagnostic information about the dialog nodes that were visited during processing of the message.
Copyright © 2023 IBM Cloud. All rights reserved.