retrieval routing-Natural Language Processing(NLP)-阿里云帮助中心

1. Parameters

1.1 Request parameters

Top-level parameters

Parameter	Type	Required	Description
algorithm	string	Yes	The identifier.
model	string	No	The model version. This parameter is optional.
input	map<string, object>	Yes	The input parameters.
parameters	map<string, object>	No	The configuration parameters.
debug	boolean	No	The debug mode. The default value is false.

Second-level parameters

Second-level parameter	Type	Required	Description
input.query	string	Yes	Searching for Decision Content

{
    "algorithm": "retrieve_router",
    "model": "",
    "input": {
        "query": "Hello"
    }
}

1.2 Response parameters

Top-level parameters

Parameter	Type	Description
requestId	string	The request ID.
status	int	The status of the request.
message	string	The response message.
data	map<string, object>	The result of the retrieval routing decision.
debugInfo	map<string, object>	The debug information.

Second-level parameters

Second-level parameter	Type	Description
data.retrieveRouter	boolean	The result of the retrieval routing decision: true: A search is required. false: A search is not required.
data.timeCost	float	The time consumed by the service, in ms.
data.inputTokens	int	The number of input tokens.
data.outputTokens	int	The number of output tokens.

{
    "data": {
        "retrieveRouter": false,
        "outputTokens": 1,
        "timeCost": 36.9,
        "inputTokens": 4
    },
    "requestId": null,
    "debugInfo": null,
    "message": null,
    "status": 0
}

2. SDK calls

2.1 Java SDK

2.1.1 Maven dependency

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>alinlp20200629</artifactId>
    <version>3.0.0</version>
</dependency>

<!--Import this dependency if a java.lang.NoSuchMethodError: com.aliyun.credentials.Client.getCredential()Lcom/aliyun/credentials/models/CredentialModel; exception occurs.-->
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>credentials-java</artifactId>
    <version>0.3.0</version>
</dependency>

2.1.2 Call example

/**
 * Initializes the client with an AccessKey ID and an AccessKey secret.
 * @param accessKeyId
 * @param accessKeySecret
 * @return Client
 * @throws Exception
 */
public static Client createClient(String accessKeyId, String accessKeySecret) throws Exception {
    Config config = new Config()
    // Required. Your AccessKey ID.
    .setAccessKeyId(accessKeyId)
    // Required. Your AccessKey secret.
    .setAccessKeySecret(accessKeySecret);
    // For the endpoint, see https://api.aliyun.com/product/alinlp.
    config.endpoint = "alinlp.cn-beijing.aliyuncs.com";
    return new Client(config);
}

public static void main(String[] args) throws Exception {
    String accessKeyId = "xxx";
    String accessKeySecret = "xxx";
    Client client = createClient(accessKeyId, accessKeySecret);
		PostISRetrieveRouterRequest request = new PostISRetrieveRouterRequest();
		request.setAlgorithm("retrieve_router");
		String input = "{\"query\": \"Hello\"}";
		Map<String, Object> inputMap = JSONObject.parseObject(input, Map.class);
    request.setInput(inputMap);
    PostISRetrieveRouterResponse response = client.postISRetrieveRouter(request);
    System.out.println(JSONObject.toJSONString(response.getBody()));
}

2.2 Python SDK

2.2.1 pip source

pip install alibabacloud-alinlp20200629==3.0.0

2.2.2 Call example

import json

from alibabacloud_alinlp20200629 import client
from alibabacloud_tea_openapi import models as api_models
from alibabacloud_alinlp20200629 import models


def retrieve_router():
    config = api_models.Config(
        access_key_id='xxx',
        access_key_secret='xxx',
        region_id="cn-beijing")
    nlp_client = client.Client(config)
    request = models.PostISRetrieveRouterRequest()
    input_str = '{\"query\": \"Hello\"}'
    request.input = json.loads(input_str)
    request.algorithm = 'retrieve_router'
    response = nlp_client.post_isretrieve_router(request)
    print(json.dumps(response.body.data, ensure_ascii=False))


if __name__ == '__main__':
    retrieve_router()