Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 2.39 KB

File metadata and controls

34 lines (25 loc) · 2.39 KB

AlertApplicationConfigInput

Configuration for attaching an alert to a collection. The key responsibility here is INPUT MAPPING: connecting document fields (or constants) to the retriever's expected inputs. Note: Filtering logic (scroll_filters, min_score, etc.) belongs in the retriever, not here. The retriever owns all query semantics. Use Cases: - Attach safety alert to video upload collection - Configure different field mappings for different collections - Set execution priority for multiple alerts Attributes: alert_id: ID of the alert to execute execution_mode: When this alert should execute input_mappings: Map document fields or constants to retriever inputs execution_phase: Which phase this alert runs in (default: ALERT) priority: Priority within the execution phase (higher = runs first)

Properties

Name Type Description Notes
alert_id str ID of the alert to execute
execution_mode AlertExecutionMode When this alert should execute [optional]
input_mappings List[AlertInputMapping] Map document fields or constants to retriever input parameters
execution_phase PostProcessingPhase Which phase this alert runs in. Default: ALERT (phase 3, after taxonomies and clusters) [optional]
priority int Priority within the execution phase (higher = runs first) [optional] [default to 0]

Example

from mixpeek.models.alert_application_config_input import AlertApplicationConfigInput

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

# convert the object into a dict
alert_application_config_input_dict = alert_application_config_input_instance.to_dict()
# create an instance of AlertApplicationConfigInput from a dict
alert_application_config_input_from_dict = AlertApplicationConfigInput.from_dict(alert_application_config_input_dict)

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