Docs
Elasticsearch Guide [8.1] » REST APIs » Machine learning trained model APIs » Create trained model vocabulary API
« Create trained models API Delete trained model aliases API »

Create trained model vocabulary API

Creates a trained model vocabulary. This is supported only for natural language processing (NLP) models.

This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Request

PUT _ml/trained_models/<model_id>/vocabulary/

Prerequisites

Requires the manage_ml cluster privilege. This privilege is included in the machine_learning_admin built-in role.

Description

The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition.

Path parameters

<model_id>
(Required, string) The unique identifier of the trained model.

Request body

vocabulary
(array) The model vocabulary. Must not be empty.

Examples

The following example shows how to create a model vocabulary for a previously stored trained model configuration.

PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary
{
  "vocabulary": [
    "[PAD]",
    "[unused0]",
    ...
  ]
}

The API returns the following results:

{
    "acknowledged": true
}
« Create trained models API Delete trained model aliases API »