ChatResultAnnotation

@Serializable
data class ChatResultAnnotation(val type: String, val urlCitation: UrlCitation? = null, val url: String? = null, val title: String? = null, val startIndex: Int? = null, val endIndex: Int? = null, val text: String? = null, val fileId: String? = null, val filename: String? = null, val index: Int? = null, val containerId: String? = null)

Output citation used by rich Chat result messages.

Constructors

Link copied to clipboard
constructor(type: String, urlCitation: UrlCitation? = null, url: String? = null, title: String? = null, startIndex: Int? = null, endIndex: Int? = null, text: String? = null, fileId: String? = null, filename: String? = null, index: Int? = null, containerId: String? = null)

Properties

Link copied to clipboard
@SerialName(value = "container_id")
val containerId: String? = null

Container holding a cited file.

Link copied to clipboard
@SerialName(value = "end_index")
val endIndex: Int? = null

End character offset.

Link copied to clipboard
@SerialName(value = "file_id")
val fileId: String? = null

Referenced file ID.

Link copied to clipboard
val filename: String? = null

Referenced file name.

Link copied to clipboard
val index: Int? = null

File citation position.

Link copied to clipboard
@SerialName(value = "start_index")
val startIndex: Int? = null

Start character offset.

Link copied to clipboard
val text: String? = null

Citation text.

Link copied to clipboard
val title: String? = null

Flat source title.

Link copied to clipboard

Citation kind.

Link copied to clipboard
val url: String? = null

Flat URL for compatible providers.

Link copied to clipboard
@SerialName(value = "url_citation")
val urlCitation: UrlCitation? = null

URL citation returned by Chat Completions.