Class AgentEndpointSummary

Summary information about an endpoint.

Inheritance
object
AgentEndpointSummary
Inherited Members
Namespace: Oci.GenerativeaiagentService.Models
Assembly: OCI.DotNetSDK.Generativeaiagent.dll
Syntax
public class AgentEndpointSummary

Properties

AgentId

Declaration
[Required(ErrorMessage = "AgentId is required.")]
[JsonProperty(PropertyName = "agentId")]
public string AgentId { get; set; }
Property Value
Type Description
string

The OCID of the agent that this AgentEndpoint is associated with.
Remarks

Required

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment.
Remarks

Required

ContentModerationConfig

Declaration
[JsonProperty(PropertyName = "contentModerationConfig")]
public ContentModerationConfig ContentModerationConfig { get; set; }
Property Value
Type Description
ContentModerationConfig

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}

Description

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

An optional description of the endpoint.

DisplayName

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

A user-friendly name. Does not have to be unique, and it's changeable.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}

GuardrailConfig

Declaration
[JsonProperty(PropertyName = "guardrailConfig")]
public GuardrailConfig GuardrailConfig { get; set; }
Property Value
Type Description
GuardrailConfig

HumanInputConfig

Declaration
[JsonProperty(PropertyName = "humanInputConfig")]
public HumanInputConfig HumanInputConfig { get; set; }
Property Value
Type Description
HumanInputConfig

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the AgentEndpoint.
Remarks

Required

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

A message that describes the current state of the endpoint in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public AgentEndpoint.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
AgentEndpoint.LifecycleStateEnum?

The current state of the endpoint.
Remarks

Required

Metadata

Declaration
[JsonProperty(PropertyName = "metadata")]
public Dictionary<string, string> Metadata { get; set; }
Property Value
Type Description
Dictionary<string, string>

Key-value pairs to allow additional configurations.

OutputConfig

Declaration
[JsonProperty(PropertyName = "outputConfig")]
public OutputConfig OutputConfig { get; set; }
Property Value
Type Description
OutputConfig

SessionConfig

Declaration
[JsonProperty(PropertyName = "sessionConfig")]
public SessionConfig SessionConfig { get; set; }
Property Value
Type Description
SessionConfig

ShouldEnableCitation

Declaration
[JsonProperty(PropertyName = "shouldEnableCitation")]
public bool? ShouldEnableCitation { get; set; }
Property Value
Type Description
bool?

Whether to show citations in the chat result.

ShouldEnableMultiLanguage

Declaration
[JsonProperty(PropertyName = "shouldEnableMultiLanguage")]
public bool? ShouldEnableMultiLanguage { get; set; }
Property Value
Type Description
bool?

Whether to enable multi-language for chat.

ShouldEnableSession

Declaration
[JsonProperty(PropertyName = "shouldEnableSession")]
public bool? ShouldEnableSession { get; set; }
Property Value
Type Description
bool?

Whether or not to enable Session-based chat.

ShouldEnableTrace

Declaration
[JsonProperty(PropertyName = "shouldEnableTrace")]
public bool? ShouldEnableTrace { get; set; }
Property Value
Type Description
bool?

Whether to show traces in the chat result.

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the endpoint was created, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z
Remarks

Required

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The date and time the AgentEndpoint was updated, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z