// 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.

// Language API
//
// OCI Language Service solutions can help enterprise customers integrate AI into their products immediately using our proven,
// pre-trained and custom models or containers, without a need to set up an house team of AI and ML experts.
// This allows enterprises to focus on business drivers and development work rather than AI and ML operations, which shortens the time to market.
//

package ailanguage

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

// BatchLanguageTranslationDetails The documents details for translation call.
type BatchLanguageTranslationDetails struct {

	// List of documents for translation.
	Documents []TextDocument `mandatory:"true" json:"documents"`

	// Unique name to identify an endpoint to be used for inferencing
	Alias *string `mandatory:"false" json:"alias"`

	// The endpoint that has to be used for inferencing.
	EndpointId *string `mandatory:"false" json:"endpointId"`

	// List of words not to be translated
	NoTranslate []string `mandatory:"false" json:"noTranslate"`

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// Language code supported
	// Arabic - ar
	// Brazilian Portuguese -  pt-BR
	// Canadian French - fr-CA
	// Croatian - hr
	// Czech - cs
	// Danish - da
	// Dutch - nl
	// English - en
	// Finnish - fi
	// French - fr
	// German - de
	// Greek - el
	// Hebrew - he
	// Hungarian - hu
	// Italian - it
	// Japanese - ja
	// Korean - ko
	// Norwegian - no
	// Polish - pl
	// Portuguese - pt
	// Romanian - ro
	// Russian - ru
	// Simplified Chinese - zh-CN
	// Slovak - sk
	// Slovenian - sl
	// Spanish - es
	// Swedish - sv
	// Thai - th
	// Traditional Chinese - zh-TW
	// Turkish - tr
	// Vietnamese - vi
	TargetLanguageCode *string `mandatory:"false" json:"targetLanguageCode"`
}

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

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