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: retrieves-a-vector-store-file
|
|
title: "Retrieves a vector store file."
|
|
description: "Retrieves a vector store file."
|
|
sidebar_label: "Retrieves a vector store file."
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWt1u2zgWfpUDXs0UipMWnZ2p77JNZifYdhIk6QKLJDCOpWOLLUWqJOXEE+gZ5n6u9jH2efYF9hUWh5Rs2VKaZKc3BdybOjJ5fr/v4498Lyy50mhHTozvxauDA/4vI5daWXpptBiLQ/gHpd7YC28s/SwVnU4/UurBUmnJkfZSz8HnBDOpaCQSkRrtSXu2hGWpZIpsaf+jY3P3wqU5Fcif/LIkMRYm2BOJKK0pyXoZg5FZZ4zzVuq5SLZi+6Dl54pAZhzGTJKFmbGrYESdtMYHLc2wUl6MxSLkN3Gc4ChM3PbTpMwmOs4SQHWLSwfXfRPXgr2j91ZOKx8z2s4Xs0yyA1RnG5kbTaczMb5azdCVUqJOVn9PjVGEuvtIV8WUbPdJk2jnCVqLy+6DJpL6pt5O+O+03FugqgjWKQA6Z1KJnjK4lT7fqHOaV/qT1POJ8xY9zZeDiTzQ6vhtv0Wp0Y4bhJU3Gx1bPejGfNF4Dm3q9IYHX4uADP5YoJcptPGKun6oETNUjhJh6XMlLWVifBUDvEmEl15xpB1mvG0MtlEcDoV42PMPbb1CfBFGEGAUSutGA/16bvmcZ5cbBew8ekoJ4/CmiPGPTgWT1lxPO94aPZPzygYFgBItFuTJuhVNt2ytqiGSR3IOMyZmQVZhOfHmE+kux6T2NCfbzfn1wcF2ur8G0oCZQTQA3kBjEqbkb4k0YPYRU9I+xug42wLvJtG/k7/Rk5z/1Hf+Hu9kURWgt4MoyUZnCRSV8zClVTAvDw4AdQavD9785XnIHazXQ6k8DeEXoXexxf8HjVaoeY63AcQ+QKegUGmLv6miDvxGor5JRCbZUCE1emO5fQ3Clr9iwcE0URZYlgxzXs6Y048uXDs1+6KadcRiJ2s7WdvJ2teUtbq3k1thv3KURaCXSvqNXTtI7U0HCakl3uVN0D/Q/q6DS1mQ81iUcJuTXtu8RQeYZZQx/PhpVw7Yi0LnJ2RtFN9No9+dlrHk38MxjwCpZ8YWkXByFj2U1qTkHGcyQ6koe5xeJqPBjWlfXMguyDbh9XfV64Fc3YmShfQTukuJMsri6rKRT0yC3YPUWTgSNfUPZwozCxlUsTAFOYfzQe3btPpLVaDes4RZQEIIFprZEIdOV31u7T+LXlyvdUDDkOYz4Tt0/ripVSBA5QZks7KWJafTtzg0qER7mEie0J3UFKUiz6X+QmuknpTWzC0598VxKeqUlHrEWgOx+uEiXMS860RUXK7JdLl58BsQ0J58sjHunisxpcjZ6RJ8Ll3LVIhm62Tj0Dl5ynH55Kit9MbSzAd2lDoipXH0PJxIpt76XLs+9Q4dDDf0ZYWWzaL1k3u47Ket360ze0n68KS5vIAwGng4xDiDWNaJeD1053GZE3B+5HzQMakXqGQGTC9UrERBbL7STceaL49I7S+Xl2ctZQI161VRHmt9FKAwOAEElxvrwVVFgXbZgiLqx20u0xxkTNpK1D5uNnXzffATlhmPUj3VcxzNrpXRc7KQb2pXZ85GOOxJaueZoo/76iwbh/Dh/F2TTIqatxuBTd6AJW8lLQgKxkR3ZcGpqXzcwZWUyplMwaRpkK2UtuJ6Dj9WGI/dWhWvA+qonsPFay/pYGZNEWI4PDsZwbmp5rnivbZS5tbB+c9v4cefDn4Mu2y6Q9bILr7CVrH191fM4DxCfB3PE5HfMOfVm2HmpEqyzOfogO8HwRsDBepla5itAsJcLngjWphK+1BbWdCOVDtSfWOkevVm7e/SGHjPSG+Y5brU+qepIMcFQbtPDE55UYSwfxzBmSJ0BN4uAecoNSj0ZNuV6oeHVqq4VwXSKVOJLGUMrErTXUkp39ZSU4YdtXbU+oao9UN3vTphZGtUcBHRvvbf0OuwD/m2GNkITisLnrAIq9KULx20CW9xspZeqz157wXYFwzvSLUj1bdFqoMhb0+gUGAJQw3njrOJ56qTU9G76zhvKusA+1fA/IJ4fWMVDvk6XrdvH/i45WIsSvR5/84pJ3jKYba5iuq0m/2vm+JtRUmfou2rU74OaKJjO8+L6s95DlUtLaV8UG6HF+Rzk4mxmFMQEA5iLPYXL/dNSRolf+qW0e3fb1W13g/38Pv3TT41H8CDoMZeVJZxkHtfjvf3US/3cuM8ZXtKYYF7zmP6aZSaItyCOEorK/0yTDxq1fPqhr9jPoW0Gqi94/lwwfPhomFVZNseHK3yZETHs791saSLlwNVZllyGwTFrmR0ffkcw33TQmbkrjVs/UNwFM4epLPSSO1duIf2OUm+rbORcxmDieXYzjAlF42ipWtGmjI2CErf+JTPUIoWFC50YlTvTUbKja71tX7x4j9//Ou///4djo7Pzo/fHl4eH714MYZ3NMd0GSoRHRW4ZN2yVJgFZXx0mlW+sgz7UCU3gg+sCnxCk/PmnYSlGTV6pdUyaEFpnC8wrEkNph8l6kbh79cr3eMzGzh7uvP7pUKpw62YDStFhO1V7G0ELvf85dalDwNh3BeFgF/+qmXkTSIYpGzx/n6Kjj5YVdf8+HNFltF5k4iwiE0Zilf3/OKPP2crlX4wz+/OG8J+D39Ocgbr0f4sQ/OdWPi1hRgLkYhPtBzQQxajrxD5V4qurX747UhOmJENtY3fHqYplb4zr7czYpFYydnfji9FXf8P3C3nSg==
|
|
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 file."}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
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.
|
|
|
|
:::
|
|
|
|
Retrieves 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 retrieve.","required":true,"schema":{"type":"string"}},{"name":"file_id","in":"path","description":"The ID of the file to retrieve.","required":true,"schema":{"type":"string"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"A VectorStoreFileObject representing the 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>
|