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

opik/rest_api/prompts/client.py

@@ -10,6 +10,8 @@ from ..types.prompt_page_public import PromptPagePublic
 from ..types.prompt_version_detail import PromptVersionDetail
 from ..types.prompt_version_page_public import PromptVersionPagePublic
 from .raw_client import AsyncRawPromptsClient, RawPromptsClient
+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
@@ -85,6 +87,7 @@ class PromptsClient:
         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,
     ) -> None:
@@ -107,6 +110,9 @@ class PromptsClient:
 
         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]
@@ -130,13 +136,19 @@ class PromptsClient:
             metadata=metadata,
             change_description=change_description,
             type=type,
+            template_structure=template_structure,
             tags=tags,
             request_options=request_options,
         )
         return _response.data
 
     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,
     ) -> PromptVersionDetail:
         """
         Create prompt version
@@ -147,6 +159,9 @@ class PromptsClient:
 
         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.
 
@@ -162,7 +177,9 @@ class PromptsClient:
         client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", )
         client.prompts.create_prompt_version(name='name', version=PromptVersionDetail(template='template', ), )
         """
-        _response = self._raw_client.create_prompt_version(name=name, version=version, request_options=request_options)
+        _response = self._raw_client.create_prompt_version(
+            name=name, version=version, template_structure=template_structure, request_options=request_options
+        )
         return _response.data
 
     def get_prompt_by_id(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> PromptDetail:
@@ -474,6 +491,7 @@ class AsyncPromptsClient:
         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,
     ) -> None:
@@ -496,6 +514,9 @@ class AsyncPromptsClient:
 
         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]
@@ -522,13 +543,19 @@ class AsyncPromptsClient:
             metadata=metadata,
             change_description=change_description,
             type=type,
+            template_structure=template_structure,
             tags=tags,
             request_options=request_options,
         )
         return _response.data
 
     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,
     ) -> PromptVersionDetail:
         """
         Create prompt version
@@ -539,6 +566,9 @@ class AsyncPromptsClient:
 
         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.
 
@@ -558,7 +588,7 @@ class AsyncPromptsClient:
         asyncio.run(main())
         """
         _response = await self._raw_client.create_prompt_version(
-            name=name, version=version, request_options=request_options
+            name=name, version=version, template_structure=template_structure, request_options=request_options
         )
         return _response.data
 

opik/rest_api/prompts/raw_client.py

@@ -19,6 +19,8 @@ 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.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 +101,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 +124,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 +147,7 @@ class RawPromptsClient:
                 "metadata": metadata,
                 "change_description": change_description,
                 "type": type,
+                "template_structure": template_structure,
                 "tags": tags,
             },
             headers={
@@ -191,7 +198,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 +214,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 +233,7 @@ class RawPromptsClient:
                 "version": convert_and_respect_annotation_metadata(
                     object_=version, annotation=PromptVersionDetail, direction="write"
                 ),
+                "template_structure": template_structure,
             },
             headers={
                 "content-type": "application/json",
@@ -800,6 +816,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]:
@@ -822,6 +839,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]
@@ -842,6 +862,7 @@ class AsyncRawPromptsClient:
                 "metadata": metadata,
                 "change_description": change_description,
                 "type": type,
+                "template_structure": template_structure,
                 "tags": tags,
             },
             headers={
@@ -892,7 +913,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
@@ -903,6 +929,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.
 
@@ -919,6 +948,7 @@ class AsyncRawPromptsClient:
                 "version": convert_and_respect_annotation_metadata(
                     object_=version, annotation=PromptVersionDetail, direction="write"
                 ),
+                "template_structure": template_structure,
             },
             headers={
                 "content-type": "application/json",

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",
 ]

opik/rest_api/spans/client.py

@@ -16,6 +16,8 @@ from ..types.project_stats_public import ProjectStatsPublic
 from ..types.span_filter_public import SpanFilterPublic
 from ..types.span_page_public import SpanPagePublic
 from ..types.span_public import SpanPublic
+from ..types.span_update import SpanUpdate
+from ..types.span_update_type import SpanUpdateType
 from ..types.span_write import SpanWrite
 from ..types.span_write_type import SpanWriteType
 from ..types.value_entry import ValueEntry
@@ -24,7 +26,6 @@ from .types.find_feedback_score_names_1_request_type import FindFeedbackScoreNam
 from .types.get_span_stats_request_type import GetSpanStatsRequestType
 from .types.get_spans_by_project_request_type import GetSpansByProjectRequestType
 from .types.span_search_stream_request_public_type import SpanSearchStreamRequestPublicType
-from .types.span_update_type import SpanUpdateType
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -173,6 +174,74 @@ class SpansClient:
         )
         return _response.data
 
