model-preference

Import

Import

import * as api from "@fungi.computer/shiitake/model-preference";

Exports

Kind	Export	Description
constconstant	modelReasoningLevels	The thinking levels a model choice may name, shared by every model path.
constconstant	ModelPreferenceSchema	Secret-free request to the host’s maintained model catalogue.
constconstant	parseModelPreference	Decode the bounded client preference; availability remains model-owner policy.
constconstant	parseModelPreferenceJson	Decode the serialized preference with the same maintained schema.
constconstant	modelPreferenceJsonSchema	JSON Schema generated from Shiitake’s maintained model preference schema.
fnfunction	parseModelAddress()	Parse the footer’s provider/model spelling; model ids may contain slashes.
fnfunction	resolveModelPreference()	Resolve host-owned defaults for a future run. Hosts supply offered, logged-in availability; an explicit choice never silently falls through on auth failure.

modelReasoningLevelsconstconstant

Signature

const modelReasoningLevels: readonly [
  "minimal",
  "low",
  "medium",
  "high",
  "xhigh",
  "max",
];

The thinking levels a model choice may name, shared by every model path.

---

ModelPreferenceSchemaconstconstant

Signature

const ModelPreferenceSchema: Struct<{
  providerId: String;
  modelId: String;
  reasoning: optional<
    Literals<readonly ["minimal", "low", "medium", "high", "xhigh", "max"]>
  >;
}>;

Secret-free request to the host’s maintained model catalogue.

---

parseModelPreferenceconstconstant

Signature

const parseModelPreference: (
  input,
  options?,
) => {
  providerId: string;
  modelId: string;
  reasoning?: "high" | "low" | "max" | "medium" | "minimal" | "xhigh";
} | null;

Decode the bounded client preference; availability remains model-owner policy.

Parameters

Parameter	Type
input	unknown
options?	ParseOptions

Returns

| { providerId: string; modelId: string; reasoning?: "high" | "low" | "max" | "medium" | "minimal" | "xhigh"; } | null

---

parseModelPreferenceJsonconstconstant

Signature

const parseModelPreferenceJson: (
  input,
  options?,
) => {
  providerId: string;
  modelId: string;
  reasoning?: "high" | "low" | "max" | "medium" | "minimal" | "xhigh";
} | null;

Decode the serialized preference with the same maintained schema.

Parameters

Parameter	Type
input	unknown
options?	ParseOptions

Returns

| { providerId: string; modelId: string; reasoning?: "high" | "low" | "max" | "medium" | "minimal" | "xhigh"; } | null

---

modelPreferenceJsonSchemaconstconstant

Signature

const modelPreferenceJsonSchema: JsonSchema;

JSON Schema generated from Shiitake’s maintained model preference schema.

parseModelAddress()fnfunction

Signature

function parseModelAddress(input): object;

Parse the footer’s provider/model spelling; model ids may contain slashes.

Parameters

Parameter	Type
input	unknown

Returns

object

Name	Type	Default value
providerId	string	identifier
modelId	string	identifier
reasoning?	"high" | "low" | "max" | "medium" | "minimal" | "xhigh"	-

---

resolveModelPreference()fnfunction

Signature

function resolveModelPreference(layers): {
  providerId: string;
  modelId: string;
  reasoning?: "high" | "low" | "max" | "medium" | "minimal" | "xhigh";
} | null;

Resolve host-owned defaults for a future run. Hosts supply offered, logged-in availability; an explicit choice never silently falls through on auth failure.

Parameters

Parameter	Type
layers	Readonly<{ session?: ModelPreference | null; agent?: ModelPreference | null; manual?: ModelPreference | null; team?: ModelPreference | null; available?: ModelPreference | null; }>

Returns

| { providerId: string; modelId: string; reasoning?: "high" | "low" | "max" | "medium" | "minimal" | "xhigh"; } | null

References

ModelPreference

Re-exports ModelPreference