rtemis.llm (version 0.8.1)

field: Define a schema field

Description

Define a schema field

Usage

field(
  name,
  description = name,
  type = c("string", "number", "integer", "boolean", "array", "object"),
  required = TRUE
)

Value

Field object

Arguments

name

Optional Character: The name of the field.

description

Optional Character: A brief description of the field.

type

Character {"string", "number", "integer", "boolean", "array", "object"}: The field type.

required

Logical: Whether the field is required.

Author

EDG

Examples

# `type` defaults to "string", `required` defaults to TRUE
field("lab_name", "Name of the lab test")
field("normal_range_low", "Lower bound of normal range", type = "number")