Exosphere.Community.Preference.Ai (Exosphere v0.3.0)

Copy Markdown View Source

Declares a user's preferences regarding AI usage of their public data. A record at key 'self' with globalScope establishes default preferences. Additional records keyed by TID establish scoped overrides for specific entities or content collections.

Record schema community.lexicon.preference.ai.

Fields

  • preferences: ref #preferenceSet
  • scope: What this record's preferences apply to.
  • updated_at: Timestamp of the most recent change to this record.

Summary

Types

t()

Functions

from_map(map)

Decode a wire-format map. Delegates to new/1.

new(attrs)

Build and validate from a map of attrs (atom or wire string keys).

new!(attrs)

Build and validate, raising ArgumentError on error.

to_map(struct)

Encode to the wire-format map. Record schemas include "$type".

type_id()

The lexicon type ID (nsid or nsid#def) this module was generated from.

Types

t()

@type t() :: %Exosphere.Community.Preference.Ai{
  extra: term(),
  preferences: Exosphere.Community.Preference.Ai.PreferenceSet.t(),
  scope:
    Exosphere.Community.Preference.Ai.GlobalScope.t()
    | Exosphere.Community.Preference.Ai.EntityScope.t()
    | Exosphere.Community.Preference.Ai.CollectionScope.t()
    | map(),
  updated_at: String.t()
}

Functions

from_map(map)

@spec from_map(map()) ::
  {:ok, t()} | {:error, [{path :: String.t(), message :: String.t()}]}

Decode a wire-format map. Delegates to new/1.

new(attrs)

@spec new(map()) ::
  {:ok, t()} | {:error, [{path :: String.t(), message :: String.t()}]}

Build and validate from a map of attrs (atom or wire string keys).

Unknown keys are kept in extra and re-emitted by to_map/1.

new!(attrs)

@spec new!(map()) :: t()

Build and validate, raising ArgumentError on error.

to_map(struct)

@spec to_map(t()) :: map()

Encode to the wire-format map. Record schemas include "$type".

type_id()

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

The lexicon type ID (nsid or nsid#def) this module was generated from.