mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-05 04:17:32 +00:00
68 lines
14 KiB
Text
68 lines
14 KiB
Text
---
|
|
id: list-files-in-a-vector-store
|
|
title: "List files in a vector store."
|
|
description: "List files in a vector store."
|
|
sidebar_label: "List files in a vector store."
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWltv2zgW/iuEn3aAXJyiszPNW7bT7hSbTook3cWiKRxaoi22EqkhKSeeIP99zzmkJMqSHbvtzqCACwS1ZfJcv3O1H0ZG2FIrK+zo9GH0bDzG/1JhEyNLJ7UanY7O2L9F4rS5gj9xLq17LXNhL8M9lmjluFRSzZnLBMvhANMzNsNDR6ODEX4ulEO6vCxzmXCke/zJIvGHkU0yUXB85ZalAHZ6+gnYwcXS6FIYJ71o4XF7zjoDPOFcKma8yuGjEfKmB7H4F3SR4S0mU5BEzqQwB4znd3xp2Q3duhmNHuEid7Ek3Bi+BHrSicI+LaFMh6WLhXmv5O9VLAebaUN2Q3uhDNvouSB/TCw65Igu7qx0j4S3AHfAbVo5MagvT1OJDHj+rusbJS5mo9MPzQ1V5TmQa95Ptc4FV/EjVRVTYeInQdHoiXdA9CBI8vjxcVXhf4nl4YLnYNtWBcat1YnkTqTsTrqsY+ckq9Rn4AcmMHBivuwD/yp8wioLFNBRFvDrXA11JMWkcpoRMQsW6lliDVb8p30fQ7BY9DCvnO64vHkwKCCSiZyLh29GJDG+LCDiElYrPHp8XOfJGc+tOICU8HsljQA4f/ACfjwYOelylDRKBS8DwVqKsyERz3r8WW1wks/jkBEO65zRd/iu5rMOWXYMGD3axoT+eDCifxNZ8KAm18PMS61mcl4ZSnKs5IYXwgljmzhfodVYAyTbrDPdmOiFMDkvJ05/FioOUsChmENARTo/H49X1f2Nog7zsycA/7FAkk2FuxNCMZ5+4gmkjBrVoG3B7yeev5V/iK2Y/9xn/pbfy6IqmFoVArT0zA5YUUH5mIpGmJPxmHGVsufjF3/fDbmD9lqnynYIvyLfeRd/QRg1qNmF2wBi14QTpbikxt8UclMLPwgqYJpKJFRIxYEfui8gbPkbHAPSQcoC6jTCHCs2xvSTlW+fzTZmsyhZ7NPaPq3t09q3TGso7xZcqeUzAnvBCXdrfBzLcy0LAXoVJbvLwGFNv3fHoa9MU2gIAWP4NI555JJz6ybCGJ9hu0T/dlF6u/7AXuEJ6B4hgAofVdIPTQziIxHWohFmHB6kT8eQTsVgH97PIMIAcoJ4/d67PYhWm+RQK0CX+0QIUNiXkI4+XglkD5qkNNqF3pgmDxwDQYPKGwbsafl8MMF1qf5aFVwdgrNScjcJy8Jt5o9Omx68pr9TDKG9WoGGcYtT7jn48lWwFaG8sgO5sTIG80rkN3+UUkE9cgzMBj2jJ7oocwB2utE1Uk2A1RwGd7vxXMJVIvL8CWoBYo/rjXDl9QYLVGiuyXTZHQ8HsmQvRyIx9J4tIQf7eWoKxSmTtp6imCcLXOLRdLLNUP3ml9rSnfrbWUwERrvhRGLotdNvOxsPjY+d/NKgpWu0vnLrzX5R812Z7Euhzt6ElQyj0wyPMy8n9RvdG+dhI9NrTsIVMvpMGkhb21g7ymGt4el648pmD4TdQcnn2HDi5To7fjEbvL0Nl4zbSYH5uGVTryAilAaPd/n+JxNAmJoaMBOHv6Jp5hhfQLRQUpqKpYb6TcAqMYnsBKwGU7RxiuQdhkNv6dazVrONmxldkFWofJDQYCrecT5VTRD3+dC27xqsiqJC8aNaJ9WC5zJlmIJ5jtWKCtI32uq1OfWJcvzr9fW7Oq1S+m7L/lNI8kWKDkMnzGymjWO2KgpuljWwfI25y2SSMemVNpIrjy2uwufEh+ILEku+LWd/GlnnWoFuLOvWt+hORxzkJCFJYxrfKV7O2PvL86AMFAHsOynjQsNiBNwWiwDquPvgU10538qXIpEz6MV0klBpS8SKXLtAvcmD3luN8SKk+wo7bDzTATbKcPbuzRG71NU8y3HoynN9Z9nl65fsp5/HP1H6E/cc62iML5oZan7/4Cm79BBv5dkS+SFynr0Yjpwkl9gKQDwziy+c1nBZLWvCIRrncoETSaErRanZQbO5D6p9UH1nQfXsRcvvGpD+FpEeIsvGofVfXUFMgIXqWYKYYuPEaMY4Yu+gOINADtDD59C1QamHAa+uVD+uq1R+nmFgTgwlqNgpAqtS4h7sjXt/EcywD619aH1HofVjXK/eILJBcnbl0d7yD+F11od8bYz0iF1UgATBC6pKU9w+KU3fB6Z1eDUdce+r3w2E90G1D6rvK6jGQ9y2CCGKEoQan1vUxk9mby5GvX0Yjdprpy7AfbO5pD2Q8l+7rO4E0OPwuOQu668lQfk1+w7wbN7yR1Mhy9YNzlTgll5Q1l+745IoCEQ1uRYDqrlZbkYanWfaj+TtGjysF1CwKbbWrjIKE9I5HUdQGg6x0C7FaSV+AqmPXiCxkJkwHJ+Nu+oEmPX0qZNHrJA2KaWT7RS6wtxAV/ySSrDbdrVzS8263wwHLwQ9j9gtt8mtzxY2ESrFGdzTQX1ukaH/GF/Fn2+n2YCn+MztoNgZA0Bb7X90AtkAQdouTlB+JHeL1gbneLUQbS7jDl0hFQBrqaGelDnu8aIlzBdrMBUzXHx8MxU8vT9XB4i4Xdzwmo4jtmiVFQoafmWl8mWIkxDFzc9WQj6G3OSPPyHr975rxiOQKDMNyo3mgnoGTIeno+PFyTHUGsUlvopTpz1+WMmkj8dkRdzGUufks25lMOFnzpWnx8cwsRxm2oIdDvOcF/wQzJt8PgLrkJhWANykW9LFX+o26cNH/AwLJ+EiqHKO99kV3mdXoXz6jSSufY31OFicDOR07DZsp+7yuBOIKROOwScLCURuFFv5B62NoJUCpJdSQy60dS6V+EWN8aWUMg8mSjODGLCeKDfiBjfmuTbUJ/SJT3E1kkPnQLt8L9Vb6MNy/zV3CXaEpgZtEgLjqXrYscND208+eTEgzIl7dwxxLGnrS459CED54C3toYIeOFnZviMsTvul1yMG3IuoQDIPD1OYTN+b/PERH/voRjik0mLrlg4vkmNt/qpiOWilz2IZlXj6zRy8p7j9Io3+mmq5QbW62H+9av/nerlBh7qu/wk6fGXB3KBEU9q/XotvVTI3SNsU8Vbaj/gGRsAp5vfdIv4y1OYf2M4d+6CM9S9i1TKWsJZ9NY3RD2QzmC1BIRTcnzpLElHGQd8b2jtl95+vrqEQ/w+Zxzp5
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/llama-stack-specification
|
|
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={"List files in a vector store."}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v1/openai/v1/vector_stores/{vector_store_id}/files"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
List files in 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 list files from.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"(Optional) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.","required":false,"schema":{"type":"integer"}},{"name":"order","in":"query","description":"(Optional) Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.","required":false,"schema":{"type":"string"}},{"name":"after","in":"query","description":"(Optional) A cursor for use in pagination. `after` is an object ID that defines your place in the list.","required":false,"schema":{"type":"string"}},{"name":"before","in":"query","description":"(Optional) A cursor for use in pagination. `before` is an object ID that defines your place in the list.","required":false,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"(Optional) Filter by file status to only return files with the specified status.","required":false,"schema":{"oneOf":[{"type":"string","const":"completed"},{"type":"string","const":"in_progress"},{"type":"string","const":"cancelled"},{"type":"string","const":"failed"}],"title":"VectorStoreFileStatus"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"A VectorStoreListFilesResponse containing the list of files.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","default":"list","description":"Object type identifier, always \"list\""},"data":{"type":"array","items":{"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":{"description":"Strategy used for splitting the file into chunks","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."}}},"title":"VectorStoreChunkingStrategy"},"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."},"description":"List of vector store file objects"},"first_id":{"type":"string","description":"(Optional) ID of the first file in the list for pagination"},"last_id":{"type":"string","description":"(Optional) ID of the last file in the list for pagination"},"has_more":{"type":"boolean","default":false,"description":"Whether there are more files available beyond this page"}},"additionalProperties":false,"required":["object","data","has_more"],"title":"VectorStoreListFilesResponse","description":"Response from listing files in a vector store."}}}},"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>
|