Create an AlibabaCloud AI Search inference endpoint

PUT /_inference/{task_type}/{alibabacloud_inference_id}

Create an inference endpoint to perform an inference task with the alibabacloud-ai-search service.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Request body

chunking_settings object: The chunking configuration object.; Reference
service enum required: The type of service supported for the specified task type. In this case, alibabacloud-ai-search.; Values: alibabacloud-ai-search
service_settings object required: Settings used to install the inference model. These settings are specific to the alibabacloud-ai-search service.
task_settings object: Settings to configure the inference task. These settings are specific to the task type you specified.

Response

application/json

Examples

Request Console 1 / 8 languages

Run PUT _inference/completion/alibabacloud_ai_search_completion to create an inference endpoint that performs a completion task.

Console Kibana Dev Tools

PUT _inference/completion/alibabacloud_ai_search_completion
{
    "service": "alibabacloud-ai-search",
    "service_settings": {
        "host" : "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
        "api_key": "AlibabaCloud-API-Key",
        "service_id": "ops-qwen-turbo",
        "workspace" : "default"
    }
}

JavaScript Elasticsearch JavaScript Client

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: "AlibabaCloud-API-Key",
      service_id: "ops-qwen-turbo",
      workspace: "default",
    },
  },
});

Python Elasticsearch Python Client

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": "AlibabaCloud-API-Key",
            "service_id": "ops-qwen-turbo",
            "workspace": "default"
        }
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_inference/completion/alibabacloud_ai_search_completion" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "service": "alibabacloud-ai-search",
    "service_settings": {
      "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
      "api_key": "AlibabaCloud-API-Key",
      "service_id": "ops-qwen-turbo",
      "workspace": "default"
    }
  }'

Java Elasticsearch Java Client

client.inference().put(p -> p
    .inferenceId("alibabacloud_ai_search_completion")
    .taskType(TaskType.Completion)
    .inferenceConfig(i -> i
        .service("alibabacloud-ai-search")
        .serviceSettings(JsonData.fromJson("{\"host\":\"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\"api_key\":\"AlibabaCloud-API-Key\",\"service_id\":\"ops-qwen-turbo\",\"workspace\":\"default\"}"))
    )
);

C# Elasticsearch .NET Client

var response = await client.Inference
    .PutAsync(new PutInferenceRequest()
    {
        InferenceId = "alibabacloud_ai_search_completion",
        TaskType = TaskType.Completion,
        InferenceConfig = new()
        {
            Service = "alibabacloud-ai-search",
            ServiceSettings = JsonSerializer.Deserialize<JsonElement>("""
            {
              "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
              "api_key": "AlibabaCloud-API-Key",
              "service_id": "ops-qwen-turbo",
              "workspace": "default"
            }
            """)
        }
    });

PHP Elasticsearch PHP Client

$resp = $client->inference()->put([
    "task_type" => "completion",
    "inference_id" => "alibabacloud_ai_search_completion",
    "body" => [
        "service" => "alibabacloud-ai-search",
        "service_settings" => [
            "host" => "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
            "api_key" => "AlibabaCloud-API-Key",
            "service_id" => "ops-qwen-turbo",
            "workspace" => "default",
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.inference.put(
  task_type: "completion",
  inference_id: "alibabacloud_ai_search_completion",
  body: {
    "service": "alibabacloud-ai-search",
    "service_settings": {
      "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
      "api_key": "AlibabaCloud-API-Key",
      "service_id": "ops-qwen-turbo",
      "workspace": "default"
    }
  }
)

Response

No example

Request Console 1 / 2 languages

Run PUT _inference/rerank/alibabacloud_ai_search_rerank to create an inference endpoint that performs a rerank task.

Console Kibana Dev Tools

PUT _inference/rerank/alibabacloud_ai_search_rerank
{
    "service": "alibabacloud-ai-search",
    "service_settings": {
        "api_key": "AlibabaCloud-API-Key",
        "service_id": "ops-bge-reranker-larger",
        "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
        "workspace": "default"
    }
}

Generated from the API spec

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_inference/rerank/alibabacloud_ai_search_rerank" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "service": "alibabacloud-ai-search",
      "service_settings": {
          "api_key": "AlibabaCloud-API-Key",
          "service_id": "ops-bge-reranker-larger",
          "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
          "workspace": "default"
      }
  }'

Generated from the API spec

Response

No example

Request Console 1 / 2 languages

Run PUT _inference/sparse_embedding/alibabacloud_ai_search_sparse to create an inference endpoint that performs perform a sparse embedding task.

Console Kibana Dev Tools

PUT _inference/sparse_embedding/alibabacloud_ai_search_sparse
{
    "service": "alibabacloud-ai-search",
    "service_settings": {
        "api_key": "AlibabaCloud-API-Key",
        "service_id": "ops-text-sparse-embedding-001",
        "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
        "workspace": "default"
    }
}

Generated from the API spec

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_inference/sparse_embedding/alibabacloud_ai_search_sparse" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "service": "alibabacloud-ai-search",
      "service_settings": {
          "api_key": "AlibabaCloud-API-Key",
          "service_id": "ops-text-sparse-embedding-001",
          "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
          "workspace": "default"
      }
  }'

Generated from the API spec

Response

No example

Request Console 1 / 2 languages

Run PUT _inference/text_embedding/alibabacloud_ai_search_embeddings to create an inference endpoint that performs a text embedding task.

Console Kibana Dev Tools

PUT _inference/text_embedding/alibabacloud_ai_search_embeddings
{
    "service": "alibabacloud-ai-search",
    "service_settings": {
        "api_key": "AlibabaCloud-API-Key",
        "service_id": "ops-text-embedding-001",
        "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
        "workspace": "default"
    }
}

Generated from the API spec

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_inference/text_embedding/alibabacloud_ai_search_embeddings" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "service": "alibabacloud-ai-search",
      "service_settings": {
          "api_key": "AlibabaCloud-API-Key",
          "service_id": "ops-text-embedding-001",
          "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com",
          "workspace": "default"
      }
  }'

Generated from the API spec

Response

No example

Required authorization

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body