CreateProjectRequest.md

CreateProjectRequest

Properties

Name	Type	Description	Notes
name	str	Project name
domain	str	Website domain URL
prompt	str	Natural language prompt for crawling	[optional]
search_query	str	Search query for targeted crawling	[optional]
sitemap_mode	str	How to handle sitemaps	[optional] [default to 'include']
include_subdomains	bool	Whether to include subdomains	[optional] [default to True]
ignore_query_params	bool	Whether to ignore URL query parameters	[optional] [default to True]
max_discovery_depth	int	Maximum crawl depth	[optional]
exclude_paths	List[str]	Paths to exclude from crawling	[optional]
include_paths	List[str]	Specific paths to include	[optional]
crawl_entire_domain	bool	Whether to crawl the entire domain	[optional] [default to False]
allow_external_links	bool	Whether to allow external links	[optional] [default to False]
max_pages	int	Maximum number of pages to crawl	[optional] [default to 100]
crawl_delay	int	Delay between crawl requests (ms)	[optional]
crawl_max_concurrency	int	Maximum concurrent crawl requests	[optional]
only_main_content	bool	Whether to extract only main content	[optional] [default to True]
custom_headers	Dict[str, str]	Custom headers for crawling	[optional]
wait_for	int	Wait time for page load (ms)	[optional] [default to 0]
block_ads	bool	Whether to block ads	[optional] [default to True]
proxy_mode	str	Proxy mode for crawling	[optional] [default to 'auto']
use_reranking	bool	Whether to use AI reranking	[optional] [default to True]
enable_change_tracking	bool	Whether to enable change tracking	[optional] [default to False]

Example

from rankvectors.models.create_project_request import CreateProjectRequest

# TODO update the JSON string below
json = "{}"
# create an instance of CreateProjectRequest from a JSON string
create_project_request_instance = CreateProjectRequest.from_json(json)
# print the JSON string representation of the object
print(CreateProjectRequest.to_json())

# convert the object into a dict
create_project_request_dict = create_project_request_instance.to_dict()
# create an instance of CreateProjectRequest from a dict
create_project_request_from_dict = CreateProjectRequest.from_dict(create_project_request_dict)

[Back to Model list] [Back to API list] [Back to README]