mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
66 lines
2 KiB
Text
66 lines
2 KiB
Text
|
|
tag::api-key-admonition[]
|
|
IMPORTANT: You need to provide the API key only once, during the {infer} model creation.
|
|
The <<get-inference-api>> does not retrieve your API key.
|
|
After creating the {infer} model, you cannot change the associated API key.
|
|
If you want to use a different API key, delete the {infer} model and recreate it with the same name and the updated API key.
|
|
end::api-key-admonition[]
|
|
|
|
tag::inference-id[]
|
|
The unique identifier of the {infer} endpoint.
|
|
end::inference-id[]
|
|
|
|
tag::request-per-minute-example[]
|
|
[source,text]
|
|
----
|
|
"rate_limit": {
|
|
"requests_per_minute": <<number_of_requests>>
|
|
}
|
|
----
|
|
end::request-per-minute-example[]
|
|
|
|
|
|
tag::service-settings[]
|
|
Settings used to install the {infer} model.
|
|
end::service-settings[]
|
|
|
|
tag::task-settings[]
|
|
Settings to configure the {infer} task.
|
|
These settings are specific to the `<task_type>` you specified.
|
|
end::task-settings[]
|
|
|
|
tag::task-type[]
|
|
The type of the {infer} task that the model will perform.
|
|
end::task-type[]
|
|
|
|
tag::chunking-settings[]
|
|
Chunking configuration object.
|
|
Refer to <<infer-chunking-config>> to learn more about chunking.
|
|
end::chunking-settings[]
|
|
|
|
tag::chunking-settings-max-chunking-size[]
|
|
Specifies the maximum size of a chunk in words.
|
|
Defaults to `250`.
|
|
This value cannot be higher than `300` or lower than `20` (for `sentence` strategy) or `10` (for `word` strategy).
|
|
end::chunking-settings-max-chunking-size[]
|
|
|
|
tag::chunking-settings-overlap[]
|
|
Only for `word` chunking strategy.
|
|
Specifies the number of overlapping words for chunks.
|
|
Defaults to `100`.
|
|
This value cannot be higher than the half of `max_chunking_size`.
|
|
end::chunking-settings-overlap[]
|
|
|
|
tag::chunking-settings-sentence-overlap[]
|
|
Only for `sentence` chunking strategy.
|
|
Specifies the numnber of overlapping sentences for chunks.
|
|
It can be either `1` or `0`.
|
|
Defaults to `1`.
|
|
end::chunking-settings-sentence-overlap[]
|
|
|
|
tag::chunking-settings-strategy[]
|
|
Specifies the chunking strategy.
|
|
It could be either `sentence` or `word`.
|
|
end::chunking-settings-strategy[]
|
|
|
|
|