s() API Signature and field APIs. rust api api/s packages/rust/axir-api.json api s() API

s() API

Signature, field, schema, and validation APIs.

Most Used

s

Parse an Ax string signature into the target language signature object.

FieldValue
Kindfunction
Ax concepts
API sectionSignatures
Forms(spec: &str)
ReturnsAxResult

Examples

Rust
let sig = s("question:string -> answer:string")?;

Full reference

f

Build signatures and field types fluently when the target has a fluent helper.

FieldValue
Kindfunction
Ax conceptf
API sectionSignatures
Formf().input(...).output(...).build()
Returnssignature builder or field factory

Important Options

  • input fields
  • output fields
  • field descriptions
  • constraints

Full reference

AxSignature

Parsed signature with input/output fields, descriptions, and JSON schema helpers.

FieldValue
Kindtype
Ax conceptAxSignature
API sectionSignatures
FormAxSignature
Returnssignature object

Important Options

  • inputs
  • outputs
  • description

Full reference

Full Reference

Open the full Rust reference. This page highlights the s symbols most relevant to everyday use.

Docs