cohere_message.go

// Copyright (c) 2016, 2018, 2024, 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 Service Inference API
//
// OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.
// Use the Generative AI service inference API to access your custom model endpoints, or to try the out-of-the-box models to Chat, GenerateText, SummarizeText, and EmbedText.
// To use a Generative AI custom model for inference, you must first create an endpoint for that model. Use the Generative AI service management API (https://docs.cloud.oracle.com/#/en/generative-ai/latest/) to Model by fine-tuning an out-of-the-box model, or a previous version of a custom model, using your own data. Fine-tune the custom model on a  DedicatedAiCluster. Then, create a DedicatedAiCluster with an Endpoint to host your custom model. For resource management in the Generative AI service, use the Generative AI service management API (https://docs.cloud.oracle.com/#/en/generative-ai/latest/).
// To learn more about the service, see the Generative AI documentation (https://docs.cloud.oracle.com/iaas/Content/generative-ai/home.htm).
//

package generativeaiinference

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

// CohereMessage A message that represents a single chat dialog.
type CohereMessage interface {
}

type coheremessage struct {
	JsonData []byte
	Role     string `json:"role"`
}

// UnmarshalJSON unmarshals json
func (m *coheremessage) UnmarshalJSON(data []byte) error {
	m.JsonData = data
	type Unmarshalercoheremessage coheremessage
	s := struct {
		Model Unmarshalercoheremessage
	}{}
	err := json.Unmarshal(data, &s.Model)
	if err != nil {
		return err
	}
	m.Role = s.Model.Role

	return err
}

// UnmarshalPolymorphicJSON unmarshals polymorphic json
func (m *coheremessage) UnmarshalPolymorphicJSON(data []byte) (interface{}, error) {

	if data == nil || string(data) == "null" {
		return nil, nil
	}

	var err error
	switch m.Role {
	case "CHATBOT":
		mm := CohereChatBotMessage{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "SYSTEM":
		mm := CohereSystemMessage{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "TOOL":
		mm := CohereToolMessage{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "USER":
		mm := CohereUserMessage{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	default:
		common.Logf("Recieved unsupported enum value for CohereMessage: %s.", m.Role)
		return *m, nil
	}
}

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

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

// CohereMessageRoleEnum Enum with underlying type: string
type CohereMessageRoleEnum string

// Set of constants representing the allowable values for CohereMessageRoleEnum
const (
	CohereMessageRoleChatbot CohereMessageRoleEnum = "CHATBOT"
	CohereMessageRoleUser    CohereMessageRoleEnum = "USER"
	CohereMessageRoleSystem  CohereMessageRoleEnum = "SYSTEM"
	CohereMessageRoleTool    CohereMessageRoleEnum = "TOOL"
)

var mappingCohereMessageRoleEnum = map[string]CohereMessageRoleEnum{
	"CHATBOT": CohereMessageRoleChatbot,
	"USER":    CohereMessageRoleUser,
	"SYSTEM":  CohereMessageRoleSystem,
	"TOOL":    CohereMessageRoleTool,
}

var mappingCohereMessageRoleEnumLowerCase = map[string]CohereMessageRoleEnum{
	"chatbot": CohereMessageRoleChatbot,
	"user":    CohereMessageRoleUser,
	"system":  CohereMessageRoleSystem,
	"tool":    CohereMessageRoleTool,
}

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

// GetCohereMessageRoleEnumStringValues Enumerates the set of values in String for CohereMessageRoleEnum
func GetCohereMessageRoleEnumStringValues() []string {
	return []string{
		"CHATBOT",
		"USER",
		"SYSTEM",
		"TOOL",
	}
}

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