面向智能体的入门指南

更新时间:
复制 MD 格式

本文档面向希望通过 AI 智能体(Agent)接入阿里云向量检索服务 DashVector 的开发者,提供 LLM 可消费的 API 文档结构和快速入门指导。

你能完成什么

通过本文档,AI 智能体可以:

  • 理解 DashVector 核心能力:通过结构化的模块概览,快速了解 DashVector 支持的功能(Cluster 管理、Collection 管理、Partition 管理、向量管理等)。

  • 获取 API 调用知识:每个模块的文档包含该模块的 API 操作列表、参数说明和使用示例,LLM 可直接从中学习如何调用 API。

  • 掌握认证与鉴权:了解 DashVector API 支持的认证方式(API_KEY),正确配置调用凭证。

  • 处理常见错误:获取常见错误码及排查方法,使 AI 智能体具备自主排障能力。

前提条件

在使用 DashVector API 前,请确保已完成以下准备

  1. 开通向量检索服务开通服务

  2. 创建 API_KEYAPI-KEY管理

  3. 安装 SDK:推荐使用 DashVector SDK 调用 API。支持 Python SDK 和 Java SDK。安装DashVector SDK

llms.txt 简介

llms.txt 是 DashVector 团队针对大语言模型(LLM)优化的文档索引文件。它将官方 DashVector 文档按场景、API、子文档路径整合,供 Coding Agent 一次性加载、按需展开。

llms.txt文件内容:

# DashVector 向量检索服务 - 官方文档索引

向量检索服务 DashVector 基于通义实验室自研的高效向量引擎 Proxima 内核,提供具备水平拓展能力的云原生、全托管的向量检索服务。

## 目录

