mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-04 04:04:14 +00:00
71 lines
No EOL
10 KiB
Text
71 lines
No EOL
10 KiB
Text
---
|
|
id: get-a-dataset-by-its-id
|
|
title: "Get a dataset by its ID."
|
|
description: "Get a dataset by its ID."
|
|
sidebar_label: "Get a dataset by its ID."
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWUtvGzcQ/ivsXpIAsuQESdOoJ7dOEwNJbdjOobAMg9qltEy45IbkShYE/fd+Q+5Kq4cfaXpIAOmiJTkk5/HNcIacJ1a40mgnXNKfJy8OD+kvEy61svTS6KSfHLFj7rkTvpt0ktRoL7QnKl6WSqacqHqfHZHOE5fmouD05WelwGQz/CxSj4mlNaWwXsaNZIZF5EgK26J13ko9ThaBeAISewPuTGVTcSOz+wnvGI8dmwOdROiqSPpXSWEyodB2uRQqw8cE3Bp7kw3xnUWxaTg1NPFmVOk0aKWTDIVO84LbL/j2xqj672ZsTVVGeYvSJ9dBZQ4Kay2XiRGv1GZfW+eX4JeZEWvk7zCupnzm2JN6xhM2MpbVDRdUUdnSuHulxbg/8JZLjf5eIZzjY9gDBBOuel8r4Wj7A67dFIapuxuypvt6k9ezuDGx63PR8MSkzgI69JhJ79AEbjKRsQo8gt0o1zbaCGssDjJobiTHlQ0YCwK3NgB/RovTEQR7CG13oaCxTGXlmlWoDRbpb8esDUu1RE65ZkMoYuihYog6AgYYZ5/OT7rsbXfcZQdskOTel67f6xWzqRg66UU3NQVatEiX/EgNkkCo3CjSbY1QRz91k9+H2PbXl515/L+pnXMxSJIF+OdZJolLrs5a6hhx5UQHfv+1klZkhIsgYZQX1vXSKxIYbJMxLqKhNuU+Wkrtc36v6FDl9xrImqlbs1DogIjhfzWRW8tnIIRWC7crCu1WyXwbSbpSqs34EL4tuG53wamG8IdWzzLubDC0rYDFNRnobiRJxxziEBQpNSMhlwC6YvNB0vjkIOmzK7QtmKPvQQLvsoOkg68aDLH7vVDKdNjUWJX9MgBDbG0Wd046z4n6wanXC3b9n+AVbNXC1znajwLYhibAAmgl0RZScwySBWtAzf7mBS1e71ngkCKTgGDdm/eR4seMFJsevQ8Y+4Dx/QGDdm9Waa2A3kJ4TtN+cNtvybpkjTUSbOVH36TyVkK+nlV3Gms0+eUydWsp73pdvbsy2rp/mdEGdslQlCBynTGepgAptZoMlYGCUtAq5n8huJEtIdfLXYUK+QPJhDSWTTmlnJgsM1qm4Ar7FSL7/0oYwN9X7ZhBGe446G+drfeXl2csUiOjzQLsam09dGS8tZaMSsSoAJjLjQW6qwJ1x6zJt0WgmeYyzSkKkNBWwjODghFr43jYJ8AIYVc9dudITVsroyEby6uC6wMrYPahAtRWc9bYoZ2kpgCRPkLKp6dlxOgzdoRz4EMtTH1QIEBlzBtYFrPFRLACzg0xyZ4RGHxoKh82d6VIAeKUmTStrEWJJjb4+hafqC3cWGupvBbag5ruUF5TWccTjng4OsPxfm6qca5mMA/C5NSx87/+ZK9/O3wdTj9xy4syIqPBF6C+2u8PnrHzCPEVP49Efu05L97s9pxUSXgFyzHd0QeqWUzWs2ZhWhVAGMuJwH9hKtCQbmUh9k61d6qfzKlevFntdwmkfySk157l2q71j6ngE9CQuE2FoAsM2tRyL5hC/eG77AxnPRjyQA8f4+RiCoO2Oale3XVSIe+awPhQJ7mSoIQFtqm0uIW+PVqiVsPetfau9RO51qv2eXVCyKYs9SKifbV/7V5H25BvlJF12WkFJAhehFNpKHDwaBOy1Kxxr2WFt3Vrfc/Ce6faO9XP5VSHu3Z7hAsFLyGo8bEjaY6bB4OtW/x3qM34soIezsKl/ckxvfmU3HKUesK6UPTqeMNWk8YaUdISJff5zluvk+PNxwGYchwflFa69rYSnW3Pa+pkuvUDF7kBaTIOFWbYsJ/0Js97zUtIb77ia0G1aog7kfHKkrroVq3f6+G8P8iNg8oOlOIFP4Cq0y90wxbuF52AAqWfhYnHTZC5uqYxgl1gsLbIB5rPLmg+u6jBx+tnIto8KmLyfIduyFfdGmp524/aK4fLs7oydwPNNn4IDCIk5EJnpUEYcqGqxirSIuLYCMQsPMdQUB5xlNtxUW7FQBOYwq2JN9uLD6mwUPA7y8cNVx/p6cwFwNK7EkIC6aQGxz1oWlPBfBWI75tTQ8GLW98rFXKseOkaQlgEwVWt3wbfnaTfAiiMRrYmsnm4Av1k1WJB3Uj4LBkZnyFkDsmiMHkmHX1ny5hwJ9tPz2sEP2MPYX2nGM3lj6Z7SLrtoBY+v4jZupeFa6AcUZceTcFiJDhKU1H61tSt42zNcd69vYQr/QtrO2Jc
|
|
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={"Get a dataset by its ID."}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v1/datasets/{dataset_id}"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Get a dataset by its ID.
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={[{"name":"dataset_id","in":"path","description":"The ID of the dataset to get.","required":true,"schema":{"type":"string"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"A Dataset.","content":{"application/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string"},"provider_resource_id":{"type":"string"},"provider_id":{"type":"string"},"type":{"type":"string","enum":["model","shield","vector_db","dataset","scoring_function","benchmark","tool","tool_group","prompt"],"const":"dataset","default":"dataset","description":"Type of resource, always 'dataset' for datasets"},"purpose":{"type":"string","enum":["post-training/messages","eval/question-answer","eval/messages-answer"],"description":"Purpose of the dataset indicating its intended use"},"source":{"description":"Data source configuration for the dataset","oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"uri","default":"uri"},"uri":{"type":"string","description":"The dataset can be obtained from a URI. E.g. - \"https://mywebsite.com/mydata.jsonl\" - \"lsfs://mydata.jsonl\" - \"data:csv;base64,{base64_content}\""}},"additionalProperties":false,"required":["type","uri"],"title":"URIDataSource","description":"A dataset that can be obtained from a URI."},{"type":"object","properties":{"type":{"type":"string","const":"rows","default":"rows"},"rows":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The dataset is stored in rows. E.g. - [ {\"messages\": [{\"role\": \"user\", \"content\": \"Hello, world!\"}, {\"role\": \"assistant\", \"content\": \"Hello, world!\"}]} ]"}},"additionalProperties":false,"required":["type","rows"],"title":"RowsDataSource","description":"A dataset stored in rows."}],"discriminator":{"propertyName":"type","mapping":{"uri":{"type":"object","properties":{"type":{"type":"string","const":"uri","default":"uri"},"uri":{"type":"string","description":"The dataset can be obtained from a URI. E.g. - \"https://mywebsite.com/mydata.jsonl\" - \"lsfs://mydata.jsonl\" - \"data:csv;base64,{base64_content}\""}},"additionalProperties":false,"required":["type","uri"],"title":"URIDataSource","description":"A dataset that can be obtained from a URI."},"rows":{"type":"object","properties":{"type":{"type":"string","const":"rows","default":"rows"},"rows":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The dataset is stored in rows. E.g. - [ {\"messages\": [{\"role\": \"user\", \"content\": \"Hello, world!\"}, {\"role\": \"assistant\", \"content\": \"Hello, world!\"}]} ]"}},"additionalProperties":false,"required":["type","rows"],"title":"RowsDataSource","description":"A dataset stored in rows."}}},"title":"DataSource"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Additional metadata for the dataset"}},"additionalProperties":false,"required":["identifier","provider_id","type","purpose","source","metadata"],"title":"Dataset","description":"Dataset resource for storing and accessing training or evaluation data."}}}},"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>
|
|
|
|
|
|
|