View Source OpenAi.Message.Delta.Content.Text.Annotations.FileCitation (OpenAI REST API Client v0.4.4)

MessageDeltaContentTextAnnotationsFileCitationObject: title: File citation type: object description: 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. properties:

  index:
      type: integer
      description: The index of the annotation in the text content part.
  type:
      description: Always `file_citation`.
      type: string
      enum: ["file_citation"]
  text:
      description: The text in the message content that needs to be replaced.
      type: string
  file_citation:
      type: object
      properties:
          file_id:
              description: The ID of the specific File the citation is from.
              type: string
          quote:
              description: The specific quote in the file.
              type: string
  start_index:
      type: integer
      minimum: 0
  end_index:
      type: integer
      minimum: 0

required:

  - index
  - type

Summary

Types

@type t() :: %OpenAi.Message.Delta.Content.Text.Annotations.FileCitation{
  end_index: integer(),
  file_citation:
    OpenAi.Message.Delta.Content.Text.Annotations.FileCitationFileCitation.t(),
  index: integer(),
  start_index: integer(),
  text: String.t(),
  type: String.t()
}