# coding: utf-8
"""
Arize REST API
API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment.
The version of the OpenAPI document: 2.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
from __future__ import annotations
import pprint
import re # noqa: F401
import json
from datetime import datetime
from pydantic import BaseModel, ConfigDict, Field, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from arize._generated.api_client.models.input_variable_format import InputVariableFormat
from arize._generated.api_client.models.invocation_params import InvocationParams
from arize._generated.api_client.models.llm_message import LLMMessage
from arize._generated.api_client.models.llm_provider import LlmProvider
from arize._generated.api_client.models.provider_params import ProviderParams
from typing import Optional, Set
from typing_extensions import Self
[docs]
class PromptVersion(BaseModel):
"""
A prompt version represents a specific snapshot of a prompt's configuration. Each version captures the messages, model settings, and parameters at a point in time. Versions are immutable once created and are identified by a commit hash.
""" # noqa: E501
id: StrictStr = Field(description="The prompt version ID")
prompt_id: StrictStr = Field(description="The prompt ID this version belongs to")
commit_hash: StrictStr = Field(description="The commit hash of this version")
commit_message: StrictStr = Field(description="The commit message describing the changes in this version")
messages: List[LLMMessage] = Field(description="The messages that make up the prompt template")
input_variable_format: InputVariableFormat
provider: LlmProvider
model: StrictStr = Field(description="The model to use for the call")
invocation_params: Optional[InvocationParams] = None
provider_params: Optional[ProviderParams] = None
created_at: datetime = Field(description="When the version was created")
created_by_user_id: StrictStr = Field(description="The user ID of the user who created this version")
labels: Optional[List[StrictStr]] = Field(default=None, description="Label names currently pointing to this version (e.g., \"production\", \"staging\"). Labels are case-sensitive.")
__properties: ClassVar[List[str]] = ["id", "prompt_id", "commit_hash", "commit_message", "messages", "input_variable_format", "provider", "model", "invocation_params", "provider_params", "created_at", "created_by_user_id", "labels"]
model_config = ConfigDict(
populate_by_name=True,
validate_assignment=True,
protected_namespaces=(),
)
[docs]
def to_str(self) -> str:
"""Returns the string representation of the model using alias"""
return pprint.pformat(self.model_dump(by_alias=True))
[docs]
def to_json(self) -> str:
"""Returns the JSON representation of the model using alias"""
# TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
return json.dumps(self.to_dict())
[docs]
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
"""Create an instance of PromptVersion from a JSON string"""
return cls.from_dict(json.loads(json_str))
[docs]
def to_dict(self) -> Dict[str, Any]:
"""Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic's
`self.model_dump(by_alias=True)`:
* `None` is only added to the output dict for nullable fields that
were set at model initialization. Other fields with value `None`
are ignored.
"""
excluded_fields: Set[str] = set([
])
_dict = self.model_dump(
by_alias=True,
exclude=excluded_fields,
exclude_none=True,
)
# override the default output from pydantic by calling `to_dict()` of each item in messages (list)
_items = []
if self.messages:
for _item_messages in self.messages:
if _item_messages:
_items.append(_item_messages.to_dict())
_dict['messages'] = _items
# override the default output from pydantic by calling `to_dict()` of invocation_params
if self.invocation_params:
_dict['invocation_params'] = self.invocation_params.to_dict()
# override the default output from pydantic by calling `to_dict()` of provider_params
if self.provider_params:
_dict['provider_params'] = self.provider_params.to_dict()
return _dict
[docs]
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"""Create an instance of PromptVersion from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return cls.model_validate(obj)
# raise errors for additional fields in the input
for _key in obj.keys():
if _key not in cls.__properties:
raise ValueError("Error due to additional fields (not defined in PromptVersion) in the input: " + _key)
_obj = cls.model_validate({
"id": obj.get("id"),
"prompt_id": obj.get("prompt_id"),
"commit_hash": obj.get("commit_hash"),
"commit_message": obj.get("commit_message"),
"messages": [LLMMessage.from_dict(_item) for _item in obj["messages"]] if obj.get("messages") is not None else None,
"input_variable_format": obj.get("input_variable_format"),
"provider": obj.get("provider"),
"model": obj.get("model"),
"invocation_params": InvocationParams.from_dict(obj["invocation_params"]) if obj.get("invocation_params") is not None else None,
"provider_params": ProviderParams.from_dict(obj["provider_params"]) if obj.get("provider_params") is not None else None,
"created_at": obj.get("created_at"),
"created_by_user_id": obj.get("created_by_user_id"),
"labels": obj.get("labels")
})
return _obj
