commonMain.com.xebia.functional.openai.generated.model.FunctionObject.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xef-openai-client Show documentation

Building applications with LLMs through composability in Kotlin

There is a newer version: 0.0.5-alpha.118

/**
 *
 * Please note:
 * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * Do not edit this file manually.
 *
 */

@file:Suppress(
    "ArrayInDataClass",
    "EnumEntryName",
    "RemoveRedundantQualifierName",
    "UnusedImport"
)

package com.xebia.functional.openai.generated.model




import kotlinx.serialization.Serializable
import kotlinx.serialization.SerialName
import kotlinx.serialization.Contextual
import kotlin.js.JsName
import kotlinx.serialization.json.*

/**
* 
*
    * @param name The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
    * @param description A description of what the function does, used by the model to choose when and how to call the function.
    * @param parameters 
    * @param strict Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling).
*/
@Serializable


data class FunctionObject (
        /* The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. */
    @SerialName(value = "name") val name: kotlin.String,
        /* A description of what the function does, used by the model to choose when and how to call the function. */
    @SerialName(value = "description") val description: kotlin.String? = null,
        @SerialName(value = "parameters") val parameters: kotlinx.serialization.json.JsonObject? = null,
        /* Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling). */
    @SerialName(value = "strict") val strict: kotlin.Boolean? = false
) {

}