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

The newest version!

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



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

/**
* A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"file_search\" tool to search files.
*
    * @param index The index of the annotation in the text content part.
    * @param type Always `file_citation`.
    * @param text The text in the message content that needs to be replaced.
    * @param fileCitation 
    * @param startIndex 
    * @param endIndex 
*/
@Serializable


data class MessageDeltaContentTextAnnotationsFileCitationObject (
        /* The index of the annotation in the text content part. */
    @SerialName(value = "index") val index: kotlin.Int,
        /* Always `file_citation`. */
    @SerialName(value = "type") val type: MessageDeltaContentTextAnnotationsFileCitationObject.Type,
        /* The text in the message content that needs to be replaced. */
    @SerialName(value = "text") val text: kotlin.String? = null,
        @SerialName(value = "file_citation") val fileCitation: MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation? = null,
        @SerialName(value = "start_index") val startIndex: kotlin.Int? = null,
        @SerialName(value = "end_index") val endIndex: kotlin.Int? = null
) {

            /**
            * Always `file_citation`.
            *
            * Values: file_citation
            */
            @Serializable
            enum class Type(val value: kotlin.String) {
                @SerialName(value = "file_citation") file_citation("file_citation");
                }
}