2319 - generated

Author: monikakuster

docs/src/content/docs/reference/components/tavily.md

@@ -0,0 +1,177 @@
+---
+title: "Tavily"
+description: "Tavily is an AI-powered search tool designed to help users quickly find accurate, relevant, and up-to-date information from the web."
+---
+
+Tavily is an AI-powered search tool designed to help users quickly find accurate, relevant, and up-to-date information from the web.
+
+
+Categories: Artificial Intelligence
+
+
+Type: tavily/v1
+
+<hr />
+
+
+
+## Connections
+
+Version: 1
+
+
+### Bearer Token
+
+#### Properties
+
+|      Name       |      Label     |     Type     |     Description     | Required |
+|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
+| token | Token | STRING |  | true |
+
+
+
+
+
+<hr />
+
+
+
+## Actions
+
+
+### Search
+Name: search
+
+Execute a search query.
+
+#### Properties
+
+|      Name       |      Label     |     Type     |     Description     | Required |
+|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
+| query | Query | STRING | The search query to execute. | true |
+| topic | Topic | STRING <details> <summary> Options </summary> general, news </details> | The category of the search. | false |
+| search_depth | Search Depth | STRING <details> <summary> Options </summary> basic, advanced </details> | The depth of the search. | false |
+| time_range | Time Range | STRING <details> <summary> Options </summary> day, week, month, year </details> | The time range back from the current date to filter results. | false |
+| max_results | Max Results | INTEGER | The maximum number of search results to return. | false |
+| include_answer | Include Answer | BOOLEAN <details> <summary> Options </summary> true, false </details> | Include an LLM-generated answer to the provided query. | false |
+| include_images | Include Images | BOOLEAN <details> <summary> Options </summary> true, false </details> | Perform an image search and include the results in the response. | false |
+
+#### Example JSON Structure
+```json
+{
+  "label" : "Search",
+  "name" : "search",
+  "parameters" : {
+    "query" : "",
+    "topic" : "",
+    "search_depth" : "",
+    "time_range" : "",
+    "max_results" : 1,
+    "include_answer" : false,
+    "include_images" : false
+  },
+  "type" : "tavily/v1/search"
+}
+```
+
+#### Output
+
+
+
+Type: OBJECT
+
+
+#### Properties
+
+|     Name     |     Type     |     Description     |
+|:------------:|:------------:|:-------------------:|
+| query | STRING | The search query that was executed. |
+| answer | STRING | A short answer to the user's query, generated by an LLM. Included in the response only if include_answer is requested. |
+| images | ARRAY <details> <summary> Items </summary> [{}] </details> | List of query-related images. |
+| results | ARRAY <details> <summary> Items </summary> [{STRING\(title), STRING\(url), STRING\(content), NUMBER\(score)}] </details> | A list of sorted search results, ranked by relevancy. |
+| response_time | NUMBER | Time in seconds it took to complete the request. |
+
+
+
+
+#### Output Example
+```json
+{
+  "query" : "",
+  "answer" : "",
+  "images" : [ { } ],
+  "results" : [ {
+    "title" : "",
+    "url" : "",
+    "content" : "",
+    "score" : 0.0
+  } ],
+  "response_time" : 0.0
+}
+```
+
+
+### Extract
+Name: extract
+
+Extract web page content from one or more specified URLs.
+
+#### Properties
+
+|      Name       |      Label     |     Type     |     Description     | Required |
+|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
+| urls | URLs | ARRAY <details> <summary> Items </summary> [STRING] </details> | A list of URLs to extract content from. | true |
+| include_images | Include Images | BOOLEAN <details> <summary> Options </summary> true, false </details> | Include a list of images extracted from the URLs in the response. | false |
+| extract_depth | Extract Depth | STRING <details> <summary> Options </summary> basic, advanced </details> | The depth of the extraction process. | false |
+
+#### Example JSON Structure
+```json
+{
+  "label" : "Extract",
+  "name" : "extract",
+  "parameters" : {
+    "urls" : [ "" ],
+    "include_images" : false,
+    "extract_depth" : ""
+  },
+  "type" : "tavily/v1/extract"
+}
+```
+
+#### Output
+
+
+
+Type: OBJECT
+
+
+#### Properties
+
+|     Name     |     Type     |     Description     |
+|:------------:|:------------:|:-------------------:|
+| results | ARRAY <details> <summary> Items </summary> [{STRING\(url), STRING\(raw_content), [STRING]\(images)}] </details> | A list of extracted content from the provided URLs. |
+| failed_results | ARRAY <details> <summary> Items </summary> [{STRING\(url), STRING\(error)}] </details> | A list of URLs that could not be processed. |
+| response_time | NUMBER | Time in seconds it took to complete the request. |
+
+
+
+
+#### Output Example
+```json
+{
+  "results" : [ {
+    "url" : "",
+    "raw_content" : "",
+    "images" : [ "" ]
+  } ],
+  "failed_results" : [ {
+    "url" : "",
+    "error" : ""
+  } ],
+  "response_time" : 0.0
+}
+```
+
+
+
+