Source code for arize._generated.api_client.models.provider_params
# 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 pydantic import BaseModel, ConfigDict, Field, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from arize._generated.api_client.models.provider_params_anthropic_headers import ProviderParamsAnthropicHeaders
from arize._generated.api_client.models.provider_params_azure_params import ProviderParamsAzureParams
from arize._generated.api_client.models.provider_params_bedrock_options import ProviderParamsBedrockOptions
from typing import Optional, Set
from typing_extensions import Self
[docs]
class ProviderParams(BaseModel):
"""
Provider-specific parameters
""" # noqa: E501
azure_params: Optional[ProviderParamsAzureParams] = None
anthropic_headers: Optional[ProviderParamsAnthropicHeaders] = None
anthropic_version: Optional[StrictStr] = Field(default=None, description="Anthropic API version")
bedrock_options: Optional[ProviderParamsBedrockOptions] = None
region: Optional[StrictStr] = Field(default=None, description="Region for the model deployment")
additional_properties: Dict[str, Any] = {}
__properties: ClassVar[List[str]] = ["azure_params", "anthropic_headers", "anthropic_version", "bedrock_options", "region"]
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 ProviderParams 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.
* Fields in `self.additional_properties` are added to the output dict.
"""
excluded_fields: Set[str] = set([
"additional_properties",
])
_dict = self.model_dump(
by_alias=True,
exclude=excluded_fields,
exclude_none=True,
)
# override the default output from pydantic by calling `to_dict()` of azure_params
if self.azure_params:
_dict['azure_params'] = self.azure_params.to_dict()
# override the default output from pydantic by calling `to_dict()` of anthropic_headers
if self.anthropic_headers:
_dict['anthropic_headers'] = self.anthropic_headers.to_dict()
# override the default output from pydantic by calling `to_dict()` of bedrock_options
if self.bedrock_options:
_dict['bedrock_options'] = self.bedrock_options.to_dict()
# puts key-value pairs in additional_properties in the top level
if self.additional_properties is not None:
for _key, _value in self.additional_properties.items():
_dict[_key] = _value
return _dict
[docs]
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"""Create an instance of ProviderParams from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return cls.model_validate(obj)
_obj = cls.model_validate({
"azure_params": ProviderParamsAzureParams.from_dict(obj["azure_params"]) if obj.get("azure_params") is not None else None,
"anthropic_headers": ProviderParamsAnthropicHeaders.from_dict(obj["anthropic_headers"]) if obj.get("anthropic_headers") is not None else None,
"anthropic_version": obj.get("anthropic_version"),
"bedrock_options": ProviderParamsBedrockOptions.from_dict(obj["bedrock_options"]) if obj.get("bedrock_options") is not None else None,
"region": obj.get("region")
})
# store additional fields in additional_properties
for _key in obj.keys():
if _key not in cls.__properties:
_obj.additional_properties[_key] = obj.get(_key)
return _obj