文档中心

向量数据库VikingDB

请输入

资源导入与同步

上传代码仓库

概述

OpenViking 支持通过 add-resource 命令导入代码仓库，将公开或私有仓库导出、解析、切片、索引后写入指定数据库。

支持的导入范围

OpenVIking支持以下代码仓库：
Github, GItlab, Gitcode, Gitee, Bitbucket, Codeberg, Gitea, SourceHut

OpenViking 支持导入仓库中的以下信息：

公开仓库（不需要连接，可以直接通过命令上传）
有克隆权限的私有HTTPS仓库
仓库中指定的分支或commit版本

上传方式

本地文件支持控制台上传，CLI上传，API上传三种方式。

控制台上传

正在开发中，敬请期待

CLI上传

示例如下，具体命令与参数详见 add-resource-添加资源。

ov add-resource "https://github.com/volcengine/OpenViking" \
 --to "viking://resources/openviking-repo" \
 --watch-interval 1440 \
 --args '{
  "branch": "main",
  "auth_config": {
    "username": "oauth2",
    "token": "<PAT_TOKEN>"
  }
}'

API上传

示例如下，具体命令与参数详见 add_resource-导入资源。

curl -X POST "https://api.vikingdb.cn-beijing.volces.com/openviking/api/v1/resources" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ZGVmYXVsdA.ZGVmYXVsdA." \
    -d '{
    "path": "https://github.com/volcengine/ark-cli",
    "to": "viking://resources/openviking-repo2",
    "reason": "git connector import"
}'

获取鉴权参数

Github

首先，需要进入设置页面，进入开发者界面。

创建一个PAT (Personal_access_token)。

选择”过期时间“，”仓库范围“和”权限“，其中权限选择"Contents ready-only"；如需要定时同步，过期时间建议选”No expiration“。

保存生成的PAT (Personal_access_token)，供后续上传使用。

Gitlab

首先，需要进入设置页面，进入开发者界面。

创建一个PAT (Personal_access_token)，建议使用旧版令牌。

选择”过期时间“和”权限“，其中权限至少需要授予”只读“权限；如需要定时同步，过期时间建议延长。

保存生成的PAT (Personal_access_token)，供后续上传使用。

Gitcode

首先，需要进入设置页面，进入开发者界面。

创建一个PAT (Personal_access_token)。

选择”过期时间“和”权限“，其中权限至少需要授予”只读“权限；如需要定时同步，过期时间建议选择“长期有效”。

保存生成的PAT (Personal_access_token)，供后续上传使用。

Gitee

首先，需要进入设置页面，进入开发者界面。

创建一个PAT (Personal_access_token)。

BitBucket

首先，需要进入设置页面，进入开发者界面。

创建一个PAT (Personal_access_token)。

选择”过期时间“，如需要定时同步，过期时间建议延长。

保存生成的PAT (Personal_access_token)，供后续上传使用。

Codeberg

首先，需要进入设置页面，进入开发者界面。

创建一个PAT (Personal_access_token)。

选择”过期时间“和”权限“，其中权限至少需要授予”只读“权限；如需要定时同步，过期时间建议选择“长期有效”。

保存生成的PAT (Personal_access_token)，供后续上传使用。