// Copyright (c) 2016, 2018, 2026, Oracle and/or its affiliates.  All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.

// Generative AI Agents Management API
//
// OCI Generative AI Agents is a fully managed service that combines the power of large language models (LLMs) with an intelligent retrieval system to create contextually relevant answers by searching your knowledge base, making your AI applications smart and efficient.
// OCI Generative AI Agents supports several ways to onboard your data and then allows you and your customers to interact with your data using a chat interface or API.
// Use the Generative AI Agents API to create and manage agents, knowledge bases, data sources, endpoints, data ingestion jobs, and work requests.
// For creating and managing client chat sessions see the /EN/generative-ai-agents-client/latest/.
// To learn more about the service, see the Generative AI Agents documentation (https://docs.oracle.com/iaas/Content/generative-ai-agents/home.htm).
//

package generativeaiagent

import (
	"fmt"
	"github.com/oracle/oci-go-sdk/v65/common"
	"strings"
)

// AgentEndpoint The endpoint to access a deployed agent.
// To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type AgentEndpoint struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the agent that this endpoint is associated with.
	AgentId *string `mandatory:"true" json:"agentId"`

	// The date and time the AgentEndpoint was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the endpoint.
	LifecycleState AgentEndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// An optional description of the endpoint.
	Description *string `mandatory:"false" json:"description"`

	ContentModerationConfig *ContentModerationConfig `mandatory:"false" json:"contentModerationConfig"`

	GuardrailConfig *GuardrailConfig `mandatory:"false" json:"guardrailConfig"`

	// Key-value pairs to allow additional configurations.
	Metadata map[string]string `mandatory:"false" json:"metadata"`

	HumanInputConfig *HumanInputConfig `mandatory:"false" json:"humanInputConfig"`

	OutputConfig *OutputConfig `mandatory:"false" json:"outputConfig"`

	// Whether to show traces in the chat result.
	ShouldEnableTrace *bool `mandatory:"false" json:"shouldEnableTrace"`

	// Whether to show citations in the chat result.
	ShouldEnableCitation *bool `mandatory:"false" json:"shouldEnableCitation"`

	// Whether or not to enable Session-based chat.
	ShouldEnableSession *bool `mandatory:"false" json:"shouldEnableSession"`

	// Whether to enable multi-language for chat.
	ShouldEnableMultiLanguage *bool `mandatory:"false" json:"shouldEnableMultiLanguage"`

	SessionConfig *SessionConfig `mandatory:"false" json:"sessionConfig"`

	// The date and time the endpoint was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// 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.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	ProvisionedCapacityConfig *ProvisionedCapacityConfig `mandatory:"false" json:"provisionedCapacityConfig"`

	// 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

func (m AgentEndpoint) String() string {
	return common.PointerString(m)
}

// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (m AgentEndpoint) ValidateEnumValue() (bool, error) {
	errMessage := []string{}
	if _, ok := GetMappingAgentEndpointLifecycleStateEnum(string(m.LifecycleState)); !ok && m.LifecycleState != "" {
		errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleState: %s. Supported values are: %s.", m.LifecycleState, strings.Join(GetAgentEndpointLifecycleStateEnumStringValues(), ",")))
	}

	if len(errMessage) > 0 {
		return true, fmt.Errorf("%s", strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// AgentEndpointLifecycleStateEnum Enum with underlying type: string
type AgentEndpointLifecycleStateEnum string

// Set of constants representing the allowable values for AgentEndpointLifecycleStateEnum
const (
	AgentEndpointLifecycleStateCreating AgentEndpointLifecycleStateEnum = "CREATING"
	AgentEndpointLifecycleStateUpdating AgentEndpointLifecycleStateEnum = "UPDATING"
	AgentEndpointLifecycleStateActive   AgentEndpointLifecycleStateEnum = "ACTIVE"
	AgentEndpointLifecycleStateDeleting AgentEndpointLifecycleStateEnum = "DELETING"
	AgentEndpointLifecycleStateDeleted  AgentEndpointLifecycleStateEnum = "DELETED"
	AgentEndpointLifecycleStateFailed   AgentEndpointLifecycleStateEnum = "FAILED"
)

var mappingAgentEndpointLifecycleStateEnum = map[string]AgentEndpointLifecycleStateEnum{
	"CREATING": AgentEndpointLifecycleStateCreating,
	"UPDATING": AgentEndpointLifecycleStateUpdating,
	"ACTIVE":   AgentEndpointLifecycleStateActive,
	"DELETING": AgentEndpointLifecycleStateDeleting,
	"DELETED":  AgentEndpointLifecycleStateDeleted,
	"FAILED":   AgentEndpointLifecycleStateFailed,
}

var mappingAgentEndpointLifecycleStateEnumLowerCase = map[string]AgentEndpointLifecycleStateEnum{
	"creating": AgentEndpointLifecycleStateCreating,
	"updating": AgentEndpointLifecycleStateUpdating,
	"active":   AgentEndpointLifecycleStateActive,
	"deleting": AgentEndpointLifecycleStateDeleting,
	"deleted":  AgentEndpointLifecycleStateDeleted,
	"failed":   AgentEndpointLifecycleStateFailed,
}

// GetAgentEndpointLifecycleStateEnumValues Enumerates the set of values for AgentEndpointLifecycleStateEnum
func GetAgentEndpointLifecycleStateEnumValues() []AgentEndpointLifecycleStateEnum {
	values := make([]AgentEndpointLifecycleStateEnum, 0)
	for _, v := range mappingAgentEndpointLifecycleStateEnum {
		values = append(values, v)
	}
	return values
}

// GetAgentEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for AgentEndpointLifecycleStateEnum
func GetAgentEndpointLifecycleStateEnumStringValues() []string {
	return []string{
		"CREATING",
		"UPDATING",
		"ACTIVE",
		"DELETING",
		"DELETED",
		"FAILED",
	}
}

// GetMappingAgentEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingAgentEndpointLifecycleStateEnum(val string) (AgentEndpointLifecycleStateEnum, bool) {
	enum, ok := mappingAgentEndpointLifecycleStateEnumLowerCase[strings.ToLower(val)]
	return enum, ok
}
