Create a trained model vocabulary

PUT /_ml/trained_models/{model_id}/vocabulary

This API is supported only for natural language processing (NLP) models. The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Request body

Response

application/json

Examples

Request Console 1 / 8 languages

An example body for a PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary request.

Console Kibana Dev Tools

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

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.putTrainedModelVocabulary({
  model_id: "elastic__distilbert-base-uncased-finetuned-conll03-english",
  vocabulary: ["[PAD]", "[unused0]"],
});

Python Elasticsearch Python Client

resp = client.ml.put_trained_model_vocabulary(
    model_id="elastic__distilbert-base-uncased-finetuned-conll03-english",
    vocabulary=[
        "[PAD]",
        "[unused0]"
    ],
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vocabulary": [
      "[PAD]",
      "[unused0]"
    ]
  }'

Java Elasticsearch Java Client

client.ml().putTrainedModelVocabulary(p -> p
    .modelId("elastic__distilbert-base-uncased-finetuned-conll03-english")
    .vocabulary(List.of("[PAD]","[unused0]"))
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .PutTrainedModelVocabularyAsync(modelId: "elastic__distilbert-base-uncased-finetuned-conll03-english", d1 => d1
        .Vocabulary("[PAD]", "[unused0]")
    );

PHP Elasticsearch PHP Client

$resp = $client->ml()->putTrainedModelVocabulary([
    "model_id" => "elastic__distilbert-base-uncased-finetuned-conll03-english",
    "body" => [
        "vocabulary" => array(
            "[PAD]",
            "[unused0]",
        ),
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ml.put_trained_model_vocabulary(
  model_id: "elastic__distilbert-base-uncased-finetuned-conll03-english",
  body: {
    "vocabulary": [
      "[PAD]",
      "[unused0]"
    ]
  }
)

Response

No example

Required authorization

Authentication

Path parameters

Request body { }

Response

Request body