GetGraphRAGJob - AnalyticDB - Alibaba Cloud Documentation Center

Retrieves a task to build a knowledge graph.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:GetGraphRAGJob	get	All Resources ``	none	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-hangzhou
Namespace	string	No	The name of the namespace. Default value: public. Note You can 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 when you call the 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
JobId	string	Yes	The job ID.	231460f8-75dc-405e-a669-0c5204887e91

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	The additional information that is returned.	success
Status	string	The status of the operation. Valid values: success fail	success
Job	object	The details of the task for building a knowledge graph.
Id	string	The job ID.	231460f8-75dc-405e-a669-0c5204887e91
Completed	boolean	Indicates whether the operation is complete.	false
CreateTime	string	The job creation time.	2024-01-08 16:52:04.864664
UpdateTime	string	The job last updated time.	2024-01-08 16:53:04.864664
Status	string	The state of the job. Valid values: Success Failed (See the Error parameter for failure reasons.) Running Pending	Running
Error	string	The error message that is returned when the current operation is abnormal or fails.	Failed to connect database.
Progress	integer	The progress of the document upload job. Unit: %. A value of 100 indicates that the job is complete.	20
Usage	object	The number of tokens that are consumed by document understanding or embedding.
EmbeddingTokens	integer	The number of tokens that are consumed during vectorization. Note A token is the minimum unit for splitting text. A token can be a word, phrase, punctuation, or character.	475
LLMInputTokens	integer	The number of tokens used by the large model input.	600
LLMOutputTokens	integer	The number of tokens used for large model output.	125

Examples

Sample success responses

JSONformat

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "Job": {
    "Id": "231460f8-75dc-405e-a669-0c5204887e91",
    "Completed": false,
    "CreateTime": "2024-01-08 16:52:04.864664",
    "UpdateTime": "2024-01-08 16:53:04.864664",
    "Status": "Running",
    "Error": "Failed to connect database.",
    "Progress": 20
  },
  "Usage": {
    "EmbeddingTokens": 475,
    "LLMInputTokens": 600,
    "LLMOutputTokens": 125
  }
}

Error codes

For a list of error codes, visit the Service error codes.