SDK: Prompt-based locator (#4027)
This commit is contained in:
committed by
GitHub
parent
90f51bcacb
commit
8fb46ef1ca
4
skyvern/client/prompts/__init__.py
Normal file
4
skyvern/client/prompts/__init__.py
Normal file
@@ -0,0 +1,4 @@
|
||||
# This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
# isort: skip_file
|
||||
|
||||
145
skyvern/client/prompts/client.py
Normal file
145
skyvern/client/prompts/client.py
Normal file
@@ -0,0 +1,145 @@
|
||||
# This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
import typing
|
||||
|
||||
from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
|
||||
from ..core.request_options import RequestOptions
|
||||
from ..types.improve_prompt_response import ImprovePromptResponse
|
||||
from .raw_client import AsyncRawPromptsClient, RawPromptsClient
|
||||
|
||||
# this is used as the default value for optional parameters
|
||||
OMIT = typing.cast(typing.Any, ...)
|
||||
|
||||
|
||||
class PromptsClient:
|
||||
def __init__(self, *, client_wrapper: SyncClientWrapper):
|
||||
self._raw_client = RawPromptsClient(client_wrapper=client_wrapper)
|
||||
|
||||
@property
|
||||
def with_raw_response(self) -> RawPromptsClient:
|
||||
"""
|
||||
Retrieves a raw implementation of this client that returns raw responses.
|
||||
|
||||
Returns
|
||||
-------
|
||||
RawPromptsClient
|
||||
"""
|
||||
return self._raw_client
|
||||
|
||||
def improve_prompt(
|
||||
self,
|
||||
*,
|
||||
use_case: str,
|
||||
prompt: str,
|
||||
context: typing.Optional[str] = OMIT,
|
||||
request_options: typing.Optional[RequestOptions] = None,
|
||||
) -> ImprovePromptResponse:
|
||||
"""
|
||||
Improve a prompt based on a specific use-case
|
||||
|
||||
Parameters
|
||||
----------
|
||||
use_case : str
|
||||
The use-case for prompt improvement
|
||||
|
||||
prompt : str
|
||||
The original prompt to improve
|
||||
|
||||
context : typing.Optional[str]
|
||||
Additional context about the user's needs
|
||||
|
||||
request_options : typing.Optional[RequestOptions]
|
||||
Request-specific configuration.
|
||||
|
||||
Returns
|
||||
-------
|
||||
ImprovePromptResponse
|
||||
Successful Response
|
||||
|
||||
Examples
|
||||
--------
|
||||
from skyvern import Skyvern
|
||||
|
||||
client = Skyvern(
|
||||
api_key="YOUR_API_KEY",
|
||||
)
|
||||
client.prompts.improve_prompt(
|
||||
use_case="use-case",
|
||||
prompt="prompt",
|
||||
)
|
||||
"""
|
||||
_response = self._raw_client.improve_prompt(
|
||||
use_case=use_case, prompt=prompt, context=context, request_options=request_options
|
||||
)
|
||||
return _response.data
|
||||
|
||||
|
||||
class AsyncPromptsClient:
|
||||
def __init__(self, *, client_wrapper: AsyncClientWrapper):
|
||||
self._raw_client = AsyncRawPromptsClient(client_wrapper=client_wrapper)
|
||||
|
||||
@property
|
||||
def with_raw_response(self) -> AsyncRawPromptsClient:
|
||||
"""
|
||||
Retrieves a raw implementation of this client that returns raw responses.
|
||||
|
||||
Returns
|
||||
-------
|
||||
AsyncRawPromptsClient
|
||||
"""
|
||||
return self._raw_client
|
||||
|
||||
async def improve_prompt(
|
||||
self,
|
||||
*,
|
||||
use_case: str,
|
||||
prompt: str,
|
||||
context: typing.Optional[str] = OMIT,
|
||||
request_options: typing.Optional[RequestOptions] = None,
|
||||
) -> ImprovePromptResponse:
|
||||
"""
|
||||
Improve a prompt based on a specific use-case
|
||||
|
||||
Parameters
|
||||
----------
|
||||
use_case : str
|
||||
The use-case for prompt improvement
|
||||
|
||||
prompt : str
|
||||
The original prompt to improve
|
||||
|
||||
context : typing.Optional[str]
|
||||
Additional context about the user's needs
|
||||
|
||||
request_options : typing.Optional[RequestOptions]
|
||||
Request-specific configuration.
|
||||
|
||||
Returns
|
||||
-------
|
||||
ImprovePromptResponse
|
||||
Successful Response
|
||||
|
||||
Examples
|
||||
--------
|
||||
import asyncio
|
||||
|
||||
from skyvern import AsyncSkyvern
|
||||
|
||||
client = AsyncSkyvern(
|
||||
api_key="YOUR_API_KEY",
|
||||
)
|
||||
|
||||
|
||||
async def main() -> None:
|
||||
await client.prompts.improve_prompt(
|
||||
use_case="use-case",
|
||||
prompt="prompt",
|
||||
)
|
||||
|
||||
|
||||
asyncio.run(main())
|
||||
"""
|
||||
_response = await self._raw_client.improve_prompt(
|
||||
use_case=use_case, prompt=prompt, context=context, request_options=request_options
|
||||
)
|
||||
return _response.data
|
||||
169
skyvern/client/prompts/raw_client.py
Normal file
169
skyvern/client/prompts/raw_client.py
Normal file
@@ -0,0 +1,169 @@
|
||||
# This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
import typing
|
||||
from json.decoder import JSONDecodeError
|
||||
|
||||
from ..core.api_error import ApiError
|
||||
from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
|
||||
from ..core.http_response import AsyncHttpResponse, HttpResponse
|
||||
from ..core.pydantic_utilities import parse_obj_as
|
||||
from ..core.request_options import RequestOptions
|
||||
from ..errors.unprocessable_entity_error import UnprocessableEntityError
|
||||
from ..types.improve_prompt_response import ImprovePromptResponse
|
||||
|
||||
# this is used as the default value for optional parameters
|
||||
OMIT = typing.cast(typing.Any, ...)
|
||||
|
||||
|
||||
class RawPromptsClient:
|
||||
def __init__(self, *, client_wrapper: SyncClientWrapper):
|
||||
self._client_wrapper = client_wrapper
|
||||
|
||||
def improve_prompt(
|
||||
self,
|
||||
*,
|
||||
use_case: str,
|
||||
prompt: str,
|
||||
context: typing.Optional[str] = OMIT,
|
||||
request_options: typing.Optional[RequestOptions] = None,
|
||||
) -> HttpResponse[ImprovePromptResponse]:
|
||||
"""
|
||||
Improve a prompt based on a specific use-case
|
||||
|
||||
Parameters
|
||||
----------
|
||||
use_case : str
|
||||
The use-case for prompt improvement
|
||||
|
||||
prompt : str
|
||||
The original prompt to improve
|
||||
|
||||
context : typing.Optional[str]
|
||||
Additional context about the user's needs
|
||||
|
||||
request_options : typing.Optional[RequestOptions]
|
||||
Request-specific configuration.
|
||||
|
||||
Returns
|
||||
-------
|
||||
HttpResponse[ImprovePromptResponse]
|
||||
Successful Response
|
||||
"""
|
||||
_response = self._client_wrapper.httpx_client.request(
|
||||
"v1/prompts/improve",
|
||||
method="POST",
|
||||
params={
|
||||
"use-case": use_case,
|
||||
},
|
||||
json={
|
||||
"context": context,
|
||||
"prompt": prompt,
|
||||
},
|
||||
headers={
|
||||
"content-type": "application/json",
|
||||
},
|
||||
request_options=request_options,
|
||||
omit=OMIT,
|
||||
)
|
||||
try:
|
||||
if 200 <= _response.status_code < 300:
|
||||
_data = typing.cast(
|
||||
ImprovePromptResponse,
|
||||
parse_obj_as(
|
||||
type_=ImprovePromptResponse, # type: ignore
|
||||
object_=_response.json(),
|
||||
),
|
||||
)
|
||||
return HttpResponse(response=_response, data=_data)
|
||||
if _response.status_code == 422:
|
||||
raise UnprocessableEntityError(
|
||||
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)
|
||||
|
||||
|
||||
class AsyncRawPromptsClient:
|
||||
def __init__(self, *, client_wrapper: AsyncClientWrapper):
|
||||
self._client_wrapper = client_wrapper
|
||||
|
||||
async def improve_prompt(
|
||||
self,
|
||||
*,
|
||||
use_case: str,
|
||||
prompt: str,
|
||||
context: typing.Optional[str] = OMIT,
|
||||
request_options: typing.Optional[RequestOptions] = None,
|
||||
) -> AsyncHttpResponse[ImprovePromptResponse]:
|
||||
"""
|
||||
Improve a prompt based on a specific use-case
|
||||
|
||||
Parameters
|
||||
----------
|
||||
use_case : str
|
||||
The use-case for prompt improvement
|
||||
|
||||
prompt : str
|
||||
The original prompt to improve
|
||||
|
||||
context : typing.Optional[str]
|
||||
Additional context about the user's needs
|
||||
|
||||
request_options : typing.Optional[RequestOptions]
|
||||
Request-specific configuration.
|
||||
|
||||
Returns
|
||||
-------
|
||||
AsyncHttpResponse[ImprovePromptResponse]
|
||||
Successful Response
|
||||
"""
|
||||
_response = await self._client_wrapper.httpx_client.request(
|
||||
"v1/prompts/improve",
|
||||
method="POST",
|
||||
params={
|
||||
"use-case": use_case,
|
||||
},
|
||||
json={
|
||||
"context": context,
|
||||
"prompt": prompt,
|
||||
},
|
||||
headers={
|
||||
"content-type": "application/json",
|
||||
},
|
||||
request_options=request_options,
|
||||
omit=OMIT,
|
||||
)
|
||||
try:
|
||||
if 200 <= _response.status_code < 300:
|
||||
_data = typing.cast(
|
||||
ImprovePromptResponse,
|
||||
parse_obj_as(
|
||||
type_=ImprovePromptResponse, # type: ignore
|
||||
object_=_response.json(),
|
||||
),
|
||||
)
|
||||
return AsyncHttpResponse(response=_response, data=_data)
|
||||
if _response.status_code == 422:
|
||||
raise UnprocessableEntityError(
|
||||
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)
|
||||
Reference in New Issue
Block a user