Interface AssistantOrBuilder (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 AssistantOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsEnabledTools(String key)

public abstract boolean containsEnabledTools(String key)

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Represents the time when this Assistant was created.

.google.protobuf.Timestamp create_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Represents the time when this Assistant was created.

.google.protobuf.Timestamp create_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getCustomerPolicy()

public abstract Assistant.CustomerPolicy getCustomerPolicy()

Optional. Customer policy for the assistant.

.google.cloud.discoveryengine.v1beta.Assistant.CustomerPolicy customer_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.CustomerPolicy	The customerPolicy.

getCustomerPolicyOrBuilder()

public abstract Assistant.CustomerPolicyOrBuilder getCustomerPolicyOrBuilder()

Optional. Customer policy for the assistant.

.google.cloud.discoveryengine.v1beta.Assistant.CustomerPolicy customer_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.CustomerPolicyOrBuilder

getDefaultWebGroundingToggleOff()

public abstract boolean getDefaultWebGroundingToggleOff()

Optional. This field controls the default web grounding toggle for end users if web_grounding_type is set to WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. By default, this field is set to false. If web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.

bool default_web_grounding_toggle_off = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The defaultWebGroundingToggleOff.

getDescription()

public abstract String getDescription()

Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. The assistant display name.

It must be a UTF-8 encoded string with a length limit of 128 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The assistant display name.

It must be a UTF-8 encoded string with a length limit of 128 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getEnabledTools() (deprecated)

public abstract Map<String,Assistant.ToolList> getEnabledTools()

Use #getEnabledToolsMap() instead.

Returns
Type	Description
Map<String,ToolList>

getEnabledToolsCount()

public abstract int getEnabledToolsCount()

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getEnabledToolsMap()

public abstract Map<String,Assistant.ToolList> getEnabledToolsMap()

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,ToolList>

getEnabledToolsOrDefault(String key, Assistant.ToolList defaultValue)

public abstract Assistant.ToolList getEnabledToolsOrDefault(String key, Assistant.ToolList defaultValue)

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	Assistant.ToolList

Returns
Type	Description
Assistant.ToolList

getEnabledToolsOrThrow(String key)

public abstract Assistant.ToolList getEnabledToolsOrThrow(String key)

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

map<string, .google.cloud.discoveryengine.v1beta.Assistant.ToolList> enabled_tools = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
Assistant.ToolList

getGenerationConfig()

public abstract Assistant.GenerationConfig getGenerationConfig()

Optional. Configuration for the generation of the assistant response.

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig generation_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.GenerationConfig	The generationConfig.

getGenerationConfigOrBuilder()

public abstract Assistant.GenerationConfigOrBuilder getGenerationConfigOrBuilder()

Optional. Configuration for the generation of the assistant response.

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig generation_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.GenerationConfigOrBuilder

getName()

public abstract String getName()

Immutable. Resource name of the assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

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

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

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. Resource name of the assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

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

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

Returns
Type	Description
ByteString	The bytes for name.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Represents the time when this Assistant was most recently updated.

.google.protobuf.Timestamp update_time = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Represents the time when this Assistant was most recently updated.

.google.protobuf.Timestamp update_time = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getWebGroundingType()

public abstract Assistant.WebGroundingType getWebGroundingType()

Optional. The type of web grounding to use.

.google.cloud.discoveryengine.v1beta.Assistant.WebGroundingType web_grounding_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Assistant.WebGroundingType	The webGroundingType.

getWebGroundingTypeValue()

public abstract int getWebGroundingTypeValue()

Optional. The type of web grounding to use.

.google.cloud.discoveryengine.v1beta.Assistant.WebGroundingType web_grounding_type = 4 [(.google.api.field_behavior) = OPTIONAL];

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

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Represents the time when this Assistant was created.

.google.protobuf.Timestamp create_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasCustomerPolicy()

public abstract boolean hasCustomerPolicy()

Optional. Customer policy for the assistant.

.google.cloud.discoveryengine.v1beta.Assistant.CustomerPolicy customer_policy = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the customerPolicy field is set.

hasGenerationConfig()

public abstract boolean hasGenerationConfig()

Optional. Configuration for the generation of the assistant response.

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig generation_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the generationConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Represents the time when this Assistant was most recently updated.

.google.protobuf.Timestamp update_time = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.