ModelSpecification

Describes how to communicate with an external Large Language Model API.

Can be registered with the Model Registry using the roli register-model SDK command.
Used by Sessions to run Programs.
Retrieved from the Model Registry at runtime using the getModel function.

Constructors

new ModelSpecification(name, url, settings, apiKey?, headers?): ModelSpecification

• name: string

• url: string

• apiKey?: null | string

• headers?: null | Object

apiKey?: null | string

Optional. The API key authorized to call the Generative AI hosting provider.

headers?: null | Object

Optional. Additional information to pass to the Generative AI hosting provider’s API.

name: string

The name of the model as passed to the Generative AI hosting provider.

settings: ChatModelSettings

The settings object to pass to the Generative AI hosting provider.

url: string

The HTTPS URL of the Generative AI hosting provider’s API.