Enables knowledge graph construction for the knowledge base.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| gpdb:EnableCollectionGraphRAG | update | *Collection acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The cluster ID. Note
You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
| gp-xxxxxxxxx |
| RegionId | string | Yes | The region ID of the cluster. Note
You can call the DescribeRegions operation to query the most recent region list.
| cn-beijing |
| ManagerAccount | string | Yes | The name of the privileged database account that has the rds_superuser permission. Note
You can call the CreateAccount operation to create an account.
| testaccount |
| ManagerAccountPassword | string | Yes | The password for the privileged database account. | testpassword |
| Namespace | string | No | The name of the namespace. Default value: public. Note
You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.
| mynamespace |
| NamespacePassword | string | Yes | The password of the namespace. Note
The value of this parameter is specified by CreateNamespace operation.
| testpassword |
| Collection | string | Yes | The name of the document collection. Note
You can call the CreateDocumentCollection operation to create a document collection and call the ListDocumentCollections operation to query a list of document collections.
| document |
| LLMModel | string | No | The name of the LLM model. Note
Valid values:
Note
This parameter takes effect only when the knowledge graph construction is enabled.
| knowledge-extract-standard |
| Language | string | No | The language used to build the knowledge graph. Valid values:
Note
This parameter takes effect only when the knowledge graph construction is enabled.
| Simplified Chinese |
| EntityTypes | array | Yes | The list of entity types. Note
If the knowledge graph construction is enabled, this parameter is required.
| |
| string | Yes | The entity type. | ||
| RelationshipTypes | array | Yes | The list of relationship edge types. Note
If the knowledge graph construction is enabled, this parameter is required.
| |
| string | Yes | The type of the relationship edge. |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Message": "success",
"Status": "success",
"JobId": "231460f8-75dc-405e-a669-0c5204887e91"
}Error codes
For a list of error codes, visit the Service error codes.