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

opik/rest_api/prompts/raw_client.py

@@ -19,6 +19,9 @@ from ..types.prompt_detail import PromptDetail
 from ..types.prompt_page_public import PromptPagePublic
 from ..types.prompt_version_detail import PromptVersionDetail
 from ..types.prompt_version_page_public import PromptVersionPagePublic
+from ..types.prompt_version_update import PromptVersionUpdate
+from .types.create_prompt_version_detail_template_structure import CreatePromptVersionDetailTemplateStructure
+from .types.prompt_write_template_structure import PromptWriteTemplateStructure
 from .types.prompt_write_type import PromptWriteType
 
 # this is used as the default value for optional parameters
@@ -99,6 +102,7 @@ class RawPromptsClient:
         metadata: typing.Optional[JsonNodeWrite] = OMIT,
         change_description: typing.Optional[str] = OMIT,
         type: typing.Optional[PromptWriteType] = OMIT,
+        template_structure: typing.Optional[PromptWriteTemplateStructure] = OMIT,
         tags: typing.Optional[typing.Sequence[str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[None]:
@@ -121,6 +125,9 @@ class RawPromptsClient:
 
         type : typing.Optional[PromptWriteType]
 
+        template_structure : typing.Optional[PromptWriteTemplateStructure]
+            Template structure type: 'text' or 'chat'. Immutable after creation.
+
         tags : typing.Optional[typing.Sequence[str]]
 
         request_options : typing.Optional[RequestOptions]
@@ -141,6 +148,7 @@ class RawPromptsClient:
                 "metadata": metadata,
                 "change_description": change_description,
                 "type": type,
+                "template_structure": template_structure,
                 "tags": tags,
             },
             headers={
@@ -191,7 +199,12 @@ class RawPromptsClient:
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
     def create_prompt_version(
-        self, *, name: str, version: PromptVersionDetail, request_options: typing.Optional[RequestOptions] = None
+        self,
+        *,
+        name: str,
+        version: PromptVersionDetail,
+        template_structure: typing.Optional[CreatePromptVersionDetailTemplateStructure] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[PromptVersionDetail]:
         """
         Create prompt version
@@ -202,6 +215,9 @@ class RawPromptsClient:
 
         version : PromptVersionDetail
 
+        template_structure : typing.Optional[CreatePromptVersionDetailTemplateStructure]
+            Template structure for the prompt: 'text' or 'chat'. Note: This field is only used when creating a new prompt. If a prompt with the given name already exists, this field is ignored and the existing prompt's template structure is used. Template structure is immutable after prompt creation.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -218,6 +234,7 @@ class RawPromptsClient:
                 "version": convert_and_respect_annotation_metadata(
                     object_=version, annotation=PromptVersionDetail, direction="write"
                 ),
+                "template_structure": template_structure,
             },
             headers={
                 "content-type": "application/json",
@@ -273,6 +290,80 @@ class RawPromptsClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
+    def update_prompt_versions(
+        self,
+        *,
+        ids: typing.Sequence[str],
+        update: PromptVersionUpdate,
+        merge_tags: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[None]:
+        """
+        Update one or more prompt versions.
+
+        Note: Prompt versions are immutable by design.
+        Only organizational properties, such as tags etc., can be updated.
+        Core properties like template and metadata cannot be modified after creation.
+
+        PATCH semantics:
+        - non-empty values update the field
+        - null values preserve existing field values (no change)
+        - empty values explicitly clear the field
+
+        Parameters
+        ----------
+        ids : typing.Sequence[str]
+            IDs of prompt versions to update
+
+        update : PromptVersionUpdate
+
+        merge_tags : typing.Optional[bool]
+            Tag merge behavior:
+            - true: Add new tags to existing tags (union)
+            - false: Replace all existing tags with new tags (default behaviour if not provided)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[None]
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/private/prompts/versions",
+            method="PATCH",
+            json={
+                "ids": ids,
+                "update": convert_and_respect_annotation_metadata(
+                    object_=update, annotation=PromptVersionUpdate, direction="write"
+                ),
+                "merge_tags": merge_tags,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return HttpResponse(response=_response, data=None)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
     def get_prompt_by_id(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[PromptDetail]:
@@ -537,6 +628,9 @@ class RawPromptsClient:
         *,
         page: typing.Optional[int] = None,
         size: typing.Optional[int] = None,
+        search: typing.Optional[str] = None,
+        sorting: typing.Optional[str] = None,
+        filters: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[PromptVersionPagePublic]:
         """
@@ -550,6 +644,13 @@ class RawPromptsClient:
 
         size : typing.Optional[int]
 
+        search : typing.Optional[str]
+            Search text to find in template or change description fields
+
+        sorting : typing.Optional[str]
+
+        filters : typing.Optional[str]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -564,6 +665,9 @@ class RawPromptsClient:
             params={
                 "page": page,
                 "size": size,
+                "search": search,
+                "sorting": sorting,
+                "filters": filters,
             },
             request_options=request_options,
         )
@@ -582,6 +686,68 @@ class RawPromptsClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
+    def restore_prompt_version(
+        self, prompt_id: str, version_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[PromptVersionDetail]:
+        """
+        Restore a prompt version by creating a new version with the content from the specified version
+
+        Parameters
+        ----------
+        prompt_id : str
+
+        version_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[PromptVersionDetail]
+            OK
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/private/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/restore",
+            method="POST",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PromptVersionDetail,
+                    parse_obj_as(
+                        type_=PromptVersionDetail,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
     def retrieve_prompt_version(
         self, *, name: str, commit: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[PromptVersionDetail]:
@@ -738,6 +904,7 @@ class AsyncRawPromptsClient:
         metadata: typing.Optional[JsonNodeWrite] = OMIT,
         change_description: typing.Optional[str] = OMIT,
         type: typing.Optional[PromptWriteType] = OMIT,
+        template_structure: typing.Optional[PromptWriteTemplateStructure] = OMIT,
         tags: typing.Optional[typing.Sequence[str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[None]:
@@ -760,6 +927,9 @@ class AsyncRawPromptsClient:
 
         type : typing.Optional[PromptWriteType]
 
+        template_structure : typing.Optional[PromptWriteTemplateStructure]
+            Template structure type: 'text' or 'chat'. Immutable after creation.
+
         tags : typing.Optional[typing.Sequence[str]]
 
         request_options : typing.Optional[RequestOptions]
@@ -780,6 +950,7 @@ class AsyncRawPromptsClient:
                 "metadata": metadata,
                 "change_description": change_description,
                 "type": type,
+                "template_structure": template_structure,
                 "tags": tags,
             },
             headers={
@@ -830,7 +1001,12 @@ class AsyncRawPromptsClient:
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
     async def create_prompt_version(
-        self, *, name: str, version: PromptVersionDetail, request_options: typing.Optional[RequestOptions] = None
+        self,
+        *,
+        name: str,
+        version: PromptVersionDetail,
+        template_structure: typing.Optional[CreatePromptVersionDetailTemplateStructure] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[PromptVersionDetail]:
         """
         Create prompt version
@@ -841,6 +1017,9 @@ class AsyncRawPromptsClient:
 
         version : PromptVersionDetail
 
+        template_structure : typing.Optional[CreatePromptVersionDetailTemplateStructure]
+            Template structure for the prompt: 'text' or 'chat'. Note: This field is only used when creating a new prompt. If a prompt with the given name already exists, this field is ignored and the existing prompt's template structure is used. Template structure is immutable after prompt creation.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -857,6 +1036,7 @@ class AsyncRawPromptsClient:
                 "version": convert_and_respect_annotation_metadata(
                     object_=version, annotation=PromptVersionDetail, direction="write"
                 ),
+                "template_structure": template_structure,
             },
             headers={
                 "content-type": "application/json",
@@ -912,6 +1092,80 @@ class AsyncRawPromptsClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
+    async def update_prompt_versions(
+        self,
+        *,
+        ids: typing.Sequence[str],
+        update: PromptVersionUpdate,
+        merge_tags: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[None]:
+        """
+        Update one or more prompt versions.
+
+        Note: Prompt versions are immutable by design.
+        Only organizational properties, such as tags etc., can be updated.
+        Core properties like template and metadata cannot be modified after creation.
+
+        PATCH semantics:
+        - non-empty values update the field
+        - null values preserve existing field values (no change)
+        - empty values explicitly clear the field
+
+        Parameters
+        ----------
+        ids : typing.Sequence[str]
+            IDs of prompt versions to update
+
+        update : PromptVersionUpdate
+
+        merge_tags : typing.Optional[bool]
+            Tag merge behavior:
+            - true: Add new tags to existing tags (union)
+            - false: Replace all existing tags with new tags (default behaviour if not provided)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[None]
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/private/prompts/versions",
+            method="PATCH",
+            json={
+                "ids": ids,
+                "update": convert_and_respect_annotation_metadata(
+                    object_=update, annotation=PromptVersionUpdate, direction="write"
+                ),
+                "merge_tags": merge_tags,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return AsyncHttpResponse(response=_response, data=None)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
     async def get_prompt_by_id(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[PromptDetail]:
@@ -1178,6 +1432,9 @@ class AsyncRawPromptsClient:
         *,
         page: typing.Optional[int] = None,
         size: typing.Optional[int] = None,
+        search: typing.Optional[str] = None,
+        sorting: typing.Optional[str] = None,
+        filters: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[PromptVersionPagePublic]:
         """
@@ -1191,6 +1448,13 @@ class AsyncRawPromptsClient:
 
         size : typing.Optional[int]
 
+        search : typing.Optional[str]
+            Search text to find in template or change description fields
+
+        sorting : typing.Optional[str]
+
+        filters : typing.Optional[str]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -1205,6 +1469,9 @@ class AsyncRawPromptsClient:
             params={
                 "page": page,
                 "size": size,
+                "search": search,
+                "sorting": sorting,
+                "filters": filters,
             },
             request_options=request_options,
         )
@@ -1223,6 +1490,68 @@ class AsyncRawPromptsClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
+    async def restore_prompt_version(
+        self, prompt_id: str, version_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[PromptVersionDetail]:
+        """
+        Restore a prompt version by creating a new version with the content from the specified version
+
+        Parameters
+        ----------
+        prompt_id : str
+
+        version_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[PromptVersionDetail]
+            OK
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/private/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/restore",
+            method="POST",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PromptVersionDetail,
+                    parse_obj_as(
+                        type_=PromptVersionDetail,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
     async def retrieve_prompt_version(
         self, *, name: str, commit: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[PromptVersionDetail]:

opik/rest_api/prompts/types/__init__.py

@@ -2,6 +2,8 @@
 
 # isort: skip_file
 
+from .create_prompt_version_detail_template_structure import CreatePromptVersionDetailTemplateStructure
+from .prompt_write_template_structure import PromptWriteTemplateStructure
 from .prompt_write_type import PromptWriteType
 
-__all__ = ["PromptWriteType"]
+__all__ = ["CreatePromptVersionDetailTemplateStructure", "PromptWriteTemplateStructure", "PromptWriteType"]

opik/rest_api/prompts/types/create_prompt_version_detail_template_structure.py

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

opik/rest_api/prompts/types/prompt_write_template_structure.py

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

opik/rest_api/spans/__init__.py

@@ -7,7 +7,6 @@ from .types import (
     GetSpanStatsRequestType,
     GetSpansByProjectRequestType,
     SpanSearchStreamRequestPublicType,
-    SpanUpdateType,
 )
 
 __all__ = [
@@ -15,5 +14,4 @@ __all__ = [
     "GetSpanStatsRequestType",
     "GetSpansByProjectRequestType",
     "SpanSearchStreamRequestPublicType",
-    "SpanUpdateType",
 ]