Project node

A project encapsulates a large part of what is in the Mix.nlu tool. The project node is the primary container for a Mix.nlu model. Projects are defined per language.

Project XML meta

<project xmlns:nuance="https://developer.nuance.com/mix/nlu/trsx"
  xml:lang="en-us"
  nuance:version="2.6">
    <metadata/>
    <sources/>
    <ontology/>
    <dictionaries/>
    <samples/>
</project>

Project node specification

The project node is defined as follows:

  • The project node contains zero-1 metadata, sources, ontology, and dictionaries nodes.
  • The project node contains zero-many samples nodes.

A project node has the following attributes:

Project node attributes
Attribute Required? Description
nuance:version Required TRSX spec version. For example: 2.6.
xml:lang Optional Language of the project. See Geographies for the list of valid language codes per region/geography.
nuance:enginePackVersion Optional Engine pack version of the project when exported. For example: 3.8. See Manage engine packs and data packs for more information.

Project schema

<xs:element name='project'>
    <xs:annotation>
        <xs:documentation>Mix.nlu Project: Metadata, Sources, Ontology,
              Dictionaries &amp; Samples.</xs:documentation>
    </xs:annotation>
    <xs:complexType>
        <xs:sequence>
            <xs:element minOccurs='0' maxOccurs='1' ref='metadata'>
                <xs:annotation>
                    <xs:documentation>Metadata for the project.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element minOccurs='0' maxOccurs='1' ref='sources'>
                <xs:annotation>
                    <xs:documentation>Sources for the project.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element minOccurs='0' maxOccurs='1' ref='ontology'>
                <xs:annotation>
                    <xs:documentation>Ontology for the project.</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element minOccurs='0' maxOccurs='1' ref='dictionaries'>
                <xs:annotation>
                    <xs:documentation>Dictionary values (entity literals and their values).</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element minOccurs='0' maxOccurs='unbounded' ref='samples'>
                <xs:annotation>
                    <xs:documentation>Samples part of the training set. Samples may have annotations.</xs:documentation>
                </xs:annotation>
            </xs:element>
        </xs:sequence>
        <xs:attribute ref='nuance:version' use='required'/>
        <xs:attribute ref='xml:lang' default='en-us'/>
        <xs:attribute ref='nuance:enginePackVersion'/>
    </xs:complexType>
</xs:element>