llama-index tools openapi integration
Project description
OpenAPI Tool
This tool loads an OpenAPI spec and allow the Agent to retrieve endpoints and details about endpoints. The RequestsToolSpec can also be laoded into the agent to allow the agent to hit the nessecary endpoints with a REST request.
Usage
This tool has more extensive example usage documented in a Jupyter notebook here
Here's an example usage of the OpenAPIToolSpec.
from llama_hub.tools.openapi import OpenAPIToolSpec
from llama_index.agent import OpenAIAgent
f = requests.get(
"https://raw.githubusercontent.com/APIs-guru/openapi-directory/main/APIs/openai.com/1.2.0/openapi.yaml"
).text
open_api_spec = yaml.safe_load(f)
# OR
open_spec = OpenAPIToolSpec(
url="https://raw.githubusercontent.com/APIs-guru/openapi-directory/main/APIs/openai.com/1.2.0/openapi.yaml"
)
tool_spec = OpenAPIToolSpec(open_api_spec)
agent = OpenAIAgent.from_tools(tool_spec.to_tool_list())
agent.chat("What is the base url for the API")
agent.chat("What parameters does the x endpoint need?")
load_openapi_spec
: Returns the parsed OpenAPI spec that the class was initialized with
This loader is designed to be used as a way to load data as a Tool in a Agent. See here for examples.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for flying_delta_tools_openapi-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9965183d54bc789ecbdabef47246734622e48fc5eca956aba00b2f6c1e00b24 |
|
MD5 | 4a97a4c5a52c7f28f8d9527d99eb2fc3 |
|
BLAKE2b-256 | 284c9465fb3eef1d1757b9ee1ec451168c25a6c08854f67d751fae97a5aa06bd |
Close
Hashes for flying_delta_tools_openapi-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 839b1633a40c397e6b9ca819a6fc91ec7ed1d54403c0e15b691ee4617be57f2a |
|
MD5 | aa0268dcbade21d158fb67c3b271654c |
|
BLAKE2b-256 | 293ef057ecac50542e1416500d868291cce974a2e2a4d2939c0fa51444468fd2 |