Interface: ModelRouteParams

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:22

Parameters provided to the model router to aid in its selection process. This context allows the router to make informed decisions.

Properties

activePersona?

optional activePersona: IPersonaDefinition

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:30

The full active persona definition.

---

customContext?

optional customContext: Record<string, any>

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:72

Additional custom parameters or context to aid routing decisions.

---

excludedModelIds?

optional excludedModelIds: string[]

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:60

A list of model IDs that should be excluded from consideration.

---

language?

optional language: string

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:38

The target language for the model's output (e.g., "en", "es", "ja").

---

maxCostPerKInputTokens?

optional maxCostPerKInputTokens: number

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:64

Maximum acceptable cost per 1000 input tokens (in USD), if cost is a critical factor.

---

maxCostPerKOutputTokens?

optional maxCostPerKOutputTokens: number

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:68

Maximum acceptable cost per 1000 output tokens (in USD).

---

optimizationPreference?

optional optimizationPreference: "balanced" | "cost" | "speed" | "quality"

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:43

A preference for optimizing model selection (e.g., for speed, cost, or quality). This can guide the router if multiple suitable models are found.

---

personaId?

optional personaId: string

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:28

The ID of the active persona guiding the interaction.

---

preferredModelIds?

optional preferredModelIds: string[]

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:52

A list of preferred model IDs, if any. The router should try to use one of these if suitable.

---

preferredProviderIds?

optional preferredProviderIds: string[]

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:56

A list of preferred provider IDs, if any.

---

query?

optional query: string

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:36

The user's query or the primary input text for the task.

---

requestingAgentId?

optional requestingAgentId: string

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:26

The ID of the GMI or agent instance making the request.

---

requiredCapabilities?

optional requiredCapabilities: string[]

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:48

Explicitly required capabilities for the model (e.g., "tool_use", "vision_input", "json_mode"). The router must ensure the selected model supports all listed capabilities.

---

taskHint

taskHint: string

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:24

A hint or classification of the current task (e.g., "code_generation", "summarization", "general_chat").

---

userApiKeys?

optional userApiKeys: Record<string, string>

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:70

User-provided API keys for specific providers, which might enable access to certain models.

---

userId?

optional userId: string

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:32

The ID of the user initiating the request.

---

userSubscriptionTier?

optional userSubscriptionTier: ISubscriptionTier

Defined in: packages/agentos/src/core/llm/routing/IModelRouter.ts:34

The subscription tier of the user, which might affect model availability or preference.