mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-11 19:56:03 +00:00
68 lines
8 KiB
Text
68 lines
8 KiB
Text
---
|
|
id: get-the-result-of-a-job
|
|
title: "Get the result of a job."
|
|
description: "Get the result of a job."
|
|
sidebar_label: "Get the result of a job."
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWM1u20YQfpXBnhKDlpwgQRvd3EZNDcSNITtAC9sIhssRuc5yl9ldyhYEPUuPBfp0fYRilqRES7JhBzk0hX0xteTMznzzfbM/C+HIV9Z48mK0EC8PDvhfRl46VQVljRiJs4LAka91ADuFUBBc2XQgEiGtCWQCW2BVaSWRLYZXns0WwsuCSuSnMK9IjIRNr0gGkYjK2YpcUM2kORly0dT3PkbncC4SoQKVfpcTzDLFRqhPbrmzhj5Mxeh8ZWFqrcUyWf1OrdWEpj9k6jIl1x/xwSmT90eagHoDbSTLy+Uy2QFZLy2YOltG5GiGuo6DA7FMhJfW0aOyux/K6O+Ts9f/KyQ5K2XyjoRT64BQFuDs9QDG7RMoDwglVkxSaXVdGjBYEgQLDDpFwDHPHeUYKPvUePuvA7KJx3GTYEnBKblKcJ1Wk6tgIHdnMUXtKRGOvtTKUSZG533W7EToMhFBBc2BnTalmMQ3YjO4w12lQvDK5JpiucSdBaa7VPKYTPqtZKWuXvjjxjFN2qa3lUHb6+LLJh40G+FwQK/u7pNfavIBrtGDMjPUKgProEQ9ta6k7Nt1TR8w1H32KhMoJ7eV0q9nZyfQfA3SZsQlaPHYpOSm6dg56yB+nHAdC+sC+Los0c27tYDiN9eFkgVLkJN2Ck1be9O+j/PE2gdU+qEzN1/z1NqanBwUdYlm3xFmmGqCns2tcHgmZXxAIx+Q5bMPVUOu53AIHyfv22QkGkgJak8ZS8yx4mhGUFpHoAzXM1YOMLV1iJP7iqSaKglWyto5MpI24nqULJsKd9Vagdfnc/S6G7zbNOYYDk+OBjCxdV7oOUyt1vbaw+SXn+GHHw9+iNKkGyyrhhkdv14dHKzn+wkzmDQUX8fzQOa3ynn5ZrdypFZkAhTowfNDsBZKNPPOMXsFhFzNyACWtjbNdkSV9CSqJ1F9Z6J6+WY935m1cMxMb5Xl+9L6w9ZQ4IyAbiRRxrCx2DAQaFWqMIATTegJgpsD5qgMaAzkupXq9V0rlSc3IwdkJEuJHGVMrNrQTUWSNxLUwvAkrSdpfUfSet1fr46Y2QY1nDZsX8/fyutwm/IdGNkAPtQOAmEZV6WUyICxQU0VZZ28Mpoi74S3JHaf4ydRPYnq+xLVwa7ZHiChqBKmGuaes+HzF4d+O9R31CC3vmTC7oqpQoclBXI+Hrv5vMvHbDKyKNF9/qRYTIqdVBiKnce5o7cd/CuzWMrabJw1gc93ffSDqynZ1mJ3fufzehvQlU0fF8qVTTmIfDPzxwUQkawcST6ur+hTUihsJkYip9gxOJqRGM5eoK4KHHLCwxUUfrjoo7kcXtnUDxdNQsuh6w76zXahqULtuO5FCNVoOEQz3y+sD5Tta40l7vuA8vNA2lJwfJ5k7VSYR8O3Xbc8v+R3rJ+YVkut92wPp2wPp62Kmsrsw/imIqdKMgE1c5glwQE14M5e7MCbG5G/JUnsN4n+bKHAAJWzM5WRvzCw8YfgKfKSTFZZZYIHNHEnphxI6xqVZXzxwQ3YTVGSb5yiowvDSrEutpBt5ymfmjTNyGHeRXVsM9J+cGEuzN7eP3/+9TeMfz8ZT46Ox7+dHb7f2xvBiaN9R83Wj+GAZ219E5i9SCng82b+EucgCzQ503/KXSslaUsO1Qfun1HylfWhxLj0tIy+R5O3cF6sl7L7bFrmBroJw0qj4iuyhkeLlqDnok1AJIIpKpK1zLnYow3RM095eCW9lqqXiWA6ssPFIkVPH51eLnn4S02OeXiZiLg8pUy684XIlOfntYDuTPDZpJXmc/iazrIThO4K0PAVbXN5NxIiEZ9pvtnpuOF8g2Dv6z1fEWJbgHhXWRBm5CKqzctDKakKPbOt3Q43glXHejc+E8vlvx8JkRQ=
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api-experimental/llama-stack-specification-experimental-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 the result of a job."}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v1alpha/eval/benchmarks/{benchmark_id}/jobs/{job_id}/result"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Get the result of a job.
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={[{"name":"benchmark_id","in":"path","description":"The ID of the benchmark to run the evaluation on.","required":true,"schema":{"type":"string"}},{"name":"job_id","in":"path","description":"The ID of the job to get the result of.","required":true,"schema":{"type":"string"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"The result of the job.","content":{"application/json":{"schema":{"type":"object","properties":{"generations":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The generations from the evaluation."},"scores":{"type":"object","additionalProperties":{"type":"object","properties":{"score_rows":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The scoring result for each row. Each row is a map of column name to value."},"aggregated_results":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Map of metric name to aggregated value"}},"additionalProperties":false,"required":["score_rows","aggregated_results"],"title":"ScoringResult","description":"A scoring result for a single row."},"description":"The scores from the evaluation."}},"additionalProperties":false,"required":["generations","scores"],"title":"EvaluateResponse","description":"The response from an evaluation."}}}},"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>
|