langfuse.api.prompt_version.client

  1# This file was auto-generated by Fern from our API Definition.
  2
  3import typing
  4
  5from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
  6from ..core.request_options import RequestOptions
  7from ..prompts.types.prompt import Prompt
  8from .raw_client import AsyncRawPromptVersionClient, RawPromptVersionClient
  9
 10# this is used as the default value for optional parameters
 11OMIT = typing.cast(typing.Any, ...)
 12
 13
 14class PromptVersionClient:
 15    def __init__(self, *, client_wrapper: SyncClientWrapper):
 16        self._raw_client = RawPromptVersionClient(client_wrapper=client_wrapper)
 17
 18    @property
 19    def with_raw_response(self) -> RawPromptVersionClient:
 20        """
 21        Retrieves a raw implementation of this client that returns raw responses.
 22
 23        Returns
 24        -------
 25        RawPromptVersionClient
 26        """
 27        return self._raw_client
 28
 29    def update(
 30        self,
 31        name: str,
 32        version: int,
 33        *,
 34        new_labels: typing.Sequence[str],
 35        request_options: typing.Optional[RequestOptions] = None,
 36    ) -> Prompt:
 37        """
 38        Update labels for a specific prompt version
 39
 40        Parameters
 41        ----------
 42        name : str
 43            The name of the prompt. If the prompt is in a folder (e.g., "folder/subfolder/prompt-name"),
 44            the folder path must be URL encoded.
 45
 46        version : int
 47            Version of the prompt to update
 48
 49        new_labels : typing.Sequence[str]
 50            New labels for the prompt version. Labels are unique across versions. The "latest" label is reserved and managed by Langfuse.
 51
 52        request_options : typing.Optional[RequestOptions]
 53            Request-specific configuration.
 54
 55        Returns
 56        -------
 57        Prompt
 58
 59        Examples
 60        --------
 61        from langfuse import LangfuseAPI
 62
 63        client = LangfuseAPI(
 64            x_langfuse_sdk_name="YOUR_X_LANGFUSE_SDK_NAME",
 65            x_langfuse_sdk_version="YOUR_X_LANGFUSE_SDK_VERSION",
 66            x_langfuse_public_key="YOUR_X_LANGFUSE_PUBLIC_KEY",
 67            username="YOUR_USERNAME",
 68            password="YOUR_PASSWORD",
 69            base_url="https://yourhost.com/path/to/api",
 70        )
 71        client.prompt_version.update(
 72            name="name",
 73            version=1,
 74            new_labels=["newLabels", "newLabels"],
 75        )
 76        """
 77        _response = self._raw_client.update(
 78            name, version, new_labels=new_labels, request_options=request_options
 79        )
 80        return _response.data
 81
 82
 83class AsyncPromptVersionClient:
 84    def __init__(self, *, client_wrapper: AsyncClientWrapper):
 85        self._raw_client = AsyncRawPromptVersionClient(client_wrapper=client_wrapper)
 86
 87    @property
 88    def with_raw_response(self) -> AsyncRawPromptVersionClient:
 89        """
 90        Retrieves a raw implementation of this client that returns raw responses.
 91
 92        Returns
 93        -------
 94        AsyncRawPromptVersionClient
 95        """
 96        return self._raw_client
 97
 98    async def update(
 99        self,
100        name: str,
101        version: int,
102        *,
103        new_labels: typing.Sequence[str],
104        request_options: typing.Optional[RequestOptions] = None,
105    ) -> Prompt:
106        """
107        Update labels for a specific prompt version
108
109        Parameters
110        ----------
111        name : str
112            The name of the prompt. If the prompt is in a folder (e.g., "folder/subfolder/prompt-name"),
113            the folder path must be URL encoded.
114
115        version : int
116            Version of the prompt to update
117
118        new_labels : typing.Sequence[str]
119            New labels for the prompt version. Labels are unique across versions. The "latest" label is reserved and managed by Langfuse.
120
121        request_options : typing.Optional[RequestOptions]
122            Request-specific configuration.
123
124        Returns
125        -------
126        Prompt
127
128        Examples
129        --------
130        import asyncio
131
132        from langfuse import AsyncLangfuseAPI
133
134        client = AsyncLangfuseAPI(
135            x_langfuse_sdk_name="YOUR_X_LANGFUSE_SDK_NAME",
136            x_langfuse_sdk_version="YOUR_X_LANGFUSE_SDK_VERSION",
137            x_langfuse_public_key="YOUR_X_LANGFUSE_PUBLIC_KEY",
138            username="YOUR_USERNAME",
139            password="YOUR_PASSWORD",
140            base_url="https://yourhost.com/path/to/api",
141        )
142
143
144        async def main() -> None:
145            await client.prompt_version.update(
146                name="name",
147                version=1,
148                new_labels=["newLabels", "newLabels"],
149            )
150
151
152        asyncio.run(main())
153        """
154        _response = await self._raw_client.update(
155            name, version, new_labels=new_labels, request_options=request_options
156        )
157        return _response.data