OpenSearch:Batch query

URL

/vector-service/batch-query

• The preceding URL omits information such as request header parameters and encoding.

• The preceding URL also omits the host endpoint that is used to connect to an application.

• For more information about the definitions, usage, and example values of all the request parameters that are concatenated in the preceding URL, see the "Request parameters" section of this topic.

Protocol

HTTP

Request method

POST

Supported format

JSON

Signature mechanism

You can use the following method to calculate a signature (authorization).

import com.aliyun.darabonba.encode.Encoder;
import com.aliyun.darabonbastring.Client;

public class GenerateAuthorization {
    public static void main(String[] args) throws Exception {
        String accessUserName = "username";
        String accessPassWord = "password";
        String realmStr = "" + accessUserName + ":" + accessPassWord + "";
        String authorization = Encoder.base64EncodeToString(Client.toBytes(realmStr, "UTF-8"));
        System.out.println(authorization);
    }
}

Valid format for the value of the authorization header:

cm9vdDp******mdhbA==

If using an HTTP request, you must add the Basic prefix to the authorization header.

Example:

authorization: Basic cm9vdDp******mdhbA==

Request body

Query:

Response parameters

• QueryResult:

  Parameter	Description	Type
  queryId	The ID of the query to which the result belongs.	Integer
  totalCount	The number of results.	Integer
  data	The list of result documents.	List[Item]

• Item:

  Parameter	Description	Type
  id	The primary key value. The value is of the defined data type.	FieldType
  score	The score of the vector.	Float
  fields	The fields and the corresponding values.	Map<String, FieldType>
  vector	The vector value.	List[Float]
  namespace	The namespace of the vector. This parameter is returned if a namespace is configured for the vector.	String

Examples

Sample request:

{
    "queries":
    [
        {
            "indexName": "vector",
            "outputFields":
            [
                "id",
                "name"
            ],
            "tableName": "test",
            "vector":
            [
                0.363397,
                0.843076,
                0.47759,
                0.48623
            ]
        },
        {
            "indexName": "vector",
            "outputFields":
            [
                "id",
                "title"
            ],
            "tableName": "test1",
            "vector":
            [
                0.822608,
                0.972663,
                0.014438,
                0.410083
            ]
        }
    ]
}

Sample response:

{
    "result":
    [
        {
            "queryId": 0,
            "totalCount": 1,
            "data":
            [
                {
                    "id": 1,
                    "score": 0.521898,
                    "__source__": 0,
                    "fields":
                    {
                        "name": "Test1"
                    }
                }
            ]
        },
        {
            "queryId": 1,
            "totalCount": 1,
            "data":
            [
                {
                    "id": 1,
                    "score": 1.200817,
                    "__source__": 1,
                    "fields":
                    {
                        "title": "Title1"
                    }
                }
            ]
        }
    ],
    "totalTime": 4.419
}