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

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.

Fields

  • :end_index - required - integer()
    Constraints: minimum: 0

  • :file_citation - required - {:%{}, [], [{{:required, [], [:file_id]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}]}

  • :start_index - required - integer()
    Constraints: minimum: 0

  • :text - required - String.t()
    The text in the message content that needs to be replaced.

  • :type - required - :file_citation
    Always file_citation.
    Allowed values: "file_citation"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.MessageContentTextAnnotationsFileCitationObject{
  end_index: integer(),
  file_citation: %{file_id: String.t()},
  start_index: integer(),
  text: String.t(),
  type: :file_citation
}