mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-11 19:56:03 +00:00
72 lines
12 KiB
Text
72 lines
12 KiB
Text
---
|
|
id: updates-a-vector-store-file
|
|
title: "Updates a vector store file."
|
|
description: "Updates a vector store file."
|
|
sidebar_label: "Updates a vector store file."
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWs1u4zgSfpUCTzMNxUk3enamfcskGUxjuydBfhZYJIFRlsoWOxSpJiknnsDPsPc9zWPM8+wL7CssipRsyVb+dnJpwLnEkan6/74ii7kXllxptCMnhvfi3d4e/8rIpVaWXhothmIf/kGpN/bMG0u/SEXH4y+UerBUWnKkvdRT8DlBVWboKYOJVDQQiUiN9qQ9S8SyVDJFlrj7xbHYe+HSnArkT35ekhgKE+SKRJTWlGS9jEbJrLXGeSv1VCRrNl5o+bUikBmbM5FkYWJsMIqNEYukEd4raYKV8mIoZsHPkWNHB+HFdT216yyipSwBVLc4d3C1KeJKsHb03spx5aNH6/5ilklWgOqk47nRdDwRw8vlG7pSSiyS5d9jYxShbj/SVTEm235SO9p6gtbivP2gtmRxvVh3+O8035mhqghWLgA6Z1IZcn0rfd6Jc5pX+kbq6ch5i56m815HHkh1/HYzRanRjhOElTedjC0ftG0+qzWHNLVyw4uvRKgM/liglyk09orF4qFETFA5SoSlr5W0lInhZTTwOhFeesWWthByUAtsrNjvM3F/Qz808Qr2xTKCUEYhtG7Qk6+Xhs95VtkJYOvRc0IYl9dBjH+0Ipg04jY45MDoiZxWNjAAlGixIE/WLWG6JmsZDZE84XN4Y2RmZBWWI29uSLcxJrWnKdm2z+/39tbd/S2ABswEogDwBmqRMCZ/S6QBsy+YkvbRRsfeFng3ivqd/J2epfynTeWf8U4WVQF63YiSbFSWQFE5D2NaGvN2bw9QZ/B+78PfXla5vfF6yJXnVfhZyF1M8f8Bo2XVvERbT8U+AKfAUGlTf2NFrfIbiMV1IjLJggqp0RvL6asrbP4bFmxMbWWBZcllzu2MMf1k49qy2aNs1iKLLa1taW1La69Ja4uNndyy9ivHe3Qu9FJJv9y9My5Bam9alZBa4l3eCP0D6W8rOJcFOY9FCbc56ZXMW3SAWUYZlx8/bdMBa1Ho/IisjeTbFfrdcRlD/j0c8QqQemJsEQEnJ1FDaU1KzrEnE5SKsqfhZTLq3ZhukgvZGdnavM1d9WohR3ekZCH9iO5Sooyy2F06/kQnWD1InYUjUR3/cKYwk+BBFQNTkHM47eW+rtRfqwL1jiXMQiUEY6F+G+LS8TLPjfwXwYvjtTKov6T5bPgJnT+qYxUAULke2qysZcpp5S0uDSzRHCaSZ2QnNUWpyHOoH0mN1KPSmqkl5x5dl6JOSaknpNUltng4CGfR70UiKg7XaDzvHvx6CHSDPlkYZ8+VmFLE7HgOPpeuQSpEsYukc+gcPee4/PGwiXSnNfOBHaWOlVIrelmdSIbe6ly7OvX2HQw7/LKslm7QNp17OOzHjd61M3tJev9jPcSAsBp4OUQ7A1kuEvG+b/ZxnhOwf+R84DGpZ6hkBgwvVMxEgWxeadKxwssTVPvr+flJA5kAzcUyKE+lPhJQWJwAgsuN9eCqokA7b4oi8sdtLtMcZHTaStQ+bjZ1/X3QE9qMR6meqzmuZtXK6ClZyLvc1XqnYw5rktp5hujTulptYx8uTj/VzqSoebsR0OQNWPJW0oyg4JpodxYcm8rHHVxJqZzIFEyaBtpKac2ul+BjWeMxW8vgtYo6smd/8JphHUysKYIN+ycfB3BqqmmueK+tlLl1cPrLAfz4096PYZdNd8gc2a6vsFVs9P2MGZzGEl/Z88zKr5Hz7kM/clIlmeZzdMBzQvDGQIF63ghmqYAwlTPeiBam0j7EVha0BdUWVN8YqN59WOk7NwY+c6XXyHJtaP3TVJDjjKDZJwal3BQh7B8HcKIIHYG3c8ApSg0KPdmmU/3wUKeKe1UgnTKUyFLGhVVpuisp5Wkt1WHYQmsLrW8IWj+0+9VHrmyNCs5ita/01/Da3yz5JhjZAI4rC56wCF1pzEMHbcItTtbAa7kn37gIe0TwFlRbUH1boNrr0/YMCAWUcKnh1LE38Vz18VhszDouwn2wA9wcAPP18GpeFY74Og7b1497nHAxFCX6fHPilBM85yhbD6K8qa+oWfsqId5WlGzCs7k25VFAbRtLeZlNf0XvdVxMzv9ssnmcWr0Kw3yzl9HnrX8yuOm7mPamTn/nWnrwMni2wtNCJE8RUMaSXps7NKenAItufoMLpaWUbW5SXpDPTcYFZMKZK9TRUOzO3u6aoIU/tXHgdu/XYLHYDdcou/d1SS54fhL6YQRTZRnGufflcHcX9XwnN85TtqMUFrjjPKY3g9QUYYjlKK2s9PPw4mHT/C6v+TsurdNVER6taKRTRIvAy5N4J1YH7BOrgjNWBWc1f0Ze3YHDZUyYu+KUx7qY5NnbHkxxA3IdKsZ2c2jr8jmGyeJMZuSuNKz9IDgKp0zSWWmk9i7cOPicJM9lbWTXjImDG6+dYMqFxULR0hWzijI2tI5N4WM+LSuaURjdRas+m4yUG1zpK/3mzX/+/cd///wXHB6dnB4d7J8fHb55M4RPNMV0HiIRFRU45w5lqTAzyviQPKl8ZZniQpTcAC6Y//ksLqf17ZOlCdWdSat5YH2urwIDN9QM9gQld8Le4pun3quR6+nO75YKpQ6zTxv2A7G6L2NeY31zvt+ujfa4CIab5B/KnL9quPc6EVzLLPH+foyOLqxaLPjx14osF/F1IsJWZcxleHnP17v8OVuC/UEvvzutwfs9/JXW0huNhu00zz0DcYmhEIm4oXlP12M6fAW7X8W2JvKBkHPCjGyIa/z2IFqxcx7vvJq3N/oTexTf2E9TKv2ja69bJHlyfHYuEjGue2ARbm6ExVtupngbLTUhKqFPhWf3QqGeVuHyRESZ/PM/nKi/pg==
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
|
|
custom_edit_url: null
|
|
---
|
|
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import ParamsDetails from "@theme/ParamsDetails";
|
|
import RequestSchema from "@theme/RequestSchema";
|
|
import StatusCodes from "@theme/StatusCodes";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
import Heading from "@theme/Heading";
|
|
|
|
<Heading
|
|
as={"h1"}
|
|
className={"openapi__heading"}
|
|
children={"Updates a vector store file."}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"post"}
|
|
path={"/v1/openai/v1/vector_stores/{vector_store_id}/files/{file_id}"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
:::caution deprecated
|
|
|
|
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
|
|
|
|
:::
|
|
|
|
Updates a vector store file.
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={[{"name":"vector_store_id","in":"path","description":"The ID of the vector store containing the file to update.","required":true,"schema":{"type":"string"}},{"name":"file_id","in":"path","description":"The ID of the file to update.","required":true,"schema":{"type":"string"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The updated key-value attributes to store with the file."}},"additionalProperties":false,"required":["attributes"],"title":"OpenaiUpdateVectorStoreFileRequest"}}},"required":true}}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"A VectorStoreFileObject representing the updated file.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the file"},"object":{"type":"string","default":"vector_store.file","description":"Object type identifier, always \"vector_store.file\""},"attributes":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Key-value attributes associated with the file"},"chunking_strategy":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"auto","default":"auto","description":"Strategy type, always \"auto\" for automatic chunking"}},"additionalProperties":false,"required":["type"],"title":"VectorStoreChunkingStrategyAuto","description":"Automatic chunking strategy for vector store files."},{"type":"object","properties":{"type":{"type":"string","const":"static","default":"static","description":"Strategy type, always \"static\" for static chunking"},"static":{"description":"Configuration parameters for the static chunking strategy","type":"object","properties":{"chunk_overlap_tokens":{"type":"integer","default":400,"description":"Number of tokens to overlap between adjacent chunks"},"max_chunk_size_tokens":{"type":"integer","default":800,"description":"Maximum number of tokens per chunk, must be between 100 and 4096"}},"additionalProperties":false,"required":["chunk_overlap_tokens","max_chunk_size_tokens"],"title":"VectorStoreChunkingStrategyStaticConfig"}},"additionalProperties":false,"required":["type","static"],"title":"VectorStoreChunkingStrategyStatic","description":"Static chunking strategy with configurable parameters."}],"discriminator":{"propertyName":"type","mapping":{"auto":{"type":"object","properties":{"type":{"type":"string","const":"auto","default":"auto","description":"Strategy type, always \"auto\" for automatic chunking"}},"additionalProperties":false,"required":["type"],"title":"VectorStoreChunkingStrategyAuto","description":"Automatic chunking strategy for vector store files."},"static":{"type":"object","properties":{"type":{"type":"string","const":"static","default":"static","description":"Strategy type, always \"static\" for static chunking"},"static":{"description":"Configuration parameters for the static chunking strategy","type":"object","properties":{"chunk_overlap_tokens":{"type":"integer","default":400,"description":"Number of tokens to overlap between adjacent chunks"},"max_chunk_size_tokens":{"type":"integer","default":800,"description":"Maximum number of tokens per chunk, must be between 100 and 4096"}},"additionalProperties":false,"required":["chunk_overlap_tokens","max_chunk_size_tokens"],"title":"VectorStoreChunkingStrategyStaticConfig"}},"additionalProperties":false,"required":["type","static"],"title":"VectorStoreChunkingStrategyStatic","description":"Static chunking strategy with configurable parameters."}}},"description":"Strategy used for splitting the file into chunks"},"created_at":{"type":"integer","description":"Timestamp when the file was added to the vector store"},"last_error":{"description":"(Optional) Error information if file processing failed","type":"object","properties":{"code":{"oneOf":[{"type":"string","const":"server_error"},{"type":"string","const":"rate_limit_exceeded"}],"description":"Error code indicating the type of failure"},"message":{"type":"string","description":"Human-readable error message describing the failure"}},"additionalProperties":false,"required":["code","message"],"title":"VectorStoreFileLastError"},"status":{"description":"Current processing status of the file","oneOf":[{"type":"string","const":"completed"},{"type":"string","const":"in_progress"},{"type":"string","const":"cancelled"},{"type":"string","const":"failed"}],"title":"VectorStoreFileStatus"},"usage_bytes":{"type":"integer","default":0,"description":"Storage space used by this file in bytes"},"vector_store_id":{"type":"string","description":"ID of the vector store containing this file"}},"additionalProperties":false,"required":["id","object","attributes","chunking_strategy","created_at","status","usage_bytes","vector_store_id"],"title":"VectorStoreFileObject","description":"OpenAI Vector Store File object."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|