commonMain.com.xebia.functional.openai.generated.model.BatchRequestInput.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.*

/**
* The per-line object of the batch input file
*
    * @param customId A developer-provided per-request id that will be used to match outputs to inputs. Must be unique for each request in a batch.
    * @param method The HTTP method to be used for the request. Currently only `POST` is supported.
    * @param url The OpenAI API relative URL to be used for the request. Currently `/v1/chat/completions`, `/v1/embeddings`, and `/v1/completions` are supported.
*/
@Serializable


data class BatchRequestInput (
        /* A developer-provided per-request id that will be used to match outputs to inputs. Must be unique for each request in a batch. */
    @SerialName(value = "custom_id") val customId: kotlin.String? = null,
        /* The HTTP method to be used for the request. Currently only `POST` is supported. */
    @SerialName(value = "method") val method: BatchRequestInput.Method? = null,
        /* The OpenAI API relative URL to be used for the request. Currently `/v1/chat/completions`, `/v1/embeddings`, and `/v1/completions` are supported. */
    @SerialName(value = "url") val url: kotlin.String? = null
) {

            /**
            * The HTTP method to be used for the request. Currently only `POST` is supported.
            *
            * Values: post
            */
            @Serializable
            enum class Method(val value: kotlin.String) {
                @SerialName(value = "POST") post("POST");
                }
}