Omni.Content.Attachment (Omni v2.0.0)

Copy Markdown View Source

An attachment content block: an image, a PDF or other binary content.

A model takes only the media it supports (see :input_modalities on Omni.Model); a request with an attachment it can't take is an error before anything is sent.

Omni.attachment({:base64, Base.encode64(File.read!("photo.png"))}, "image/png")
Omni.attachment({:url, "https://example.com/report.pdf"}, "application/pdf")

Struct fields

  • :source - where the content is: {:base64, data} for inline base64-encoded data, or {:url, url} for content hosted elsewhere
  • :media_type - the MIME type, such as "image/png" or "application/pdf"
  • :meta - a map for your application's own data, such as a filename or a label for a UI. Omni never reads it or sends it to a provider

Summary

Types

An attachment source: inline base64 data or a remote URL.

t()

Binary content with a source, media type, and optional application metadata.

Functions

Creates a new attachment content block from a keyword list or map.

Creates a new attachment content block from a source and media type.

Types

source()

@type source() :: {:base64, binary()} | {:url, String.t()}

An attachment source: inline base64 data or a remote URL.

t()

@type t() :: %Omni.Content.Attachment{
  media_type: String.t(),
  meta: map(),
  source: source()
}

Binary content with a source, media type, and optional application metadata.

Functions

new(attrs)

@spec new(Enumerable.t()) :: t()

Creates a new attachment content block from a keyword list or map.

Attachment.new(source: {:url, "https://example.com/cat.png"}, media_type: "image/png", meta: %{name: "cat.png"})

new(source, media_type)

@spec new(source(), String.t()) :: t()

Creates a new attachment content block from a source and media type.

Attachment.new({:base64, Base.encode64(File.read!("photo.png"))}, "image/png")
Attachment.new({:url, "https://example.com/report.pdf"}, "application/pdf")