skyvern-llamaindex 0.0.1__py3-none-any.whl

skyvern_llamaindex/agent.py

@@ -0,0 +1,95 @@
+from typing import Any, Dict, List, Tuple
+
+from llama_index.core.tools.tool_spec.base import SPEC_FUNCTION_TYPE, BaseToolSpec
+from llama_index.core.tools.types import ToolMetadata
+from skyvern_llamaindex.schema import GetTaskInput, TaskV1Request, TaskV2Request
+
+from skyvern.agent import Agent
+from skyvern.forge.sdk.schemas.observers import ObserverTask
+from skyvern.forge.sdk.schemas.tasks import CreateTaskResponse, TaskResponse
+
+
+class SkyvernAgentToolSpec(BaseToolSpec):
+    spec_functions: List[SPEC_FUNCTION_TYPE] = [
+        "run_task_v1",
+        "queue_task_v1",
+        "get_task_v1",
+        "run_task_v2",
+        "queue_task_v2",
+        "get_task_v2",
+    ]
+    spec_metadata: Dict[str, ToolMetadata] = {
+        "run_task_v1": ToolMetadata(
+            name="run-skyvern-agent-task-v1",
+            description="Use Skyvern agent to run a v1 task. It is usually used for the simple tasks. This function won't return until the task is finished.",
+            fn_schema=TaskV1Request,
+        ),
+        "queue_task_v1": ToolMetadata(
+            name="queue-skyvern-agent-task-v1",
+            description="Use Skyvern agent to queue a v1 task. It is usually used for the simple tasks. This function will return immediately and the task will be running in the background.",
+            fn_schema=TaskV1Request,
+        ),
+        "get_task_v1": ToolMetadata(
+            name="get-skyvern-agent-task-v1",
+            description="Use Skyvern agent to get a v1 task. v1 tasks are usually simple tasks.",
+            fn_schema=GetTaskInput,
+        ),
+        "run_task_v2": ToolMetadata(
+            name="run-skyvern-agent-task-v2",
+            description="Use Skyvern agent to run a v2 task. It is usually used for the complicated tasks. This function won't return until the task is finished.",
+            fn_schema=TaskV2Request,
+        ),
+        "queue_task_v2": ToolMetadata(
+            name="queue-skyvern-agent-task-v2",
+            description="Use Skyvern agent to queue a v2 task. It is usually used for the complicated tasks. This function will return immediately and the task will be running in the background.",
+            fn_schema=TaskV2Request,
+        ),
+        "get_task_v2": ToolMetadata(
+            name="get-skyvern-agent-task-v2",
+            description="Use Skyvern agent to get a v2 task. v2 tasks are usually complicated tasks.",
+            fn_schema=GetTaskInput,
+        ),
+    }
+
+    def __init__(self) -> None:
+        self.agent = Agent()
+
+    def get_metadata_from_fn_name(
+        self, fn_name: str, spec_functions: List[str | Tuple[str, str]] | None = None
+    ) -> ToolMetadata | None:
+        try:
+            getattr(self, fn_name)
+        except AttributeError:
+            return None
+
+        return self.spec_metadata.get(fn_name)
+
+    async def run_task_v1(self, **kwargs: Dict[str, Any]) -> TaskResponse:
+        """Use Skyvern agent to run a v1 task. It is usually used for the simple tasks. This function won't return until the task is finished."""
+        task_request = TaskV1Request(**kwargs)
+        return await self.agent.run_task(task_request=task_request, timeout_seconds=task_request.timeout_seconds)
+
+    async def queue_task_v1(self, **kwargs: Dict[str, Any]) -> CreateTaskResponse:
+        """Use Skyvern agent to queue a v1 task. It is usually used for the simple tasks. This function will return immediately and the task will be running in the background."""
+        task_request = TaskV1Request(**kwargs)
+        return await self.agent.create_task(task_request=task_request)
+
+    async def get_task_v1(self, task_id: str) -> TaskResponse | None:
+        """Use Skyvern agent to get a v1 task. v1 tasks are usually simple tasks."""
+        return await self.agent.get_task(task_id=task_id)
+
+    async def run_task_v2(self, **kwargs: Dict[str, Any]) -> ObserverTask:
+        """Use Skyvern agent to run a v2 task. It is usually used for the complicated tasks. This function won't return until the task is finished."""
+        task_request = TaskV2Request(**kwargs)
+        return await self.agent.run_observer_task_v_2(
+            task_request=task_request, timeout_seconds=task_request.timeout_seconds
+        )
+
+    async def queue_task_v2(self, **kwargs: Dict[str, Any]) -> ObserverTask:
+        """Use Skyvern agent to queue a v2 task. It is usually used for the complicated tasks. This function will return immediately and the task will be running in the background."""
+        task_request = TaskV2Request(**kwargs)
+        return await self.agent.observer_task_v_2(task_request=task_request)
+
+    async def get_task_v2(self, task_id: str) -> ObserverTask | None:
+        """Use Skyvern agent to get a v2 task. v2 tasks are usually complicated tasks."""
+        return await self.agent.get_observer_task_v_2(task_id=task_id)

