Back to Autogpt

Exa Websets Polling

docs/integrations/block-integrations/exa/websets_polling.md

0.6.445.7 KB
Original Source

Exa Websets Polling

<!-- MANUAL: file_description -->

Blocks for polling and waiting on Exa webset operations to complete.

<!-- END MANUAL -->

Exa Wait For Enrichment

What it is

Wait for a webset enrichment to complete with progress tracking

How it works

<!-- MANUAL: how_it_works -->

This block polls an enrichment operation until it completes or times out. It checks status at configurable intervals and can include sample results when done.

Use this to block workflow execution until enrichments finish, enabling sequential operations that depend on enrichment data being available.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
webset_idThe ID or external ID of the WebsetstrYes
enrichment_idThe ID of the enrichment to monitorstrYes
timeoutMaximum time to wait in secondsintNo
check_intervalInitial interval between status checks in secondsintNo
sample_resultsInclude sample enrichment results in outputboolNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
enrichment_idThe enrichment ID that was monitoredstr
final_statusThe final status of the enrichmentstr
items_enrichedNumber of items successfully enrichedint
enrichment_titleTitle/description of the enrichmentstr
elapsed_timeTotal time elapsed in secondsfloat
sample_dataSample of enriched data (if requested)List[SampleEnrichmentModel]
timed_outWhether the operation timed outbool

Possible use case

<!-- MANUAL: use_case -->

Sequential Processing: Wait for enrichments to complete before proceeding to export or analysis.

Data Validation: Ensure enrichments finish and review samples before continuing workflow.

Synchronous Workflows: Convert async enrichment operations to blocking calls for simpler logic.

<!-- END MANUAL -->

What it is

Wait for a specific webset search to complete with progress tracking

How it works

<!-- MANUAL: how_it_works -->

This block polls a webset search operation until it completes or times out. It provides progress information including items found, items analyzed, and completion percentage.

Use this when you need search results before proceeding with downstream operations like enrichments or exports.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
webset_idThe ID or external ID of the WebsetstrYes
search_idThe ID of the search to monitorstrYes
timeoutMaximum time to wait in secondsintNo
check_intervalInitial interval between status checks in secondsintNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
search_idThe search ID that was monitoredstr
final_statusThe final status of the searchstr
items_foundNumber of items found by the searchint
items_analyzedNumber of items analyzedint
completion_percentageCompletion percentage (0-100)int
elapsed_timeTotal time elapsed in secondsfloat
recall_infoInformation about expected results and confidenceDict[str, Any]
timed_outWhether the operation timed outbool

Possible use case

<!-- MANUAL: use_case -->

Search Completion: Wait for initial webset population before accessing items.

Progress Monitoring: Track search progress in long-running operations.

Sequential Workflows: Ensure searches complete before starting enrichments.

<!-- END MANUAL -->

Exa Wait For Webset

What it is

Wait for a webset to reach a specific status with progress tracking

How it works

<!-- MANUAL: how_it_works -->

This block polls a webset until it reaches a target status (idle, completed, or running). It uses exponential backoff for efficient polling and provides detailed progress information.

Use this for general-purpose waiting on webset operations when you don't need to track a specific search or enrichment.

<!-- END MANUAL -->

Inputs

InputDescriptionTypeRequired
webset_idThe ID or external ID of the Webset to monitorstrYes
target_statusStatus to wait for (idle=all operations complete, completed=search done, running=actively processing)"idle" | "completed" | "running" | "paused" | "any_complete"No
timeoutMaximum time to wait in secondsintNo
check_intervalInitial interval between status checks in secondsintNo
max_intervalMaximum interval between checks (for exponential backoff)intNo
include_progressInclude detailed progress information in outputboolNo

Outputs

OutputDescriptionType
errorError message if the operation failedstr
webset_idThe webset ID that was monitoredstr
final_statusThe final status of the websetstr
elapsed_timeTotal time elapsed in secondsfloat
item_countNumber of items foundint
search_progressDetailed search progress informationDict[str, Any]
enrichment_progressDetailed enrichment progress informationDict[str, Any]
timed_outWhether the operation timed outbool

Possible use case

<!-- MANUAL: use_case -->

Workflow Orchestration: Wait for all webset operations to complete before next workflow steps.

Idle State Detection: Ensure webset is fully idle before making configuration changes.

Completion Gates: Block workflow until webset reaches a specific readiness state.

<!-- END MANUAL -->