Skip to content

[E&A][bugbash] Fixes an admonition in HuggingFace inference integration docs #757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 12, 2025
Merged

[E&A][bugbash] Fixes an admonition in HuggingFace inference integration docs #757

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f3f9b4
[E&A][bugbash] Fixes an admonition in HuggingFace inference integrati…
szabosteve Mar 12, 2025
0b8db02
Merge branch 'main' into szabosteve/bug-bash
szabosteve Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions ...re-analyze/elastic-inference/inference-api/huggingface-inference-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,10 @@ Refer to the [{{infer-cap}} APIs](https://www.elastic.co/docs/api/doc/elasticsea

Creates an {{infer}} endpoint to perform an {{infer}} task with the `hugging_face` service.


## {{api-request-title}} [infer-service-hugging-face-api-request]

`PUT /_inference/<task_type>/<inference_id>`


## {{api-path-parms-title}} [infer-service-hugging-face-api-path-params]

`<inference_id>`
Expand All @@ -33,8 +31,6 @@ Creates an {{infer}} endpoint to perform an {{infer}} task with the `hugging_fac

* `text_embedding`.



## {{api-request-body-title}} [infer-service-hugging-face-api-request-body]

`chunking_settings`
Expand All @@ -52,7 +48,6 @@ Creates an {{infer}} endpoint to perform an {{infer}} task with the `hugging_fac
`strategy`
: (Optional, string) Specifies the chunking strategy. It could be either `sentence` or `word`.


`service`
: (Required, string) The type of service supported for the specified task type. In this case, `hugging_face`.

Expand All @@ -63,7 +58,6 @@ Creates an {{infer}} endpoint to perform an {{infer}} task with the `hugging_fac

`api_key`
: (Required, string) A valid access token of your Hugging Face account. You can find your Hugging Face access tokens or you can create a new one [on the settings page](https://huggingface.co/settings/tokens).

::::{important}
You need to provide the API key only once, during the {{infer}} model creation. The [Get {{infer}} API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-get) 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.
::::
Expand Down