public final class AnalyzeContentRequest extends GeneratedMessageV3 implements AnalyzeContentRequestOrBuilder
The request message for
Participants.AnalyzeContent.
Protobuf type google.cloud.dialogflow.v2beta1.AnalyzeContentRequest
Static Fields
ASSIST_QUERY_PARAMS_FIELD_NUMBER
public static final int ASSIST_QUERY_PARAMS_FIELD_NUMBER
Field Value
AUDIO_INPUT_FIELD_NUMBER
public static final int AUDIO_INPUT_FIELD_NUMBER
Field Value
CX_CURRENT_PAGE_FIELD_NUMBER
public static final int CX_CURRENT_PAGE_FIELD_NUMBER
Field Value
CX_PARAMETERS_FIELD_NUMBER
public static final int CX_PARAMETERS_FIELD_NUMBER
Field Value
EVENT_INPUT_FIELD_NUMBER
public static final int EVENT_INPUT_FIELD_NUMBER
Field Value
MESSAGE_SEND_TIME_FIELD_NUMBER
public static final int MESSAGE_SEND_TIME_FIELD_NUMBER
Field Value
PARTICIPANT_FIELD_NUMBER
public static final int PARTICIPANT_FIELD_NUMBER
Field Value
QUERY_PARAMS_FIELD_NUMBER
public static final int QUERY_PARAMS_FIELD_NUMBER
Field Value
REPLY_AUDIO_CONFIG_FIELD_NUMBER
public static final int REPLY_AUDIO_CONFIG_FIELD_NUMBER
Field Value
REQUEST_ID_FIELD_NUMBER
public static final int REQUEST_ID_FIELD_NUMBER
Field Value
TEXT_INPUT_FIELD_NUMBER
public static final int TEXT_INPUT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AnalyzeContentRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AnalyzeContentRequest.Builder newBuilder()
Returns
newBuilder(AnalyzeContentRequest prototype)
public static AnalyzeContentRequest.Builder newBuilder(AnalyzeContentRequest prototype)
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static AnalyzeContentRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AnalyzeContentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AnalyzeContentRequest parseFrom(byte[] data)
Parameter
Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AnalyzeContentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AnalyzeContentRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AnalyzeContentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static AnalyzeContentRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AnalyzeContentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static AnalyzeContentRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AnalyzeContentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AnalyzeContentRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AnalyzeContentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AnalyzeContentRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAssistQueryParams()
public AssistQueryParameters getAssistQueryParams()
Parameters for a human assist query.
.google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 14;
Returns
getAssistQueryParamsOrBuilder()
public AssistQueryParametersOrBuilder getAssistQueryParamsOrBuilder()
Parameters for a human assist query.
.google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 14;
Returns
getAudioInput()
public AudioInput getAudioInput()
The natural language speech audio to be processed.
.google.cloud.dialogflow.v2beta1.AudioInput audio_input = 7;
Returns
getAudioInputOrBuilder()
public AudioInputOrBuilder getAudioInputOrBuilder()
The natural language speech audio to be processed.
.google.cloud.dialogflow.v2beta1.AudioInput audio_input = 7;
Returns
getCxCurrentPage()
public String getCxCurrentPage()
The unique identifier of the CX page to override the current_page
in the
session.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/pages/<Page ID>
.
If cx_current_page
is specified, the previous state of the session will
be ignored by Dialogflow CX, including the previous
page and the previous session
parameters. In most cases, cx_current_page
and
cx_parameters
should be configured together to direct a session to a
specific state.
Note: this field should only be used if you are connecting to a Dialogflow
CX agent.
string cx_current_page = 20;
Returns
Type |
Description |
String |
The cxCurrentPage.
|
getCxCurrentPageBytes()
public ByteString getCxCurrentPageBytes()
The unique identifier of the CX page to override the current_page
in the
session.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/pages/<Page ID>
.
If cx_current_page
is specified, the previous state of the session will
be ignored by Dialogflow CX, including the previous
page and the previous session
parameters. In most cases, cx_current_page
and
cx_parameters
should be configured together to direct a session to a
specific state.
Note: this field should only be used if you are connecting to a Dialogflow
CX agent.
string cx_current_page = 20;
Returns
Type |
Description |
ByteString |
The bytes for cxCurrentPage.
|
getCxParameters()
public Struct getCxParameters()
Additional parameters to be put into Dialogflow CX session parameters. To
remove a parameter from the session, clients should explicitly set the
parameter value to null.
Note: this field should only be used if you are connecting to a Dialogflow
CX agent.
.google.protobuf.Struct cx_parameters = 18;
Returns
Type |
Description |
Struct |
The cxParameters.
|
getCxParametersOrBuilder()
public StructOrBuilder getCxParametersOrBuilder()
Additional parameters to be put into Dialogflow CX session parameters. To
remove a parameter from the session, clients should explicitly set the
parameter value to null.
Note: this field should only be used if you are connecting to a Dialogflow
CX agent.
.google.protobuf.Struct cx_parameters = 18;
Returns
getDefaultInstanceForType()
public AnalyzeContentRequest getDefaultInstanceForType()
Returns
getEventInput()
public EventInput getEventInput()
An input event to send to Dialogflow.
.google.cloud.dialogflow.v2beta1.EventInput event_input = 8;
Returns
getEventInputOrBuilder()
public EventInputOrBuilder getEventInputOrBuilder()
An input event to send to Dialogflow.
.google.cloud.dialogflow.v2beta1.EventInput event_input = 8;
Returns
getInputCase()
public AnalyzeContentRequest.InputCase getInputCase()
Returns
getMessageSendTime()
public Timestamp getMessageSendTime()
Optional. The send time of the message from end user or human agent's
perspective. It is used for identifying the same message under one
participant.
Given two messages under the same participant:
- If send time are different regardless of whether the content of the
messages are exactly the same, the conversation will regard them as
two distinct messages sent by the participant.
- If send time is the same regardless of whether the content of the
messages are exactly the same, the conversation will regard them as
same message, and ignore the message received later.
If the value is not provided, a new request will always be regarded as a
new message without any de-duplication.
.google.protobuf.Timestamp message_send_time = 10;
Returns
Type |
Description |
Timestamp |
The messageSendTime.
|
getMessageSendTimeOrBuilder()
public TimestampOrBuilder getMessageSendTimeOrBuilder()
Optional. The send time of the message from end user or human agent's
perspective. It is used for identifying the same message under one
participant.
Given two messages under the same participant:
- If send time are different regardless of whether the content of the
messages are exactly the same, the conversation will regard them as
two distinct messages sent by the participant.
- If send time is the same regardless of whether the content of the
messages are exactly the same, the conversation will regard them as
same message, and ignore the message received later.
If the value is not provided, a new request will always be regarded as a
new message without any de-duplication.
.google.protobuf.Timestamp message_send_time = 10;
Returns
getParserForType()
public Parser<AnalyzeContentRequest> getParserForType()
Returns
Overrides
getParticipant()
public String getParticipant()
Required. The name of the participant this text comes from.
Format: projects/<Project ID>/locations/<Location
ID>/conversations/<Conversation ID>/participants/<Participant ID>
.
string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type |
Description |
String |
The participant.
|
getParticipantBytes()
public ByteString getParticipantBytes()
Required. The name of the participant this text comes from.
Format: projects/<Project ID>/locations/<Location
ID>/conversations/<Conversation ID>/participants/<Participant ID>
.
string participant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type |
Description |
ByteString |
The bytes for participant.
|
getQueryParams()
public QueryParameters getQueryParams()
Parameters for a Dialogflow virtual-agent query.
.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 9;
Returns
getQueryParamsOrBuilder()
public QueryParametersOrBuilder getQueryParamsOrBuilder()
Parameters for a Dialogflow virtual-agent query.
.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 9;
Returns
getReplyAudioConfig()
public OutputAudioConfig getReplyAudioConfig()
Speech synthesis configuration.
The speech synthesis settings for a virtual agent that may be configured
for the associated conversation profile are not used when calling
AnalyzeContent. If this configuration is not supplied, speech synthesis
is disabled.
.google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 5;
Returns
getReplyAudioConfigOrBuilder()
public OutputAudioConfigOrBuilder getReplyAudioConfigOrBuilder()
Speech synthesis configuration.
The speech synthesis settings for a virtual agent that may be configured
for the associated conversation profile are not used when calling
AnalyzeContent. If this configuration is not supplied, speech synthesis
is disabled.
.google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 5;
Returns
getRequestId()
public String getRequestId()
A unique identifier for this request. Restricted to 36 ASCII characters.
A random UUID is recommended.
This request is only idempotent if a request_id
is provided.
string request_id = 11;
Returns
Type |
Description |
String |
The requestId.
|
getRequestIdBytes()
public ByteString getRequestIdBytes()
A unique identifier for this request. Restricted to 36 ASCII characters.
A random UUID is recommended.
This request is only idempotent if a request_id
is provided.
string request_id = 11;
Returns
Type |
Description |
ByteString |
The bytes for requestId.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTextInput()
public TextInput getTextInput()
The natural language text to be processed.
.google.cloud.dialogflow.v2beta1.TextInput text_input = 6;
Returns
getTextInputOrBuilder()
public TextInputOrBuilder getTextInputOrBuilder()
The natural language text to be processed.
.google.cloud.dialogflow.v2beta1.TextInput text_input = 6;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasAssistQueryParams()
public boolean hasAssistQueryParams()
Parameters for a human assist query.
.google.cloud.dialogflow.v2beta1.AssistQueryParameters assist_query_params = 14;
Returns
Type |
Description |
boolean |
Whether the assistQueryParams field is set.
|
hasAudioInput()
public boolean hasAudioInput()
The natural language speech audio to be processed.
.google.cloud.dialogflow.v2beta1.AudioInput audio_input = 7;
Returns
Type |
Description |
boolean |
Whether the audioInput field is set.
|
hasCxParameters()
public boolean hasCxParameters()
Additional parameters to be put into Dialogflow CX session parameters. To
remove a parameter from the session, clients should explicitly set the
parameter value to null.
Note: this field should only be used if you are connecting to a Dialogflow
CX agent.
.google.protobuf.Struct cx_parameters = 18;
Returns
Type |
Description |
boolean |
Whether the cxParameters field is set.
|
hasEventInput()
public boolean hasEventInput()
An input event to send to Dialogflow.
.google.cloud.dialogflow.v2beta1.EventInput event_input = 8;
Returns
Type |
Description |
boolean |
Whether the eventInput field is set.
|
hasMessageSendTime()
public boolean hasMessageSendTime()
Optional. The send time of the message from end user or human agent's
perspective. It is used for identifying the same message under one
participant.
Given two messages under the same participant:
- If send time are different regardless of whether the content of the
messages are exactly the same, the conversation will regard them as
two distinct messages sent by the participant.
- If send time is the same regardless of whether the content of the
messages are exactly the same, the conversation will regard them as
same message, and ignore the message received later.
If the value is not provided, a new request will always be regarded as a
new message without any de-duplication.
.google.protobuf.Timestamp message_send_time = 10;
Returns
Type |
Description |
boolean |
Whether the messageSendTime field is set.
|
hasQueryParams()
public boolean hasQueryParams()
Parameters for a Dialogflow virtual-agent query.
.google.cloud.dialogflow.v2beta1.QueryParameters query_params = 9;
Returns
Type |
Description |
boolean |
Whether the queryParams field is set.
|
hasReplyAudioConfig()
public boolean hasReplyAudioConfig()
Speech synthesis configuration.
The speech synthesis settings for a virtual agent that may be configured
for the associated conversation profile are not used when calling
AnalyzeContent. If this configuration is not supplied, speech synthesis
is disabled.
.google.cloud.dialogflow.v2beta1.OutputAudioConfig reply_audio_config = 5;
Returns
Type |
Description |
boolean |
Whether the replyAudioConfig field is set.
|
hasTextInput()
public boolean hasTextInput()
The natural language text to be processed.
.google.cloud.dialogflow.v2beta1.TextInput text_input = 6;
Returns
Type |
Description |
boolean |
Whether the textInput field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AnalyzeContentRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AnalyzeContentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AnalyzeContentRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions