opik 1.8.39__py3-none-any.whl → 1.9.71__py3-none-any.whl

opik/rest_api/types/llm_as_judge_model_parameters_write.py

@@ -4,11 +4,14 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .json_node_write import JsonNodeWrite
 
 
 class LlmAsJudgeModelParametersWrite(UniversalBaseModel):
     name: str
     temperature: float
+    seed: typing.Optional[int] = None
+    custom_parameters: typing.Optional[JsonNodeWrite] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

opik/rest_api/types/manual_evaluation_request.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .manual_evaluation_request_entity_type import ManualEvaluationRequestEntityType
+
+
+class ManualEvaluationRequest(UniversalBaseModel):
+    project_id: str = pydantic.Field()
+    """
+    Project ID
+    """
+
+    entity_ids: typing.List[str] = pydantic.Field()
+    """
+    List of entity IDs (trace IDs or thread IDs) to evaluate
+    """
+
+    rule_ids: typing.List[str] = pydantic.Field()
+    """
+    List of automation rule IDs to apply
+    """
+
+    entity_type: ManualEvaluationRequestEntityType = pydantic.Field()
+    """
+    Type of entity to evaluate (trace or thread)
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

opik/rest_api/types/manual_evaluation_request_entity_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ManualEvaluationRequestEntityType = typing.Union[typing.Literal["trace", "thread", "span"], typing.Any]

opik/rest_api/types/manual_evaluation_response.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class ManualEvaluationResponse(UniversalBaseModel):
+    entities_queued: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of entities queued for evaluation
+    """
+
+    rules_applied: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of rules that will be applied
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

opik/rest_api/types/optimization.py

@@ -6,8 +6,9 @@ import typing
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .feedback_score_average import FeedbackScoreAverage
-from .json_node import JsonNode
+from .json_list_string import JsonListString
 from .optimization_status import OptimizationStatus
+from .optimization_studio_config import OptimizationStudioConfig
 
 
 class Optimization(UniversalBaseModel):
@@ -16,7 +17,8 @@ class Optimization(UniversalBaseModel):
     dataset_name: str
     objective_name: str
     status: OptimizationStatus
-    metadata: typing.Optional[JsonNode] = None
+    metadata: typing.Optional[JsonListString] = None
+    studio_config: typing.Optional[OptimizationStudioConfig] = None
     dataset_id: typing.Optional[str] = None
     num_trials: typing.Optional[int] = None
     feedback_scores: typing.Optional[typing.List[FeedbackScoreAverage]] = None

opik/rest_api/types/optimization_public.py

@@ -6,8 +6,9 @@ import typing
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .feedback_score_average_public import FeedbackScoreAveragePublic
-from .json_node_public import JsonNodePublic
+from .json_list_string_public import JsonListStringPublic
 from .optimization_public_status import OptimizationPublicStatus
+from .optimization_studio_config_public import OptimizationStudioConfigPublic
 
 
 class OptimizationPublic(UniversalBaseModel):
@@ -16,7 +17,8 @@ class OptimizationPublic(UniversalBaseModel):
     dataset_name: str
     objective_name: str
     status: OptimizationPublicStatus
-    metadata: typing.Optional[JsonNodePublic] = None
+    metadata: typing.Optional[JsonListStringPublic] = None
+    studio_config: typing.Optional[OptimizationStudioConfigPublic] = None
     dataset_id: typing.Optional[str] = None
     num_trials: typing.Optional[int] = None
     feedback_scores: typing.Optional[typing.List[FeedbackScoreAveragePublic]] = None

opik/rest_api/types/optimization_public_status.py

@@ -2,4 +2,6 @@
 
 import typing
 
-OptimizationPublicStatus = typing.Union[typing.Literal["running", "completed", "cancelled"], typing.Any]
+OptimizationPublicStatus = typing.Union[
+    typing.Literal["running", "completed", "cancelled", "initialized", "error"], typing.Any
+]

opik/rest_api/types/optimization_status.py

@@ -2,4 +2,6 @@
 
 import typing
 
-OptimizationStatus = typing.Union[typing.Literal["running", "completed", "cancelled"], typing.Any]
+OptimizationStatus = typing.Union[
+    typing.Literal["running", "completed", "cancelled", "initialized", "error"], typing.Any
+]

opik/rest_api/types/optimization_studio_config.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .studio_evaluation import StudioEvaluation
+from .studio_llm_model import StudioLlmModel
+from .studio_optimizer import StudioOptimizer
+from .studio_prompt import StudioPrompt
+
+
+class OptimizationStudioConfig(UniversalBaseModel):
+    dataset_name: str
+    prompt: StudioPrompt
+    llm_model: StudioLlmModel
+    evaluation: StudioEvaluation
+    optimizer: StudioOptimizer
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

