EdgeApi¶

所有URI均相对于{INTERACTIVE_ADMIN_ENDPOINT}

方法	HTTP请求	描述
add_edge	POST /v1/graph/{graph_id}/edge	向图中添加边
get_edge	GET /v1/graph/{graph_id}/edge	通过源顶点和目标顶点主键获取边的属性。
update_edge	PUT /v1/graph/{graph_id}/edge	更新边的属性

add_edge¶

结果[str] add_edge(graph_id, edge_request)

向图中添加一条边。

示例¶

from gs_interactive.client.driver import Driver
from gs_interactive.client.session import Session
from gs_interactive.models import *

driver = Driver()
sess = driver.session()

graph_id = "1"

edge_request = [
    EdgeRequest(
        src_label="person",
        dst_label="person",
        edge_label="knows",
        src_primary_key_value=2,
        dst_primary_key_value=4,
        properties=[ModelProperty(name="weight", value=9.123)],
    ),
    EdgeRequest(
        src_label="person",
        dst_label="person",
        edge_label="knows",
        src_primary_key_value=2,
        dst_primary_key_value=6,
        properties=[ModelProperty(name="weight", value=3.233)],
    ),
]
resp = sess.add_edge(graph_id, edge_request)
print(resp)
assert resp.is_ok()

参数¶

名称	类型	描述	备注
graph_id	str
edge_request	List[EdgeRequest]

返回类型¶

结果[str]

授权¶

无需授权

HTTP请求头¶

内容类型: application/json
Accept: application/json

HTTP响应详情¶

状态码	描述	响应头
200	成功插入边	-
400	无效的输入边	-
409	边已存在	-
500	服务器内部错误	-

[返回顶部] [返回API列表] [返回模型列表] [返回python_sdk]

get_edge¶

结果[EdgeData] get_edge(graph_id, edge_label, src_label, src_primary_key_value, dst_label, dst_primary_key_value)

通过源顶点和目标顶点的主键获取边的属性。

获取指定顶点的属性。

示例¶

from gs_interactive.client.driver import Driver
from gs_interactive.client.session import Session
from gs_interactive.models import *

driver = Driver()
sess = driver.session()

graph_id = "1"

resp = sess.get_edge(graph_id, "knows", "person", 2, "person", 4)
assert resp.is_ok()
for k, v in resp.get_value().properties:
    if k == "weight":
        assert v == 9.123
print(resp)
assert resp.is_ok()

参数¶

名称	类型	描述
graph_id	str
edge_label	str	查询边的标签名称。
src_label	str	源顶点的标签名称。
src_primary_key_value	object	源顶点的主键值。
dst_label	str	目标顶点的标签名称。
dst_primary_key_value	object	目标顶点主键的值

返回类型¶

结果[边数据]

授权¶

无需授权

HTTP请求头¶

Content-Type: 未定义
Accept: application/json

HTTP响应详情¶

状态码	描述	响应头
200	找到边	-
400	错误的输入参数	-
404	边不存在或图不存在	-
500	服务器内部错误	-

[返回顶部] [返回API列表] [返回模型列表] [返回python_sdk]

update_edge¶

结果[str] update_edge(graph_id, edge_request=edge_request)

更新边的属性

更新运行图中的边。

示例¶

from gs_interactive.client.driver import Driver
from gs_interactive.client.session import Session
from gs_interactive.models import *

driver = Driver()
sess = driver.session()

graph_id = "1"

resp = sess.update_edge(
    graph_id,
    EdgeRequest(
        src_label="person",
        dst_label="person",
        edge_label="knows",
        src_primary_key_value=2,
        dst_primary_key_value=4,
        properties=[ModelProperty(name="weight", value=3)],
    ),
)
print(resp)
assert resp.is_ok()

参数¶

名称	类型	描述	备注
graph_id	str
edge_request	EdgeRequest		[可选]

返回类型¶

结果[str]

授权¶

无需授权

HTTP请求头¶

内容类型: application/json
Accept: application/json

HTTP响应详情¶

状态码	描述	响应头
200	成功更新边	-
400	无效的输入参数	-
404	边不存在	-
500	服务器内部错误	-

[返回顶部] [返回API列表] [返回模型列表] [返回python_sdk]