Class GoogleCloudDiscoveryengineV1alphaAgentView

The data for displaying an Agent.

Inheritance
object
GoogleCloudDiscoveryengineV1alphaAgentView
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class GoogleCloudDiscoveryengineV1alphaAgentView : IDirectResponseSchema

Properties

AgentOrigin

Immutable. The origin of the Agent.

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

AgentSharingState

Output only. The sharing state of the agent.

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

AgentType

Output only. The type of the agent.

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

CustomPlaceholderText

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

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 and to generate the first version of the steps for the agent that can be modified by the user. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.

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

DisplayName

Required. Display name of the agent. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.

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

Name

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

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

State

Output only. The state of the Agent.

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

SuggestedPrompts

Optional. The suggested prompts for the agent, to be shown on the agent landing page.

Declaration
[JsonProperty("suggestedPrompts")]
public virtual IList<GoogleCloudDiscoveryengineV1alphaAgentViewSuggestedPrompt> SuggestedPrompts { get; set; }
Property Value
Type Description
IList<GoogleCloudDiscoveryengineV1alphaAgentViewSuggestedPrompt>

SuspensionReason

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

UserAnnotations

Optional. Per-user annotations of the current caller for the agent.

Declaration
[JsonProperty("userAnnotations")]
public virtual GoogleCloudDiscoveryengineV1alphaUserAnnotations UserAnnotations { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaUserAnnotations

UserPermissions

The permissions of the user for this Agent.

Declaration
[JsonProperty("userPermissions")]
public virtual GoogleCloudDiscoveryengineV1alphaAgentViewUserPermissions UserPermissions { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaAgentViewUserPermissions

Implements