opik/rest_api/types/optimization_studio_config_public.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .studio_evaluation_public import StudioEvaluationPublic
+from .studio_llm_model_public import StudioLlmModelPublic
+from .studio_optimizer_public import StudioOptimizerPublic
+from .studio_prompt_public import StudioPromptPublic
+
+
+class OptimizationStudioConfigPublic(UniversalBaseModel):
+    dataset_name: str
+    prompt: StudioPromptPublic
+    llm_model: StudioLlmModelPublic
+    evaluation: StudioEvaluationPublic
+    optimizer: StudioOptimizerPublic
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

opik/rest_api/types/optimization_studio_config_write.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .studio_evaluation_write import StudioEvaluationWrite
+from .studio_llm_model_write import StudioLlmModelWrite
+from .studio_optimizer_write import StudioOptimizerWrite
+from .studio_prompt_write import StudioPromptWrite
+
+
+class OptimizationStudioConfigWrite(UniversalBaseModel):
+    dataset_name: str
+    prompt: StudioPromptWrite
+    llm_model: StudioLlmModelWrite
+    evaluation: StudioEvaluationWrite
+    optimizer: StudioOptimizerWrite
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

opik/rest_api/types/optimization_studio_log.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class OptimizationStudioLog(UniversalBaseModel):
+    url: typing.Optional[str] = None
+    last_modified: typing.Optional[dt.datetime] = None
+    expires_at: typing.Optional[dt.datetime] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

opik/rest_api/types/optimization_write.py

@@ -5,7 +5,8 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .json_node_write import JsonNodeWrite
+from .json_list_string_write import JsonListStringWrite
+from .optimization_studio_config_write import OptimizationStudioConfigWrite
 from .optimization_write_status import OptimizationWriteStatus
 
 
@@ -15,7 +16,8 @@ class OptimizationWrite(UniversalBaseModel):
     dataset_name: str
     objective_name: str
     status: OptimizationWriteStatus
-    metadata: typing.Optional[JsonNodeWrite] = None
+    metadata: typing.Optional[JsonListStringWrite] = None
+    studio_config: typing.Optional[OptimizationStudioConfigWrite] = None
     last_updated_at: typing.Optional[dt.datetime] = None
 
     if IS_PYDANTIC_V2:

opik/rest_api/types/optimization_write_status.py

@@ -2,4 +2,6 @@
 
 import typing
 
-OptimizationWriteStatus = typing.Union[typing.Literal["running", "completed", "cancelled"], typing.Any]
+OptimizationWriteStatus = typing.Union[
+    typing.Literal["running", "completed", "cancelled", "initialized", "error"], typing.Any
+]

opik/rest_api/types/project.py

@@ -27,6 +27,7 @@ class Project(UniversalBaseModel):
     total_estimated_cost_sum: typing.Optional[float] = None
     usage: typing.Optional[typing.Dict[str, float]] = None
     trace_count: typing.Optional[int] = None
+    thread_count: typing.Optional[int] = None
     guardrails_failed_count: typing.Optional[int] = None
     error_count: typing.Optional[ErrorCountWithDeviation] = None
 

opik/rest_api/types/project_detailed.py

@@ -27,6 +27,7 @@ class ProjectDetailed(UniversalBaseModel):
     total_estimated_cost_sum: typing.Optional[float] = None
     usage: typing.Optional[typing.Dict[str, float]] = None
     trace_count: typing.Optional[int] = None
+    thread_count: typing.Optional[int] = None
     guardrails_failed_count: typing.Optional[int] = None
     error_count: typing.Optional[ErrorCountWithDeviationDetailed] = None
 

opik/rest_api/types/project_reference.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class ProjectReference(UniversalBaseModel):
+    """
+    Project reference with ID and name
+    """
+
+    project_id: str = pydantic.Field()
+    """
+    Project ID
+    """
+
+    project_name: str = pydantic.Field()
+    """
+    Project name
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

opik/rest_api/types/project_reference_public.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class ProjectReferencePublic(UniversalBaseModel):
+    """
+    Project reference with ID and name
+    """
+
+    project_id: str = pydantic.Field()
+    """
+    Project ID
+    """
+
+    project_name: str = pydantic.Field()
+    """
+    Project name
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

opik/rest_api/types/project_stats_summary_item.py

@@ -17,6 +17,7 @@ class ProjectStatsSummaryItem(UniversalBaseModel):
     total_estimated_cost_sum: typing.Optional[float] = None
     usage: typing.Optional[typing.Dict[str, float]] = None
     trace_count: typing.Optional[int] = None