skyvern_llamaindex/client.py

@@ -0,0 +1,146 @@
+from typing import Any, Dict, List, Tuple
+
+from httpx import AsyncClient
+from llama_index.core.tools.tool_spec.base import SPEC_FUNCTION_TYPE, BaseToolSpec
+from llama_index.core.tools.types import ToolMetadata
+from skyvern_llamaindex.schema import GetTaskInput, TaskV1Request, TaskV2Request
+
+from skyvern.client import AsyncSkyvern
+from skyvern.forge.sdk.schemas.tasks import CreateTaskResponse, TaskResponse
+
+
+class SkyvernClientToolSpec(BaseToolSpec):
+    spec_functions: List[SPEC_FUNCTION_TYPE] = [
+        "run_task_v1",
+        "queue_task_v1",
+        "get_task_v1",
+        "run_task_v2",
+        "queue_task_v2",
+        "get_task_v2",
+    ]
+
+    spec_metadata: Dict[str, ToolMetadata] = {
+        "run_task_v1": ToolMetadata(
+            name="run-skyvern-client-task-v1",
+            description="Use Skyvern client to run a v1 task. It is usually used for the simple tasks. This function won't return until the task is finished.",
+            fn_schema=TaskV1Request,
+        ),
+        "queue_task_v1": ToolMetadata(
+            name="queue-skyvern-client-task-v1",
+            description="Use Skyvern client to queue a v1 task. It is usually used for the simple tasks. This function will return immediately and the task will be running in the background.",
+            fn_schema=TaskV1Request,
+        ),
+        "get_task_v1": ToolMetadata(
+            name="get-skyvern-client-task-v1",
+            description="Use Skyvern client to get a v1 task. v1 tasks are usually simple tasks.",
+            fn_schema=GetTaskInput,
+        ),
+        "run_task_v2": ToolMetadata(
+            name="run-skyvern-client-task-v2",
+            description="Use Skyvern client to run a v2 task. It is usually used for the complicated tasks. This function won't return until the task is finished.",
+            fn_schema=TaskV2Request,
+        ),
+        "queue_task_v2": ToolMetadata(
+            name="queue-skyvern-client-task-v2",
+            description="Use Skyvern client to queue a v2 task. It is usually used for the complicated tasks. This function will return immediately and the task will be running in the background.",
+            fn_schema=TaskV2Request,
+        ),
+        "get_task_v2": ToolMetadata(
+            name="get-skyvern-client-task-v2",
+            description="Use Skyvern client to get a v2 task. It is usually used for the complicated tasks.",
+            fn_schema=GetTaskInput,
+        ),
+    }
+
+    def __init__(self, credential: str, base_url: str = "https://api.skyvern.com"):
+        httpx_client = AsyncClient(
+            headers={
+                "Content-Type": "application/json",
+                "x-api-key": credential,
+            },
+        )
+        self.client = AsyncSkyvern(base_url=base_url, httpx_client=httpx_client)
+
+    def get_metadata_from_fn_name(
+        self, fn_name: str, spec_functions: List[str | Tuple[str, str]] | None = None
+    ) -> ToolMetadata | None:
+        try:
+            getattr(self, fn_name)
+        except AttributeError:
+            return None
+
+        return self.spec_metadata.get(fn_name)
+
+    async def run_task_v1(self, **kwargs: Dict[str, Any]) -> TaskResponse:
+        task_request = TaskV1Request(**kwargs)
+        return await self.client.agent.run_task(
+            max_steps_override=task_request.max_steps,
+            timeout_seconds=task_request.timeout_seconds,
+            url=task_request.url,
+            title=task_request.title,
+            webhook_callback_url=task_request.webhook_callback_url,
+            totp_verification_url=task_request.totp_verification_url,
+            totp_identifier=task_request.totp_identifier,
+            navigation_goal=task_request.navigation_goal,
+            data_extraction_goal=task_request.data_extraction_goal,
+            navigation_payload=task_request.navigation_goal,
+            error_code_mapping=task_request.error_code_mapping,
+            proxy_location=task_request.proxy_location,
+            extracted_information_schema=task_request.extracted_information_schema,
+            complete_criterion=task_request.complete_criterion,
+            terminate_criterion=task_request.terminate_criterion,
+            browser_session_id=task_request.browser_session_id,
+        )
+
+    async def queue_task_v1(self, **kwargs: Dict[str, Any]) -> CreateTaskResponse:
+        task_request = TaskV1Request(**kwargs)
+        return await self.client.agent.create_task(
+            max_steps_override=task_request.max_steps,
+            url=task_request.url,
+            title=task_request.title,
+            webhook_callback_url=task_request.webhook_callback_url,
+            totp_verification_url=task_request.totp_verification_url,
+            totp_identifier=task_request.totp_identifier,
+            navigation_goal=task_request.navigation_goal,
+            data_extraction_goal=task_request.data_extraction_goal,
+            navigation_payload=task_request.navigation_goal,
+            error_code_mapping=task_request.error_code_mapping,
+            proxy_location=task_request.proxy_location,
+            extracted_information_schema=task_request.extracted_information_schema,
+            complete_criterion=task_request.complete_criterion,
+            terminate_criterion=task_request.terminate_criterion,
+            browser_session_id=task_request.browser_session_id,
+        )
+
+    async def get_task_v1(self, task_id: str) -> TaskResponse:
+        return await self.client.agent.get_task(task_id=task_id)
+
+    async def run_task_v2(self, **kwargs: Dict[str, Any]) -> Dict[str, Any | None]:
+        task_request = TaskV2Request(**kwargs)
+        return await self.client.agent.run_observer_task_v_2(
+            max_iterations_override=task_request.max_iterations,
+            timeout_seconds=task_request.timeout_seconds,
+            user_prompt=task_request.user_prompt,
+            url=task_request.url,
+            browser_session_id=task_request.browser_session_id,
+            webhook_callback_url=task_request.webhook_callback_url,
+            totp_verification_url=task_request.totp_verification_url,
+            totp_identifier=task_request.totp_identifier,
+            proxy_location=task_request.proxy_location,
+        )
+
+    async def queue_task_v2(self, **kwargs: Dict[str, Any]) -> Dict[str, Any | None]:
+        task_request = TaskV2Request(**kwargs)
+        return await self.client.agent.observer_task_v_2(
+            max_iterations_override=task_request.max_iterations,
+            user_prompt=task_request.user_prompt,
+            url=task_request.url,
+            browser_session_id=task_request.browser_session_id,
+            webhook_callback_url=task_request.webhook_callback_url,
+            totp_verification_url=task_request.totp_verification_url,
+            totp_identifier=task_request.totp_identifier,
+            proxy_location=task_request.proxy_location,
+        )
+
+    async def get_task_v2(self, task_id: str) -> Dict[str, Any | None]:
+        return await self.client.agent.get_observer_task_v_2(task_id=task_id)

skyvern_llamaindex/schema.py

@@ -0,0 +1,18 @@
+from pydantic import BaseModel
+
+from skyvern.forge.sdk.schemas.observers import ObserverTaskRequest
+from skyvern.forge.sdk.schemas.tasks import TaskRequest
+
+
+class TaskV1Request(TaskRequest):
+    max_steps: int = 10
+    timeout_seconds: int = 60 * 60
+
+
+class TaskV2Request(ObserverTaskRequest):
+    max_iterations: int = 10
+    timeout_seconds: int = 60 * 60
+
+
+class GetTaskInput(BaseModel):
+    task_id: str

skyvern_llamaindex-0.0.1.dist-info/METADATA

@@ -0,0 +1,197 @@
+Metadata-Version: 2.1
+Name: skyvern-llamaindex
+Version: 0.0.1
+Summary: Skyvern integration for LlamaIndex
+Author: lawyzheng
+Author-email: lawy@skyvern.com
+Requires-Python: >=3.11,<3.12
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: llama-index (>=0.12.19,<0.13.0)
+Requires-Dist: skyvern (>=0.1.56,<0.2.0)
+Description-Content-Type: text/markdown
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Skyvern LlamaIndex](#skyvern-llamaindex)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Run a task(sync) with skyvern agent (calling skyvern agent function directly in the tool)](#run-a-tasksync-with-skyvern-agent-calling-skyvern-agent-function-directly-in-the-tool)
+    - [Run a task(async) with skyvern agent (calling skyvern agent function directly in the tool)](#run-a-taskasync-with-skyvern-agent-calling-skyvern-agent-function-directly-in-the-tool)
+    - [Run a task(sync) with skyvern client (calling skyvern OpenAPI in the tool)](#run-a-tasksync-with-skyvern-client-calling-skyvern-openapi-in-the-tool)
+    - [Run a task(async) with skyvern client (calling skyvern OpenAPI in the tool)](#run-a-taskasync-with-skyvern-client-calling-skyvern-openapi-in-the-tool)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# Skyvern LlamaIndex
+
+This is a LlamaIndex integration for Skyvern.
+
+## Installation
+
+```bash
+pip install skyvern-llamaindex
+```
+
+## Usage
+
+### Run a task(sync) with skyvern agent (calling skyvern agent function directly in the tool)
+> sync task won't return until the task is finished.
+
+:warning: :warning: if you want to run this code block, you need to run `skyvern init --openai-api-key <your_openai_api_key>` command in your terminal to set up skyvern first.
+
+
+```python
+import asyncio
+from dotenv import load_dotenv
+from llama_index.agent.openai import OpenAIAgent
+from llama_index.llms.openai import OpenAI
+from skyvern_llamaindex.agent import SkyvernAgentToolSpec
+
+# load OpenAI API key from .env
+load_dotenv()
+
+skyvern_tool = SkyvernAgentToolSpec()
+
+tools = skyvern_tool.to_tool_list(["run_task_v2"])
+
+agent = OpenAIAgent.from_tools(
+    tools=tools,
+    llm=OpenAI(model="gpt-4o"),
+    verbose=True,
+    max_function_calls=10,
+)
+
+# to run skyvern agent locally, must run `skyvern init` first
+response = agent.chat("Run the task with skyvern. The task is about 'Navigate to the Hacker News homepage and get the top 3 posts.'")
+print(response)
+```
+
+### Run a task(async) with skyvern agent (calling skyvern agent function directly in the tool)
+> async task will return immediately and the task will be running in the background. You can use `get_task_v2` tool to poll the task information until the task is finished.
+
+:warning: :warning: if you want to run this code block, you need to run `skyvern init --openai-api-key <your_openai_api_key>` command in your terminal to set up skyvern first.
+
+```python
+import asyncio
+from dotenv import load_dotenv
+from llama_index.agent.openai import OpenAIAgent
+from llama_index.llms.openai import OpenAI
+from llama_index.core.tools import FunctionTool
+from skyvern_llamaindex.agent import SkyvernAgentToolSpec
+
+async def sleep(seconds: int) -> str:
+    await asyncio.sleep(seconds)
+    return f"Slept for {seconds} seconds"
+
+# load OpenAI API key from .env
+load_dotenv()
+
+skyvern_tool = SkyvernAgentToolSpec()
+
+sleep_tool = FunctionTool.from_defaults(
+    async_fn=sleep,
+    description="Sleep for a given number of seconds",
+    name="sleep",
+)
+
+tools = skyvern_tool.to_tool_list(["queue_task_v2", "get_task_v2"])
+tools.append(sleep_tool)
+
+agent = OpenAIAgent.from_tools(
+    tools=tools,
+    llm=OpenAI(model="gpt-4o"),
+    verbose=True,
+    max_function_calls=10,
+)
+
+response = agent.chat("Queue a task with Skyvern. The task is about 'Navigate to the Hacker News homepage and get the top 3 posts.' Then, get this task information until it's completed. The task information re-get interval should be 60s.")
+print(response)
+
+```
+
+### Run a task(sync) with skyvern client (calling skyvern OpenAPI in the tool)
+> sync task won't return until the task is finished.
+
+no need to run `skyvern init` command in your terminal to set up skyvern before using this integration.
+
+```python
+import asyncio
+from dotenv import load_dotenv
+from llama_index.agent.openai import OpenAIAgent
+from llama_index.llms.openai import OpenAI
+from skyvern_llamaindex.client import SkyvernClientToolSpec
+
+
+async def sleep(seconds: int) -> str:
+    await asyncio.sleep(seconds)
+    return f"Slept for {seconds} seconds"
+
+# load OpenAI API key from .env
+load_dotenv()
+
+skyvern_client_tool = SkyvernClientToolSpec(
+    credential="<your_organization_api_key>",
+)
+
+tools = skyvern_client_tool.to_tool_list(["run_task_v2"])
+
+agent = OpenAIAgent.from_tools(
+    tools=tools,
+    llm=OpenAI(model="gpt-4o"),
+    verbose=True,
+    max_function_calls=10,
+)
+
+response = agent.chat("Run the task with skyvern. The task is about 'Navigate to the Hacker News homepage and get the top 3 posts.'")
+print(response)
+
+```
+
+### Run a task(async) with skyvern client (calling skyvern OpenAPI in the tool)
+> async task will return immediately and the task will be running in the background. You can use `GetSkyvernClientTaskV2Tool` tool to poll the task information until the task is finished.
+
+no need to run `skyvern init` command in your terminal to set up skyvern before using this integration.
+
+```python
+import asyncio
+from dotenv import load_dotenv
+from llama_index.agent.openai import OpenAIAgent
+from llama_index.llms.openai import OpenAI
+from llama_index.core.tools import FunctionTool
+from skyvern_llamaindex.client import SkyvernClientToolSpec
+
+
+async def sleep(seconds: int) -> str:
+    await asyncio.sleep(seconds)
+    return f"Slept for {seconds} seconds"
+
+# load OpenAI API key from .env
+load_dotenv()
+
+skyvern_client_tool = SkyvernClientToolSpec(
+    credential="<your_organization_api_key>",
+)
+
+sleep_tool = FunctionTool.from_defaults(
+    async_fn=sleep,
+    description="Sleep for a given number of seconds",
+    name="sleep",
+)
+
+tools = skyvern_client_tool.to_tool_list(["queue_task_v2", "get_task_v2"])
+tools.append(sleep_tool)
+
+agent = OpenAIAgent.from_tools(
+    tools=tools,
+    llm=OpenAI(model="gpt-4o"),
+    verbose=True,
+    max_function_calls=10,
+)
+
+response = agent.chat("Queue a task with Skyvern. The task is about 'Navigate to the Hacker News homepage and get the top 3 posts.' Then, get this task information until it's completed. The task information re-get interval should be 60s.")
+print(response)
+
+```

skyvern_llamaindex-0.0.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+skyvern_llamaindex/agent.py,sha256=x1Hg19Pw3Y6NuOWR8FcylJClzcqL-cyysx9Mon2R-a0,4815
+skyvern_llamaindex/client.py,sha256=ZVKQR7trdrutRZlSDkouWIkW-FUaObAE3ewMUdKFt3g,6996
+skyvern_llamaindex/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+skyvern_llamaindex/schema.py,sha256=tTvnSC-ms_tW8bnzIn6FXPOCngom7l62B-IyhIwvRxQ,409
+skyvern_llamaindex-0.0.1.dist-info/METADATA,sha256=yblp6nsXM5AR8C1NxjicYXCXrL8FHYgSRIvPWYGgIo0,6757
+skyvern_llamaindex-0.0.1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+skyvern_llamaindex-0.0.1.dist-info/RECORD,,

skyvern_llamaindex-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.1
+Root-Is-Purelib: true
+Tag: py3-none-any