public class MessageInputStateless
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
MessageInputStateless.Builder
Builder.
|
static interface |
MessageInputStateless.MessageType
The type of the message:
|
Modifier and Type | Method and Description |
---|---|
RequestAnalytics |
analytics()
Gets the analytics.
|
List<MessageInputAttachment> |
attachments()
Gets the attachments.
|
List<RuntimeEntity> |
entities()
Gets the entities.
|
List<RuntimeIntent> |
intents()
Gets the intents.
|
String |
messageType()
Gets the messageType.
|
MessageInputStateless.Builder |
newBuilder()
New builder.
|
MessageInputOptionsStateless |
options()
Gets the options.
|
String |
suggestionId()
Gets the suggestionId.
|
String |
text()
Gets the text.
|
public MessageInputStateless.Builder newBuilder()
public String messageType()
The type of the message:
- `text`: The user input is processed normally by the assistant. - `search`: Only search results are returned. (Any dialog or action skill is bypassed.)
**Note:** A `search` message results in an error if no search skill is configured for the assistant.
public String text()
The text of the user input. This string cannot contain carriage return, newline, or tab characters.
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 String suggestionId()
For internal use only.
public List<MessageInputAttachment> attachments()
An array of multimedia attachments to be sent with the message. Attachments are not processed by the assistant itself, but can be sent to external services by webhooks.
**Note:** Attachments are not supported on IBM Cloud Pak for Data.
public RequestAnalytics analytics()
An optional object containing analytics data. Currently, this data is used only for events sent to the Segment extension.
public MessageInputOptionsStateless options()
Optional properties that control how the assistant responds.
Copyright © 2023 IBM Cloud. All rights reserved.