model

Model

Immutable representation of a model from an integration provider.

Models are associated with specific providers (OpenAI, Azure, Bedrock, etc.) and represent available LLM models that can be used in experiments and logging.

The Model class is immutable once created and serializes to a string (model alias) when used in API calls or function parameters.

Examples

# Create a model from a provider
openai_provider = Integration.create_openai(token="sk-...")
models = openai_provider.models
model = models[0]

# Use model in experiment (serializes to string)
experiment = Experiment(
    name="test",
    dataset_name="dataset",
    prompt_name="prompt",
    project_name="project",
    model=model  # Automatically converts to string alias
)

# Model is immutable
model.alias = "new-value"  # Raises AttributeError

alias

def alias(self) -> str

Get the model alias.

name

def name(self) -> str

Get the model name.

provider_name

def provider_name(self) -> str

Get the provider name.

to_dict

def to_dict(self) -> dict[str, Any]

Convert model to dictionary representation.

Returns

dict: Dictionary with model properties.