Create an Anthropic inference endpoint
- PUT /_inference/{task_type}/{anthropic_inference_id}
Create an inference endpoint to perform an inference task with the anthropic service.
- Cluster privileges:
manage_inference
Path Parameters
-
task_typeAnthropicTaskTyperequired -
The task type. The only valid task type for the model to perform is
completion. -
Values:
completion -
anthropic_inference_idstring Idrequired -
The unique identifier of the inference endpoint.
Query Parameters
-
timeoutstring Duration · default: 30s Specifies the amount of time to wait for the inference endpoint to be created.
Request
-
chunking_settingsInferenceChunkingSettings -
The chunking configuration object.
- Reference
-
max_chunk_sizenumber · default: 250 -
The maximum size of a chunk in words. This value cannot be higher than
300or lower than20(forsentencestrategy) or10(forwordstrategy). -
overlapnumber · default: 100 -
The number of overlapping words for chunks. It is applicable only to a
wordchunking strategy. This value cannot be higher than half themax_chunk_sizevalue. -
sentence_overlapnumber · default: 1 -
The number of overlapping sentences for chunks. It is applicable only for a
sentencechunking strategy. It can be either1or0. -
strategystring · default: sentence -
The chunking strategy:
sentenceorword. -
serviceAnthropicServiceTyperequired -
The type of service supported for the specified task type. In this case,
anthropic. -
Values:
anthropic -
service_settingsAnthropicServiceSettingsrequired -
Settings used to install the inference model. These settings are specific to the
watsonxaiservice. -
api_keystringrequired -
A valid API key for the Anthropic API.
-
model_idstringrequired -
The name of the model to use for the inference task. Refer to the Anthropic documentation for the list of supported models.
-
rate_limitRateLimitSetting -
This setting helps to minimize the number of rate limit errors returned from Anthropic. By default, the
anthropicservice sets the number of requests allowed per minute to 50. -
requests_per_minutenumber -
The number of requests allowed per minute.
-
task_settingsAnthropicTaskSettings -
Settings to configure the inference task. These settings are specific to the task type you specified.
-
max_tokensnumberrequired -
For a
completiontask, it is the maximum number of tokens to generate before stopping. -
temperaturenumber -
For a
completiontask, it is the amount of randomness injected into the response. For more details about the supported range, refer to Anthropic documentation. - External docs
-
top_knumber -
For a
completiontask, it specifies to only sample from the top K options for each subsequent token. It is recommended for advanced use cases only. You usually only need to usetemperature. -
top_pnumber -
For a
completiontask, it specifies to use Anthropic's nucleus sampling. In nucleus sampling, Anthropic computes the cumulative distribution over all the options for each subsequent token in decreasing probability order and cuts it off once it reaches the specified probability. You should either altertemperatureortop_p, but not both. It is recommended for advanced use cases only. You usually only need to usetemperature.
Response
-
chunking_settingsInferenceChunkingSettings -
Chunking configuration object
-
max_chunk_sizenumber · default: 250 -
The maximum size of a chunk in words. This value cannot be higher than
300or lower than20(forsentencestrategy) or10(forwordstrategy). -
overlapnumber · default: 100 -
The number of overlapping words for chunks. It is applicable only to a
wordchunking strategy. This value cannot be higher than half themax_chunk_sizevalue. -
sentence_overlapnumber · default: 1 -
The number of overlapping sentences for chunks. It is applicable only for a
sentencechunking strategy. It can be either1or0. -
strategystring · default: sentence -
The chunking strategy:
sentenceorword. -
servicestringrequired -
The service type
-
service_settingsServiceSettingsrequired -
Settings specific to the service
-
task_settingsTaskSettings -
Task settings specific to the service and task type
-
inference_idstringrequired -
The inference Id