Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Руководство [8.17] ›REST API ›API вывода

Интеграция вывода AlibabaCloud AI Search

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

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

Создает точку вывода для выполнения задачи вывода с помощью сервиса alibabacloud-ai-search.

Запрос

PUT /_inference/<task_type>/<inference_id>

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

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

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

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

  • completion,
  • rerank
  • sparse_embedding,
  • 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
(Обязательно, строка) Тип сервиса, поддерживаемого для указанного типа задачи. В этом случае, alibabacloud-ai-search.
service_settings

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

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

api_key
(Обязательно, строка) Действительный API-ключ для API AlibabaCloud AI Search.
service_id

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

Доступные service_id для задачи completion:

  • ops-qwen-turbo
  • qwen-turbo
  • qwen-plus
  • qwen-max ÷ qwen-max-longcontext

Для поддерживаемых service_id сервиса completion, обратитесь к документации.

Доступный service_id для задачи rerank:

  • ops-bge-reranker-larger

Для поддерживаемых service_id сервиса rerank, обратитесь к документации.

Доступный service_id для задачи sparse_embedding:

  • ops-text-sparse-embedding-001

Для поддерживаемых service_id сервиса sparse_embedding, обратитесь к документации.

Доступные service_ids для задачи text_embedding:

  • ops-text-embedding-001
  • ops-text-embedding-zh-001
  • ops-text-embedding-en-001
  • ops-text-embedding-002

Для поддерживаемых service_ids сервиса text_embedding, обратитесь к документации.

host
(Обязательно, строка) Имя адреса хоста, используемого для задачи вывода. Адрес хоста можно найти в разделе ключей API документации.
workspace
(Обязательно, строка) Название рабочего пространства, используемого для задачи вывода.
rate_limit

(Необязательно, объект) По умолчанию, сервис alibabacloud-ai-search устанавливает количество разрешенных запросов в минуту на 1000. Это помогает минимизировать количество ошибок ограничения скорости, возвращаемых от AlibabaCloud AI Search. Для изменения этого, установите настройку requests_per_minute в ваших настройках сервиса: 

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

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

task_settings для типа задачи text_embedding
input_type

(Необязательно, строка) Указывает тип входных данных, передаваемых в модель. Допустимые значения:

  • ingest: для хранения эмбеддингов документов в базе данных векторов.
  • search: для хранения эмбеддингов поисковых запросов, выполняемых в базе данных векторов, чтобы найти соответствующие документы.
task_settings для типа задачи sparse_embedding
input_type

(Необязательно, строка) Указывает тип входных данных, передаваемых в модель. Допустимые значения:

  • ingest: для хранения эмбеддингов документов в базе данных векторов.
  • search: для хранения эмбеддингов поисковых запросов, выполняемых в базе данных векторов, чтобы найти соответствующие документы.
return_token
(Необязательно, булево) Если true, имя токена будет возвращено в ответе. По умолчанию значение равно false, что означает, что в ответе будет возвращен только идентификатор токена.

Примеры сервиса AlibabaCloud AI Search

В следующем примере показано, как создать точку вывода с именем alibabacloud_ai_search_completion для выполнения задачи типа completion.

resp = client.inference.put(
    task_type="completion",
    inference_id="alibabacloud_ai_search_completion",
    inference_config={
        "service": "alibabacloud-ai-search",
        "service_settings": {
            "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
            "api_key": "{{API_KEY}}",
            "service_id": "ops-qwen-turbo",
            "workspace": "default"
        }
    },
)
print(resp)
const response = await client.inference.put({
  task_type: "completion",
  inference_id: "alibabacloud_ai_search_completion",
  inference_config: {
    service: "alibabacloud-ai-search",
    service_settings: {
      host: "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
      api_key: "{{API_KEY}}",
      service_id: "ops-qwen-turbo",
      workspace: "default",
    },
  },
});
console.log(response);
PUT _inference/completion/alibabacloud_ai_search_completion
{
    "service": "alibabacloud-ai-search",
    "service_settings": {
        "host" : "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
        "api_key": "{{API_KEY}}",
        "service_id": "ops-qwen-turbo",
        "workspace" : "default"
    }
}

Следующий пример демонстрирует создание точки вывода с именем alibabacloud_ai_search_rerank для выполнения задачи типа rerank.

resp = client.inference.put(
    task_type="rerank",
    inference_id="alibabacloud_ai_search_rerank",
    inference_config={
        "service": "alibabacloud-ai-search",
        "service_settings": {
            "api_key": "<api_key>",
            "service_id": "ops-bge-reranker-larger",
            "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
            "workspace": "default"
        }
    },
)
print(resp)
const response = await client.inference.put({
  task_type: "rerank",
  inference_id: "alibabacloud_ai_search_rerank",
  inference_config: {
    service: "alibabacloud-ai-search",
    service_settings: {
      api_key: "<api_key>",
      service_id: "ops-bge-reranker-larger",
      host: "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
      workspace: "default",
    },
  },
});
console.log(response);
PUT _inference/rerank/alibabacloud_ai_search_rerank
{
    "service": "alibabacloud-ai-search",
    "service_settings": {
        "api_key": "<api_key>",
        "service_id": "ops-bge-reranker-larger",
        "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
        "workspace": "default"
    }
}

В следующем примере показано, как создать точку вывода под названием alibabacloud_ai_search_sparse для выполнения задачи типа sparse_embedding.

resp = client.inference.put(
    task_type="sparse_embedding",
    inference_id="alibabacloud_ai_search_sparse",
    inference_config={
        "service": "alibabacloud-ai-search",
        "service_settings": {
            "api_key": "<api_key>",
            "service_id": "ops-text-sparse-embedding-001",
            "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
            "workspace": "default"
        }
    },
)
print(resp)
const response = await client.inference.put({
  task_type: "sparse_embedding",
  inference_id: "alibabacloud_ai_search_sparse",
  inference_config: {
    service: "alibabacloud-ai-search",
    service_settings: {
      api_key: "<api_key>",
      service_id: "ops-text-sparse-embedding-001",
      host: "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
      workspace: "default",
    },
  },
});
console.log(response);
PUT _inference/sparse_embedding/alibabacloud_ai_search_sparse
{
    "service": "alibabacloud-ai-search",
    "service_settings": {
        "api_key": "<api_key>",
        "service_id": "ops-text-sparse-embedding-001",
        "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
        "workspace": "default"
    }
}

В следующем примере показано создание точки вывода с именем alibabacloud_ai_search_embeddings для выполнения задачи типа text_embedding.

resp = client.inference.put(
    task_type="text_embedding",
    inference_id="alibabacloud_ai_search_embeddings",
    inference_config={
        "service": "alibabacloud-ai-search",
        "service_settings": {
            "api_key": "<api_key>",
            "service_id": "ops-text-embedding-001",
            "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
            "workspace": "default"
        }
    },
)
print(resp)
const response = await client.inference.put({
  task_type: "text_embedding",
  inference_id: "alibabacloud_ai_search_embeddings",
  inference_config: {
    service: "alibabacloud-ai-search",
    service_settings: {
      api_key: "<api_key>",
      service_id: "ops-text-embedding-001",
      host: "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
      workspace: "default",
    },
  },
});
console.log(response);
PUT _inference/text_embedding/alibabacloud_ai_search_embeddings
{
    "service": "alibabacloud-ai-search",
    "service_settings": {
        "api_key": "<api_key>",
        "service_id": "ops-text-embedding-001",
        "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
        "workspace": "default"
    }
}

© 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-alibabacloud-ai-search.html

Spec-Zone.ru

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