pub.chive.tag.getSuggestions

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get tag suggestions based on a query using the TaxoFolk system",
      "errors": [],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "suggestions": {
              "description": "List of tag suggestions",
              "items": {
                "ref": "#tagSuggestion",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "suggestions"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "limit": {
            "default": 10,
            "description": "Maximum number of suggestions to return",
            "maximum": 20,
            "minimum": 1,
            "type": "integer"
          },
          "q": {
            "description": "Query string to get suggestions for",
            "maxLength": 100,
            "minLength": 2,
            "type": "string"
          }
        },
        "required": [
          "q"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "tagSuggestion": {
      "description": "A tag suggestion from the TaxoFolk system",
      "properties": {
        "confidence": {
          "description": "Suggestion confidence (0-100, scaled from 0-1)",
          "maximum": 100,
          "minimum": 0,
          "type": "integer"
        },
        "displayForm": {
          "description": "Suggested display form",
          "type": "string"
        },
        "matchedTerm": {
          "description": "Term that triggered this suggestion",
          "type": "string"
        },
        "normalizedForm": {
          "description": "Normalized form of the suggestion",
          "type": "string"
        },
        "source": {
          "description": "Source of the suggestion",
          "knownValues": [
            "cooccurrence",
            "authority",
            "facet"
          ],
          "type": "string"
        }
      },
      "required": [
        "displayForm",
        "normalizedForm",
        "confidence",
        "source"
      ],
      "type": "object"
    }
  },
  "id": "pub.chive.tag.getSuggestions",
  "lexicon": 1,
  "revision": 1
}