EnableCollectionGraphRAG - 知识库开启构建知识图谱

更新时间:

知识库开启构建知识图谱

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:EnableCollectionGraphRAGupdate
*Collection
acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-xxxxxxxxx
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看可用的地域 ID。
cn-beijing
ManagerAccountstring

具有 rds_superuser 权限的管理账号名称。

说明 您可以调用 CreateAccount 接口创建账号。
testaccount
ManagerAccountPasswordstring

管理账号密码。

testpassword
Namespacestring

命名空间,默认为 public。

说明 您可以通过 CreateNamespace 接口创建,通过 ListNamespaces 接口查看列表。
mynamespace
NamespacePasswordstring

命名空间对应的密码。

说明 本值为 CreateNamespace 接口指定。
testpassword
Collectionstring

文档库名称。

说明 CreateDocumentCollection 接口创建。您可以调用 ListDocumentCollections 接口查看已经创建的文档库。
document
LLMModelstring

LLM 模型名称。

说明 取值范围
  • knowledge-extract-standard:默认值。
  • knowledge-extract-mini
  • 说明 仅当开启构建知识图谱时,该参数生效。
    knowledge-extract-standard
    Languagestring

    构建知识图谱使用的语言。取值说明:

    • Simplified Chinese: 简体中文。默认值。
    • English:英语。
    说明 仅当开启构建知识图谱时,该参数生效。
    Simplified Chinese
    EntityTypesarray

    实体类型列表。

    说明 当开启构建知识图谱时,该参数必传。
    string

    实体类型。

    地点
    RelationshipTypesarray

    关系边类型列表。

    说明 当开启构建知识图谱时,该参数必传。
    string

    关系边类型。

    发生

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    ABB39CC3-4488-4857-905D-2E4A051D0521
    Messagestring

    返回信息。

    success
    Statusstring

    状态,取值说明:

    • success:成功。
    • fail:失败。
    success
    JobIdstring

    任务 ID,用于后续使用GetGraphRAGJob查看任务状态。

    231460f8-75dc-405e-a669-0c5204887e91

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
      "Message": "success",
      "Status": "success",
      "JobId": "231460f8-75dc-405e-a669-0c5204887e91"
    }

    错误码

    访问错误中心查看更多错误码。