Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST API ›Inference API

Интеграция с HuggingFace для инференса

Справочник нового API

Для получения самых актуальных данных об API, обратитесь к Inference API.

Создаёт конечную точку инференса для выполнения задачи инференса с помощью сервиса hugging_face.

Запрос

PUT /_inference/<task_type>/<inference_id>

Параметры пути

<inference_id>
(Обязательно, строка) Уникальный идентификатор конечной точки инференса.
<task_type>

(Обязательно, строка) Тип задачи инференса, которую будет выполнять модель.

Доступные типы задач:

  • text_embedding.

Тело запроса

chunking_settings

(Необязательно, объект) Объект конфигурации разбиения на фрагменты. Обратитесь к Настройка разбиения на фрагменты для получения дополнительной информации о разбиении на фрагменты.

max_chunk_size
(Необязательно, целое число) Указывает максимальный размер фрагмента в словах. По умолчанию устанавливается значение 250. Это значение не может быть выше 300 или ниже 20 (для стратегии sentence) или 10 (для стратегии word).
overlap
(Необязательно, целое число) Только для стратегии разбиения на фрагменты word. Указывает количество перекрывающихся слов для фрагментов. По умолчанию устанавливается значение 100. Это значение не может быть выше половины max_chunk_size.
sentence_overlap
(Необязательно, целое число) Только для стратегии разбиения на фрагменты sentence. Указывает количество перекрывающихся предложений для фрагментов. Может быть либо 1, либо 0. По умолчанию устанавливается значение 1.
strategy
(Необязательно, строка) Указывает стратегию разбиения на фрагменты. Может быть либо sentence, либо word.
service
(Обязательно, строка) Тип сервиса, поддерживаемого для указанного типа задачи. В данном случае, hugging_face.
service_settings

(Обязательно, объект) Настройки, используемые для установки модели инференса.

Эти настройки специфичны для сервиса hugging_face.

api_key

(Обязательно, строка) Действительный токен доступа к вашему аккаунту Hugging Face. Вы можете найти свои токены доступа Hugging Face или создать новый на странице настроек на странице настроек.

Вам необходимо предоставить ключ API только один раз во время создания модели инференса. API Получение API инференса не извлекает ваш ключ API. После создания модели инференса вы не сможете изменить связанный ключ API. Если вы хотите использовать другой ключ API, удалите модель инференса и пересоздайте её с тем же именем и обновлённым ключом API.

url
(Обязательно, строка) URL-адрес конечной точки, используемой для запросов.
rate_limit

(Необязательно, объект) По умолчанию сервис huggingface устанавливает количество разрешённых запросов в минуту на 3000. Это помогает свести к минимуму количество ошибок ограничений скорости, возвращаемых Hugging Face. Чтобы изменить это, установите настройку requests_per_minute в настройках вашего сервиса:

"rate_limit": {
    "requests_per_minute": <<number_of_requests>>
}

Пример сервиса Hugging Face

В следующем примере показано, как создать конечную точку инференса под названием hugging-face-embeddings для выполнения задачи типа text_embedding.

resp = client.inference.put(
    task_type="text_embedding",
    inference_id="hugging-face-embeddings",
    inference_config={
        "service": "hugging_face",
        "service_settings": {
            "api_key": "<access_token>",
            "url": "<url_endpoint>"
        }
    },
)
print(resp)
const response = await client.inference.put({
  task_type: "text_embedding",
  inference_id: "hugging-face-embeddings",
  inference_config: {
    service: "hugging_face",
    service_settings: {
      api_key: "<access_token>",
      url: "<url_endpoint>",
    },
  },
});
console.log(response);
PUT _inference/text_embedding/hugging-face-embeddings
{
  "service": "hugging_face",
  "service_settings": {
    "api_key": "<access_token>", 
    "url": "<url_endpoint>" 
  }
}

Действительный токен доступа Hugging Face. Его можно найти на странице настроек вашего аккаунта.

URL-адрес конечной точки инференса, созданной вами на Hugging Face.

Создайте новую конечную точку инференса на странице конечных точек Hugging Face, чтобы получить URL-адрес конечной точки. Выберите модель, которую вы хотите использовать на странице создания новой конечной точки — например, intfloat/e5-small-v2 — затем выберите задачу Sentence Embeddings в разделе «Дополнительные настройки». Создайте конечную точку. Скопируйте URL после завершения инициализации конечной точки.

Список рекомендуемых моделей для сервиса Hugging Face:

  • all-MiniLM-L6-v2
  • all-MiniLM-L12-v2
  • all-mpnet-base-v2
  • e5-base-v2
  • e5-small-v2
  • multilingual-e5-base
  • multilingual-e5-small

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/infer-service-hugging-face.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API