Show / Hide Table of Contents

Class GoogleCloudDiscoveryengineV1alphaAgent

Performs a predefined, specific task.

Inheritance
object
GoogleCloudDiscoveryengineV1alphaAgent
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class GoogleCloudDiscoveryengineV1alphaAgent : IDirectResponseSchema

Properties

A2aAgentDefinition

Optional. The behavior of the agent is defined as an A2A agent.

Declaration
[JsonProperty("a2aAgentDefinition")]
public virtual GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition A2aAgentDefinition { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition

AdkAgentDefinition

Optional. The behavior of the agent is defined as an ADK agent.

Declaration
[JsonProperty("adkAgentDefinition")]
public virtual GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition AdkAgentDefinition { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition

AuthorizationConfig

Optional. The authorizations that are required by the agent.

Declaration
[JsonProperty("authorizationConfig")]
public virtual GoogleCloudDiscoveryengineV1alphaAuthorizationConfig AuthorizationConfig { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaAuthorizationConfig

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp when this Agent was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

CustomPlaceholderText

Optional. The custom placeholder text that appears in the text box before the user enters any text.

Declaration
[JsonProperty("customPlaceholderText")]
public virtual string CustomPlaceholderText { get; set; }
Property Value
Type Description
string

DeploymentFailureReason

Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.

Declaration
[JsonProperty("deploymentFailureReason")]
public virtual string DeploymentFailureReason { get; set; }
Property Value
Type Description
string

Description

Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

DialogflowAgentDefinition

Optional. The behavior of the agent is defined as a Dialogflow agent.

Declaration
[JsonProperty("dialogflowAgentDefinition")]
public virtual GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition DialogflowAgentDefinition { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition

DisplayName

Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Icon

Optional. The icon that represents the agent on the UI.

Declaration
[JsonProperty("icon")]
public virtual GoogleCloudDiscoveryengineV1alphaAgentImage Icon { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaAgentImage

LanguageCode

Optional. The code of the language of the text in the description, display_name and starter_prompts fields.

Declaration
[JsonProperty("languageCode")]
public virtual string LanguageCode { get; set; }
Property Value
Type Description
string

ManagedAgentDefinition

Optional. The behavior of the Google managed agent.

Declaration
[JsonProperty("managedAgentDefinition")]
public virtual GoogleCloudDiscoveryengineV1alphaManagedAgentDefinition ManagedAgentDefinition { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaManagedAgentDefinition

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

RejectionReason

Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.

Declaration
[JsonProperty("rejectionReason")]
public virtual string RejectionReason { get; set; }
Property Value
Type Description
string

SharingConfig

Optional. The sharing config of the agent.

Declaration
[JsonProperty("sharingConfig")]
public virtual GoogleCloudDiscoveryengineV1alphaAgentSharingConfig SharingConfig { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaAgentSharingConfig

StarterPrompts

Optional. The starter prompt suggestions to show the user on the landing page of the agent.

Declaration
[JsonProperty("starterPrompts")]
public virtual IList<GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt> StarterPrompts { get; set; }
Property Value
Type Description
IList<GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt>

State

Output only. The lifecycle state of the agent.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

SuspensionReason

Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.

Declaration
[JsonProperty("suspensionReason")]
public virtual string SuspensionReason { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. Timestamp when this Agent was most recently updated.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX