View Source ExOpenAI.Components.FileCitationBody (ex_openai.ex v2.0.0-beta2)

A citation to a file.

Fields

  • :file_id - required - String.t()
    The ID of the file.

  • :filename - required - String.t()
    The filename of the file cited.

  • :index - required - integer()
    The index of the file in the list of files.

  • :type - required - :file_citation
    The type of the file citation. Always file_citation.
    Allowed values: "file_citation"
    Default: "file_citation"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.FileCitationBody{
  file_id: String.t(),
  filename: String.t(),
  index: integer(),
  type: :file_citation
}