Guava.Field (Guava v0.35.0)

A structured-data collection instruction given to the agent during a call.

Mirrors guava.types.Field. The key is used later with Guava.Call.get_field/2 to retrieve the collected value.

Field types requiring options ("multiple_choice", "calendar_slot") must supply either :choices (a small static list) or set :searchable and register a handler via Guava.Agent.handle_search_query/4.

Set :sensitive to mark a field as holding sensitive data (e.g. a "cvv" or "digit_sequence") so the server redacts it from logs and transcripts.

Summary

Types

t()

Functions

new(attrs)

Build and validate a Guava.Field.

Types

t()

@type t() :: %Guava.Field{
  choices: [String.t()],
  description: String.t(),
  field_type: String.t(),
  item_type: String.t(),
  key: String.t(),
  question: String.t(),
  required: boolean(),
  searchable: boolean(),
  sensitive: boolean()
}

Functions

new(attrs)

@spec new(keyword() | map()) :: t()

Build and validate a Guava.Field.

Accepts a keyword list or map of attributes. Raises ArgumentError for invalid combinations, matching the Python SDK's validation:

"datetime" collection is not implemented.
:choices are only valid for "multiple_choice" / "calendar_slot".
"calendar_slot" choices must be ISO-8601 (YYYY-MM-DDTHH:MM).