URL
POST /v3/openapi/apps/[app_group_identity]/actions/knowledge-summaryIn the sample URL, [app_group_identity] specifies the name of the application that you want to access. You can specify an application name to access an application that is in service.
The sample URL omits information such as the request headers and the encoding method.
The sample URL also omits the endpoint that is used to connect to the application.
For more information about how to construct request headers, see Signature method of OpenSearch API V3.
Protocol
HTTP
HTTP request method
POST
Supported format
JSON
Request parameters
Parameter | Type | Required | Valid value | Default value | Description |
doc_id | String | Yes | The document ID. |
Sample request
{
"doc_id": "The document ID"
}Response parameters
Parameter | Type | Description |
request_id | String | The primary key ID of the document. |
latency | Double | The latency. |
summary | String | The summary that is generated. |
code | String | The error code. |
message | String | The error message. |
Sample response
{
"request_id": "abc123-ABC",
"latency": 10.0, # Unit: seconds.
"result": {
"summary": "The summary that is generated"
},
"errors": [
{
"code": "The error code that is returned if an error occurs",
"message" "The error message that is returned if an error occurs"
}
]
}