schema

Tokenize text using a property's configuration

Tokenizes the provided text using the tokenization method configured for the specified property. This endpoint automatically applies the property's tokenization setting and the collection's stopword configuration, making it useful for understanding exactly how text will be processed for a given property during indexing and querying.

post/schema/{className}/properties/{propertyName}/tokenize

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/schema/{className}/properties/{propertyName}/tokenize
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Path parameters

classNamestring required

The name of the collection (class) containing the property.

propertyNamestring required

The name of the property whose tokenization configuration should be used.

Request body

textstring required

The text to tokenize using the property's configured tokenization.

Response

Successfully tokenized the text using the property's configuration.

indexedstring[]

The tokens as they would be stored in the inverted index.

querystring[]

The tokens as they would be used for query matching (e.g., after stopword removal).

Changes

No recorded changes to this operation across all 1 revision of this API.