From fea9ff3831e0f1bd13da3bade1f01741fa612eb9 Mon Sep 17 00:00:00 2001 From: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Date: Wed, 24 Jul 2024 10:51:39 -0700 Subject: [PATCH] docs: add tables for search and code interpreter tools (#24586) --- docs/Makefile | 2 + docs/scripts/tool_feat_table.py | 181 ++++++++++++++++++++++++++++++++ docs/sidebars.js | 4 +- 3 files changed, 185 insertions(+), 2 deletions(-) create mode 100644 docs/scripts/tool_feat_table.py diff --git a/docs/Makefile b/docs/Makefile index b17859e676..e0d580b701 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -38,6 +38,8 @@ generate-files: $(PYTHON) scripts/model_feat_table.py $(INTERMEDIATE_DIR) + $(PYTHON) scripts/tool_feat_table.py $(INTERMEDIATE_DIR) + $(PYTHON) scripts/document_loader_feat_table.py $(INTERMEDIATE_DIR) $(PYTHON) scripts/copy_templates.py $(INTERMEDIATE_DIR) diff --git a/docs/scripts/tool_feat_table.py b/docs/scripts/tool_feat_table.py new file mode 100644 index 0000000000..c3393abfe0 --- /dev/null +++ b/docs/scripts/tool_feat_table.py @@ -0,0 +1,181 @@ +import sys +from pathlib import Path + +SEARCH_TOOL_FEAT_TABLE = { + "Exa Search": { + "pricing": "1000 free searches/month", + "available_data": "URL, Author, Title, Published Date", + "link": "/docs/integrations/tools/exa_search", + }, + "Bing Search": { + "pricing": "Paid", + "available_data": "URL, Snippet, Title", + "link": "/docs/integrations/tools/bing_search", + }, + "DuckDuckgoSearch": { + "pricing": "Free", + "available_data": "URL, Snippet, Title", + "link": "/docs/integrations/tools/ddg", + }, + "Brave Search": { + "pricing": "Free", + "available_data": "URL, Snippet, Title", + "link": "/docs/integrations/tools/brave_search", + }, + "Google Search": { + "pricing": "Paid", + "available_data": "URL, Snippet, Title", + "link": "/docs/integrations/tools/google_search", + }, + "Google Serper": { + "pricing": "Free", + "available_data": "URL, Snippet, Title, Search Rank, Site Links", + "link": "/docs/integrations/tools/google_serper", + }, + "Mojeek Search": { + "pricing": "Paid", + "available_data": "URL, Snippet, Title", + "link": "/docs/integrations/tools/mojeek_search", + }, + "SearxNG Search": { + "pricing": "Free", + "available_data": "URL, Snippet, Title, Category", + "link": "/docs/integrations/tools/searx_search", + }, + "You.com Search": { + "pricing": "Free for 60 days", + "available_data": "URL, Title, Page Content", + "link": "/docs/integrations/tools/you", + }, + "SearchApi": { + "pricing": "100 Free Searches on Sign Up", + "available_data": "URL, Snippet, Title, Search Rank, Site Links, Authors", + "link": "/docs/integrations/tools/searchapi", + }, + "SerpAPI": { + "pricing": "100 Free Searches/Month", + "available_data": "Answer", + "link": "/docs/integrations/tools/serpapi", + }, +} + +CODE_INTERPRETER_TOOL_FEAT_TABLE = { + "Bearly Code Interpreter": { + "langauges": "Python", + "sandbox_lifetime": "Resets on Execution", + "upload": True, + "return_results": "Text", + "link": "/docs/integrations/tools/bearly", + }, + "Riza Code Interpreter": { + "langauges": "Python, JavaScript, PHP, Ruby", + "sandbox_lifetime": "Resets on Execution", + "upload": False, + "return_results": "Text", + "link": "/docs/integrations/tools/riza", + }, + "E2B Data Analysis": { + "langauges": "Python. In beta: JavaScript, R, Java", + "sandbox_lifetime": "24 Hours", + "upload": True, + "return_results": "Text, Images, Videos", + "link": "/docs/integrations/tools/e2b_data_analysis", + }, + "Azure Container Apps dynamic sessions": { + "langauges": "Python", + "sandbox_lifetime": "1 Hour", + "upload": True, + "return_results": "Text, Images", + "link": "/docs/integrations/tools/azure_dynamic_sessions", + }, +} + +TOOLS_TEMPLATE = """\ +--- +sidebar_position: 0 +sidebar_class_name: hidden +keywords: [compatibility] +custom_edit_url: +hide_table_of_contents: true +--- + +# Tools + +## Search Tools + +The following table shows tools that execute online searches in some shape or form: + +{search_table} + +## Code Interpreter Tools + +The following table shows tools that can be used as code interpreters: + +{code_interpreter_table} + +""" + + +def get_search_tools_table() -> str: + """Get the table of search tools.""" + header = ["tool", "pricing", "available_data"] + title = ["Tool", "Free/Paid", "Return Data"] + rows = [title, [":-"] + [":-:"] * (len(title) - 1)] + for search_tool, feats in sorted(SEARCH_TOOL_FEAT_TABLE.items()): + # Fields are in the order of the header + row = [ + f"[{search_tool}]({feats['link']})", + ] + for h in header[1:]: + row.append(feats.get(h)) + rows.append(row) + return "\n".join(["|".join(row) for row in rows]) + + +def get_code_interpreter_table() -> str: + """Get the table of search tools.""" + header = [ + "tool", + "langauges", + "sandbox_lifetime", + "upload", + "return_results", + ] + title = [ + "Tool", + "Supported Languages", + "Sandbox Lifetime", + "Supports File Uploads", + "Return Types", + ] + rows = [title, [":-"] + [":-:"] * (len(title) - 1)] + for search_tool, feats in sorted(CODE_INTERPRETER_TOOL_FEAT_TABLE.items()): + # Fields are in the order of the header + row = [ + f"[{search_tool}]({feats['link']})", + ] + for h in header[1:]: + value = feats.get(h) + if h == "upload": + if value is True: + row.append("✅") + else: + row.append("❌") + else: + row.append(value) + rows.append(row) + return "\n".join(["|".join(row) for row in rows]) + + +if __name__ == "__main__": + output_dir = Path(sys.argv[1]) + output_integrations_dir = output_dir / "integrations" + output_integrations_dir_tools = output_integrations_dir / "tools" + output_integrations_dir_tools.mkdir(parents=True, exist_ok=True) + + tools_page = TOOLS_TEMPLATE.format( + search_table=get_search_tools_table(), + code_interpreter_table=get_code_interpreter_table(), + ) + with open(output_integrations_dir / "tools" / "index.mdx", "w") as f: + f.write(tools_page) diff --git a/docs/sidebars.js b/docs/sidebars.js index 63c68eb6e9..7b170dc72a 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -243,8 +243,8 @@ module.exports = { }, ], link: { - type: "generated-index", - slug: "integrations/tools", + type: "doc", + id: "integrations/tools/index", }, }, {