adk_content (erlang_adk v0.7.0)

View Source

Versioned, JSON-safe model content.

A content value is independent of any model provider. Binary payloads are base64 encoded at this boundary so the canonical value can be persisted, replayed, and encoded as JSON without retaining an ambiguous Erlang binary. Validation is deliberately bounded; callers can lower (but not exceed) the library safety ceilings through content_limits in a provider config.

Summary

Types

content/0
error_reason/0
limits/0
part/0

Functions

codec_version()
default_limits()
file_data(MimeType, Uri)
file_data(MimeType, Uri, LimitOverrides)
function_call(Name, Args)
function_call(Name, Args, Options)
function_response(Name, Response)
function_response(Name, Response, Options)
inline_data(MimeType, Bytes)

Construct an inline-data part from raw bytes. The canonical part stores RFC 4648 base64, never raw bytes.

inline_data(MimeType, Bytes, LimitOverrides)
new(Parts)
new(Parts, LimitOverrides)
normalize_limits(Overrides)

Validate limit overrides and return a complete limit map. Unknown keys, zero/negative limits, and values above hard safety ceilings are rejected.

part_types(Content)
parts(_)
safety_limits()

Hard codec ceilings used by trusted persistence boundaries. Provider configs may lower any value, but no public content can exceed this map.

text(Value)
validate(Content)
validate(Content, LimitOverrides)

Types

content/0

-type content() :: #{binary() => term()}.

error_reason/0

-type error_reason() :: term().

limits/0

-type limits() :: #{atom() => pos_integer()}.

part/0

-type part() :: #{binary() => term()}.

Functions

codec_version()

-spec codec_version() -> pos_integer().

default_limits()

-spec default_limits() -> limits().

file_data(MimeType, Uri)

-spec file_data(binary(), binary()) -> {ok, part()} | {error, error_reason()}.

file_data(MimeType, Uri, LimitOverrides)

-spec file_data(binary(), binary(), map()) -> {ok, part()} | {error, error_reason()}.

function_call(Name, Args)

-spec function_call(binary(), map()) -> {ok, part()} | {error, error_reason()}.

function_call(Name, Args, Options)

-spec function_call(binary(), map(), map()) -> {ok, part()} | {error, error_reason()}.

function_response(Name, Response)

-spec function_response(binary(), map()) -> {ok, part()} | {error, error_reason()}.

function_response(Name, Response, Options)

-spec function_response(binary(), map(), map()) -> {ok, part()} | {error, error_reason()}.

inline_data(MimeType, Bytes)

-spec inline_data(binary(), binary()) -> {ok, part()} | {error, error_reason()}.

Construct an inline-data part from raw bytes. The canonical part stores RFC 4648 base64, never raw bytes.

inline_data(MimeType, Bytes, LimitOverrides)

-spec inline_data(binary(), binary(), map()) -> {ok, part()} | {error, error_reason()}.

new(Parts)

-spec new([part()]) -> {ok, content()} | {error, error_reason()}.

new(Parts, LimitOverrides)

-spec new([part()], map()) -> {ok, content()} | {error, error_reason()}.

normalize_limits(Overrides)

-spec normalize_limits(map()) -> {ok, limits()} | {error, error_reason()}.

Validate limit overrides and return a complete limit map. Unknown keys, zero/negative limits, and values above hard safety ceilings are rejected.

part_types(Content)

-spec part_types(content()) -> [binary()].

parts(_)

-spec parts(content()) -> [part()].

safety_limits()

-spec safety_limits() -> limits().

Hard codec ceilings used by trusted persistence boundaries. Provider configs may lower any value, but no public content can exceed this map.

text(Value)

-spec text(term()) -> {ok, part()} | {error, error_reason()}.

validate(Content)

-spec validate(term()) -> {ok, content()} | {error, error_reason()}.

validate(Content, LimitOverrides)

-spec validate(term(), map()) -> {ok, content()} | {error, error_reason()}.