opik 1.9.5__py3-none-any.whl → 1.9.39__py3-none-any.whl

opik/rest_api/types/dataset_version_public.py

@@ -0,0 +1,49 @@
+# 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 DatasetVersionPublic(UniversalBaseModel):
+    id: typing.Optional[str] = None
+    dataset_id: typing.Optional[str] = None
+    version_hash: typing.Optional[str] = None
+    tags: typing.Optional[typing.List[str]] = None
+    items_total: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total number of items in this version
+    """
+
+    items_added: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of items added since last version
+    """
+
+    items_modified: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of items modified since last version
+    """
+
+    items_deleted: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of items deleted since last version
+    """
+
+    change_description: typing.Optional[str] = None
+    metadata: typing.Optional[typing.Dict[str, str]] = None
+    created_at: typing.Optional[dt.datetime] = None
+    created_by: typing.Optional[str] = None
+    last_updated_at: typing.Optional[dt.datetime] = None
+    last_updated_by: typing.Optional[str] = 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/experiment.py

@@ -6,6 +6,7 @@ import typing
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .comment import Comment
+from .experiment_score import ExperimentScore
 from .experiment_status import ExperimentStatus
 from .experiment_type import ExperimentType
 from .feedback_score_average import FeedbackScoreAverage
@@ -34,6 +35,7 @@ class Experiment(UniversalBaseModel):
     created_by: typing.Optional[str] = None
     last_updated_by: typing.Optional[str] = None
     status: typing.Optional[ExperimentStatus] = None
+    experiment_scores: typing.Optional[typing.List[ExperimentScore]] = None
     prompt_version: typing.Optional[PromptVersionLink] = None
     prompt_versions: typing.Optional[typing.List[PromptVersionLink]] = None
 

opik/rest_api/types/experiment_public.py

@@ -8,6 +8,7 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .comment_public import CommentPublic
 from .experiment_public_status import ExperimentPublicStatus
 from .experiment_public_type import ExperimentPublicType
+from .experiment_score_public import ExperimentScorePublic
 from .feedback_score_average_public import FeedbackScoreAveragePublic
 from .json_list_string_public import JsonListStringPublic
 from .percentage_values_public import PercentageValuesPublic
@@ -34,6 +35,7 @@ class ExperimentPublic(UniversalBaseModel):
     created_by: typing.Optional[str] = None
     last_updated_by: typing.Optional[str] = None
     status: typing.Optional[ExperimentPublicStatus] = None
+    experiment_scores: typing.Optional[typing.List[ExperimentScorePublic]] = None
     prompt_version: typing.Optional[PromptVersionLinkPublic] = None
     prompt_versions: typing.Optional[typing.List[PromptVersionLinkPublic]] = None
 

opik/rest_api/types/experiment_score.py

@@ -0,0 +1,20 @@
+# 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 ExperimentScore(UniversalBaseModel):
+    name: str
+    value: float
+
+    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/experiment_score_public.py

@@ -0,0 +1,20 @@
+# 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 ExperimentScorePublic(UniversalBaseModel):
+    name: str
+    value: float
+
+    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/experiment_score_write.py

@@ -0,0 +1,20 @@
+# 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 ExperimentScoreWrite(UniversalBaseModel):
+    name: str
+    value: float
+
+    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/feedback.py

@@ -9,6 +9,7 @@ import pydantic
 import typing_extensions
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
+from .boolean_feedback_detail import BooleanFeedbackDetail
 from .categorical_feedback_detail import CategoricalFeedbackDetail
 from .numerical_feedback_detail import NumericalFeedbackDetail
 
@@ -74,4 +75,22 @@ class Feedback_Categorical(Base):
             extra = pydantic.Extra.allow
 
 
-Feedback = typing.Union[Feedback_Numerical, Feedback_Categorical]
+class Feedback_Boolean(Base):
+    type: typing.Literal["boolean"] = "boolean"
+    details: typing.Optional[BooleanFeedbackDetail] = None
+    created_at: typing.Optional[dt.datetime] = None
+    created_by: typing.Optional[str] = None
+    last_updated_at: typing.Optional[dt.datetime] = None
+    last_updated_by: typing.Optional[str] = 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
+
+
+Feedback = typing.Union[Feedback_Numerical, Feedback_Categorical, Feedback_Boolean]

opik/rest_api/types/feedback_create.py

@@ -6,6 +6,7 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .boolean_feedback_detail_create import BooleanFeedbackDetailCreate
 from .categorical_feedback_detail_create import CategoricalFeedbackDetailCreate
 from .numerical_feedback_detail_create import NumericalFeedbackDetailCreate
 
@@ -56,4 +57,18 @@ class FeedbackCreate_Categorical(Base):
             extra = pydantic.Extra.allow
 
 
