mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-11 19:56:03 +00:00
72 lines
10 KiB
Text
72 lines
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: eJztWc1y4zYSfpUOLkmmaMmZmmwS5eSNvYmrJhmXxj6kLJWrBbZIZECAA4DSsFR6hr3vaR9jn2dfYF9hq0FSon7scTZ7yFRJF4pgA+hufF+j0VgJR760xpMXo5V4eX7Oj5S8dKoMyhoxEhdwiQE9hYFIhLQmkAkshWWplUSWGv7mWXQlvMypQP4X6pLESNjZbySDSETpbEkuqGYilZIJaq7I9WR9cMpkYh2FFyol9+DI28pJelDp04KPfG8a9j8kgkxViNG9KGxKWiTC54p0KhKxIBmse/DBOhKJSBvLWUJa7vswr4yMjknEjIzMC3TvRCKCtbp9PGTOVmVjclEGMY1e80GMesOlNMdK77f13X5blwR2Dp0LEkC9xNrD522Pz2FuHbQvPnqjcqX1TxpcWh/OgkNllMmGBXmPGXkWWKAevq/I8/RnaPySXNfciXXN031db5qJWd2QU6cTKJNGgJgMVPCgGDoppVB5YnUbu1hba+jNXIzuPwabx5az82/l1I5v+X2dxMeRXnv+7iku0cCMwM4CKkMpzJ0tAOFufD2Aq0E2gDOYiDyE0o+Gw6Je0syrQANpi2FR8yADJoSeiCio/byRO/jCDSPpF9/P0NNfXiWr5vnQsmw9EWK9TgSmqWItUd/03DFH7SkRjt5XylHKqxstbOydJiKooNngu/E1M/ht4+59uy82VoccnzRdrJM/ukDOLv3OCsWGddI8tx3ROaxFIlSgwh8LJ8ddcgRJptK6r/jMWk1o+k2mKmbk+i2bALKn0KED1lNeoMeRpDzEWJKCMsBGbgB0D6uJ6Jg1ESO4X02Es5r4/0RUntxEJDDpQm7T/BNpbRNYWqfTzyZincBOL/Re+YAs/dGu0zVM/yd4xbXq4Wtsl/5ZANvzhFhzIFEsWyiDwcbNoAVU/QsWPHg7Z4FlyUsyWu2x+RQp/pyRYp/Rp4BxChh/PGAc+o7HgSaTAGnNXGWVizlpzI562QiDpqCA/PonB8iBQzaqQWfBoXW/Z1166fduDp10S9alkpssree83kpePpK8tu2b5DWqy6vJuSCaFFBK8p7fumQUrAPONqtm9WIE5AVfJ+LVsWMJk4ZtIh9giZxdLlCrlIcpUM+tKyj9/x1YfMBQ9QMLJ7NZ9N+uWj/d3t5AIw3SpjHRbb31sX3lyjleVBZOAMHn1gXwVVGgq7vUmqLMMlcy51DBRjuFJkQHo2m/x3kijAIq/dyZG2meWluTkYO8KtCcOcIUZ5qg12dHHZ5JGY4i8hlWfvGmbDD6JVzA3fh1a0y7m1SeUggWHAWnaEFQWEegDK9nAwyc2SrEyX1JUs2VBCtl5RwZSXt6/R5OtCvcrdbGeT20Rzc94rzuHN1sg6zDxc31AMa2ynJdw9xqbZcexn/7Ab759vybuEXSByzKBhkdvl6dn2/n+yumMG4gvtXnmchvmfPyu+PMkVqRCZCjB89/grVQoKm7gXlUQMjUggxgYSsTom9VQSdSnUj1iZHq5Xfb+W6thZ8Z6S2zfJ9av9oKclwQ0AdJxLUKntRhINCqUGEAN5rQEwRXA2aoDGgM5Lqd6uvHdipPbkEOyEimEnFWgwYqQx9KkoHS1rknap2o9UlR6+v+fnXNyOYs9W2D9u38Lb0uDiHfOSMdwJvKQSAs4q40IzJgbMxS045em2PgQY36iYFPpDqR6tMi1fmx2Z5BocgShhpmnq257O4GDgr2P1IA3ByzZ3Wsz19f8g1PiQ4LCuR8PPSapgzXijZnRMVDlBjyo6Wx68v9e4BgIWuuj7a+Dq6i5JB53Tk5lgapdCQxbMULCrlNxUhk8cwZVRiJ4eKrYXcNMlxtNV3z6TVGosaUyrEDuRg3Gg7R1Ge59YHSM62xwDMfUL7jwlwsS3qSlVOhjh0vu7BzP+VvDMSocrtGr7k/vOX+8LaFYwPTM7jc2MBQ8PGGyfnGWYuvjviP+ex3kI19rvXnilW49vTuJwb2fgjsezsHMmlplQk+nrxDTsqBtK4BaxpvZzhwz1GSbwZFRxPDgIvll2APB5/x4UPTghxmnVY/82WaH0zMxLx48e9//PM///o7XF7djK9+uLi9unzxYgSvKUNZR080ExVYM+EdFXbRFHrmVagcQeslP4A731QPCpW1hR1Hc2qJbnQdScTXWgXGYN4C9gmE77h8td0cnurTwjPQhzAsNSrTVItjWG1geN+uZ8e5RIx6pJkmgtHGYqtYu71zer3m5vcVOYbZNBExjM8YU/crLozz/3QTpx5V+4txy6ov4WP8O2pGV5AyXEDlCgy/iUS8o3qX+bE0lROmfG17v2oFLqSkMvS6HmyxTJoNdX+8uhXr9X8B70KR0A==
|
|
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={"Get a dataset by its ID."}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v1/datasets/{dataset_id}"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
:::caution deprecated
|
|
|
|
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
|
|
|
|
:::
|
|
|
|
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_store","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":{"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."}}},"description":"Data source configuration for the dataset"},"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>
|