app.gainforest.evaluator.subscription

gainforest.earth

Documentation

User subscription to an evaluator service. Published by the user (not the evaluator) to declare they want evaluations.

main record

User subscription to an evaluator service. Published by the user (not the evaluator) to declare they want evaluations.

Record Key tid Timestamp-based ID

Properties

collections array of string Optional

Which of the user's record collections should be evaluated (NSIDs). Must be a subset of the evaluator's subjectCollections. If omitted, all supported collections are evaluated.

maxLength: 20 items
createdAt string datetime Required

Timestamp of when this subscription was created.

evaluationTypes array of string Optional

Which evaluation types the user wants. If omitted, all types the evaluator supports are applied.

maxLength: 20 items
evaluator string did Required

DID of the evaluator service to subscribe to.

View raw schema
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "evaluator",
      "createdAt"
    ],
    "properties": {
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp of when this subscription was created."
      },
      "evaluator": {
        "type": "string",
        "format": "did",
        "description": "DID of the evaluator service to subscribe to."
      },
      "collections": {
        "type": "array",
        "items": {
          "type": "string",
          "maxGraphemes": 128
        },
        "maxLength": 20,
        "description": "Which of the user's record collections should be evaluated (NSIDs). Must be a subset of the evaluator's subjectCollections. If omitted, all supported collections are evaluated."
      },
      "evaluationTypes": {
        "type": "array",
        "items": {
          "type": "string",
          "maxGraphemes": 64
        },
        "maxLength": 20,
        "description": "Which evaluation types the user wants. If omitted, all types the evaluator supports are applied."
      }
    }
  },
  "description": "User subscription to an evaluator service. Published by the user (not the evaluator) to declare they want evaluations."
}

Lexicon Garden

@