+    thread_count: typing.Optional[int] = None
     guardrails_failed_count: typing.Optional[int] = None
     error_count: typing.Optional[ErrorCountWithDeviation] = None
 

opik/rest_api/types/prompt.py

@@ -6,6 +6,7 @@ import typing
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .json_node import JsonNode
+from .prompt_template_structure import PromptTemplateStructure
 from .prompt_type import PromptType
 from .prompt_version import PromptVersion
 
@@ -18,6 +19,11 @@ class Prompt(UniversalBaseModel):
     metadata: typing.Optional[JsonNode] = None
     change_description: typing.Optional[str] = None
     type: typing.Optional[PromptType] = None
+    template_structure: typing.Optional[PromptTemplateStructure] = pydantic.Field(default=None)
+    """
+    Template structure type: 'text' or 'chat'. Immutable after creation.
+    """
+
     tags: typing.Optional[typing.List[str]] = None
     created_at: typing.Optional[dt.datetime] = None
     created_by: typing.Optional[str] = None

opik/rest_api/types/prompt_detail.py

@@ -5,6 +5,7 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .prompt_detail_template_structure import PromptDetailTemplateStructure
 from .prompt_version_detail import PromptVersionDetail
 
 
@@ -12,6 +13,11 @@ class PromptDetail(UniversalBaseModel):
     id: typing.Optional[str] = None
     name: str
     description: typing.Optional[str] = None
+    template_structure: typing.Optional[PromptDetailTemplateStructure] = pydantic.Field(default=None)
+    """
+    Template structure type: 'text' or 'chat'. Immutable after creation.
+    """
+
     tags: typing.Optional[typing.List[str]] = None
     created_at: typing.Optional[dt.datetime] = None
     created_by: typing.Optional[str] = None

opik/rest_api/types/prompt_detail_template_structure.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PromptDetailTemplateStructure = typing.Union[typing.Literal["text", "chat"], typing.Any]

opik/rest_api/types/prompt_public.py

@@ -5,12 +5,18 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .prompt_public_template_structure import PromptPublicTemplateStructure
 
 
 class PromptPublic(UniversalBaseModel):
     id: typing.Optional[str] = None
     name: str
     description: typing.Optional[str] = None
+    template_structure: typing.Optional[PromptPublicTemplateStructure] = pydantic.Field(default=None)
+    """
+    Template structure type: 'text' or 'chat'. Immutable after creation.
+    """
+
     tags: typing.Optional[typing.List[str]] = None
     created_at: typing.Optional[dt.datetime] = None
     created_by: typing.Optional[str] = None

opik/rest_api/types/prompt_public_template_structure.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PromptPublicTemplateStructure = typing.Union[typing.Literal["text", "chat"], typing.Any]

opik/rest_api/types/prompt_template_structure.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PromptTemplateStructure = typing.Union[typing.Literal["text", "chat"], typing.Any]

opik/rest_api/types/prompt_version.py

@@ -6,6 +6,7 @@ import typing
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .json_node import JsonNode
+from .prompt_version_template_structure import PromptVersionTemplateStructure
 from .prompt_version_type import PromptVersionType
 
 
@@ -25,7 +26,9 @@ class PromptVersion(UniversalBaseModel):
     metadata: typing.Optional[JsonNode] = None
     type: typing.Optional[PromptVersionType] = None
     change_description: typing.Optional[str] = None
+    tags: typing.Optional[typing.List[str]] = None
     variables: typing.Optional[typing.List[str]] = None
+    template_structure: typing.Optional[PromptVersionTemplateStructure] = None
     created_at: typing.Optional[dt.datetime] = None
     created_by: typing.Optional[str] = None
 

opik/rest_api/types/prompt_version_detail.py

@@ -6,6 +6,7 @@ import typing
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .json_node_detail import JsonNodeDetail
+from .prompt_version_detail_template_structure import PromptVersionDetailTemplateStructure
 from .prompt_version_detail_type import PromptVersionDetailType
 
 
@@ -25,7 +26,9 @@ class PromptVersionDetail(UniversalBaseModel):
     metadata: typing.Optional[JsonNodeDetail] = None
     type: typing.Optional[PromptVersionDetailType] = None
     change_description: typing.Optional[str] = None
+    tags: typing.Optional[typing.List[str]] = None
     variables: typing.Optional[typing.List[str]] = None
+    template_structure: typing.Optional[PromptVersionDetailTemplateStructure] = None
     created_at: typing.Optional[dt.datetime] = None
     created_by: typing.Optional[str] = None
 

