ActorModel

Represents a single versioned actor. All actor models are represented using this type, regardless of the meta type (that is, agent, user and domain are all represented by this common model type).

Properties

• id (required): Unique identifier. Includes the agent ID and the version. Refer to #/$defs/EntityId.
• description (string or null): Default: null.
• skills: Refer to #/$defs/ActorSkillsModel. Default: {"skills": [], "skillsets": [], "canLock": false, "lock": {}, "observanceLock": {}}.

Definitions

• EntityId (string)
• ActorSkillsModel (object): Common interface for defining skills implemented and called by an actor.
  • skills (array): Default: [].
    • Items: Refer to #/$defs/SubjectModel.
  • skillsets (array): Default: [].
    • Items: Refer to #/$defs/SkillRefModel.
  • canLock (boolean): Default: true.
  • lock (object): Skill calls created by an actor. Can contain additional properties. Default: {}.
    • Additional properties: Refer to #/$defs/SkillSetLock.
  • observanceLock (object): Can contain additional properties. Default: {}.
    • Additional properties: Refer to #/$defs/SkillObservanceLock.
  • upgrades (object or null): Can contain additional properties.
    • Additional properties (string)
• 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)
• SkillRefModel (object): Model used by Actor implementations to reference a skill that they implement.
  • id (required): Skill id. Refer to #/$defs/EntityId.
  • skills (array): Default: [].
    • Items: Refer to #/$defs/SubjectModel.
• EntityReq (string)
• SkillSetLock (object): A skill lock represents a set of skills which are used by an actor. These skills and optional target actors include specific versions to "lock" the use of these skill requests to these particular versions. Note that this list is not considered exhaustive. That is, an actor which defines a SkillLock is permitted to use skill requests not listed in the lock, however, they will follow standard skill matching rules when called instead of using the locked versions.
  • subject (string, required)
  • action (string, required)
  • version: Skillset ID and version associated with it.
    • Any of
      • : Refer to #/$defs/EntityId.
      • null
  • actor
    • Any of
      • : Refer to #/$defs/EntityId.
      • null
• SkillObservanceLock (object)
  • key (required): Refer to #/$defs/SkillObservanceLockKey.
  • lock (required): Refer to #/$defs/SkillObservanceLockValue.
• SkillObservanceLockKey (object)
  • obsId (required): Refer to #/$defs/Id.
  • requester: Default: null.
    • Any of
      • : Refer to #/$defs/EntityReq.
      • null
  • fulfiller: Default: null.
    • Any of
      • : Refer to #/$defs/EntityReq.
      • null
  • subject (string, required)
  • action (string, required)
  • filter (required): Refer to #/$defs/ObservationMessageFilter.
• Id (string)
• ObservationMessageFilter (object)
  • kind (required): Refer to #/$defs/ObservationMessageType.
  • pncp: Default: null.
    • Any of
      • : Refer to #/$defs/PncpMessageKind.
      • null
• ObservationMessageType (string): Must be one of: "Skill" or "Pncp".
• PncpMessageKind (string): Must be one of: "Question", "Answer", "Status", "Cancel", "Response", or "Error".
• SkillObservanceLockValue (object)
  • obsId (required): Refer to #/$defs/Id.
  • requester
    • Any of
      • : Refer to #/$defs/EntityId.
      • null
  • fulfiller
    • Any of
      • : Refer to #/$defs/EntityId.
      • null
  • subject (string, required)
  • action (string, required)
  • filter (required): Refer to #/$defs/ObservationMessageFilter.