latest--lsdlschema-1.2

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/lsdlschema-json/_shared/latest--lsdlschema-1.2.json
Parent schema lsdlschema-json
Type: object

Linguistic Schema Definition Language schema

Properties

Version enum required

Version of LSDL

Values: "1.1.0" "1.2.0"
Language string required

Target language for the linguistic schema

format=languagepattern=^[A-Za-z][A-Za-z]+(-[A-Za-z0-9][A-Za-z0-9]+)*$
DynamicImprovement enum

Indicates which heuristics should be run to automatically improve the linguistic schema.

Default: "Default"
Values: "Default" "Full" "HighConfidence" "None"
MinResultConfidence enum

Indicates the confidence score required for an interpretation of an utterance to be returned.

Default: "Default"
Values: "Default" "VeryHigh" "High" "Medium" "Low"
Namespaces object

A set of references to additional linguistic schemas that may be referenced by objects in this linguistic schema

format=identifier-properties
Entities object

The entities in the linguistic schema

format=identifier-properties
Relationships object

The relationships in the linguistic schema

format=identifier-properties
GlobalSubstitutions globalSubstitution[]

Global text substitutions in the linguistic schema.

minItems=1

Definitions

identifier string

Identifier for a linguistic schema object

modelItemReference string

Name of the conceptual model object to which the linguistic schema object is bound

nonEmptyString string
state enum

Indicates the state of an object in the linguistic schema.

weight number

Indicates a weight to apply to an object when selecting between ambiguous alternatives. A higher weight is a stronger preference for selecting the object.

templateSchema string

Identifies the shared template schema from which an object in the linguistic schema is derived

dateTime string

Date and time in UTC

namespaces object

A set of references to additional linguistic schemas that may be referenced by objects in this linguistic schema

lsdlReference object

A reference to an additional linguistic schema.

entities object

The entities in the linguistic schema

entity object

An entity in the linguistic schema

Binding conceptualEntityBinding | conceptualPropertyBinding | hierarchyBinding | hierarchyLevelBinding required

The conceptual model object which represents the entity

State enum

Indicates the state of an object in the linguistic schema.

Default: "Authored"
Values: "Authored" "Generated" "Suggested" "Deleted"
Hidden boolean

Indicates the entity is hidden. Hidden entities are ignored for all purposes other than being available nodes along paths between other related entities.

Weight number

Indicates a weight to apply to an object when selecting between ambiguous alternatives. A higher weight is a stronger preference for selecting the object.

Default: 1
min=0max=1
TemplateSchema string

Identifies the shared template schema from which an object in the linguistic schema is derived

Terms term[]

A list of terms in the linguistic schema

minItems=1
SemanticType enum

The overall semantic category of the entity

Values: "Person" "Animate" "Inanimate" "Location" "Time" "Duration"
Units term[]

A list of terms in the linguistic schema

minItems=1
Instances object

Defines how instance values from the model are recognized

4 nested properties
Index enum

Indicates whether the values of this entity should be available in the term index, enabling recognition, completion, and suggestions.

Default: "Default"
Values: "Default" "None"
PluralNormalization enum

Indicates whether values that appear to be plural should match singular words in the utterance.

Default: "Default"
Values: "Default" "Normalized" "None"
Synonyms object

A pair of properties that contain synonyms for the instances of an entity.

3 nested properties
SynonymBinding object | object | object required

A conceptual property, column, or measure in the conceptual model to which a linguistic schema object is bound.

ValueBinding object | object | object required

A conceptual property, column, or measure in the conceptual model to which a linguistic schema object is bound.

State enum

Indicates the state of an object in the linguistic schema.

Default: "Authored"
Values: "Authored" "Generated" "Suggested" "Deleted"
Weights object

A reference to column in the model that contains the weight to apply to instances of this entity when selecting between ambiguous alternative instances. A higher weight is a stronger preference for selecting this instance of this entity.

1 nested properties
Binding object | object | object required

A conceptual property, column, or measure in the conceptual model to which a linguistic schema object is bound.

conceptualEntityBinding object | object

A conceptual entity or table in the conceptual model to which a linguistic schema object is bound

conceptualPropertyBinding object | object | object

A conceptual property, column, or measure in the conceptual model to which a linguistic schema object is bound.

hierarchyBinding object | object

A hierarchy in the conceptual model to which a linguistic schema object is bound

hierarchyLevelBinding object | object

A hierarchy level in the conceptual model to which a linguistic schema object is bound

terms term[]

A list of terms in the linguistic schema

term nonEmptyString | fullTerm

A term in the linguistic schema

fullTerm object

A term in the linguistic schema

termProperties object

Properties of a term in the linguistic schema

Type enum

The part of speech of the term

Values: "Noun" "Verb" "Adjective" "Preposition"
State enum

Indicates the state of an object in the linguistic schema.

Default: "Authored"
Values: "Authored" "Generated" "Suggested" "Deleted"
Weight number

Indicates a weight to apply to an object when selecting between ambiguous alternatives. A higher weight is a stronger preference for selecting the object.

Default: 1
min=0max=1
TemplateSchema string

