// Copyright (c) 2016, 2018, 2025, 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 Client 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 Client API to create and manage client chat sessions. A session represents an interactive conversation initiated by a user through an API to engage with an agent. It involves a series of exchanges where the user sends queries or prompts, and the agent responds with relevant information, actions, or assistance based on the user's input. The session persists for the duration of the interaction, maintaining context and continuity to provide coherent and meaningful responses throughout the conversation.
// For creating and managing agents, knowledge bases, data sources, endpoints, and data ingestion jobs see the /EN/generative-ai-agents/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 generativeaiagentruntime

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

// RagToolOutput Specifies the output format for RAG tool, including the generated answer and citations.
type RagToolOutput struct {

	// Specifies the unique OCID of the tool.
	ToolId *string `mandatory:"true" json:"toolId"`

	// Specifies the generated answer from the RAG tool.
	Text *string `mandatory:"true" json:"text"`

	// Specifies the display name of the tool.
	ToolName *string `mandatory:"false" json:"toolName"`

	// Citations to data sources used for tool's generated answer.
	Citations []Citation `mandatory:"false" json:"citations"`

	// A list of citations used to generate the paragraphs of the tool's generated answer.
	ParagraphCitations []ParagraphCitation `mandatory:"false" json:"paragraphCitations"`
}

// GetToolId returns ToolId
func (m RagToolOutput) GetToolId() *string {
	return m.ToolId
}

// GetToolName returns ToolName
func (m RagToolOutput) GetToolName() *string {
	return m.ToolName
}

func (m RagToolOutput) 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 RagToolOutput) ValidateEnumValue() (bool, error) {
	errMessage := []string{}

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

// MarshalJSON marshals to json representation
func (m RagToolOutput) MarshalJSON() (buff []byte, e error) {
	type MarshalTypeRagToolOutput RagToolOutput
	s := struct {
		DiscriminatorParam string `json:"toolOutputType"`
		MarshalTypeRagToolOutput
	}{
		"RAG_TOOL_OUTPUT",
		(MarshalTypeRagToolOutput)(m),
	}

	return json.Marshal(&s)
}
