Discovery Engine v1beta API - Class Assistant (1.0.0-beta24) 

public sealed class Assistant : IMessage<Assistant>, IEquatable<Assistant>, IDeepCloneable<Assistant>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1beta API class Assistant.

Discovery Engine Assistant resource.

Inheritance

object > Assistant

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

Assistant()

public Assistant()

Assistant(Assistant)

public Assistant(Assistant other)
Parameter
Name Description
other Assistant

Properties

AssistantName

public AssistantName AssistantName { get; set; }

AssistantName-typed view over the Name resource name property.

Property Value
Type Description
AssistantName

CreateTime

public Timestamp CreateTime { get; set; }

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

Property Value
Type Description
Timestamp

CustomerPolicy

public Assistant.Types.CustomerPolicy CustomerPolicy { get; set; }

Optional. Customer policy for the assistant.

Property Value
Type Description
AssistantTypesCustomerPolicy

DefaultWebGroundingToggleOff

public bool DefaultWebGroundingToggleOff { get; set; }

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.

Property Value
Type Description
bool

Description

public string Description { get; set; }

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

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Required. The assistant display name.

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

Property Value
Type Description
string

EnabledTools

public MapField<string, Assistant.Types.ToolList> EnabledTools { get; }

Optional. Note: not implemented yet. Use [enabled_actions][google.cloud.discoveryengine.v1beta.Assistant.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"),..] }

Property Value
Type Description
MapFieldstringAssistantTypesToolList

GenerationConfig

public Assistant.Types.GenerationConfig GenerationConfig { get; set; }

Optional. Configuration for the generation of the assistant response.

Property Value
Type Description
AssistantTypesGenerationConfig

Name

public string Name { get; set; }

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.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
Type Description
Timestamp

WebGroundingType

public Assistant.Types.WebGroundingType WebGroundingType { get; set; }

Optional. The type of web grounding to use.

Property Value
Type Description
AssistantTypesWebGroundingType