From TenantAnswerPhraseSyncerSettings.schema.yaml (jarvisv2/TenantAnswerPhraseSyncerSettings.schema)
---
$defs:
StopwordSettings:
description: Configure stopwords on a per answer type/field level.
properties:
answer_field:
description: The field in the answer where the object is used.
title: Answer Field
type: string
answer_type:
description: The answer type where the object is used.
enum: [clinical-trial, dialogue, directory, document, document-snippet, monograph,
roster, test]
title: Answer Type
type: string
stopwords:
anyOf:
- const: en-standard
type: string
- items:
minLength: 1
type: string
type: array
description: The stopwords for this answer type/field. It can be a list of
phrases or a stopword set name.
maxLength: 512
minLength: 1
title: Stopwords
required: [answer_type, answer_field, stopwords]
title: Stopword Settings
type: object
SynonymSettings:
description: Configure synonyms on a per answer type/field level.
properties:
answer_field:
description: The field in the answer where the object is used.
title: Answer Field
type: string
answer_type:
description: The answer type where the object is used.
enum: [clinical-trial, dialogue, directory, document, document-snippet, monograph,
roster, test]
title: Answer Type
type: string
synonym_expansion_rounds:
default: 3
description: The number of rounds to expand the synonyms. Each round will
generate more candidate synonyms.
minimum: 0
title: Synonym Expansion Rounds
type: integer
synonyms:
description: The synonyms for this answer type/field as a list of synonym
groups.
items:
anyOf:
- additionalProperties:
description: Synonyms of the first phrase.
items:
type: string
minItems: 1
type: array
description: In a one-way synonym group, all phrases are synonyms of the
first phrase but not the other way round.
minProperties: 1
title: One Way Synonym Group
type: object
- description: In a two-way synonym group, all pairs of phrases are synonyms
of each other and can be used interchangeably.
items:
description: A Single synonym phrase.
minLength: 1
title: Synonym
type: string
minItems: 2
title: Two Way Synonym Group
type: array
description: Describes how synonyms are generated
title: Synonym Group
minItems: 1
title: Synonyms
type: array
required: [answer_type, answer_field, synonyms]
title: Synonym Settings
type: object
$id: https://skeleton.botmd.io/jarvisv2/TenantAnswerPhraseSyncerSettings.schema
$schema: http://json-schema.org/draft-07/schema#
description: A resource file for defining tenant resources.
properties:
description:
default: ''
description: A description of the resource file.
title: Description
type: string
stopwords:
description: Stopwords used by this tenant.
items:
$ref: '#/$defs/StopwordSettings'
title: Tenant Stopwords
type: array
syncer_id:
description: Unique name identifying this syncer.
title: Syncer ID
type: string
synonyms:
description: Synonyms used by this tenant.
items:
$ref: '#/$defs/SynonymSettings'
title: Tenant Synonyms
type: array
tenant:
anyOf:
- description: The `cleo` app tenant applicable to this object.
pattern: ^cleo\:[a-zA-Z0-9][\w\-\_]*$
title: Cleo Tenant
type: string
- description: The `hospital` app tenant applicable to this object.
pattern: ^hospital\:[a-zA-Z0-9][\w\-\_]*$
title: Hospital Tenant
type: string
description: The tenant that this resource file is applicable to.
title: Tenant
required: [syncer_id, tenant]
title: Tenant Resource
type: object