Box · Schema

Keyword Skill Card

A skill card that contains a set of keywords

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
created_at string The optional date and time this card was created at.
type string `skill_card`
skill_card_type string `keyword`
skill_card_title object The title of the card.
skill object The service that applied this metadata.
invocation object The invocation of this service, used to track which instance of a service applied the metadata.
entries array An list of entries in the metadata card.
View JSON Schema on GitHub

JSON Schema

box-keywordskillcard-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/KeywordSkillCard",
  "title": "Keyword Skill Card",
  "type": "object",
  "x-box-resource-id": "keyword_skill_card",
  "x-box-tag": "skills",
  "description": "A skill card that contains a set of keywords",
  "required": [
    "type",
    "skill_card_type",
    "skill",
    "invocation",
    "entries"
  ],
  "properties": {
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2018-04-13T13:53:23-07:00",
      "description": "The optional date and time this card was created at."
    },
    "type": {
      "type": "string",
      "description": "`skill_card`",
      "example": "skill_card",
      "enum": [
        "skill_card"
      ]
    },
    "skill_card_type": {
      "type": "string",
      "description": "`keyword`",
      "example": "keyword",
      "enum": [
        "keyword"
      ]
    },
    "skill_card_title": {
      "type": "object",
      "description": "The title of the card.",
      "required": [
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "example": "labels",
          "description": "An optional identifier for the title."
        },
        "message": {
          "type": "string",
          "example": "Labels",
          "description": "The actual title to show in the UI."
        }
      }
    },
    "skill": {
      "type": "object",
      "description": "The service that applied this metadata.",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "example": "service",
          "description": "`service`",
          "enum": [
            "service"
          ]
        },
        "id": {
          "type": "string",
          "example": "image-recognition-service",
          "description": "A custom identifier that represent the service that\napplied this metadata."
        }
      }
    },
    "invocation": {
      "type": "object",
      "description": "The invocation of this service, used to track\nwhich instance of a service applied the metadata.",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "example": "skill_invocation",
          "description": "`skill_invocation`",
          "enum": [
            "skill_invocation"
          ]
        },
        "id": {
          "type": "string",
          "example": "image-recognition-service-123",
          "description": "A custom identifier that represent the instance of\nthe service that applied this metadata. For example,\nif your `image-recognition-service` runs on multiple\nnodes, this field can be used to identify the ID of\nthe node that was used to apply the metadata."
        }
      }
    },
    "entries": {
      "type": "array",
      "description": "An list of entries in the metadata card.",
      "items": {
        "type": "object",
        "description": "An entry in the `entries` attribute of a metadata card",
        "properties": {
          "text": {
            "type": "string",
            "example": "keyword1",
            "description": "The text of the keyword."
          }
        }
      }
    }
  }
}