Schema for Jarvis Module Settings

From ModuleSettings.schema.yaml (jarvis/ModuleSettings.schema)

---
$id: https://skeleton.botmd.io/jarvis/ModuleSettings.schema
$schema: http://json-schema.org/draft-07/schema#

title: Module Settings
description: >-
  These settings are used for configuring Jarvis chat `Module`s in Chatterbox.
type: object
additionalProperties: false
required: []

properties:
  data_flow:
    title: Data Flow
    description: Whether the module is enabled for data flow. Defaults to `true`.
    type: boolean

  query_flow:
    title: Query Flow
    description: Whether the module is enabled for query flow. Defaults to `true`.
    type: boolean

  blacklisted_queries:
    title: Blacklisted Queries
    description: Blacklisted queries for the module.
    type: array
    items:
      type: string
      minLength: 1

  rank:
    title: Tie Breaker Rank
    description: Used to break ties between answers of different modules. Defaults to `0`.
    type: integer

  stop_words:
    title: Stop words
    description: Stop words applied at the module level.
    type: array
    items:
      type: string
      minLength: 1

  sorry_message:
    title: Sorry Message
    description: Optional sorry message to display if there is an intent present without answers.
    anyOf:
      - $ref: "#/definitions/Message"
      - type: array
        title: Array of Messages
        description: Used to support more than 1 message (eg. Text and Quick Reply)
        items:
          anyOf:
            - $ref: "#/definitions/Message"

definitions:
  Message:
    anyOf:
      - $ref: "/ratatoskr/Message.schema#/definitions/text_types/Text Types"
      - $ref: "/ratatoskr/Message.schema#/definitions/media_types/Media Types"
      - $ref: "/ratatoskr/Message.schema#/definitions/action_types/Action Types"
      - $ref: "/ratatoskr/Message.schema#/definitions/quick_reply_types/Quick Reply Types"
      - $ref: "/ratatoskr/Message.schema#/definitions/location_types/Location Types"
      - $ref: "/ratatoskr/Message.schema#/definitions/container_types/Container Types"
      - $ref: "/ratatoskr/Message.schema#/definitions/Carousel"
      - $ref: "/ratatoskr/Message.schema#/definitions/Application Payload"
      - $ref: "/ratatoskr/Message.schema#/definitions/Email"
      - $ref: "/ratatoskr/Message.schema#/definitions/Empty Message"

[Main Page] [Schema Documentation] [Examples]