# `ModelId`

An AI model by its provider and name, written `meta-llama/Llama-3.1-8B-Instruct`.

[Other with a published standard](types.md#other-with-a-published-standard); not ordered; since Jadpo 0.1.0.

## Make one

Build one from its fields, `ModelId { provider: ...  name: ... }`.

`text.parse(raw, as: ModelId)` reads one from its text; text that isn't one at all fails `malformed`, such as `gpt-4o`, `openai/` or `/gpt-4o`.

## Fields

| Field | Type |
|---|---|
| `provider` | `Text` |
| `name` | `Text` |

## Text, JSON and storage

`text.from` writes its canonical text, the one form `text.parse` reads back. JSON sends its canonical text as a string.

| Text | JSON |
|---|---|
| `openai/gpt-4o` | `"openai/gpt-4o"` |
| `meta-llama/Llama-3.1-8B-Instruct` | `"meta-llama/Llama-3.1-8B-Instruct"` |
| `ollama/llama3:8b` | `"ollama/llama3:8b"` |

It is stored in 2 columns, each named for the field, `_` and its suffix. This is `meta-llama/Llama-3.1-8B-Instruct`:

| Column | Type | Holds |
|---|---|---|
| `<field>_provider` | `text` | `'meta-llama'` |
| `<field>_name` | `text` | `'Llama-3.1-8B-Instruct'` |

## Shown to people

`text.format(value, locale:)` shows it to people in their locale.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `openai/gpt-4o` | `openai/gpt-4o` |
| `meta-llama/Llama-3.1-8B-Instruct` | `meta-llama/Llama-3.1-8B-Instruct` |
| `ollama/llama3:8b` | `ollama/llama3:8b` |

## Operations

It has the contract's own operations: `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. It isn't ordered, so `<` and sorting don't take it. [Every standard type meets one contract](../topics/every-standard-type-meets-one-contract.md) says how they work.