agify

package

v0.1.0 Latest Latest Go to latest Published: Jun 14, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tamnd/agify-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package agify is the library behind the agify command line: the HTTP client, request shaping, and the typed data models for the Agify.io API (predict age from a first name).

The Client is the spine every command shares. It sets a real User-Agent, paces requests so a busy session stays polite, and retries the transient failures (429 and 5xx) that any public API throws under load.

Index ¶

type Client
- func NewClient(cfg Config) *Client
- func (c *Client) Batch(ctx context.Context, names []string, country string) ([]Prediction, error)
- func (c *Client) Predict(ctx context.Context, name, country string) (*Prediction, error)
type Config
- func DefaultConfig() Config
type Domain
type Prediction

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

Client talks to api.agify.io over HTTP.

func NewClient ¶

func NewClient(cfg Config) *Client

NewClient returns a Client configured from cfg.

func (*Client) Batch ¶

func (c *Client) Batch(ctx context.Context, names []string, country string) ([]Prediction, error)

Batch returns age predictions for up to 10 names. country is an ISO 3166-1 alpha-2 code or empty string for global predictions.

func (*Client) Predict ¶

func (c *Client) Predict(ctx context.Context, name, country string) (*Prediction, error)

Predict returns the age prediction for a single first name. country is an ISO 3166-1 alpha-2 code (e.g. "US") or empty string for the global prediction.

type Config ¶

type Config struct {
	BaseURL   string
	UserAgent string
	Rate      time.Duration
	Timeout   time.Duration
	Retries   int
}

Config holds all tuneable parameters for a Client.

func DefaultConfig ¶

func DefaultConfig() Config

DefaultConfig returns the production configuration for api.agify.io.

type Domain ¶

type Domain struct{}

Domain is the agify driver. It carries no state; the per-run client is built by the factory Register hands kit.

func (Domain) Classify ¶

func (Domain) Classify(input string) (uriType, id string, err error)

Classify turns any accepted input into the canonical (type, id).

func (Domain) Info ¶

func (Domain) Info() kit.DomainInfo

Info describes the scheme, the hostnames a pasted link is matched against, and the identity reused for the binary's help and version.

func (Domain) Locate ¶

func (Domain) Locate(uriType, id string) (string, error)

Locate is the inverse: the live https URL for a (type, id).

func (Domain) Register ¶

func (Domain) Register(app *kit.App)

Register installs the client factory and every operation onto app.

type Prediction ¶

type Prediction struct {
	Name    string `json:"name"`
	Age     int    `json:"age"`
	Count   int    `json:"count"`
	Country string `json:"country_id,omitempty"`
}

Prediction is the age-prediction result for one first name.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL