diff --git a/README.md b/README.md index a83d13e8..82b5603f 100644 --- a/README.md +++ b/README.md @@ -106,79 +106,141 @@ I starred the ArcadeAI/arcade-ai repo on Github for you! You can use Ctrl-C to exit the chat at any time. -### Arcade Engine APIs +## Arcade Cloud -- **`/auth`**: Generic OAuth 2.0 flow for authorizing agents across many services -- **`/tools`**: Manage, authorize, and execute tools. Tool-calling where the tools are **actually called** -- **`/chat`**: An OpenAI-compatible LLM API that enables tool execution with new `tool_choice` options: - 1. `tool_choice='execute'`: Return the predicted tool call's output as content in the response - 2. `tool_choice='generate'`: Generate a response informed by predicted tool call(s) execution. +Arcade Cloud is a hosted version of the Arcade AI engine that hosts a number of prebuilt toolkits for interacting with a variety of services. -See the full API spec [here](https://reference.arcade-ai.com). +### Prebuilt Toolkits -### Arcade Cloud Engine +Arcade AI offers a number of prebuilt toolkits that can be used by agents to interact with a variety of services. - -

-Arcade AI offers a number of prebuilt toolkits that can be used to interact with a variety of services. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ServiceAuth TypeToolkitDocumentation
GitHubOAuthGithubGitHub Toolkit Docs
GmailOAuthGoogleGmail Toolkit Docs
Google CalendarOAuthGoogleGoogle Calendar Toolkit Docs
Google DocsOAuthGoogleGoogle Docs Toolkit Docs
Google DriveOAuthGoogleGoogle Drive Toolkit Docs
SearchAPI KeySearchSearch Toolkit Docs
SlackOAuthSlackSlack Toolkit Docs
WebAPI KeyWebWeb Toolkit Docs
TwitterOAuthXX Toolkit Docs
-#### Calling tools directly +
-```python -from arcadepy import Arcade +### Supported Auth Providers -client = Arcade() - -USER_ID = "you@example.com" -TOOL_NAME = "Github.SetStarred" - -# Perform User Authorization -auth_response = client.tools.authorize( - tool_name=TOOL_NAME, - user_id=USER_ID, -) -if auth_response.status != "completed": - print(f"Click this link to authorize: {auth_response.auth_url}") - input("After you have authorized, press Enter to continue...") - -# Run the tool -inputs = {"owner": "ArcadeAI", "name": "Hello-World", "starred": True} -response = client.tools.run( - tool_name=TOOL_NAME, - inputs=inputs, - user_id=USER_ID, -) -print(response) - -``` - -#### Calling tools with the LLM API - -```python -import os -from openai import OpenAI - -USER_ID = "you@example.com" -PROMPT = "Star the ArcadeAI/arcade-ai repository." -TOOL_NAME = "Github.SetStarred" -# Use "generate" to have the LLM generate a response after the tool executes. Use 'execute' to get the tool's output directly. -TOOL_CHOICE = "generate" - -client = OpenAI( - base_url="https://api.arcade-ai.com", - api_key=os.environ.get("ARCADE_API_KEY")) - -response = client.chat.completions.create( - messages=[ - {"role": "user", "content": PROMPT}, - ], - model="gpt-4o-mini", - user=USER_ID, - tools=[TOOL_NAME], - tool_choice=TOOL_CHOICE, -) -print(response.choices[0].message.content) -``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ProviderNameDocumentation
GitHubgithubGitHub Auth Docs
GooglegoogleGoogle Auth Docs
LinkedInlinkedinLinkedIn Auth Docs
MicrosoftmicrosoftMicrosoft Auth Docs
SlackslackSlack Auth Docs
SpotifyspotifySpotify Auth Docs
XxX Auth Docs
ZoomzoomZoom Auth Docs
OAuth 2.0oauth2Generic OAuth2 Auth Docs
### Building Your Own Tools @@ -190,17 +252,6 @@ Arcade AI enables you to evaluate your custom tools to ensure they function corr Learn how to evaluate your tools by following our [evaluating tools guide](https://docs.arcade-ai.com/home/evaluate-tools/create-an-evaluation-suite). -### Auth - - -

- -Learn how to use Arcade AI to obtain user authorization for accessing third-party services in our [authorizing agents with Arcade AI guide](https://docs.arcade-ai.com/home/get-a-token-for-a-user). - -Learn how to use Arcade AI's auth providers to enable tools and agents to call other services on behalf of users in our [tools with auth guide](https://docs.arcade-ai.com/home/build-tools/create-a-tool-with-auth). - -To see all available auth providers, refer to the [auth providers documentation](https://docs.arcade-ai.com/integrations). - ### Models diff --git a/contrib/langchain/pyproject.toml b/contrib/langchain/pyproject.toml index aa0b0d28..903ea780 100644 --- a/contrib/langchain/pyproject.toml +++ b/contrib/langchain/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "langchain-arcade" -version = "0.1.1" +version = "0.1.2" description = "An integration package connecting Arcade AI and LangChain/LangGraph" authors = ["Arcade AI "] readme = "README.md"