Updated on 2025-08-22 GMT+08:00

PersonalRank (1.0.0)

Table 1 parameters parameter description

Parameter

Mandatory

Type

Description

source

Yes

String

Node ID

alpha

No

Double

Weight coefficient (also called damping coefficient). The value range is (0, 1). The default value is 0.85.

convergence

No

Double

Convergence

The value range is between 0 and 1, excluding 0 and 1. The default value is 0.00001.

max_iterations

No

Integer

Maximum iterations. An integer ranging from 1 to 2147483647. For frontend calls, the range is [1, 2000]. The default value is 1000.

num_thread

No

Integer

Number of concurrent threads. The value ranges from 1 to 40. If the value is less than 1, it is automatically set to 1. If the value is greater than 40, it is automatically set to 40. The default value is 4.

directed

No

Boolean

Whether to consider the edge direction. The value can be true or false. The default value is true.

weight

No

String

Null or string

  • Null: The default weight and distance of edges are 1.
  • String: The property of the corresponding edge is the weight. If the edge does not have a property, the weight is 1 by default.
NOTE:

The weight of an edge must be greater than 0.

For how to adjust the values of max_iterations and convergence, see Iterations and Convergence of PageRank.

Table 2 response_data parameter description

Parameter

Type

Description

source

String

-

results

List

PersonalRank value of each node, in the format of [{"id":vertexId,"personalrank":rankValue},...], where,

  • vertexId is of the string type.
  • rankValue is of the double type.