Skip to content

ContextualMetadataConfig

Source code in docs_src/capo_elementalinference/types/contextual_metadata_config.py
class ContextualMetadataConfig(TypedDict, closed=True):
    summary_generation: NotRequired[
        "capo_elementalinference.types.summary_generation_mode.SummaryGenerationMode"
    ]
    """<p>Specifies whether Elemental Inference generates a descriptive summary of the media content for this output, along with the objects and actions that it detects. This setting is independent of <code>extendedAnalysis</code>. </p> <p>Valid values:</p> <ul> <li> <p>ENABLED (default) – Elemental Inference populates the summary, objects, and actions fields, along with the IAB taxonomy and GARM suitability classifications. </p> </li> <li> <p>DISABLED – Elemental Inference doesn't populate the summary, objects, and actions fields. </p> </li> </ul>"""
    extended_analysis: NotRequired[
        "capo_elementalinference.types.extended_analysis_mode.ExtendedAnalysisMode"
    ]
    """<p>Specifies whether Elemental Inference generates extended analysis of the media content for this output. Extended analysis identifies the people, environments, brands, and on-screen text in the media content. This setting is independent of <code>summaryGeneration</code>. </p> <p>Valid values:</p> <ul> <li> <p>ENABLED (default) – Elemental Inference populates the people, environments, brands, and on-screen text fields. </p> </li> <li> <p>DISABLED – Elemental Inference doesn't populate the people, environments, brands, and on-screen text fields. </p> </li> </ul>"""

extended_analysis instance-attribute

extended_analysis: NotRequired[ExtendedAnalysisMode]

Specifies whether Elemental Inference generates extended analysis of the media content for this output. Extended analysis identifies the people, environments, brands, and on-screen text in the media content. This setting is independent of summaryGeneration.

Valid values:

  • ENABLED (default) – Elemental Inference populates the people, environments, brands, and on-screen text fields.

  • DISABLED – Elemental Inference doesn't populate the people, environments, brands, and on-screen text fields.

summary_generation instance-attribute

summary_generation: NotRequired[SummaryGenerationMode]

Specifies whether Elemental Inference generates a descriptive summary of the media content for this output, along with the objects and actions that it detects. This setting is independent of extendedAnalysis.

Valid values:

  • ENABLED (default) – Elemental Inference populates the summary, objects, and actions fields, along with the IAB taxonomy and GARM suitability classifications.

  • DISABLED – Elemental Inference doesn't populate the summary, objects, and actions fields.