-FeedbackCreate = typing.Union[FeedbackCreate_Numerical, FeedbackCreate_Categorical]
+class FeedbackCreate_Boolean(Base):
+    type: typing.Literal["boolean"] = "boolean"
+    details: typing.Optional[BooleanFeedbackDetailCreate] = 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
+
+
+FeedbackCreate = typing.Union[FeedbackCreate_Numerical, FeedbackCreate_Categorical, FeedbackCreate_Boolean]

opik/rest_api/types/feedback_object_public.py

@@ -9,6 +9,7 @@ import pydantic
 import typing_extensions
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
+from .boolean_feedback_detail_public import BooleanFeedbackDetailPublic
 from .categorical_feedback_detail_public import CategoricalFeedbackDetailPublic
 from .numerical_feedback_detail_public import NumericalFeedbackDetailPublic
 
@@ -74,4 +75,24 @@ class FeedbackObjectPublic_Categorical(Base):
             extra = pydantic.Extra.allow
 
 
-FeedbackObjectPublic = typing.Union[FeedbackObjectPublic_Numerical, FeedbackObjectPublic_Categorical]
+class FeedbackObjectPublic_Boolean(Base):
+    type: typing.Literal["boolean"] = "boolean"
+    details: typing.Optional[BooleanFeedbackDetailPublic] = None
+    created_at: typing.Optional[dt.datetime] = None
+    created_by: typing.Optional[str] = None
+    last_updated_at: typing.Optional[dt.datetime] = None
+    last_updated_by: typing.Optional[str] = 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
+
+
+FeedbackObjectPublic = typing.Union[
+    FeedbackObjectPublic_Numerical, FeedbackObjectPublic_Categorical, FeedbackObjectPublic_Boolean
+]

opik/rest_api/types/feedback_public.py

@@ -9,6 +9,7 @@ import pydantic
 import typing_extensions
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
+from .boolean_feedback_detail_public import BooleanFeedbackDetailPublic
 from .categorical_feedback_detail_public import CategoricalFeedbackDetailPublic
 from .numerical_feedback_detail_public import NumericalFeedbackDetailPublic
 
@@ -74,4 +75,22 @@ class FeedbackPublic_Categorical(Base):
             extra = pydantic.Extra.allow
 
 
-FeedbackPublic = typing.Union[FeedbackPublic_Numerical, FeedbackPublic_Categorical]
+class FeedbackPublic_Boolean(Base):
+    type: typing.Literal["boolean"] = "boolean"
+    details: typing.Optional[BooleanFeedbackDetailPublic] = None
+    created_at: typing.Optional[dt.datetime] = None
+    created_by: typing.Optional[str] = None
+    last_updated_at: typing.Optional[dt.datetime] = None
+    last_updated_by: typing.Optional[str] = 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
+
+
+FeedbackPublic = typing.Union[FeedbackPublic_Numerical, FeedbackPublic_Categorical, FeedbackPublic_Boolean]

opik/rest_api/types/feedback_score_public.py

@@ -10,6 +10,10 @@ from .value_entry_public import ValueEntryPublic
 
 
 class FeedbackScorePublic(UniversalBaseModel):
+    """
+    Aggregated feedback scores from all spans in this trace, averaged by score name
+    """
+
     name: str
     category_name: typing.Optional[str] = None
     value: float

opik/rest_api/types/feedback_update.py

@@ -6,6 +6,7 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .boolean_feedback_detail_update import BooleanFeedbackDetailUpdate
 from .categorical_feedback_detail_update import CategoricalFeedbackDetailUpdate
 from .numerical_feedback_detail_update import NumericalFeedbackDetailUpdate
 
@@ -56,4 +57,18 @@ class FeedbackUpdate_Categorical(Base):
             extra = pydantic.Extra.allow
 
 
-FeedbackUpdate = typing.Union[FeedbackUpdate_Numerical, FeedbackUpdate_Categorical]
+class FeedbackUpdate_Boolean(Base):
+    type: typing.Literal["boolean"] = "boolean"
+    details: typing.Optional[BooleanFeedbackDetailUpdate] = 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
+
+
+FeedbackUpdate = typing.Union[FeedbackUpdate_Numerical, FeedbackUpdate_Categorical, FeedbackUpdate_Boolean]

opik/rest_api/types/image_url.py

@@ -0,0 +1,20 @@
+# 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 ImageUrl(UniversalBaseModel):
+    url: str
+    detail: typing.Optional[str] = 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/image_url_public.py

@@ -0,0 +1,20 @@
+# 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 ImageUrlPublic(UniversalBaseModel):
+    url: str
+    detail: typing.Optional[str] = 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/image_url_write.py

@@ -0,0 +1,20 @@
+# 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 ImageUrlWrite(UniversalBaseModel):
+    url: str
+    detail: typing.Optional[str] = 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/llm_as_judge_message.py