Identifies the shared template schema from which an object in the linguistic schema is derived

LastModified string

Date and time in UTC

format=date-time
instances object

Defines how instance values from the model are recognized

Index enum

Indicates whether the values of this entity should be available in the term index, enabling recognition, completion, and suggestions.

Default: "Default"
Values: "Default" "None"
PluralNormalization enum

Indicates whether values that appear to be plural should match singular words in the utterance.

Default: "Default"
Values: "Default" "Normalized" "None"
Synonyms object

A pair of properties that contain synonyms for the instances of an entity.

3 nested properties
SynonymBinding object | object | object required

A conceptual property, column, or measure in the conceptual model to which a linguistic schema object is bound.

ValueBinding object | object | object required

A conceptual property, column, or measure in the conceptual model to which a linguistic schema object is bound.

State enum

Indicates the state of an object in the linguistic schema.

Default: "Authored"
Values: "Authored" "Generated" "Suggested" "Deleted"
Weights object

A reference to column in the model that contains the weight to apply to instances of this entity when selecting between ambiguous alternative instances. A higher weight is a stronger preference for selecting this instance of this entity.

1 nested properties
Binding object | object | object required

A conceptual property, column, or measure in the conceptual model to which a linguistic schema object is bound.

instanceSynonyms object

A pair of properties that contain synonyms for the instances of an entity.

SynonymBinding object | object | object required

A conceptual property, column, or measure in the conceptual model to which a linguistic schema object is bound.

ValueBinding object | object | object required

A conceptual property, column, or measure in the conceptual model to which a linguistic schema object is bound.

State enum

Indicates the state of an object in the linguistic schema.

Default: "Authored"
Values: "Authored" "Generated" "Suggested" "Deleted"
instanceWeights object

A reference to column in the model that contains the weight to apply to instances of this entity when selecting between ambiguous alternative instances. A higher weight is a stronger preference for selecting this instance of this entity.

Binding object | object | object required

A conceptual property, column, or measure in the conceptual model to which a linguistic schema object is bound.

relationships object

The relationships in the linguistic schema

relationship object

A relationship in the linguistic schema

Binding conceptualEntityBinding

The conceptual model object which embodies the relationship

State enum

Indicates the state of an object in the linguistic schema.

Default: "Authored"
Values: "Authored" "Generated" "Suggested" "Deleted"
Weight number

Indicates a weight to apply to an object when selecting between ambiguous alternatives. A higher weight is a stronger preference for selecting the object.

Default: 1
min=0max=1
TemplateSchema string

Identifies the shared template schema from which an object in the linguistic schema is derived

Roles object

The roles in a linguistic relationship

format=identifier-properties
SemanticSlots object

Defines how roles fill certain common semantic slots (aka thematic relations) in the relationship

4 nested properties
Where identifier | fullRoleReference

A reference to a role in a linguistic relationship

When identifier | fullRoleReference

A reference to a role in a linguistic relationship

Duration identifier | fullRoleReference

A reference to a role in a linguistic relationship

Occurrences identifier | fullRoleReference

A reference to a role in a linguistic relationship

Conditions condition[]

The conditions on a relationship

minItems=1maxItems=1
Phrasings phrasing[]
minItems=1
roles object

The roles in a linguistic relationship

role identifier | fullRole

A role in a linguistic relationship.

fullRole object

A role in a linguistic relationship.

Target identifier | fullEntityReference required

A reference to an entity in a linguistic relationship

Nouns term[]

A list of terms in the linguistic schema

minItems=1
Quantity identifier | fullRoleReference

A reference to a role in a linguistic relationship

Amount identifier | fullRoleReference

A reference to a role in a linguistic relationship

entityReference identifier | fullEntityReference

A reference to an entity in a linguistic relationship

fullEntityReference object

A reference to an entity in a linguistic relationship

Entity string required

Identifier for a linguistic schema object

format=identifierpattern=^.+$
Namespace string

Identifier for a linguistic schema object

format=identifierpattern=^.+$
semanticSlots object

Defines how roles fill certain common semantic slots (aka thematic relations) in the relationship

Where identifier | fullRoleReference

A reference to a role in a linguistic relationship

When identifier | fullRoleReference

A reference to a role in a linguistic relationship

Duration identifier | fullRoleReference

A reference to a role in a linguistic relationship

Occurrences identifier | fullRoleReference

A reference to a role in a linguistic relationship

conditions condition[]

The conditions on a relationship

condition object

A filter on a relationship that defines the circumstances under which a row in the semantic model represents an instance of the relationship

Target identifier | fullRoleReference required

A reference to a role in a linguistic relationship

Operator enum required

The operator with which to compare the value and the role

Values: "Equals" "NotEquals" "GreaterThan" "LessThan" "GreaterThanOrEquals" "LessThanOrEquals" "Contains" "NotContains" "StartsWith" "NotStartsWith"
Value object | object | object | textValues | numberValues | booleanValues | null required

A literal value to use in a condition

value object | object | object | textValues | numberValues | booleanValues | null

A literal value to use in a condition

textValues nullableTextValue | nullableTextValue[]

One or more text values to use in a condition

