ai-mocks-openai/dev.mokksy.aimocks.openai.model/Annotation

Annotation

data class Annotation(val type: Annotation.Type, val index: Int, val fileId: String, val url: String, val title: String, val startIndex: Int, val endIndex: Int)(source)

Parameters

type

The type of the file citation. Always file_citation.

index

The index of the file in the list of files.

fileId

The ID of the file.

url

The URL of the web resource.

title

The title of the web resource.

startIndex

The index of the first character of the URL citation in the message.

endIndex

The index of the last character of the URL citation in the message.

Constructors

Annotation

constructor(type: Annotation.Type, index: Int, fileId: String, url: String, title: String, startIndex: Int, endIndex: Int)

Types

Type

@Serializable

enum Type : Enum<Annotation.Type>

The type of the file citation. Always file_citation.

Properties

endIndex

@SerialName(value = "end_index")

@Required

val endIndex: Int

fileId

@SerialName(value = "file_id")

@Required

val fileId: String

index

@SerialName(value = "index")

@Required

val index: Int

startIndex

@SerialName(value = "start_index")

@Required

val startIndex: Int

title

@SerialName(value = "title")

@Required

val title: String

type

@SerialName(value = "type")

@Required

val type: Annotation.Type

url

@SerialName(value = "url")

@Required

val url: String