ReqLLM.Message.ContentPart (ReqLLM v1.12.0)

View Source

ContentPart represents a single piece of content within a message.

Supports multiple content types:

  • :text - Plain text content
  • :image_url - Image from URL
  • :video_url - Video from URL
  • :image - Image from binary data
  • :file - File attachment or uploaded file reference
  • :thinking - Chain-of-thought thinking content

See also

  • ReqLLM.Message - Multi-modal message composition using ContentPart collections

Summary

Types

t()

Functions

file(data, filename, media_type \\ "application/octet-stream")
file_id(file_id, media_type_or_metadata \\ "application/pdf", metadata \\ %{})
image(data, media_type \\ "image/png")
image(data, media_type, metadata)
image_url(url)
image_url(url, metadata)
schema()

Returns the Zoi schema for this module

text(content)
text(content, metadata)
thinking(content)
thinking(content, metadata)
valid?(arg1)
video_url(url)
video_url(url, metadata)

Types

t()

@type t() :: %ReqLLM.Message.ContentPart{
  data: nil | nil | any(),
  file_id: nil | nil | binary(),
  filename: nil | nil | binary(),
  media_type: nil | nil | binary(),
  metadata: map(),
  text: nil | nil | binary(),
  type: :text | :image_url | :video_url | :image | :file | :thinking,
  url: nil | nil | binary()
}

Functions

file(data, filename, media_type \\ "application/octet-stream")

@spec file(binary(), String.t(), String.t()) :: t()

file_id(file_id, media_type_or_metadata \\ "application/pdf", metadata \\ %{})

@spec file_id(String.t(), String.t(), map()) :: t()

image(data, media_type \\ "image/png")

@spec image(binary(), String.t()) :: t()

image(data, media_type, metadata)

@spec image(binary(), String.t(), map()) :: t()

image_url(url)

@spec image_url(String.t()) :: t()

image_url(url, metadata)

@spec image_url(String.t(), map()) :: t()

schema()

Returns the Zoi schema for this module

text(content)

@spec text(String.t()) :: t()

text(content, metadata)

@spec text(String.t(), map()) :: t()

thinking(content)

@spec thinking(String.t()) :: t()

thinking(content, metadata)

@spec thinking(String.t(), map()) :: t()

valid?(arg1)

@spec valid?(t()) :: boolean()

video_url(url)

@spec video_url(String.t()) :: t()

video_url(url, metadata)

@spec video_url(String.t(), map()) :: t()