- [产品介绍](#产品介绍) - 什么是 DashVector、应用场景、功能特性
- [概念术语](#概念术语) - 向量、分区、Schema Free、过滤检索等核心概念
- [入门](#入门) - 开通服务、创建 API_KEY、快速开始
- [开发参考](#开发参考) - Cluster/Collection/Partition/向量管理的 SDK 和 API 文档
  - [Cluster 管理](#cluster-管理)
  - [Collection 管理](#collection-管理)
  - [Partition 管理](#partition-管理)
  - [向量管理](#向量管理)
- [附录](#附录) - 数据类型、状态码、约束限制
- [DashText](#dashtext) - 文本向量化工具
- [计量计费](#计量计费) - 产品计费、产品规格
- [最佳实践](#最佳实践) - 问答服务、语义搜索、多模态检索
- [常见问题](#常见问题) - FAQ

## 产品介绍

- [什么是向量检索服务](https://help.aliyun.com/zh/document_detail/2510225.html)
- [应用场景](https://help.aliyun.com/zh/document_detail/2510226.html)
- [功能特性](https://help.aliyun.com/zh/document_detail/2839171.html)

## 概念术语

- [基本概念](https://help.aliyun.com/zh/document_detail/2510229.html)
- [什么是向量](https://help.aliyun.com/zh/document_detail/2584947.html)
- [Schema Free](https://help.aliyun.com/zh/document_detail/2510228.html)
- [条件过滤检索](https://help.aliyun.com/zh/document_detail/2513006.html)
- [关键词感知检索](https://help.aliyun.com/zh/document_detail/2586282.html)
- [分区 Partition](https://help.aliyun.com/zh/document_detail/2573907.html)
- [分组向量检索](https://help.aliyun.com/zh/document_detail/2709686.html)
- [多向量检索](https://help.aliyun.com/zh/document_detail/2837745.html)
- [向量检索高级参数](https://help.aliyun.com/zh/document_detail/2838122.html)

## 入门

- [开通服务](https://help.aliyun.com/zh/document_detail/2568083.html)
- [创建 API_KEY](https://help.aliyun.com/zh/document_detail/2510230.html)
- [快速开始](https://help.aliyun.com/zh/document_detail/2510223.html)

## 开发参考

### Cluster 管理
- [创建 Cluster](https://help.aliyun.com/zh/document_detail/2631966.html)
- [升配 Cluster](https://help.aliyun.com/zh/document_detail/2636033.html)
- [释放 Cluster](https://help.aliyun.com/zh/document_detail/2636034.html)

### Collection 管理

#### 创建 Collection
- [Java SDK 创建 Collection](https://help.aliyun.com/zh/document_detail/2573558.html)
- [Python SDK 创建 Collection](https://help.aliyun.com/zh/document_detail/2510242.html)
- [HTTP API 创建 Collection](https://help.aliyun.com/zh/document_detail/2510281.html)

#### 描述 Collection
- [Java SDK 描述 Collection](https://help.aliyun.com/zh/document_detail/2573566.html)
- [Python SDK 描述 Collection](https://help.aliyun.com/zh/document_detail/2510243.html)
- [HTTP API 描述 Collection](https://help.aliyun.com/zh/document_detail/2510294.html)

#### 获取 Collection
- [Java SDK 描述 Collection](https://help.aliyun.com/zh/document_detail/2573569.html)
- [Python SDK 描述 Collection](https://help.aliyun.com/zh/document_detail/2510244.html)

#### 获取 Collection列表
- [Java SDK 获取 Collection列表](https://help.aliyun.com/zh/document_detail/2573578.html)
- [Python SDK 获取 Collection列表](https://help.aliyun.com/zh/document_detail/2510245.html)
- [HTTP API 获取 Collection列表](https://help.aliyun.com/zh/document_detail/2510298.html)

#### 统计 Collection列表
- [Java SDK 统计 Collection列表](https://help.aliyun.com/zh/document_detail/2573579.html)
- [Python SDK 统计 Collection列表](https://help.aliyun.com/zh/document_detail/2510246.html)
- [HTTP API 统计 Collection列表](https://help.aliyun.com/zh/document_detail/2510304.html)

#### 删除 Collection
- [Java SDK 删除 Collection](https://help.aliyun.com/zh/document_detail/2573580.html)
- [Python SDK 删除 Collection](https://help.aliyun.com/zh/document_detail/2510247.html)
- [HTTP API 删除 Collection](https://help.aliyun.com/zh/document_detail/2510308.html)

### Partition 管理

#### 新建Partition
- [Java SDK 新建Partition](https://help.aliyun.com/zh/document_detail/2573598.html)
- [Python SDK 新建Partition](https://help.aliyun.com/zh/document_detail/2510256.html)
- [HTTP API 新建Partition](https://help.aliyun.com/zh/document_detail/2510326.html)

#### 描述Partition
- [Java SDK 描述Partition](https://help.aliyun.com/zh/document_detail/2573599.html)
- [Python SDK 描述Partition](https://help.aliyun.com/zh/document_detail/2510257.html)
- [HTTP API 描述Partition](https://help.aliyun.com/zh/document_detail/2510327.html)

#### 获取Partition列表
- [Java SDK 获取Partition列表](https://help.aliyun.com/zh/document_detail/2573600.html)
- [Python SDK 获取Partition列表](https://help.aliyun.com/zh/document_detail/2510258.html)
- [HTTP API 获取Partition列表](https://help.aliyun.com/zh/document_detail/2510328.html)

#### 统计Partition
- [Java SDK 统计Partition](https://help.aliyun.com/zh/document_detail/2573601.html)
- [Python SDK 统计Partition](https://help.aliyun.com/zh/document_detail/2510259.html)
- [HTTP API 统计Partition](https://help.aliyun.com/zh/document_detail/2510329.html)

#### 删除Partition
- [Java SDK 删除Partition](https://help.aliyun.com/zh/document_detail/2573602.html)
- [Python SDK 删除Partition](https://help.aliyun.com/zh/document_detail/2510260.html)
- [HTTP API 删除Partition](https://help.aliyun.com/zh/document_detail/2510330.html)

### 向量管理

#### 插入向量
- [Java SDK 插入向量](https://help.aliyun.com/zh/document_detail/2573586.html)
- [Python SDK 插入向量](https://help.aliyun.com/zh/document_detail/2510249.html)
- [HTTP API 插入向量](https://help.aliyun.com/zh/document_detail/2510317.html)

#### 检索向量
- [Java SDK 检索向量](https://help.aliyun.com/zh/document_detail/2573592.html)
- [Python SDK 检索向量](https://help.aliyun.com/zh/document_detail/2510250.html)
- [HTTP API 检索向量](https://help.aliyun.com/zh/document_detail/2510319.html)

#### 分组检索向量
- [Java SDK 分组检索向量](https://help.aliyun.com/zh/document_detail/2712893.html)
- [Python SDK 分组检索向量](https://help.aliyun.com/zh/document_detail/2709529.html)
- [HTTP API 分组检索向量](https://help.aliyun.com/zh/document_detail/2715274.html)

#### 插入或更新向量
- [Java SDK 插入或更新向量](https://help.aliyun.com/zh/document_detail/2573593.html)
- [Python SDK 插入或更新向量](https://help.aliyun.com/zh/document_detail/2510251.html)
- [HTTP API 插入或更新向量](https://help.aliyun.com/zh/document_detail/2510320.html)

#### 更新向量
- [Java SDK 更新向量](https://help.aliyun.com/zh/document_detail/2573594.html)
- [Python SDK 更新向量](https://help.aliyun.com/zh/document_detail/2510252.html)
- [HTTP API 更新向量](https://help.aliyun.com/zh/document_detail/2510321.html)

#### 获取向量
- [Java SDK 获取向量](https://help.aliyun.com/zh/document_detail/2573595.html)
- [Python SDK 获取向量](https://help.aliyun.com/zh/document_detail/2510253.html)
- [HTTP API 获取向量](https://help.aliyun.com/zh/document_detail/2510324.html)

#### 删除向量
- [Java SDK 删除向量](https://help.aliyun.com/zh/document_detail/2573596.html)
- [Python SDK 删除向量](https://help.aliyun.com/zh/document_detail/2510254.html)
- [HTTP API 删除向量](https://help.aliyun.com/zh/document_detail/2510325.html)

## 附录

- [数据类型定义](https://help.aliyun.com/zh/document_detail/2510262.html)
- [返回状态码说明](https://help.aliyun.com/zh/document_detail/2510266.html)
- [约束与限制](https://help.aliyun.com/zh/document_detail/2510263.html)

## DashText
- [安装DashText SDK](https://help.aliyun.com/zh/document_detail/2712435.html)
- [DashText 快速入门](https://help.aliyun.com/zh/document_detail/2546039.html)
- [DashText 详细介绍](https://pypi.org/project/dashtext/)

## 计量计费

- [产品计费](https://help.aliyun.com/zh/document_detail/2510232.html)
- [产品规格](https://help.aliyun.com/zh/document_detail/2636861.html)

## 最佳实践

- [打造基于专属知识的问答服务](https://help.aliyun.com/zh/document_detail/2510235.html)
- [从 0 到 1 实现语义搜索](https://help.aliyun.com/zh/document_detail/2510234.html)
- [玩转多模态检索](https://help.aliyun.com/zh/document_detail/2510236.html)

## 常见问题

- [常见问题](https://help.aliyun.com/zh/document_detail/2510238.html)

模块概览

DashVector 功能按模块组织。

模块

介绍

操作方式

Cluster 管理

创建、升配、释放 Cluster

控制台

Collection 管理

创建、描述、获取、统计、删除 Collection

控制台、SDK、HTTP API

Partition 管理

新建、描述、获取列表、统计、删除 Partition

控制台、SDK、HTTP API

向量管理

插入、检索、分组检索、更新、获取、删除向量

控制台、SDK、HTTP API

常见错误及排查

code

reason

描述

排查方法

-2021

InexistentCollection

Collection 不存在

确认 Collection 名称正确,确认 Collection 未被删除

-2999

InvalidArgument

参数不合法

检查请求参数是否符合要求(类型、长度、必填等)

-2980

TokenDontExist

API_KEY 无效

确认 API_KEY 配置正确,在控制台检查 API_KEY 状态

-2019

MismatchedDimension

向量维度不匹配

确认插入/检索的向量维度与 Collection 创建时指定的维度一致

-2022

InexistentPartition

Partition 不存在

确认 Partition 名称正确,确认 Partition 未被删除

-2009

InvalidQuery

无效的查询请求

检查查询条件是否正确,是否符合查询规则