GenAI.Tool.Schema.Integer (GenAI Core v0.3.1)

Copy Markdown

Represents a schema for integer types, converting JSON schema attributes to Elixir struct fields.

Summary

Types

t()

Functions

from_json(json)

Convert Json map to a GenAI.Tool.Schema.Integer struct, handling naming conventions.

is_type(arg1)

Check if json is of type

Types

t()

@type t() :: %GenAI.Tool.Schema.Integer{
  description: String.t() | nil,
  exclusive_maximum: boolean() | nil,
  exclusive_minimum: boolean() | nil,
  maximum: integer() | nil,
  minimum: integer() | nil,
  multiple_of: integer() | nil,
  type: String.t()
}

Functions

from_json(json)

Convert Json map to a GenAI.Tool.Schema.Integer struct, handling naming conventions.

Examples

Is of Type

iex> GenAI.Tool.Schema.Integer.from_json(%{"type" => "integer", "minimum" => 5, "description" => "An integer value"})
{:ok, %GenAI.Tool.Schema.Integer{type: "integer", minimum: 5, description: "An integer value"}}

Not of Type

iex> GenAI.Tool.Schema.Integer.from_json(%{"type" => "number"})
{:error, :unrecognized_type}

is_type(arg1)

Check if json is of type

Examples

Is of Type

iex> GenAI.Tool.Schema.Enum.is_type(%{"type" => "integer"})
true

Not of Type

iex> GenAI.Tool.Schema.Enum.is_type(%{"type" => "string"})
false