Interface AssistAnswerOrBuilder (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public interface AssistAnswerOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAssistSkippedReasons(int index)

public abstract AssistAnswer.AssistSkippedReason getAssistSkippedReasons(int index)

Reasons for not answering the assist call.

repeated .google.cloud.discoveryengine.v1beta.AssistAnswer.AssistSkippedReason assist_skipped_reasons = 5;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
AssistAnswer.AssistSkippedReason	The assistSkippedReasons at the given index.

getAssistSkippedReasonsCount()

public abstract int getAssistSkippedReasonsCount()

Reasons for not answering the assist call.

repeated .google.cloud.discoveryengine.v1beta.AssistAnswer.AssistSkippedReason assist_skipped_reasons = 5;

Returns
Type	Description
int	The count of assistSkippedReasons.

getAssistSkippedReasonsList()

public abstract List<AssistAnswer.AssistSkippedReason> getAssistSkippedReasonsList()

Reasons for not answering the assist call.

repeated .google.cloud.discoveryengine.v1beta.AssistAnswer.AssistSkippedReason assist_skipped_reasons = 5;

Returns
Type	Description
List<AssistSkippedReason>	A list containing the assistSkippedReasons.

getAssistSkippedReasonsValue(int index)

public abstract int getAssistSkippedReasonsValue(int index)

Reasons for not answering the assist call.

repeated .google.cloud.discoveryengine.v1beta.AssistAnswer.AssistSkippedReason assist_skipped_reasons = 5;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
int	The enum numeric value on the wire of assistSkippedReasons at the given index.

getAssistSkippedReasonsValueList()

public abstract List<Integer> getAssistSkippedReasonsValueList()

Reasons for not answering the assist call.

repeated .google.cloud.discoveryengine.v1beta.AssistAnswer.AssistSkippedReason assist_skipped_reasons = 5;

Returns
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for assistSkippedReasons.

getCustomerPolicyEnforcementResult()

public abstract AssistAnswer.CustomerPolicyEnforcementResult getCustomerPolicyEnforcementResult()

Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.

.google.cloud.discoveryengine.v1beta.AssistAnswer.CustomerPolicyEnforcementResult customer_policy_enforcement_result = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AssistAnswer.CustomerPolicyEnforcementResult	The customerPolicyEnforcementResult.

getCustomerPolicyEnforcementResultOrBuilder()

public abstract AssistAnswer.CustomerPolicyEnforcementResultOrBuilder getCustomerPolicyEnforcementResultOrBuilder()

Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.

.google.cloud.discoveryengine.v1beta.AssistAnswer.CustomerPolicyEnforcementResult customer_policy_enforcement_result = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AssistAnswer.CustomerPolicyEnforcementResultOrBuilder

getName()

public abstract String getName()

Immutable. Identifier. Resource name of the AssistAnswer. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. Identifier. Resource name of the AssistAnswer. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getReplies(int index)

public abstract AssistAnswer.Reply getReplies(int index)

Replies of the assistant.

repeated .google.cloud.discoveryengine.v1beta.AssistAnswer.Reply replies = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
AssistAnswer.Reply

getRepliesCount()

public abstract int getRepliesCount()

Replies of the assistant.

repeated .google.cloud.discoveryengine.v1beta.AssistAnswer.Reply replies = 3;

Returns
Type	Description
int

getRepliesList()

public abstract List<AssistAnswer.Reply> getRepliesList()

Replies of the assistant.

repeated .google.cloud.discoveryengine.v1beta.AssistAnswer.Reply replies = 3;

Returns
Type	Description
List<Reply>

getRepliesOrBuilder(int index)

public abstract AssistAnswer.ReplyOrBuilder getRepliesOrBuilder(int index)

Replies of the assistant.

repeated .google.cloud.discoveryengine.v1beta.AssistAnswer.Reply replies = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
AssistAnswer.ReplyOrBuilder

getRepliesOrBuilderList()

public abstract List<? extends AssistAnswer.ReplyOrBuilder> getRepliesOrBuilderList()

Replies of the assistant.

repeated .google.cloud.discoveryengine.v1beta.AssistAnswer.Reply replies = 3;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1beta.AssistAnswer.ReplyOrBuilder>

getState()

public abstract AssistAnswer.State getState()

State of the answer generation.

.google.cloud.discoveryengine.v1beta.AssistAnswer.State state = 2;

Returns
Type	Description
AssistAnswer.State	The state.

getStateValue()

public abstract int getStateValue()

State of the answer generation.

.google.cloud.discoveryengine.v1beta.AssistAnswer.State state = 2;

Returns
Type	Description
int	The enum numeric value on the wire for state.

hasCustomerPolicyEnforcementResult()

public abstract boolean hasCustomerPolicyEnforcementResult()

Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.

.google.cloud.discoveryengine.v1beta.AssistAnswer.CustomerPolicyEnforcementResult customer_policy_enforcement_result = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the customerPolicyEnforcementResult field is set.