opik/rest_api/types/prompt_version_detail_template_structure.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PromptVersionDetailTemplateStructure = typing.Union[typing.Literal["text", "chat"], typing.Any]

opik/rest_api/types/prompt_version_link.py

@@ -10,6 +10,7 @@ class PromptVersionLink(UniversalBaseModel):
     id: str
     commit: typing.Optional[str] = None
     prompt_id: typing.Optional[str] = None
+    prompt_name: typing.Optional[str] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

opik/rest_api/types/prompt_version_link_public.py

@@ -10,6 +10,7 @@ class PromptVersionLinkPublic(UniversalBaseModel):
     id: str
     commit: typing.Optional[str] = None
     prompt_id: typing.Optional[str] = None
+    prompt_name: typing.Optional[str] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

opik/rest_api/types/prompt_version_page_public.py

@@ -3,7 +3,9 @@
 import typing
 
 import pydantic
+import typing_extensions
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
 from .prompt_version_public import PromptVersionPublic
 
 
@@ -12,6 +14,9 @@ class PromptVersionPagePublic(UniversalBaseModel):
     size: typing.Optional[int] = None
     total: typing.Optional[int] = None
     content: typing.Optional[typing.List[PromptVersionPublic]] = None
+    sortable_by: typing_extensions.Annotated[typing.Optional[typing.List[str]], FieldMetadata(alias="sortableBy")] = (
+        None
+    )
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

opik/rest_api/types/prompt_version_public.py

@@ -6,6 +6,7 @@ import typing
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .json_node_public import JsonNodePublic
+from .prompt_version_public_template_structure import PromptVersionPublicTemplateStructure
 from .prompt_version_public_type import PromptVersionPublicType
 
 
@@ -25,6 +26,8 @@ class PromptVersionPublic(UniversalBaseModel):
     metadata: typing.Optional[JsonNodePublic] = None
     type: typing.Optional[PromptVersionPublicType] = None
     change_description: typing.Optional[str] = None
+    tags: typing.Optional[typing.List[str]] = None
+    template_structure: typing.Optional[PromptVersionPublicTemplateStructure] = None
     created_at: typing.Optional[dt.datetime] = None
     created_by: typing.Optional[str] = None
 

opik/rest_api/types/prompt_version_public_template_structure.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PromptVersionPublicTemplateStructure = typing.Union[typing.Literal["text", "chat"], typing.Any]

opik/rest_api/types/prompt_version_template_structure.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PromptVersionTemplateStructure = typing.Union[typing.Literal["text", "chat"], typing.Any]

opik/rest_api/types/prompt_version_update.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class PromptVersionUpdate(UniversalBaseModel):
+    """
+    Update to apply to prompt versions.
+    Note: Prompt versions are immutable by design.
+    Only organizational properties (such as tags etc.) can be updated.
+    Core properties like template, metadata etc. cannot be modified after creation.
+    """
+
+    tags: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Tags to set or merge with existing tags. Follows PATCH semantics:
+    - If merge_tags is true, these tags will be added to existing tags.
+    - If merge_tags is false, these tags will replace all existing tags.
+    - null: preserve existing tags (no change).
+    - empty set: clear all tags merge_tags is false.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

opik/rest_api/types/provider_api_key.py

@@ -13,6 +13,11 @@ class ProviderApiKey(UniversalBaseModel):
     provider: ProviderApiKeyProvider
     api_key: typing.Optional[str] = None
     name: typing.Optional[str] = None
+    provider_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Provider name - required for custom LLM providers to uniquely identify them (e.g., 'ollama', 'vllm'). Must not be blank for custom providers. Should not be set for standard providers (OpenAI, Anthropic, etc.). This requirement is conditional and validation is enforced programmatically.
+    """
+
     headers: typing.Optional[typing.Dict[str, str]] = None
     configuration: typing.Optional[typing.Dict[str, str]] = None
     base_url: typing.Optional[str] = None
@@ -20,6 +25,10 @@ class ProviderApiKey(UniversalBaseModel):
     created_by: typing.Optional[str] = None
     last_updated_at: typing.Optional[dt.datetime] = None
     last_updated_by: typing.Optional[str] = None
+    read_only: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    If true, this provider is system-managed and cannot be edited or deleted
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

opik/rest_api/types/provider_api_key_provider.py

@@ -3,5 +3,5 @@
 import typing
 
 ProviderApiKeyProvider = typing.Union[
-    typing.Literal["openai", "anthropic", "gemini", "openrouter", "vertex-ai", "custom-llm"], typing.Any
+    typing.Literal["openai", "anthropic", "gemini", "openrouter", "vertex-ai", "custom-llm", "opik-free"], typing.Any
 ]