TRAE-AI编程
OpenAI 更新向量存储文件属性接口
更新向量存储文件属性
post /vector_stores/{vector_store_id}/files/{file_id}
更新向量存储文件的属性。
路径参数
vector_store_id: string：此请求涉及的向量存储 ID。
file_id: string：此请求涉及的文件 ID。
请求体参数
媒体类型为 application/json。
attributes: map[string or number or boolean] or null
可附加到对象的一组16个键值对，可用于以结构化格式保存额外信息，并通过API或控制台查询对象。键为最长64个字符的字符串；值可以是最长512个字符的字符串、布尔值或数字。
string（最长 512 个字符）
number
boolean
返回值
VectorStoreFile object { id, created_at, last_error, 6 more }
附加到向量存储的文件列表。
id: string
标识符，可在API端点中引用。
created_at: integer（Unix 时间戳）
向量存储文件创建时的Unix时间戳，单位为秒。
last_error: object { code, message } or null
与此向量存储文件关联的最近一次错误。没有错误时为null。
code: "server_error" or "unsupported_file" or "invalid_file"
可为server_error、unsupported_file或invalid_file。
"server_error"
"unsupported_file"
"invalid_file"
message: string
供人阅读的错误描述。
object: "vector_store.file"
对象类型，固定为vector_store.file。
"vector_store.file"
status: "in_progress" or "completed" or "cancelled" or "failed"
向量存储文件的状态，可为in_progress、completed、cancelled或failed。completed表示该向量存储文件已可使用。
"in_progress"
"completed"
"cancelled"
"failed"
usage_bytes: integer
向量存储总用量，单位为字节。注意，此值可能与原始文件大小不同。
vector_store_id: string
attributes: optional map[string or number or boolean] or null
可附加到对象的一组16个键值对，可用于以结构化格式保存额外信息，并通过API或控制台查询对象。键为最长64个字符的字符串；值可以是最长512个字符的字符串、布尔值或数字。
string（最长 512 个字符）
number
boolean
chunking_strategy: optional StaticFileChunkingStrategyObject or OtherFileChunkingStrategyObject
用于对文件分块的策略。
StaticFileChunkingStrategyObject object { static, type }
static: StaticFileChunkingStrategy
chunk_overlap_tokens: integer
相邻块之间重叠的词元数，默认值为400。
注意，重叠量不能超过max_chunk_size_tokens的一半。
max_chunk_size_tokens: integer（范围为 100 至 4096）
每个块的最大词元数，默认值为800，最小值为100，最大值为4096。
type: "static"
固定为static。
"static"
OtherFileChunkingStrategyObject object { type }
分块策略未知时返回此类型。通常是因为文件在API引入chunking_strategy概念之前就已建立索引。
type: "other"
固定为other。
"other"
示例
## [中文] 发送POST请求；将示例API凭证及资源标识替换为应用使用的值。
curl https://api.openai.com/v1/vector_stores/$VECTOR_STORE_ID/files/$FILE_ID \
-H 'Content-Type: application/json' \
-H 'OpenAI-Beta: assistants=v2' \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d '{
"attributes": {
"foo": "string"
}
}'响应
中文说明：以下为原文配置、命令或事件示例，字段名、枚举、标识符及数值保留。
{
"id": "id",
"created_at": 0,
"last_error": {
"code": "server_error",
"message": "message"
},
"object": "vector_store.file",
"status": "in_progress",
"usage_bytes": 0,
"vector_store_id": "vector_store_id",
"attributes": {
"foo": "string"
},
"chunking_strategy": {
"static": {
"chunk_overlap_tokens": 0,
"max_chunk_size_tokens": 100
},
"type": "static"
}
}示例
## [中文] 发送POST请求；将示例API凭证及资源标识替换为应用使用的值。
curl https://api.openai.com/v1/vector_stores/vs_abc123/files/file-abc123 \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"attributes": {"key1": "value1", "key2": 2}}'响应
中文说明：以下为原文配置、命令或事件示例，字段名、枚举、标识符及数值保留。
{
"id": "file-abc123",
"object": "vector_store.file",
"usage_bytes": 1234,
"created_at": 1699061776,
"vector_store_id": "vs_abc123",
"status": "completed",
"last_error": null,
"chunking_strategy": {
"type": "static",
"static": {
"max_chunk_size_tokens": 800,
"chunk_overlap_tokens": 400
}
},
"attributes": {"key1": "value1", "key2": 2}
}
更多建议：