Website Content Vector Retriever avatar
Website Content Vector Retriever
Try for free

No credit card required

View all Actors
Website Content Vector Retriever

Website Content Vector Retriever

hamza.alwan/website-content-vector-retriever
Try for free

No credit card required

URL

urlstringRequired

A URL of a website where to fetch the web pages from. The URL can be a top-level domain like https://example.com, a subdirectory https://example.com/some-directory/, or a specific page https://example.com/some-directory/page.html.

Query

querystringRequired

Text query to look for on the website.

OpenAI API key

openaiApiKeystringRequired

OpenAI API key to generate vector embeddings.

Maximum number of pages

maxCrawlPagesintegerOptional

The maximum number pages to crawl. It includes the start URLs, pagination pages, pages with no content, etc. The crawler will automatically finish after reaching this number. This setting is useful to prevent accidental crawler runaway.

Default value of this property is 1000

Max results

maxResultsintegerOptional

The maximum number of resulting web pages to store. The crawler will automatically finish after reaching this number. This setting is useful to prevent accidental crawler runaway. If both Max page and Max results are defined, then the crawler will finish when the first limit is reached. Note that the crawler skips pages with the canonical URL of a page that has already been crawled, hence it might crawl more pages than there are results.

Default value of this property is 9999999

Chunk size

chunkSizeintegerOptional

The maximum size of each chunk in characters or tokens.

Default value of this property is 1000

Chunk overlap

chunkOverlapintegerOptional

The number of overlapping characters or tokens between consecutive chunks.

Default value of this property is 200

Crawler type

crawlerTypeEnumOptional

Value options:

"playwright:firefox": string"cheerio": string

Default value of this property is "cheerio"

Max cache age in days

maxCacheAgeintegerOptional

The maximum age of cached records, in days, to consider them useful. By default, set to 30.

Default value of this property is 30

Cache key-value store name

cacheKeyValueStoreNamestringOptional

Name of the key-value store where the actor will store its cache.

Default value of this property is "website-content-vector-retriever-cache"

Index Website Content Crawled Run ID

indexWebsiteContentCrawledRunIdstringOptional

When set, it invokes a special mode in which we index the crawl to the database, rather than answer user queries. This is invoked using webhook from Website Content Crawler, scheduled by this actor. Note that the URL and Query need to also be passed, but the URL can be dummy, as they it's ignored.

Force rescrape

forceRescrapebooleanOptional

When set to true, the actor will ignore the cache and scrape the website again.

Developer
Maintained by Community
Actor metrics
  • 1 monthly user
  • 5 stars
  • 100.0% runs succeeded
  • Created in Sep 2023
  • Modified 8 months ago
Categories