Class Conversation.Interaction (0.56.0)

public static final class Conversation.Interaction extends GeneratedMessageV3 implements Conversation.InteractionOrBuilder

Represents an interaction between an end user and a Dialogflow CX agent using V3 (Streaming)DetectIntent API, or an interaction between an end user and a Dialogflow CX agent using V2 (Streaming)AnalyzeContent API.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

MISSING_TRANSITION_FIELD_NUMBER

public static final int MISSING_TRANSITION_FIELD_NUMBER
Field Value
Type Description
int

PARTIAL_RESPONSES_FIELD_NUMBER

public static final int PARTIAL_RESPONSES_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_FIELD_NUMBER

public static final int REQUEST_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_UTTERANCES_FIELD_NUMBER

public static final int REQUEST_UTTERANCES_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_FIELD_NUMBER

public static final int RESPONSE_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_UTTERANCES_FIELD_NUMBER

public static final int RESPONSE_UTTERANCES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Conversation.Interaction getDefaultInstance()
Returns
Type Description
Conversation.Interaction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Conversation.Interaction.Builder newBuilder()
Returns
Type Description
Conversation.Interaction.Builder

newBuilder(Conversation.Interaction prototype)

public static Conversation.Interaction.Builder newBuilder(Conversation.Interaction prototype)
Parameter
Name Description
prototype Conversation.Interaction
Returns
Type Description
Conversation.Interaction.Builder

parseDelimitedFrom(InputStream input)

public static Conversation.Interaction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Conversation.Interaction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Conversation.Interaction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Conversation.Interaction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Conversation.Interaction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Conversation.Interaction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Conversation.Interaction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Conversation.Interaction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Conversation.Interaction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Conversation.Interaction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Conversation.Interaction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Conversation.Interaction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Conversation.Interaction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Conversation.Interaction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Conversation.Interaction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Conversation.Interaction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Conversation.Interaction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Conversation.Interaction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Conversation.Interaction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Conversation.Interaction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Conversation.Interaction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Conversation.Interaction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Conversation.Interaction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Conversation.Interaction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Conversation.Interaction> parser()
Returns
Type Description
Parser<Interaction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

The time that the interaction was created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time that the interaction was created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Conversation.Interaction getDefaultInstanceForType()
Returns
Type Description
Conversation.Interaction

getMissingTransition()

public Conversation.Interaction.MissingTransition getMissingTransition()

Missing transition predicted for the interaction. This field is set only if the interaction match type was no-match.

.google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction.MissingTransition missing_transition = 8;

Returns
Type Description
Conversation.Interaction.MissingTransition

The missingTransition.

getMissingTransitionOrBuilder()

public Conversation.Interaction.MissingTransitionOrBuilder getMissingTransitionOrBuilder()

Missing transition predicted for the interaction. This field is set only if the interaction match type was no-match.

.google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction.MissingTransition missing_transition = 8;

Returns
Type Description
Conversation.Interaction.MissingTransitionOrBuilder

getParserForType()

public Parser<Conversation.Interaction> getParserForType()
Returns
Type Description
Parser<Interaction>
Overrides

getPartialResponses(int index)

public DetectIntentResponse getPartialResponses(int index)

The partial responses of the interaction. Empty if there is no partial response in the interaction. See the partial response documentation.

repeated .google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse partial_responses = 3;

Parameter
Name Description
index int
Returns
Type Description
DetectIntentResponse

getPartialResponsesCount()

public int getPartialResponsesCount()

The partial responses of the interaction. Empty if there is no partial response in the interaction. See the partial response documentation.

repeated .google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse partial_responses = 3;

Returns
Type Description
int

getPartialResponsesList()

public List<DetectIntentResponse> getPartialResponsesList()

The partial responses of the interaction. Empty if there is no partial response in the interaction. See the partial response documentation.

repeated .google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse partial_responses = 3;

Returns
Type Description
List<DetectIntentResponse>

getPartialResponsesOrBuilder(int index)

public DetectIntentResponseOrBuilder getPartialResponsesOrBuilder(int index)

The partial responses of the interaction. Empty if there is no partial response in the interaction. See the partial response documentation.

repeated .google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse partial_responses = 3;

Parameter
Name Description
index int
Returns
Type Description
DetectIntentResponseOrBuilder

getPartialResponsesOrBuilderList()

public List<? extends DetectIntentResponseOrBuilder> getPartialResponsesOrBuilderList()

The partial responses of the interaction. Empty if there is no partial response in the interaction. See the partial response documentation.

repeated .google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse partial_responses = 3;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.DetectIntentResponseOrBuilder>

getRequest()

public DetectIntentRequest getRequest()

The request of the interaction.

.google.cloud.dialogflow.cx.v3beta1.DetectIntentRequest request = 1;

Returns
Type Description
DetectIntentRequest

The request.

getRequestOrBuilder()

public DetectIntentRequestOrBuilder getRequestOrBuilder()

The request of the interaction.

.google.cloud.dialogflow.cx.v3beta1.DetectIntentRequest request = 1;

Returns
Type Description
DetectIntentRequestOrBuilder

getRequestUtterances()

public String getRequestUtterances()

The input text or the transcript of the input audio in the request.

string request_utterances = 4;

Returns
Type Description
String

The requestUtterances.

getRequestUtterancesBytes()

public ByteString getRequestUtterancesBytes()

The input text or the transcript of the input audio in the request.

string request_utterances = 4;

Returns
Type Description
ByteString

The bytes for requestUtterances.

getResponse()

public DetectIntentResponse getResponse()

The final response of the interaction.

.google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse response = 2;

Returns
Type Description
DetectIntentResponse

The response.

getResponseOrBuilder()

public DetectIntentResponseOrBuilder getResponseOrBuilder()

The final response of the interaction.

.google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse response = 2;

Returns
Type Description
DetectIntentResponseOrBuilder

getResponseUtterances()

public String getResponseUtterances()

The output text or the transcript of the output audio in the responses. If multiple output messages are returned, they will be concatenated into one.

string response_utterances = 5;

Returns
Type Description
String

The responseUtterances.

getResponseUtterancesBytes()

public ByteString getResponseUtterancesBytes()

The output text or the transcript of the output audio in the responses. If multiple output messages are returned, they will be concatenated into one.

string response_utterances = 5;

Returns
Type Description
ByteString

The bytes for responseUtterances.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCreateTime()

public boolean hasCreateTime()

The time that the interaction was created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
boolean

Whether the createTime field is set.

hasMissingTransition()

public boolean hasMissingTransition()

Missing transition predicted for the interaction. This field is set only if the interaction match type was no-match.

.google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction.MissingTransition missing_transition = 8;

Returns
Type Description
boolean

Whether the missingTransition field is set.

hasRequest()

public boolean hasRequest()

The request of the interaction.

.google.cloud.dialogflow.cx.v3beta1.DetectIntentRequest request = 1;

Returns
Type Description
boolean

Whether the request field is set.

hasResponse()

public boolean hasResponse()

The final response of the interaction.

.google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse response = 2;

Returns
Type Description
boolean

Whether the response field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Conversation.Interaction.Builder newBuilderForType()
Returns
Type Description
Conversation.Interaction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Conversation.Interaction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Conversation.Interaction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Conversation.Interaction.Builder toBuilder()
Returns
Type Description
Conversation.Interaction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException