Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.96 KB

File metadata and controls

32 lines (23 loc) · 1.96 KB

StageDefsEnrichmentField

Field-level enrichment behaviour specification. Defines how to copy fields from taxonomy source nodes to enriched documents. Supports field renaming via target_field parameter. Examples: - Copy field as-is: {"field_path": "category", "merge_mode": "replace"} - Rename field: {"field_path": "label", "target_field": "visual_style", "merge_mode": "replace"} - Append to array: {"field_path": "tags", "merge_mode": "append"}

Properties

Name Type Description Notes
field_path str Dot-notation path of the field to copy from the taxonomy node.
target_field str Optional target field name in the enriched document. If specified, the source field will be renamed to this name. If not specified, the field_path is used as the target name. Use this to rename fields during enrichment (e.g., label → visual_style). [optional]
merge_mode StageDefsEnrichmentMergeMode Whether to overwrite the target's value or append (for arrays). [optional]

Example

from mixpeek.models.stage_defs_enrichment_field import StageDefsEnrichmentField

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

# convert the object into a dict
stage_defs_enrichment_field_dict = stage_defs_enrichment_field_instance.to_dict()
# create an instance of StageDefsEnrichmentField from a dict
stage_defs_enrichment_field_from_dict = StageDefsEnrichmentField.from_dict(stage_defs_enrichment_field_dict)

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