Auto Analyze Text

QName: f:auto-analyze-text

With this feature in place, a content instance will automatically have its default binary attachment analyzed using a Text Analyzer service. The extracted analysis and text will then be applied back onto the node, allowing it to benefit from automatic full-text search indexing and other tooling.

To use this service, you will first need to set up a Text Analysis Service. The service can either be configured as the default Text Analysis Service for your Project or it can be referenced from the f:auto-analyze-text feature. This allows different feature configurations to use different services if that is your preference.

The feature is defined as shown here:

{
    "_qname": "f:auto-analyze-text",
    "_type": "d:feature",
    "type": "object",
    "title": "Auto Analyze Text",
    "description": "Indicates that a node should have its text automatically analyzed for comprehension",
    "systemBootstrapped": true
}

Configuration

<thead>
    <tr>
        <th>Property</th>
        <th>Type</th>
        <th>Default</th>
        <th nowrap>Read-Only</th>
        <th>Description</th>
    </tr>
</thead>
<tbody>
    <tr>
        <td>serviceId</td>
        <td>text</td>
        <td></td>
        <td></td>
        <td>
            The `_doc` identifier of the Analyze Text Service configuration to use.
        </td>
    </tr>
</tbody>

Text Analysis

With this feature in place, a text analysis process will launch whenever you create or update the default attachment for the node. The text analysis process will analyze your binary content and detect any meaningful content that is comprised of:

• Sentiment of the text
• Key Phrases contained within the text
• Entities detected within the text
• Languages contained in the text

The extracted content is then stored onto your original Node so that you can work with it from a post-processing perspective. In addition, the Cloud CMS user interface makes use of this extracted content to provide your editorial users with in-context insights and awareness of what was extracted.

For more information, please see our formal documentation on how Cloud CMS works with Text Analysis.

Example

If you have a default Text Analysis Service configured for your project, all you need to do is this:

{
    "title": "My Document",
    "_features": {
        "f:auto-analyze-text": {
        }
    }
}

Otherwise, you will need to point to a configuration:

{
    "title": "My Document",
    "_features": {
        "f:auto-analyze-text": {
            "serviceId": "ec0a7bfb2d2f971b262e"
        }
    }
}