@@ -4,12 +4,16 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .llm_as_judge_message_content import LlmAsJudgeMessageContent
 from .llm_as_judge_message_role import LlmAsJudgeMessageRole
 
 
 class LlmAsJudgeMessage(UniversalBaseModel):
     role: LlmAsJudgeMessageRole
-    content: str
+    content: typing.Optional[str] = None
+    content_array: typing.Optional[typing.List[LlmAsJudgeMessageContent]] = None
+    string_content: typing.Optional[bool] = None
+    structured_content: typing.Optional[bool] = 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/llm_as_judge_message_content.py

@@ -0,0 +1,24 @@
+# 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 .image_url import ImageUrl
+from .video_url import VideoUrl
+
+
+class LlmAsJudgeMessageContent(UniversalBaseModel):
+    type: str
+    text: typing.Optional[str] = None
+    image_url: typing.Optional[ImageUrl] = None
+    video_url: typing.Optional[VideoUrl] = 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/llm_as_judge_message_content_public.py

@@ -0,0 +1,24 @@
+# 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 .image_url_public import ImageUrlPublic
+from .video_url_public import VideoUrlPublic
+
+
+class LlmAsJudgeMessageContentPublic(UniversalBaseModel):
+    type: str
+    text: typing.Optional[str] = None
+    image_url: typing.Optional[ImageUrlPublic] = None
+    video_url: typing.Optional[VideoUrlPublic] = 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/llm_as_judge_message_content_write.py

@@ -0,0 +1,24 @@
+# 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 .image_url_write import ImageUrlWrite
+from .video_url_write import VideoUrlWrite
+
+
+class LlmAsJudgeMessageContentWrite(UniversalBaseModel):
+    type: str
+    text: typing.Optional[str] = None
+    image_url: typing.Optional[ImageUrlWrite] = None
+    video_url: typing.Optional[VideoUrlWrite] = 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/llm_as_judge_message_public.py

@@ -4,12 +4,16 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .llm_as_judge_message_content_public import LlmAsJudgeMessageContentPublic
 from .llm_as_judge_message_public_role import LlmAsJudgeMessagePublicRole
 
 
 class LlmAsJudgeMessagePublic(UniversalBaseModel):
     role: LlmAsJudgeMessagePublicRole
-    content: str
+    content: typing.Optional[str] = None
+    content_array: typing.Optional[typing.List[LlmAsJudgeMessageContentPublic]] = None
+    string_content: typing.Optional[bool] = None
+    structured_content: typing.Optional[bool] = 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/llm_as_judge_message_write.py

@@ -4,12 +4,16 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .llm_as_judge_message_content_write import LlmAsJudgeMessageContentWrite
 from .llm_as_judge_message_write_role import LlmAsJudgeMessageWriteRole
 
 
 class LlmAsJudgeMessageWrite(UniversalBaseModel):
     role: LlmAsJudgeMessageWriteRole
-    content: str
+    content: typing.Optional[str] = None
+    content_array: typing.Optional[typing.List[LlmAsJudgeMessageContentWrite]] = None
+    string_content: typing.Optional[bool] = None
+    structured_content: typing.Optional[bool] = 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/llm_as_judge_model_parameters.py

@@ -4,12 +4,14 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .json_node import JsonNode
 
 
 class LlmAsJudgeModelParameters(UniversalBaseModel):
     name: str
     temperature: float
     seed: typing.Optional[int] = None
+    custom_parameters: typing.Optional[JsonNode] = 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/llm_as_judge_model_parameters_public.py

@@ -4,12 +4,14 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .json_node_public import JsonNodePublic
 
 
 class LlmAsJudgeModelParametersPublic(UniversalBaseModel):
     name: str
     temperature: float
     seed: typing.Optional[int] = None
+    custom_parameters: typing.Optional[JsonNodePublic] = 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/llm_as_judge_model_parameters_write.py

@@ -4,12 +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/optimization.py

@@ -8,6 +8,7 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .feedback_score_average import FeedbackScoreAverage
 from .json_list_string import JsonListString
 from .optimization_status import OptimizationStatus
+from .optimization_studio_config import OptimizationStudioConfig
 
 
 class Optimization(UniversalBaseModel):
@@ -17,6 +18,7 @@ class Optimization(UniversalBaseModel):
     objective_name: str
     status: OptimizationStatus
     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

@@ -8,6 +8,7 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .feedback_score_average_public import FeedbackScoreAveragePublic
 from .json_list_string_public import JsonListStringPublic
 from .optimization_public_status import OptimizationPublicStatus
+from .optimization_studio_config_public import OptimizationStudioConfigPublic
 
 
 class OptimizationPublic(UniversalBaseModel):
@@ -17,6 +18,7 @@ class OptimizationPublic(UniversalBaseModel):
     objective_name: str
     status: OptimizationPublicStatus
     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