+    def create_spans(
+        self, *, spans: typing.Sequence[SpanWrite], request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Create spans
+
+        Parameters
+        ----------
+        spans : typing.Sequence[SpanWrite]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from Opik import OpikApi
+        from Opik import SpanWrite
+        import datetime
+        client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", )
+        client.spans.create_spans(spans=[SpanWrite(start_time=datetime.datetime.fromisoformat("2024-01-15 09:30:00+00:00", ), )], )
+        """
+        _response = self._raw_client.create_spans(spans=spans, request_options=request_options)
+        return _response.data
+
+    def batch_update_spans(
+        self,
+        *,
+        ids: typing.Sequence[str],
+        update: SpanUpdate,
+        merge_tags: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Update multiple spans
+
+        Parameters
+        ----------
+        ids : typing.Sequence[str]
+            List of span IDs to update (max 1000)
+
+        update : SpanUpdate
+
+        merge_tags : typing.Optional[bool]
+            If true, merge tags with existing tags instead of replacing them. Default: false
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from Opik import OpikApi
+        from Opik import SpanUpdate
+        client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", )
+        client.spans.batch_update_spans(ids=['ids'], update=SpanUpdate(trace_id='trace_id', ), )
+        """
+        _response = self._raw_client.batch_update_spans(
+            ids=ids, update=update, merge_tags=merge_tags, request_options=request_options
+        )
+        return _response.data
+
     def get_spans_by_project(
         self,
         *,
@@ -360,34 +429,6 @@ class SpansClient:
         )
         return _response.data
 
-    def create_spans(
-        self, *, spans: typing.Sequence[SpanWrite], request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
-        """
-        Create spans
-
-        Parameters
-        ----------
-        spans : typing.Sequence[SpanWrite]
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        None
-
-        Examples
-        --------
-        from Opik import OpikApi
-        from Opik import SpanWrite
-        import datetime
-        client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", )
-        client.spans.create_spans(spans=[SpanWrite(start_time=datetime.datetime.fromisoformat("2024-01-15 09:30:00+00:00", ), )], )
-        """
-        _response = self._raw_client.create_spans(spans=spans, request_options=request_options)
-        return _response.data
-
     def get_span_by_id(
         self,
         id: str,
@@ -798,10 +839,10 @@ class SpansClient:
             Truncate image included in either input, output or metadata
 
         from_time : typing.Optional[dt.datetime]
-            Filter spans created from this time (ISO-8601 format). Must be provided together with 'to_time'.
+            Filter spans created from this time (ISO-8601 format).
 
         to_time : typing.Optional[dt.datetime]
-            Filter spans created up to this time (ISO-8601 format). Must be provided together with 'from_time' and must be after 'from_time'.
+            Filter spans created up to this time (ISO-8601 format). If not provided, defaults to current time. Must be after 'from_time'.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
@@ -1032,6 +1073,80 @@ class AsyncSpansClient:
         )
         return _response.data
 
+    async def create_spans(
+        self, *, spans: typing.Sequence[SpanWrite], request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Create spans
+
+        Parameters
+        ----------
+        spans : typing.Sequence[SpanWrite]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from Opik import AsyncOpikApi
+        from Opik import SpanWrite
+        import datetime
+        import asyncio
+        client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", )
+        async def main() -> None:
+            await client.spans.create_spans(spans=[SpanWrite(start_time=datetime.datetime.fromisoformat("2024-01-15 09:30:00+00:00", ), )], )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_spans(spans=spans, request_options=request_options)
+        return _response.data
+
+    async def batch_update_spans(
+        self,
+        *,
+        ids: typing.Sequence[str],
+        update: SpanUpdate,
+        merge_tags: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Update multiple spans
+
+        Parameters
+        ----------
+        ids : typing.Sequence[str]
+            List of span IDs to update (max 1000)
+
+        update : SpanUpdate
+
+        merge_tags : typing.Optional[bool]
+            If true, merge tags with existing tags instead of replacing them. Default: false
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from Opik import AsyncOpikApi
+        from Opik import SpanUpdate
+        import asyncio
+        client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", )
+        async def main() -> None:
+            await client.spans.batch_update_spans(ids=['ids'], update=SpanUpdate(trace_id='trace_id', ), )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.batch_update_spans(
+            ids=ids, update=update, merge_tags=merge_tags, request_options=request_options
+        )
+        return _response.data
+
     async def get_spans_by_project(
         self,
         *,
@@ -1225,37 +1340,6 @@ class AsyncSpansClient:
         )
         return _response.data
 
-    async def create_spans(
-        self, *, spans: typing.Sequence[SpanWrite], request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
-        """
-        Create spans
-
-        Parameters
-        ----------
-        spans : typing.Sequence[SpanWrite]
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        None
-
-        Examples
-        --------
-        from Opik import AsyncOpikApi
-        from Opik import SpanWrite
-        import datetime
-        import asyncio
-        client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", )
-        async def main() -> None:
-            await client.spans.create_spans(spans=[SpanWrite(start_time=datetime.datetime.fromisoformat("2024-01-15 09:30:00+00:00", ), )], )
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.create_spans(spans=spans, request_options=request_options)
-        return _response.data
-
     async def get_span_by_id(
         self,
         id: str,
@@ -1693,10 +1777,10 @@ class AsyncSpansClient:
             Truncate image included in either input, output or metadata
 
         from_time : typing.Optional[dt.datetime]
-            Filter spans created from this time (ISO-8601 format). Must be provided together with 'to_time'.
+            Filter spans created from this time (ISO-8601 format).
 
         to_time : typing.Optional[dt.datetime]
-            Filter spans created up to this time (ISO-8601 format). Must be provided together with 'from_time' and must be after 'from_time'.
+            Filter spans created up to this time (ISO-8601 format). If not provided, defaults to current time. Must be after 'from_time'.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.