mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-12 20:12:33 +00:00
72 lines
10 KiB
Text
72 lines
10 KiB
Text
---
|
|
id: updates-a-vector-store
|
|
title: "Updates a vector store."
|
|
description: "Updates a vector store."
|
|
sidebar_label: "Updates a vector store."
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWc1uIzcSfpUCT8mgLXsGyWajm2M7WAOT2LA9Cyxswyixq9XMsMkeki1PQ9Az5L6nPEaeZ19gX2FRZLfU+vHPYHJYA9bFUpus3++rIqvnwpGvrfHkxXgu3h0c8J+cvHSqDsoaMRaH8E+SwbrLYB2dTX4jGcBR7ciTCcpMIZQETZ1joBxmcSl4XjsSmZDWBDKBpWJdayWRpe7/5ln0XHhZUoX8LbQ1ibGwUb7IRO1sTS6oZJjKB2t8cMpMRbZh5wejPjUEKmezCkUOCuuicUOjxCLrleyUWGCjgxiLtOcu7dlU1UWBdw/0ZYD6HlsPN2u7bwTrlI44QHc41KtMoCm5LflXqiIfsKrhviSz5QPco4dOIMs2WNHT8fnmLH5D/S38ihWBLXYGp/E4pbtJG1Lkd1jahehgUwEDBKcEvkZJ0HjKYdJuG68MJOmLTBRK0520jQl+G3g/K01QOyvJe8aZDxgaD2n57uRmT+BI2qrWxGF7Ogm/NtWEHIeJrfQQSgxQ4oxgQmTAN5INKxqt297KlA6JRpLWX6MkZ9eUG3q/kspxQ/UV8tNuCLaXzyKVuaudnTr++eVyZeMcmaBbmBBbuxaQYAPq58Ce14HZEK22CSAWi0xgnqsE6PNBjgvUnjLh6FOjHIfoepD0YW6WQVx3vbf2NhNBBc3mDsofQ/IowXWRiQTIx+vIUPm6t0cpZD2sH6Ajfa6VI3+HRSC3q1DuDsNcWENnhRhfL3eYRmuxyJa/J9ZqQjN8lEI/fNJ5NHiCzmE7fNBZsrhdPFJxTtiNWPuhtlrJ9sHivHT4OYVyoOHJmqm0hiSc1Wj04Q5lUDP6ClW2ABYEUZAKLdhdYM1ERQFzDDs73f9xAi8psIsfqd2boW4IalSuKyISDUwIMASUZaomX0dTxRRZRmXQL9d70nrTWJJwEOPd1D3rJW+08prM4Wl3xIG4EpIRI7FYsAPf7ToUXZUEbDz5ELuxMjPUKgfroEJdWFelcvPXHH+2Cs1DIP3H1dX5qk/mEXtdLJ46Hpw4x4zkxRkg+NK6AL6pKnRtX5worrkvlSxBJaedQhMimdF0/496IpYCKv1czWk1q9bWTMlB2VRo9hxhjhNNMNizZk7qXT5wYf+iQ9AhfLh43znTgTmeWYIFR8EpmhFU6cDC+UzFCye2CVG5r0mqQkmwMjU/SRt2fQn4lyhO2VoGb4DlGKYHgtef4qFwtoo2HJ6fjuDCNtNSc63V2t57uPj5CH74+8EPo1RokVvTEF/fHRys9P2EOVwkiK/seSbyO+a8+3E3c6RW3PlK9MCXCAjWQoWm7QXHpo8wVTMygBVTPcZWVfRKqldSvTBSvftxpe/KWviFkd4xyw+p9S/bpAsGfZZEOcVbADgMBFpVKozgXBN6guBawCkqAxoDub5Tff9Qp/LkZuSATOya5ChnYDWGPtck+dpOXRheqfVKrRdEre+H/eqUkW1Qw2VC+0p/R6/Dbcj3wchHcNY4CIRV7Erxhm9snOvkPb2Wl7qtCdkjgl9J9Uqql0Wqg13ankGhyBKGGk49e5OuVKdnbP7GpDYOiz3g1ri4RocVBXI+XnzTYHNtmnqn0sRGjEWNodyeIZUEp8e7pimc0zSmZk2ruAfXULbNwv7ivLhNi8mHn2zepiniX0Lo541t2SHzwLx29NInROwc7RwNbWLjxQ9R3v7t2XMUNIMRxBP1o6cqzzFQJWYNph79BS4ycx3z0dDakYyvEToaVBRKmzO5bLz2RY6Nxf7s7b6NGvjbkI9+f75BzwUPZWILTiRuHFeOMoR6vL+Ppt0rrQ+U72mNFe75gPLjSNpKMNE8ycap0MaNx32/vb7l/zG9LlZEPFlVrq5MLAm0yYh17CxiryhshFEXvfdsC1yyLXDZ1fQEyT04XgaJ6ymXZ3Yt5Xb2dgdfuSn6tfaAw4Y11BURUDs7Uzn5GwMbHwSfwEMmr63i1x5o+ncD0rpU8XMeuPNhwBUo+xk/OroxXLWti6DaFj7hG7ymGcWXNsmqX2xO2o9uzI158+Y///7jv3/+Dscn5xcnR4dXJ8dv3ozhPU1RtjESSVGFPPMHR5WdUc4X96IJjeNCFaPkR/CBexLPB9S0I7qjgrpuaXQb2c2Aq9AM8vlwm1iL+KAeP7Klo2mgz2G/1qhMfNfl4skkgfw6ZTPBnLP8NqZ6AHWRifFmL7rNBOOZt8/nE/T0wenFgh9/asgxkG8zEU9IE0ba9VzkyvP3fEnhB7355qIj7Lfw3La2082+ZpmWPeICJMZCZOIjtTu6ayxhJWHO3Lmed6uOklV7VyxrJWWr/3FJTDsOpaQ6PLr2dlBwzs8ur0QmJl2PrfjgOhYO77lZ432y2MYoxcoen82FRjNtcMprk0z+/A+FONUk
|
|
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."}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"post"}
|
|
path={"/v1/openai/v1/vector_stores/{vector_store_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.
|
|
|
|
<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 to update.","required":true,"schema":{"type":"string"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the vector store."},"expires_after":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The expiration policy for a vector store."},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Set of 16 key-value pairs that can be attached to an object."}},"additionalProperties":false,"title":"OpenaiUpdateVectorStoreRequest"}}},"required":true}}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"A VectorStoreObject representing the updated vector store.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the vector store"},"object":{"type":"string","default":"vector_store","description":"Object type identifier, always \"vector_store\""},"created_at":{"type":"integer","description":"Timestamp when the vector store was created"},"name":{"type":"string","description":"(Optional) Name of the vector store"},"usage_bytes":{"type":"integer","default":0,"description":"Storage space used by the vector store in bytes"},"file_counts":{"description":"File processing status counts for the vector store","type":"object","properties":{"completed":{"type":"integer","description":"Number of files that have been successfully processed"},"cancelled":{"type":"integer","description":"Number of files that had their processing cancelled"},"failed":{"type":"integer","description":"Number of files that failed to process"},"in_progress":{"type":"integer","description":"Number of files currently being processed"},"total":{"type":"integer","description":"Total number of files in the vector store"}},"additionalProperties":false,"required":["completed","cancelled","failed","in_progress","total"],"title":"VectorStoreFileCounts"},"status":{"type":"string","default":"completed","description":"Current status of the vector store"},"expires_after":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) Expiration policy for the vector store"},"expires_at":{"type":"integer","description":"(Optional) Timestamp when the vector store will expire"},"last_active_at":{"type":"integer","description":"(Optional) Timestamp of last activity on the vector store"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Set of key-value pairs that can be attached to the vector store"}},"additionalProperties":false,"required":["id","object","created_at","usage_bytes","file_counts","status","metadata"],"title":"VectorStoreObject","description":"OpenAI Vector Store 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>
|