mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-02-17 18:21:46 -05:00
<!-- Clearly explain the need for these changes: -->
we met some reality when merging into the docs site but this fixes it
### Changes 🏗️
updates paths, adds some guides
<!-- Concisely describe all of the changes made in this pull request:
-->
update to match reality
### Checklist 📋
#### For code changes:
- [x] I have clearly listed my changes in the PR description
- [x] I have made a test plan
- [x] I have tested my changes according to the test plan:
<!-- Put your test plan here: -->
- [x] deploy it and validate
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> Aligns block integrations documentation with GitBook.
>
> - Changes generator default output to
`docs/integrations/block-integrations` and writes overview `README.md`
and `SUMMARY.md` at `docs/integrations/`
> - Adds GitBook frontmatter and hint syntax to overview; prefixes block
links with `block-integrations/`
> - Introduces `generate_summary_md` to build GitBook navigation
(including optional `guides/`)
> - Preserves per-block manual sections and adds optional `extras` +
file-level `additional_content`
> - Updates sync checker to validate parent `README.md` and `SUMMARY.md`
> - Rewrites `docs/integrations/README.md` with GitBook frontmatter and
updated links; adds `docs/integrations/SUMMARY.md`
> - Adds new guides: `guides/llm-providers.md`,
`guides/voice-providers.md`
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
fdb7ff8111. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
---------
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com>
Co-authored-by: bobby.gaffin <bobby.gaffin@agpt.co>
66 lines
2.0 KiB
Markdown
66 lines
2.0 KiB
Markdown
# Jina Search
|
|
<!-- MANUAL: file_description -->
|
|
Blocks for extracting website content and performing web searches using Jina AI.
|
|
<!-- END MANUAL -->
|
|
|
|
## Extract Website Content
|
|
|
|
### What it is
|
|
This block scrapes the content from the given web URL.
|
|
|
|
### How it works
|
|
<!-- MANUAL: how_it_works -->
|
|
The block sends a request to the given URL, downloads the HTML content, and uses content extraction algorithms to identify and extract the main text content of the page.
|
|
<!-- END MANUAL -->
|
|
|
|
### Inputs
|
|
|
|
| Input | Description | Type | Required |
|
|
|-------|-------------|------|----------|
|
|
| url | The URL to scrape the content from | str | Yes |
|
|
| raw_content | Whether to do a raw scrape of the content or use Jina-ai Reader to scrape the content | bool | No |
|
|
|
|
### Outputs
|
|
|
|
| Output | Description | Type |
|
|
|--------|-------------|------|
|
|
| error | Error message if the content cannot be retrieved | str |
|
|
| content | The scraped content from the given URL | str |
|
|
|
|
### Possible use case
|
|
<!-- MANUAL: use_case -->
|
|
A data analyst could use this block to automatically extract article content from news websites for sentiment analysis or topic modeling.
|
|
<!-- END MANUAL -->
|
|
|
|
---
|
|
|
|
## Search The Web
|
|
|
|
### What it is
|
|
This block searches the internet for the given search query.
|
|
|
|
### How it works
|
|
<!-- MANUAL: how_it_works -->
|
|
The block sends the search query to a search engine API, processes the results, and returns them in a structured format.
|
|
<!-- END MANUAL -->
|
|
|
|
### Inputs
|
|
|
|
| Input | Description | Type | Required |
|
|
|-------|-------------|------|----------|
|
|
| query | The search query to search the web for | str | Yes |
|
|
|
|
### Outputs
|
|
|
|
| Output | Description | Type |
|
|
|--------|-------------|------|
|
|
| error | Error message if the operation failed | str |
|
|
| results | The search results including content from top 5 URLs | str |
|
|
|
|
### Possible use case
|
|
<!-- MANUAL: use_case -->
|
|
A content creator could use this block to research trending topics in their field, gathering ideas for new articles or videos.
|
|
<!-- END MANUAL -->
|
|
|
|
---
|