SkillSetModel

Core model for a skillset.

Properties

• id (required): Refer to #/$defs/EntityId.
• affiliates (boolean): If this is true, the skill can be affiliated. Default: false.
• actorRef: Only set when the skillset is a base skill provided by an actor. If this field is set when an external skill is provided it is ignored and set to None.
  • Any of
    • : Refer to #/$defs/EntityId.
    • null
• canLock (boolean): If this flag is true, then the skillset can participate in lock generation. Default: true.
• upgrades (object or null): List of version upgrades that are applied to this skill set model on creation. Can contain additional properties.
  • Additional properties (string)
• skillType: Type of skillset. This is specified at the skill set level instead of the individual skill level to avoid confusion of whether or not an actor implements a specific skill. Refer to #/$defs/SkillSetType. Default: "conversation".
• skills (array, required)
  • Items: Refer to #/$defs/SubjectModel.
• baseLabels (object): Can contain additional properties. Default: {}.
  • Additional properties: Refer to #/$defs/VecOrOne.

Definitions

• EntityId (string)
• SkillSetType: Specifies the type of skillset.
  • One of
    • string: Must be one of: "conversation".
    • string: Broadcast skills are "no implementor" skill types. These types of skills can be matched against and the skill message is sent to active observers, but no actor is matched or allowed to implement this type of skill. Must be: "broadcast".
• SubjectModel (object)
  • subject (string, required)
  • actions (array, required)
    • Items: Refer to #/$defs/ActionModel.
• ActionModel (object)
  • action (string, required)
  • description (string or null): Default: null.
  • params: Default: null.
  • constraints: Default: null.
  • input: input corresponds to the data model for the initial request PNCP message. Request. Default: null.
    • Any of
      • : Refer to #/$defs/SkillDataModel.
      • null
  • inputForm: Default: null.
  • inputDisplay: Default: null.
  • output: output Corresponds to the data model for the response PNCP message. Response. Default: null.
    • Any of
      • : Refer to #/$defs/SkillDataModel.
      • null
  • outputDisplay: Default: null.
  • requesterQuestions (array): Multiple possible question/answer pairs are allowed for a given action. These are organized as pairs - a question of a particular type expects an answer of a corresponding type.
    This question set contains questions that can be asked by the original requester as a "follow up" question to the fulfiller. Default: [].
    • Items: Refer to #/$defs/SkillQuestionAnswerModel.
  • fulfillerQuestions (array): This question set contains questions that can be asked by the skill fulfiller to the requester (e.g. asking for "additional information"). Default: [].
    • Items: Refer to #/$defs/SkillQuestionAnswerModel.
  • requesterLabels (object): Requester label constraints. These constraints are required for a requester to be eligible to execute this action. Can contain additional properties. Default: {}.
    • Additional properties: Refer to #/$defs/SkillLabelModel.
  • fulfillerLabels (object): Fulfiller label constraints. These constraints are required for a fulfiller to be eligible to fulfill this action. Can contain additional properties. Default: {}.
    • Additional properties: Refer to #/$defs/SkillLabelModel.
• SkillDataModel: Represents all the different ways data can be defined as an input or output from an actor. An input can be exactly one reference to an object, a list of references, or a mapping of named references to objects.
  • Any of
    • : Refer to #/$defs/SchemaRefWrapper.
    • array
      • Items: Refer to #/$defs/SchemaRefWrapper.
    • object: Can contain additional properties.
      • Additional properties: Refer to #/$defs/SchemaRefWrapper.
• SchemaRefWrapper: Wrapper for backwards compatibility with old schema ref format which was only a string.
  • Any of
    • string
    • : Refer to #/$defs/SchemaRef.
• SchemaRef (object): Can contain additional properties.
  • name (string, required)
  • optional (boolean, required)
  • redacted (boolean, required): Indicates that the field should be redacted from the ledger as well as observers.
• SkillQuestionAnswerModel (object)
  • id (string, required)
  • name (string, required)
  • description (string or null): Default: null.
  • params: Default: null.
  • question
    • Any of
      • : Refer to #/$defs/SkillDataModel.
      • null
  • questionForm: Default: null.
  • questionDisplay: Default: null.
  • answer
    • Any of
      • : Refer to #/$defs/SkillDataModel.
      • null
  • answerForm: Default: null.
  • answerDisplay: Default: null.
• SkillLabelModel (object)
  • label (string, required)
  • constraints (array, required)
• VecOrOne
  • Any of
    • string
    • array
      • Items (string)