Skip to content

WebCrawlerConfiguration

Source code in docs_src/capo_bedrock_agent/types/web_crawler_configuration.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class WebCrawlerConfiguration(TypedDict, closed=True):
    crawler_limits: NotRequired[
        "capo_bedrock_agent.types.web_crawler_limits.WebCrawlerLimits"
    ]
    """<p>The configuration of crawl limits for the web URLs.</p>"""
    inclusion_filters: NotRequired["capo_bedrock_agent.types.filter_list.FilterList"]
    """<p>A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.</p>"""
    exclusion_filters: NotRequired["capo_bedrock_agent.types.filter_list.FilterList"]
    """<p>A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.</p>"""
    scope: NotRequired["capo_bedrock_agent.types.web_scope_type.WebScopeType"]
    """<p>The scope of what is crawled for your URLs.</p> <p>You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".</p>"""
    user_agent: NotRequired["capo_bedrock_agent.types.user_agent.UserAgent"]
    """<p>Returns the user agent suffix for your web crawler.</p>"""
    user_agent_header: NotRequired[
        "capo_bedrock_agent.types.user_agent_header.UserAgentHeader"
    ]
    """<p>A string used for identifying the crawler or bot when it accesses a web server. The user agent header value consists of the <code>bedrockbot</code>, UUID, and a user agent suffix for your crawler (if one is provided). By default, it is set to <code>bedrockbot_UUID</code>. You can optionally append a custom suffix to <code>bedrockbot_UUID</code> to allowlist a specific user agent permitted to access your source URLs. </p>"""

crawler_limits instance-attribute 

crawler_limits: NotRequired[WebCrawlerLimits]

The configuration of crawl limits for the web URLs.

exclusion_filters instance-attribute 

exclusion_filters: NotRequired[FilterList]

A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.

inclusion_filters instance-attribute 

inclusion_filters: NotRequired[FilterList]

A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.

scope instance-attribute 

scope: NotRequired[WebScopeType]

The scope of what is crawled for your URLs.

You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".

user_agent instance-attribute 

user_agent: NotRequired[UserAgent]

Returns the user agent suffix for your web crawler.

user_agent_header instance-attribute 

user_agent_header: NotRequired[UserAgentHeader]

A string used for identifying the crawler or bot when it accesses a web server. The user agent header value consists of the bedrockbot, UUID, and a user agent suffix for your crawler (if one is provided). By default, it is set to bedrockbot_UUID. You can optionally append a custom suffix to bedrockbot_UUID to allowlist a specific user agent permitted to access your source URLs.