opik 1.9.26__py3-none-any.whl → 1.9.41__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/traces/client.py

@@ -887,14 +887,14 @@ class TracesClient:
         return _response.data
 
     def find_trace_threads_feedback_score_names(
-        self, *, project_id: str, request_options: typing.Optional[RequestOptions] = None
+        self, *, project_id: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[str]:
         """
         Find Trace Threads Feedback Score names
 
         Parameters
         ----------
-        project_id : str
+        project_id : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -908,7 +908,7 @@ class TracesClient:
         --------
         from Opik import OpikApi
         client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", )
-        client.traces.find_trace_threads_feedback_score_names(project_id='project_id', )
+        client.traces.find_trace_threads_feedback_score_names()
         """
         _response = self._raw_client.find_trace_threads_feedback_score_names(
             project_id=project_id, request_options=request_options
@@ -2429,14 +2429,14 @@ class AsyncTracesClient:
         return _response.data
 
     async def find_trace_threads_feedback_score_names(
-        self, *, project_id: str, request_options: typing.Optional[RequestOptions] = None
+        self, *, project_id: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[str]:
         """
         Find Trace Threads Feedback Score names
 
         Parameters
         ----------
-        project_id : str
+        project_id : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -2452,7 +2452,7 @@ class AsyncTracesClient:
         import asyncio
         client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", )
         async def main() -> None:
-            await client.traces.find_trace_threads_feedback_score_names(project_id='project_id', )
+            await client.traces.find_trace_threads_feedback_score_names()
         asyncio.run(main())
         """
         _response = await self._raw_client.find_trace_threads_feedback_score_names(

opik/rest_api/traces/raw_client.py

@@ -1124,14 +1124,14 @@ class RawTracesClient:
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
     def find_trace_threads_feedback_score_names(
-        self, *, project_id: str, request_options: typing.Optional[RequestOptions] = None
+        self, *, project_id: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[typing.List[str]]:
         """
         Find Trace Threads Feedback Score names
 
         Parameters
         ----------
-        project_id : str
+        project_id : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -3115,14 +3115,14 @@ class AsyncRawTracesClient:
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
     async def find_trace_threads_feedback_score_names(
-        self, *, project_id: str, request_options: typing.Optional[RequestOptions] = None
+        self, *, project_id: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[typing.List[str]]:
         """
         Find Trace Threads Feedback Score names
 
         Parameters
         ----------
-        project_id : str
+        project_id : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.