nullableTextValue string | null
numberValues nullableNumberValue | nullableNumberValue[]

One or more number values to use in a condition

nullableNumberValue number | null
booleanValues nullableBooleanValue | nullableBooleanValue[]

One or more Boolean values to use in a condition

nullableBooleanValue boolean | null
phrasings phrasing[]
phrasing attributePhrasing | namePhrasing | adjectivePhrasing | dynamicAdjectivePhrasing | nounPhrasing | dynamicNounPhrasing | prepositionPhrasing | verbPhrasing

The phrasings on a linguistic relationship

phrasingProperties object
State enum

Indicates the state of an object in the linguistic schema.

Default: "Authored"
Values: "Authored" "Generated" "Suggested" "Deleted"
Weight number

Indicates a weight to apply to an object when selecting between ambiguous alternatives. A higher weight is a stronger preference for selecting the object.

Default: 1
min=0max=1
TemplateSchema string

Identifies the shared template schema from which an object in the linguistic schema is derived

attributePhrasing object

An attribute phrasing on a linguistic relationship

attributePhrasingProperties object

Properties of an attribute phrasing

Subject identifier | fullRoleReference required

A reference to a role in a linguistic relationship

Object identifier | fullRoleReference required

A reference to a role in a linguistic relationship

PrepositionalPhrases prepPhrase[]

Prepositional phrases used in a phrasing

minItems=1
namePhrasing object

A name phrasing on a linguistic relationship

namePhrasingProperties object

Properties of a name phrasing

Subject identifier | fullRoleReference required

A reference to a role in a linguistic relationship

Name identifier | fullRoleReference required

A reference to a role in a linguistic relationship

adjectivePhrasing object

An adjective phrasing on a linguistic relationship

adjectivePhrasingProperties object | object

Properties of an adjective phrasing

dynamicAdjectivePhrasing object

A dynamic adjective phrasing on a linguistic relationship

dynamicAdjectivePhrasingProperties object

Properties of a dynamic adjective phrasing

Subject identifier | fullRoleReference required

A reference to a role in a linguistic relationship

Adjective identifier | fullRoleReference required

A reference to a role in a linguistic relationship

PrepositionalPhrases prepPhrase[]

Prepositional phrases used in a phrasing

minItems=1
nounPhrasing object

A noun phrasing on a linguistic relationship

nounPhrasingProperties object

Properties of a noun phrasing

Subject identifier | fullRoleReference required

A reference to a role in a linguistic relationship

Nouns term[] required

A list of terms in the linguistic schema

minItems=1
PrepositionalPhrases prepPhrase[]

Prepositional phrases used in a phrasing

minItems=1
dynamicNounPhrasing object

A dynamic noun phrasing on a linguistic relationship

dynamicNounPhrasingProperties object

Properties of a dynamic noun phrasing

Subject identifier | fullRoleReference required

A reference to a role in a linguistic relationship

Noun identifier | fullRoleReference required

A reference to a role in a linguistic relationship

PrepositionalPhrases prepPhrase[]

Prepositional phrases used in a phrasing

minItems=1
prepositionPhrasing object

A preposition phrasing on a linguistic relationship

prepositionPhrasingProperties object

Properties of a preposition phrasing

Subject identifier | fullRoleReference required

A reference to a role in a linguistic relationship

Prepositions term[] required

A list of terms in the linguistic schema

minItems=1
Object identifier | fullRoleReference required

A reference to a role in a linguistic relationship

PrepositionalPhrases prepPhrase[]

Prepositional phrases used in a phrasing

minItems=1
verbPhrasing object

A verb phrasing on a linguistic relationship

verbPhrasingProperties object

Properties of a verb phrasing

Verbs term[] required

A list of terms in the linguistic schema

minItems=1
Subject identifier | fullRoleReference

A reference to a role in a linguistic relationship

IndirectObject identifier | fullRoleReference

A reference to a role in a linguistic relationship

Object identifier | fullRoleReference

A reference to a role in a linguistic relationship

PrepositionalPhrases prepPhrase[]

Prepositional phrases used in a phrasing

minItems=1
prepPhrases prepPhrase[]

Prepositional phrases used in a phrasing

prepPhrase object

A prepositional phrase used in a phrasing

Prepositions term[] required

A list of terms in the linguistic schema

minItems=1
Object identifier | fullRoleReference required

A reference to a role in a linguistic relationship

roleReference identifier | fullRoleReference

A reference to a role in a linguistic relationship

fullRoleReference object

A reference to a role in a linguistic relationship

Role string required

Identifier for a linguistic schema object

format=identifierpattern=^.+$
globalSubstitutions globalSubstitution[]

Global text substitutions in the linguistic schema.

globalSubstitution object

A global text substitution in the linguistic schema.

globalSubstitutionProperties string | fullGlobalSubstitutionProperties
fullGlobalSubstitutionProperties object
Substitute string required

The sequence of words to substitute into the utterance.

State enum

Indicates the state of an object in the linguistic schema.

Default: "Authored"
Values: "Authored" "Generated" "Suggested" "Deleted"
TemplateSchema string

Identifies the shared template schema from which an object in the linguistic schema is derived