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

Assistant response text accompanied by optional annotations.

Fields

  • :annotations - required - [ExOpenAI.Components.FileAnnotation.t() | ExOpenAI.Components.UrlAnnotation.t()]
    Ordered list of annotations attached to the response text.

  • :text - required - String.t()
    Assistant generated text.

  • :type - required - :output_text
    Type discriminator that is always output_text.
    Allowed values: "output_text"
    Default: "output_text"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.ResponseOutputText{
  annotations: [
    ExOpenAI.Components.FileAnnotation.t()
    | ExOpenAI.Components.UrlAnnotation.t()
  ],
  text: String.t(),
  type: :output_text
}