137 lines
12 KiB
JSON
137 lines
12 KiB
JSON
{
|
|
"name": "CreateWebsetSearch",
|
|
"fully_qualified_name": "ExaApi.CreateWebsetSearch@0.1.0",
|
|
"description": "Create a new search for a specified webset.\n\nUse this tool to create a new search within a webset, reusing previous search results and applying new criteria.",
|
|
"toolkit": {
|
|
"name": "ArcadeExaApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "webset_id",
|
|
"required": true,
|
|
"description": "The unique identifier for the Webset you want to create a search in.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The id of the Webset"
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "webset"
|
|
},
|
|
{
|
|
"name": "search_criteria",
|
|
"required": true,
|
|
"description": "JSON object representing new search criteria for the webset. This specifies the parameters or conditions for the new search.",
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "requestBody"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'websets-searches-create'.",
|
|
"available_modes": [
|
|
"value",
|
|
"error",
|
|
"null"
|
|
],
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
}
|
|
},
|
|
"requirements": {
|
|
"authorization": null,
|
|
"secrets": [
|
|
{
|
|
"key": "EXA_API_KEY"
|
|
}
|
|
],
|
|
"metadata": null
|
|
},
|
|
"deprecation_message": null,
|
|
"metadata": {
|
|
"object_type": "api_wrapper_tool",
|
|
"version": "1.1.0",
|
|
"description": "Tools that enable LLMs to interact directly with the exa API."
|
|
},
|
|
"http_endpoint": {
|
|
"metadata": {
|
|
"object_type": "http_endpoint",
|
|
"version": "1.2.0",
|
|
"description": ""
|
|
},
|
|
"url": "https://api.exa.ai/websets/v0/websets/{webset}/searches",
|
|
"http_method": "POST",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "webset",
|
|
"tool_parameter_name": "webset_id",
|
|
"description": "The id of the Webset",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The id of the Webset"
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "requestBody",
|
|
"tool_parameter_name": "search_criteria",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
}
|
|
],
|
|
"documentation_urls": [],
|
|
"secrets": [
|
|
{
|
|
"arcade_key": "EXA_API_KEY",
|
|
"parameter_name": "Authorization",
|
|
"accepted_as": "header",
|
|
"formatted_value": "Bearer {authorization}",
|
|
"description": "",
|
|
"is_auth_token": false
|
|
}
|
|
],
|
|
"request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": [\n \"object\"\n ],\n \"properties\": {\n \"count\": {\n \"type\": [\n \"number\"\n ],\n \"minimum\": 1,\n \"description\": \"Number of Items the Search will attempt to find.\\n\\nThe actual number of Items found may be less than this number depending on the query complexity.\"\n },\n \"query\": {\n \"type\": [\n \"string\"\n ],\n \"minLength\": 1,\n \"maxLength\": 5000,\n \"description\": \"Natural language search query describing what you are looking for.\\n\\nBe specific and descriptive about your requirements, characteristics, and any constraints that help narrow down the results.\\n\\nAny URLs provided will be crawled and used as additional context for the search.\",\n \"examples\": [\n \"Marketing agencies based in the US, that focus on consumer products. Get brands worked with and city\",\n \"AI startups in Europe that raised Series A funding in 2024\",\n \"SaaS companies with 50-200 employees in the fintech space\"\n ]\n },\n \"entity\": {\n \"oneOf\": [\n {\n \"type\": [\n \"object\"\n ],\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"company\",\n \"default\": \"company\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"title\": \"Company\"\n },\n {\n \"type\": [\n \"object\"\n ],\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"person\",\n \"default\": \"person\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"title\": \"Person\"\n },\n {\n \"type\": [\n \"object\"\n ],\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"article\",\n \"default\": \"article\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"title\": \"Article\"\n },\n {\n \"type\": [\n \"object\"\n ],\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"research_paper\",\n \"default\": \"research_paper\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"title\": \"Research Paper\"\n },\n {\n \"type\": [\n \"object\"\n ],\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"custom\",\n \"default\": \"custom\"\n },\n \"description\": {\n \"type\": [\n \"string\"\n ],\n \"minLength\": 2,\n \"maxLength\": 200\n }\n },\n \"required\": [\n \"type\",\n \"description\"\n ],\n \"title\": \"Custom\"\n }\n ]\n },\n \"criteria\": {\n \"type\": [\n \"array\"\n ],\n \"items\": {\n \"type\": [\n \"object\"\n ],\n \"properties\": {\n \"description\": {\n \"type\": [\n \"string\"\n ],\n \"minLength\": 1,\n \"maxLength\": 1000,\n \"description\": \"The description of the criterion\"\n }\n },\n \"required\": [\n \"description\"\n ]\n },\n \"minItems\": 1,\n \"maxItems\": 5,\n \"description\": \"Criteria every item is evaluated against.\\n\\nIt's not required to provide your own criteria, we automatically detect the criteria from all the information provided in the query. Only use this when you need more fine control.\"\n },\n \"exclude\": {\n \"type\": [\n \"array\"\n ],\n \"items\": {\n \"type\": [\n \"object\"\n ],\n \"properties\": {\n \"source\": {\n \"type\": [\n \"string\"\n ],\n \"enum\": [\n \"import\",\n \"webset\"\n ]\n },\n \"id\": {\n \"description\": \"The ID of the source to exclude.\",\n \"type\": [\n \"string\"\n ],\n \"minLength\": 1\n }\n },\n \"required\": [\n \"source\",\n \"id\"\n ]\n },\n \"description\": \"Sources (existing imports or websets) to exclude from search results. Any results found within these sources will be omitted to prevent finding them during search.\"\n },\n \"scope\": {\n \"type\": [\n \"array\"\n ],\n \"items\": {\n \"type\": [\n \"object\"\n ],\n \"properties\": {\n \"source\": {\n \"type\": [\n \"string\"\n ],\n \"enum\": [\n \"import\",\n \"webset\"\n ]\n },\n \"id\": {\n \"type\": [\n \"string\"\n ],\n \"minLength\": 1,\n \"description\": \"The ID of the source to search.\"\n },\n \"relationship\": {\n \"type\": [\n \"object\"\n ],\n \"properties\": {\n \"definition\": {\n \"type\": [\n \"string\"\n ],\n \"description\": \"What the relationship of the entities you hope to find is relative to the entities contained in the provided source.\"\n },\n \"limit\": {\n \"type\": [\n \"number\"\n ],\n \"minimum\": 1,\n \"maximum\": 10\n }\n },\n \"required\": [\n \"definition\",\n \"limit\"\n ]\n }\n },\n \"required\": [\n \"source\",\n \"id\"\n ]\n },\n \"description\": \"Limit the search to specific sources (existing imports). Any results found within these sources matching the search criteria will be included in the Webset.\"\n },\n \"recall\": {\n \"type\": [\n \"boolean\"\n ],\n \"description\": \"Whether to provide an estimate of how many total relevant results could exist for this search.\\nResult of the analysis will be available in the `recall` field within the search request.\"\n },\n \"behavior\": {\n \"type\": \"string\",\n \"enum\": [\n \"override\",\n \"append\"\n ]\n },\n \"metadata\": {\n \"description\": \"Set of key-value pairs you want to associate with this object.\",\n \"type\": [\n \"object\"\n ],\n \"additionalProperties\": {\n \"type\": [\n \"string\"\n ],\n \"maxLength\": 1000\n }\n }\n },\n \"required\": [\n \"count\",\n \"query\"\n ]\n }\n }\n }\n}",
|
|
"use_request_body_schema_mode": false,
|
|
"validate_request_body_schema": false
|
|
}
|
|
}
|