pub.chive.tag.getSuggestions Documentation (EN)

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.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

limit Maximum number of suggestions to return

q * Query string to get suggestions for

View raw schema

{
  "type": "query",
  "errors": [],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "suggestions"
      ],
      "properties": {
        "suggestions": {
          "type": "array",
          "items": {
            "ref": "#tagSuggestion",
            "type": "ref"
          },
          "description": "List of tag suggestions"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "q"
    ],
    "properties": {
      "q": {
        "type": "string",
        "maxLength": 100,
        "minLength": 2,
        "description": "Query string to get suggestions for"
      },
      "limit": {
        "type": "integer",
        "default": 10,
        "maximum": 20,
        "minimum": 1,
        "description": "Maximum number of suggestions to return"
      }
    }
  },
  "description": "Get tag suggestions based on a query using the TaxoFolk system"
}

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

{
  "type": "object",
  "required": [
    "displayForm",
    "normalizedForm",
    "confidence",
    "source"
  ],
  "properties": {
    "source": {
      "type": "string",
      "description": "Source of the suggestion",
      "knownValues": [
        "cooccurrence",
        "authority",
        "facet"
      ]
    },
    "confidence": {
      "type": "integer",
      "maximum": 100,
      "minimum": 0,
      "description": "Suggestion confidence (0-100, scaled from 0-1)"
    },
    "displayForm": {
      "type": "string",
      "description": "Suggested display form"
    },
    "matchedTerm": {
      "type": "string",
      "description": "Term that triggered this suggestion"
    },
    "normalizedForm": {
      "type": "string",
      "description": "Normalized form of the suggestion"
    }
  },
  "description": "A tag suggestion from the TaxoFolk system"
}