mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-11 19:56:03 +00:00
72 lines
9.2 KiB
Text
72 lines
9.2 KiB
Text
---
|
|
id: retrieves-a-vector-store
|
|
title: "Retrieves a vector store."
|
|
description: "Retrieves a vector store."
|
|
sidebar_label: "Retrieves a vector store."
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWNtuGzcQ/ZUBn5JgLTtBgjZ6c2OnNZDEhu0UKGzDGHFHWiZcckNyZS8EfUPf+9TP6Pf0B/oLxZC78uriS5A+NID9YmlFzuXwnJnlzIQjX1njyYvhTLzY2eF/OXnpVBWUNWIoduFXksG6k2AdHY4+kQzgqHLkyQRlJhAKgmlcAp7XDEQmpDWBTGBrWFVaSWRr2588m5wJLwsqkT+FpiIxFDbaFZmonK3IBZUCUnlvjQ9OmYnIVuL7aNSXmkDlHM5YkYOxdWtBiXnWOdlocYy1DmIo0p7LtGfVVZs97+75ywD1FTYezpd2nwv2KR1hoPwS+36VCTQht2b/VJXkA5YVXBVk1nKAK/TQGmTbBku6H58nh/ET6qfwAUsCO94ITu1xQpejJiTkN0TaQrSz6oCJgRMCX6EkqD3lMGrWg1cGkvV5JsZK06W0tQl+nXBvlSaonJXkPfPLBwy1h7R88+Fm9/BI2rLSxLDdfwgf6nJEjmHiKD2EAgMUOCUYERnwteTAxrXWTRdlOg6JRpLW3+Ik59SU62d/Y5VxQ/UN9tNuCLazzyaVuaycnTj++vV2Ze0cmaAbGBFHuwRIsAH1Q2jP68CsmFbrAhDzeSYwz1Ui9FHvjMeoPWXC0ZdaOYborHfo/bNZgLicehftRSaCCprD7ZU9puSbRNd5JhIh764jfefL2b5JkHW0vkWOdF0pR/4Sx4HcpkK5GYaZsIYOx2J4tthhaq3FPFt8H1mrCU3/UYK+/6TNqPcEncOm/6CNZH4xv6Pi7HMasfZDZbWSza3FeZHwQwplz8O9NVNpDck4u9HowyXKoKb0Da7sGNgQREMqNGA3kTUTJQXMMWzsdP/jAzyhwCl+pmZriromqFC5tohINDAiwBBQFqmafJtMFUtkgUqvXy73pOWmsRBhD+PN0j3sLK+08orM7kH7agNxJaQgBmI+5wRebnoZOi0IOHjyIXZjZaaoVQ7WQYl6bF2Zys1/8/qzVmhuI+kvp6dHN30yj9xrsbjv9WDfOVYkL84AwRfWBfB1WaJruuJEcc1VoWQBKiXtFJoQxYym/T36iVwKqPRDPafV7FpbMyEHRV2i2XKEOY40QW/PUjipd/nAhf2rXoJ24ePxuzaZlszxnSVYcBScoilBmV5Y+DxT8cKRrUN07iuSaqwkWJman6SVuL6G/AsWp9NagNfjcoTpFvC6t3cYO1vGGHaPDgZwbOtJobnWam2vPBy/fQM//LjzwyAVWuTW1OfXy52dG38/YQ7HieI38TyQ+a1yXrzerBypFXe+Aj3w5QGCtVCiaTrDsekjTNSUDGDJUo/YqpIeRfUoqu9MVC9e3/g7tRbeM9NbZfm+tH6zdbpg0LUkyineAsBhINCqVGEAR5rQEwTXAE5QGdAYyHWd6tVtncqTm5IDMrFrkqOciVUbuq5IBspbcB+l9Sit70par/r96oCZbVDDSWL7jf9WXrvrlO/AyAdwWDsIhGXsSvGGb2yc6+SdvBaXurXJ2B2GH0X1KKrvS1Q7m7w9QEJRJUw1nHjOJl2pDg45/OVwj1tkPeDawLhChyUFcj5efdNoc2meeqnSzEYMRYWhWJ8iFQQHe5vmKf1TZV832AdXU7auxO7yPI8pVI5kHLm2y0sKhc3FUEwoqpWDGYrt6fNtW5FBxZ/6gfvt2Uoec76/xmqVsq0dg1yEUA23t9E0W4X1gfItrbHELR9Qfh5IWwqOx5OsnQpN3LjXlaazC/6NyRrTaM/xHe+HE94PJy1lE5W3YG+RF9OF2cfhJCinzzegy5r3S+zHvh77vuKgoHJ2qnLy5wZW/hB8GjCQySureKqLpht9SusSoXOeJ3Ktc2OU3QgTHZ0bJqV1Ua3rxkd8QdE0pTiTTlG9tzlpPzg35+bZs7//+POfv36Hvf2j4/03u6f7e8+eDeEdTVA2EYnkqEQeaYKj0k4p53vJuA61Y2JFlPwAPrLk+PqjJu2Iy9GY2mJgdBOFVlkfSowFv+X0XSpYwnx200Hu3NSSNtB12K40KhPH+S4W30TOs3SiiZ580s/jcfcoKjIxXBXbRSaYh7x9Nhuhp49Oz+f8+EtNjgl4kYnYBEbMtrOZyJXnz/miyt2az5PjVoNP4eG63ZhoN90yDefE0yoxFCITn6nZUEDisKsgzHmoejZrV+1KSVXo7V/r16yuhe5/3j8V8/m/NceRPQ==
|
|
sidebar_class_name: "get 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={"Retrieves a vector store."}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
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.
|
|
|
|
:::
|
|
|
|
Retrieves 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 retrieve.","required":true,"schema":{"type":"string"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"A VectorStoreObject representing the 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>
|