pub.chive.tag.getSuggestions

lexicons.governance.chive.pub

Documentation

Get tag suggestions based on a query using the TaxoFolk system

main query

Get tag suggestions based on a query using the TaxoFolk system

Parameters

limit integer Optional

Maximum number of suggestions to return

q string Required

Query string to get suggestions for

Output

Encodingapplication/json
suggestions array Required

List of tag suggestions

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Maximum number of suggestions to return
Query string to get suggestions for
View raw schema 
{
  "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 object

A tag suggestion from the TaxoFolk system

Properties

confidence integer Required

Suggestion confidence (0-100, scaled from 0-1)

minimum: 0maximum: 100
displayForm string Required

Suggested display form

matchedTerm string Optional

Term that triggered this suggestion

normalizedForm string Required

Normalized form of the suggestion

source string Required

Source of the suggestion

Known values: cooccurrence, authority, facet
View raw schema 
{
  "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"
}

Lexicon Garden

@