phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-10-04 12:07:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

generated mdx

Browse source
This commit is contained in:
Alexey Rybak 2025-09-23 09:48:43 -07:00
parent 334a05071c
commit 9170031326
153 changed files with 10025 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/docs/api/agents.tag.mdx Normal file
View file

@ -0,0 +1,25 @@
---
id: agents
title: "Agents API for creating and interacting with agentic systems."
description: "Agents API for creating and interacting with agentic systems."
custom_edit_url: null
---
Main functionalities provided by this API:
- Create agents with specific instructions and ability to use tools.
- Interactions with agents are grouped into sessions ("threads"), and each interaction is called a "turn".
- Agents can be provided with various tools (see the ToolGroups and ToolRuntime APIs for more details).
- Agents can be provided with various shields (see the Safety API for more details).
- Agents can also use Memory to retrieve information from knowledge bases. See the RAG Tool and Vector IO APIs for more details.
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

71
docs/docs/api/append-rows-to-a-dataset.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: append-rows-to-a-dataset
title: "Append rows to a dataset."
description: "Append rows to a dataset."
sidebar_label: "Append rows to a dataset."
hide_title: true
hide_table_of_contents: true
api: eJztV01v2zgQ/SuETi0Q22nQolvf0qaLDbaFA8c9LFJjMZLGFluK1JKUE0Pwf+8MKcVy7AQpsJcA9iGRqPme92akJrHoKqMdumTcJGenp/wvR5dZWXlpdDJOJn8nm5Pk7aFHswKFxf9qdF7cghNSr0DJXBgrSlALY0vMk5MkM9qj9qwPVaVkBqw/+uHYSJO4rMAS+MqvKySzJv2BmSfFypoKrZcxOufB164nJ8nsEi0J7ob112x2JaK0yEyOHL+XXmFP13kr9XJP9bO1FHwQPhEgXGGsF64uS7BrYRbCU8YYZG4LmRVCxqStBO0FJSxAt8+Dnw3b9yDVcz1HaXatjKbcRFGXoAcWIYdUoejp7ITDnqSmnHX2jCxfTcIVqNfiXHybfmmTySj4FEXtMBfeUGdJG1coSmOR0uR+hs4JSE3tg3NXYSYXMhMmy2prkdw/iIsCgzyX0d9Vr6ELUA5PEsaPtIST8U3X4a5b98Wb3/cvlumR4nVYFgtryhDD+dXlUExNvSzUmtqjlLl1YvrnJ/H+j9P3Qy4a3kFZRWR0+CKob/19hFxMI8S38TwT+ZsNZ//27MNh5mRKEitEQeqOL7wxpKzXnWG2SkBYyhXS/9LUJMO1lSUeSXUk1Qsj1dmHrb8ZIf0rI71llutT6x9TEyeoQniXIeZcNiYbeBRKltIPxZVCoIA8oQeWQCRR9NAOW769e2xTObQraj6Vk6mEVB4GVq3xjurt6Q7bMhypdaTWC6LWu/6+umRkU+TiOqJ967+l1/k+5Lti5EMxqQkJCGXYSinS4tHGU8HoWUuvHBdQK79PsacMH0l1JNXLItXpIW/PoFBgCUMNlo6zuQBPu8pfTjj+B4SpKtS5sBwOVRpEHmWHDHqwUCJRmY00iaYb0mgF/pVMKMk2KvDFXiF42V1edC1olYKL6DHs0+iVfW2L721NzdijYgugzWYehWljfzT5miX+J1ZzND0psBbWnKLH0h3SPgymJjEaJ4tQsVZD10pRh+/vU2Po5UH3j3Rdpmj7J12+Jw8C6h20kWzmcSTufRR3PW0LbvqdGP4eH0JteuCPsJnSafddEgC320U6IPgUJmeMmPDtEqAyTkarN6M2EGlGMcAB+xg1W3htSD6+LkX81ZZxX3hfjUcjenEbFGQT84FSUMKAOJP9HGamTBghDokJ0q+D4kW3LW7m/IxxMd0i6POWdxEBNw1VlKG9MKHtbcpf2I24Zjfiuh02AWgUJscYC796c4AJPJvdzpSC/tzsW/YFeEG4XEky8l2LBz9aBBg+wKhglaG142jOBzJJSxvGxsGTE3IE7yS7gAxdNAoWv2seHsaGqbpvPOUPSUVz1sKyi+orbS3lwoDiFtIK4Jq0o+Cp4bFTgx5Hn1Rqge3xzo8qRW/V7Df0vWmhc9NWuAMP83ALH7ob9+YTNZsxwlpNk9LpN6s2Gz6m7lsGB12GnZlyiwkquXR8nd+T4NE0Xk1brL8WvznqDibZcVzzyKHP+Jrv6PInrndnbsBmQVuYxgVHHAU+xbgGMzazNbA3Dnl6RI3zLMPKPyk77/H3anI9I+G0Hbklv8yMEwu3PLvpbwjWhDrFYcpnTaJAL2tCEz2PNvn3C5/P8tI=
sidebar_class_name: "post 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={"Append rows to a dataset."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/datasetio/append-rows/{dataset_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Append rows to a dataset.
<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 append the rows to.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The rows to append to the dataset."}},"additionalProperties":false,"required":["rows"],"title":"AppendRowsRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"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>

71
docs/docs/api/attach-a-file-to-a-vector-store.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

23
docs/docs/api/batch-inference-coming-soon.tag.mdx Normal file
View file

@ -0,0 +1,23 @@
---
id: batch-inference-coming-soon
title: "Batch inference API for generating completions and chat completions."
description: "Batch inference API for generating completions and chat completions."
custom_edit_url: null
---
This is an asynchronous API. If the request is successful, the response will be a job which can be polled for completion.
NOTE: This API is not yet implemented and is subject to change in concert with other asynchronous APIs
including (post-training, evals, etc).
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

20
docs/docs/api/benchmarks.tag.mdx Normal file
View file

@ -0,0 +1,20 @@
---
id: benchmarks
title: "Benchmarks"
description: "Benchmarks"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

71
docs/docs/api/cancel-a-job.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: cancel-a-job
title: "Cancel a job."
description: "Cancel a job."
sidebar_label: "Cancel a job."
hide_title: true
hide_table_of_contents: true
api: eJztV11PGzkU/SvWPLUSJBS16jZvtGS1aKlAIX1YUbRyPDcZg8eetT2BKMp/77meyReBilb7gpS8zJfv17nnXDvzzFOonA0Ust48Oz464ktOQXldRe1s1ssu/s4WB9n7pz4NCxKe/qspRHEvg9B2Ko3OhfOilGbsfEl5dpApZyPZyPayqoxWku27t4GdzLOgCiol38VZRXDrRrekIgwr7yryUTfZhShjHTbWabidkMfC7bT+Gg4vRbNaKJcT5x91NLRhG6LXdrJj2vceyafFB0KKUDgfRajLUvqZcGMRUTGlNfeFVoXQTdFeSxsFChbStt9TnAX7j1Kbl0ZuVnNo4yxqE0VdSnvoSeZyZEhs2Gylw5G0Rc1WvaDKNxfpTpq34kR8G5y3xSgkPyJRB8pFdOgsrGlKonSeUCb3M3VOyJGrYwoeKlJ6rJVwStXeE8I/yguJyTzXTbzLjYaOpQl0kDF/tAdPetfLDi+7tQLvZtW/BqZnwFtyWYy9K1MOJ5dnHTFw9aQwM7THGHcfxODPL+LjH0cfOwwaPciyapix5Beovo73WeZi0FB8nc8Lmb9YcPXvjz89rRxlNFQhCpgHvonOwdjOlo7ZK4gw0VPCtXQ11jC2uqS9qPaiemWiOv60jjcE078y01tlhU1p/eNqaAII0YMiyhk2FpuMJIwudeyIS0MSCUWwR04kRGLw0XdavX14bqcK5KdoPuBkKRHgYWLVlh6Ad8QTtTDspbWX1iuS1ofN/eqMmY3MxVXD9nX8Vl4nu5RfgpF3xEUNJpAs0640Imw81kUAhm+tvHIay9rEXYn9zPFeVHtRvS5RHT0V7QUSSiphqslJ4Gr6OBdy6tupfuEWGTT41o06zHHpZUlQLtvMM4sHrBoByQKku/tXs4I0W1YyFjuV8+52drrEfGWW+lfbphHIo24a5yyHXEMefY0W7AiwpQ2KWSWEbH8tFRhwEiqV+2tRgRkQKRyWIoQBOAknhOxl3em7LhfUXZUauvNNtBZdRMa7JuEFLJvNv4G39tzFIsaq1+3iGHJYuIBOHhojS3kIBqi7jnJlxjkEQl91nCXD0+Xsu77hb6yGlHpLlHO2F1dsL65aTSTIEZ+DNwhN3z0BGo+QsCUmuSnvTc+xkFFgKE41nHy34tEP84rS/wSyeeUwHQPGUTpDaY9B6Bt95ABZ8Oj0Y6koNE6lp++WOe58Ev+u8xH/3zEYB15Olll9xXA1IemoAo6YVIxJy5jHRN+qe77eFHYWtnSI9BC7lcEhj/2nxs1bFlw3SDIPcFkzAQ+9R8phMvDrlr9oHXecXcznIxwlv3mzWPBrnEY9txq3aZ6PuK9ofK4D3+ergfVsHW8GLcPfit9R5ZNlty/BVCYSLPgJt3c0ezwlWKz/Q7I7uv2NvFqwFzdYWWDrwh7NUDYfT5SiKm6Y7ZwJtgbAaf+8P+xjKvwAJUJ7Tw==
sidebar_class_name: "delete 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={"Cancel a job."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/eval/benchmarks/{benchmark_id}/jobs/{job_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Cancel 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 cancel.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"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>

71
docs/docs/api/cancel-a-training-job.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: cancel-a-training-job
title: "Cancel a training job."
description: "Cancel a training job."
sidebar_label: "Cancel a training job."
hide_title: true
hide_table_of_contents: true
api: eJztV0tv2zgQ/iuETi0Q22nQolvf0rSLzW6LGI5zWKRBQUljiyklaknKiWH4v+83pBTLzaNZYC8B7IMtiRzO8HsM5XViydWmcuSS8To5Ojzkn5xcZlXtlamScXL2V7I5SN4+NDQrSFj6pyHnxY10QlVLqVUujBWl1HNjS8qTgyQzlafKc7ysa60yyfGja8eLrBOXFVRKvvKrmrCsSa8p8wisranJehWrc176xvXmKSy7IIuJu2X9MZtNRJwtMpMT1++V19SLdd6qanEv9LO1KD5MPhBSuMJYL1xTltKuhJkLjx1TmHNTqKwQKm7aKll5gQ0LWbXjIc+G1/dS6edmjrM5tTYV9iaKppTVwJLMZapJ9GJ2yuFMqsKeq+wZu3x1Fq6kfi2OxcX0S7uZDMWnJBpHufAGzCKaliRKYwnbZD4Dc0KmpvEhuaspU3OVCZNljbWE9D/VhcJknquYb9IjdC61o4OE9aMsdDK+7Bju2LoD7+qOvwjTI+B1WhZza8pQw/HkdCimplkUegV6tDY3Tkx/PxHvfzt8P2TQ6FaWdVRGpy9IfZvvo8zFNEp8W88zlb/Z8O7fHn142DmZVnCFKBDu+MIbg+Bq1S3Mq0IIC7Uk/JamwRzGVpW0N9XeVC/MVEcftvlmUPpXVnrrLNe31t+mgSeAEN1mRDnDxmaTnoRWpfJDMdEkUZCHeuRCwiQag3bY+u3dYyeVI7sE+YCTrUSAh4XVVHQLvD3uqIVhb629tV6Qtd71z6tTVjYqF+dR7dv8rb2O70u+AyMfirMGSiBZhlMpJRw8lfEADGOtvXKay0b7+xZ7auG9qfamelmmOnwo2zMsFFzCUpMLx7uZGOdnFocUKBCvTkzJv+fGVK95Q7sbOGHiNGj3XcC1SYdsAWllSTA2L3kV4cKx+dHkK675f7IWkn1vGpX/Wjp8ml5cnH7qWEYkayUL9Q//G913WXv8RiA62P40afcGHqDdRnvbEB4AmsLgNqlNeEuvpS9wN1q+GfGTQQfnCLlGsUjMiq8DjOg6aSzzWnhfj0cjvJgMCsRRPtBalnIATWQ/hpkpk80Vx4Fp5Vch8FPXDS+veIwhn27J+bzV1RbcDtRg1rkJaLf7/sLpxDmnE+etqQKXKJdrjegv3zxACPcgt+NG2e8P/ZV9Ib0A9UuFRb5V4qcPGh6FPxpU5bVBe3XoZ+ElTFl0UhsNlrM8uffauczIxUWlpW8Vm8TY0D3uL57yHyaNfmLloqvqK7qzdsGITBdaHWNSQfFPeWIHgJ4HHo9oNe3p1o9qjTHOGJhft5K5jNjuiAb3iOcDLAoHLLM4ePJ6neI99MLqzYYfg3a7igYNh0HKnEIXCEDnxhHFgvlBK64xVjuYcUk8XTdc2j33bg66iOMso9o/Ofeq54TJ2fkMk9O2Q5R8AI4TK2/wkL/HCS5MQC94PzxbJ1pWiwbMYDyuyZ9/AfOvU6s=
sidebar_class_name: "post 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={"Cancel a training job."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/post-training/job/cancel"}
context={"endpoint"}
>
</MethodEndpoint>
Cancel a training job.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"job_uuid":{"type":"string","description":"The UUID of the job to cancel."}},"additionalProperties":false,"required":["job_uuid"],"title":"CancelTrainingJobRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"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>

71
docs/docs/api/classifies-if-text-and-or-image-inputs-are-potentially-harmful.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: classifies-if-text-and-or-image-inputs-are-potentially-harmful
title: "Classifies if text and/or image inputs are potentially harmful."
description: "Classifies if text and/or image inputs are potentially harmful."
sidebar_label: "Classifies if text and/or image inputs are potentially harmful."
hide_title: true
hide_table_of_contents: true
api: eJztWN9PGzkQ/lesfSoSEFpd1StvtNfTVWoFClSnE0XI2Z1k3Xrtre1NiFD+9/vG3rCbH9BQ8VIJHkKya4+/GX/fjD23mSNfW+PJZ8e32aujI/5XkM+dqoOyJjvOTkRlC3KSfwo7+kZ5OMz2s9yaQCbweFnXWuVxwOCb50m3mc9LqiR/C/OaYCbNxMTa2ZpcUGlJVfTG+OCUmWDMKoKLkkRj1I+GhCqwphorcmJsnQh400PnCGM84C32M36sd7Mdh4rGUyGCFRMybI82jftGBx+Nt9975qVzcg7rKlDlf+72WMvJhPq+j6zVJM0GwH9LAhAnpJkLO46gRqTtTCDgNLEOBoV0JFqLEV73ahsSWRSKjUt9toJpDchiHcmJ0MqHJYhujX1gK8SsxYmPeR+QwDYZG/q45teRMVRcK1M34ZoX/hWk98W83erFzh4Iqa2ZiJkKZXwTYQm29sLv4YkM8bHPLfxK2D2osupTfPsrbpimGpHbPd5raJVLwPDci9pRofKAsI/midcRJLjtrivyXk5oS6CgFgqykGGrYO+Dbw2djrPjy54jWsPYFiZt+rqJYW1bew9aJIurBW/pdjhjqT2xMH80yrGwLu801vPuaj8LKmg2+vlO2afR/LCV9OYubEl/D+zVxmifPQq1ioBj8uryzAO4dwQcQ/fHtvzOGbBNnGIGCikzlVpF3VZSI8tWMYZPlO99kKHps1/B7ASUWHfjn4uLM5FGixwOcczbGPwsp39wjmsDD0ZuEr60LgjfVJV0dzmU4phZqfJSqOS0U9KEWFakad/HdeJmB6l2qCZp5TSal2ahIieWTSXNgSOQcKRJ9OaswOGVlIHPJt/ByxendSLUnjgRX4afWmdygB/RXTVzhNk05UrmOLHxfiZqyJFt2rxWU46amgub541zhOXXcD2GwO0OL3frLng9Dscw3RO85YFEjJ2tIoaTs4+HYmibSann2B6N4ufF8O/34s2fR2+iFulGVnVixpJfoHq33jtZiGGieIdnR+a3ynn1drtyctQCsKbEdM9fgrWYjFrdGmarIMJETQn/K9uYlNFVRc+iehbVbyaqV2+79S7A9M/M9FZZvi+t/2wDTSBCdJMTFRw2Fhsfq7WqVDgUZzgaAFAAe+REQiQaL92yUr2+r1LhIDPF5iOcLCVCeJhYjaEbxJvPPdSG4Vlaz9L6jaT1ul+vPjKzgVycJ7Z367fyOtmk/DIYxaE4bcAEklWsSiNC4cEFjC/NxVJeBY0lDpZbLvsPGH4W1bOofi9RHW1bbQcJRZUw1eTEszfnckxhzuBXwb7X0nsWFriDUNFN4FbIAJZUhZt26iOk9kxtWThKasAvpavGjeYuWi2dxO2UHK9zlWKIWvrOFnN25KmabIxj65X9vtv3A02VjSh8jN2SF+x19HePKZen0MwPxfvERUgQ80H8ZIibRiKuxSxLz/y+SLq7e14hSakD3GeRC1NTpr1Tw1iltHS8lI19p3hl9o9t/bUB7l+ZUzdwjgPMzDa6wHnlO/EyENPhI6/yMexLPD3qDxvTXeOXF5PIuG56cA2lxkxp8TOrbby81DKU+DWYvhxgbSMVf+vQs+TSEcnHbW4cc70MoT4eDHBYOyhhhooDrWUlD6CT/PthbquMd9UT2K/Ac57417JCXF7xO2bcsOPmh05rLbe6ILfR7zWXOOHE7Wjd/8SLi3NeXJy3aSeix2xGnrZn+nLLjnGW9iv5SvYzaN9ybNtBB1MFI1+NWPsDHylexcgUtUUB8rGNmRpquXUpBRVwQXB1cmOZc9OPjULPXw2nEetift00PuIrpUbGdZwGEqrPHUF5L1EMOCYG8n+STLISqV7meALTrYx46qDWOKvHlqKLEkt8vEy7lRjJu/iyJcKSlaAQM49H3t6OcPD/4vRiwY/BKTdPyS9W3xFTBKTDBJRKnAmYjd9pzp4knw4uGA8P103MWOuZkbNZmnGS51SHB8de9TR2dnp+gcGjNvuyA3jq5Ixbcfg8zqKTySUMiM9uMy3NpImd1SzZ5L//ARJJ5iE=
sidebar_class_name: "post 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={"Classifies if text and/or image inputs are potentially harmful."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/openai/v1/moderations"}
context={"endpoint"}
>
</MethodEndpoint>
Classifies if text and/or image inputs are potentially harmful.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"input":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Input (or inputs) to classify. Can be a single string, an array of strings, or an array of multi-modal input objects similar to other models."},"model":{"type":"string","description":"The content moderation model you would like to use."}},"additionalProperties":false,"required":["input","model"],"title":"RunModerationRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A moderation object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the moderation request."},"model":{"type":"string","description":"The model used to generate the moderation results."},"results":{"type":"array","items":{"type":"object","properties":{"flagged":{"type":"boolean","description":"Whether any of the below categories are flagged."},"categories":{"type":"object","additionalProperties":{"type":"boolean"},"description":"A list of the categories, and whether they are flagged or not."},"category_applied_input_types":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"A list of the categories along with the input type(s) that the score applies to."},"category_scores":{"type":"object","additionalProperties":{"type":"number"},"description":"A list of the categories along with their scores as predicted by model."},"user_message":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}}},"additionalProperties":false,"required":["flagged","metadata"],"title":"ModerationObjectResults","description":"A moderation object."},"description":"A list of moderation objects"}},"additionalProperties":false,"required":["id","model","results"],"title":"ModerationObject","description":"A moderation 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>

71
docs/docs/api/create-a-new-open-ai-response.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/create-a-new-prompt.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: create-a-new-prompt
title: "Create a new prompt."
description: "Create a new prompt."
sidebar_label: "Create a new prompt."
hide_title: true
hide_table_of_contents: true
api: eJztWF1vEzkU/SvWvABS0hYEAqrVSoVltUigVm1BWpUKOTM3GYPHHmxP0ijKf+dc29NMWwJlhbRCah/adGLfr3POvWOvCke+tcaTL/ZXxaO9Pf5TkS+daoOyptgvTmsSpSMZqBJHzjZtENhkO1fSTjEqSmsCmcD7ZNtqVUret/vJ8+ZV4cuaGsmfwrIlmLOTT1QGbGydbckFlVy30fJgnQ9OmRnW3YzGL32gRqQtItBFEAsVajGXTsmJJtFqWVJtdUXO74j3+bEX0pGwRi+F79rWOs5oUZMRnYcrEWD6uC+HODh6vVOsR8UcNlTKJUemkPCM3I3Q3qeV4n5eIHyQyA+WZRAPR0IZlLFBreAWy7yc0wP2kPL4qKofZ//OqC8dCVXBipoq+Jha18jAJqUX91o29MfjZ+NKzVQY19LXf96LWfQ1GPiQzsklXCgU09/0vb7u/I3yQdhpX/fLahvZoF6hRpalNGJCqCfiUSZW9BKlBqgEYrPKf6xoKjs9xHtirSZpYsr5u6nUnq5H8SKtg/kqcg3lBYbw5OBOeZHxEspH99nY5WPUK63LhFsjHllViq1LfTTgZPbu6EunHAGcs0suDDEb1vZKauejIqigObckmxtoHvTF6fWEDy0+M7jMGhDIwrM4bMkcvBYvsRYJR4JfLSrX+o2WjRQnQZafwds15/V4m5w5JwKYC3BGmbnUCox0opGa6UTVr5M1JBA6fwvx/HN6eiTSalHaKvIkl+9HonjlHIPKi0dctBrKhsKbRrol85VpQHHNolZlzczgpAGaCZEPYFP6PvqJvA9S6dt6TqvZtbaGdV93jTRjtMwq6mOw50o4UQoGOZvyFlneP2wTRx+IA/Hu+E1OZqi4YIEsdtOcRAPmIM3UHtiznNguROe+pRLNoxS2LDvnCO6vxfUzmsgI92hdFm9A/1imLcXr54+YgtIxBm684th2sxqNemq1tgsvjv9+KZ4+23saWzJdSPCehvwC1Tf+XsgKjTxSfBPPLZmflfPo+ZZBqBVUIdBYBcsUJbfYbJa9YbYKIszUHGNFNrYzsWUG1dCdqO5E9ZuJ6tHzjb9TMP0tMz0ryw+l9a/toAlUiC5KoorLxmLj0aRVo8KOOMLQRkAB7JEzCZHw3HL9pHqybVJ5chi6AuVkKRFPQ2DTGbpAvfmth3IZ7qR1J63fSFpPhvPqNTMbkYuTxPaN/yyvg5uU74tR7YjDDkwg2cSpNCEMHmPj6aDq5TV42772Bvodw3eiuhPV7yWqvW95u4WEokqYanLmOZt0XPMc/dVoX8ZrEGBsaJHPYHwF0kqHIzA0zLvPU2UwIV/Yasnh/Q83JMOrkez+e1ckv/qG4L9dDez8HOdyPQYUS/Ak9Pr3/wjsZltwHeEB0Kot/i1aG88IOFfX+G93/nC3zeCPivTuwZiuis4xieoQ2v3dXbwFjWtspGqs+dQ99vHUXdqmWJ/zPtBKhWXc+Fffes/O+TsG/XhDj1cbEvfwbmAdIHLWPz2P7WJqIxg57cHJX5xkWUeKFYPbq2L+8BtM4S7or/QDOexQQ8sRRAQ5VzDywYhrP2i5FLEnU7UWDd6jo8bXQOVAQZckXvG9Bnd/NwX9MjOkow+GZRovO4K9aXzCRzaNjubkrI/qLeaDTtRlENFsuSZMuO1CvZL+QJjb1me6s4x2QVFl2FukwipT5izVtd10DCYGP1+tJnjhfef0es2PAblbpvbQ4xo5gQ0YEZiFTJbPtORgUljjU/bOy3UXxXi9d6xH/Y6DsqR4v7R97fmA9EeHJ6dYPMn9qeFJu184ucBD/r1f4IONZYqqj89WhZZm1gEAfJ9s8s9XtOrPKw==
sidebar_class_name: "post 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={"Create a new prompt."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/prompts"}
context={"endpoint"}
>
</MethodEndpoint>
Create a new prompt.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"type":"string","description":"The prompt text content with variable placeholders."},"variables":{"type":"array","items":{"type":"string"},"description":"List of variable names that can be used in the prompt template."}},"additionalProperties":false,"required":["prompt"],"title":"CreatePromptRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The created Prompt resource.","content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"type":"string","description":"The system prompt text with variable placeholders. Variables are only supported when using the Responses API."},"version":{"type":"integer","description":"Version (integer starting at 1, incremented on save)"},"prompt_id":{"type":"string","description":"Unique identifier formatted as 'pmpt_<48-digit-hash>'"},"variables":{"type":"array","items":{"type":"string"},"description":"List of prompt variable names that can be used in the prompt template"},"is_default":{"type":"boolean","default":false,"description":"Boolean indicating whether this version is the default version for this prompt"}},"additionalProperties":false,"required":["version","prompt_id","variables","is_default"],"title":"Prompt","description":"A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack."}}}},"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>

71
docs/docs/api/create-a-new-session-for-an-agent.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: create-a-new-session-for-an-agent
title: "Create a new session for an agent."
description: "Create a new session for an agent."
sidebar_label: "Create a new session for an agent."
hide_title: true
hide_table_of_contents: true
api: eJztWE1v2zgQ/SuETi2Q2GmwRbe5uWkXG6BFAsc5LNJgQUtjiy1FqiTlxDD83/uGlGK5TrbuopcA8SGRJXK+3ntDjVeZI19b48lnJ6vs+OiI/xXkc6fqoKzJTrKREaM5mXBJ3uPOqSMZaNxuG2QHWW5NwHPeKetaq1zyzuEXz9tXmc9LqiRfhWVNMGinXygP2Fg7W5MLKjn3yf6/quit9cEpM8fa7ZiujPrWkFAF/KqZIidm1olQkshjeIVorWXr9UEmi0LxRqkveh5nUns6QAG+NcoRnF73Q7g5yIIKmmN4PPuduLoHwlFonEEctyWZFBTyEFIYuhWSDXYRDhAiB/nHQ7WflGwKqfogbqUXyiykVoVAspXUyLlC4L8PgSBD43vrFMzOye2k+fdkciHSapHbgrL1fbV+htwH5xgpXnyAcvjSOpSiqSrplsLOIoYU19yWKi+FSkk7JVEyBlma9nn0s2b7QSq9r+e0ml1ra5CbKJtKmkMAVMipJtHbsxUOe1IGOZt8jyxfnNeJcC/FSFyNP7bJ5Ah+SqLxIEawTBKnaEGisg5kNoxnRE7IqW1CdO5rysHwXNg8b5wjuP8hrl8ieEK4Q+u+eD22xzI9UryuWYiZs1WMYXRxNhBj28xLvQQ8WttbL8Z/nYo3fx69GXDR6E5WdWJGxy9QfePvnSzEOFF8E8+ezG+Vc/z2YeXkWrHQSmz3fBGsxWaz7AyzVRBhrhbQqKxsgzVcW1XRs6ieRfXERHX8duNvAqZ/Yqa3yvJ9af1jG2gCFaK7nKjgsrHYcK4JrSoVBuJCk0RAAeyRcwmRaDx03Un1+rGTypNbAHyUk6VEKA8TqzF0h3rzoUxtGZ6l9SytJySt1/3z6oyZjcjFZWL7xn8rr9Eu5btiFANx3oAJJKt4Kk0JB4+x8RW26ORV0Ew2Ojz4Iv6o4WdRPYvqaYnq6CFve0goqoSpJuees4nTmefgt4NNk1o7cbWzVsedOIDx6FpLJyuCoNnUKjP4gq3xMQ+BjDa+1zKUO8XgA+/sfQdDGukAZ5o/E2obp+xrA0FwDSDZEWRLo/X6Ji3Guf3OFkte8ZtH7JTnz/jLGfLKLscun/ssB/9vuo7ee2RLSPWn7G4eiEBv1w03AFhpC8bFxpkhwnOSDRevhhEGP1x1CK6H3e8AqHfs1wnoxjHNyhDqk+EQ70mHJUxRcai1rOQhKJp/HeS2yhgKTyCeCsu48X3XnK9v+BkDMN5A9aFH861S32PLjJrZWPs2+4/sUlyyS3HZ6jyii5A53oTF4tUD8HBb9FsNQvZbVt9yKGUQIMNCwchnI374oAdTnH3IFLVFx/eQSXwvVA7N3SXNF/wTBh8HbiZz8smodPTZsG6tiw1t1/iUZziNFucASxvVJxwY2sfewCii+3JN2mLtJd2tYvQUst/ulvmB7sKw1njF5UgiK1Ytn65TzROjcHHS6wodqcAAJg4vXq2meGW+cnq95tughGPG4DKeW1PGGvwplOfr4l4gj6bxYtzy/qX45VbzYHbtTbCdmSV1w99w+ZWW/Z63vsHaEichjnyOOD0+TXEdTtjIZvtOM1ofdDtGeU51+M+1Nz0tX5xfTrB42ja8il8oTjInb7lz4m8M1cY6xVYW760yLc28Qex4nmzy5zsBj0lx
sidebar_class_name: "post 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={"Create a new session for an agent."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/agents/{agent_id}/session"}
context={"endpoint"}
>
</MethodEndpoint>
Create a new session for an agent.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","description":"The ID of the agent to create the session for.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"session_name":{"type":"string","description":"The name of the session to create."}},"additionalProperties":false,"required":["session_name"],"title":"CreateAgentSessionRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"An AgentSessionCreateResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"session_id":{"type":"string","description":"Unique identifier for the created session"}},"additionalProperties":false,"required":["session_id"],"title":"AgentSessionCreateResponse","description":"Response returned when creating a new agent session."}}}},"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>

71
docs/docs/api/create-a-new-turn-for-an-agent.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/create-an-agent-with-the-given-configuration.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/creates-a-vector-store.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

20
docs/docs/api/dataset-io.tag.mdx Normal file
View file

@ -0,0 +1,20 @@
---
id: dataset-io
title: "DatasetIO"
description: "DatasetIO"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

20
docs/docs/api/datasets.tag.mdx Normal file
View file

@ -0,0 +1,20 @@
---
id: datasets
title: "Datasets"
description: "Datasets"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

71
docs/docs/api/delete-a-file.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: delete-a-file
title: "Delete a file."
description: "Delete a file."
sidebar_label: "Delete a file."
hide_title: true
hide_table_of_contents: true
api: eJztWF1vGzcQ/CvEPSWALDlGgzR+U2sHNeDAhuygKGyjoO5WOiY88kryZAuC/ntneTx9WDLqAH0xIL/oPpa7w9kZ8uhF5sjX1njy2ekiOzk+5p+CfO5UHZQ12Wk2NOKqJjO8+KI0nZGmQKM0SChTqFwGZabCN3lO3k8aLQoOwuB+1styawKZwGllXesYbc3gu+fci8znJVWSr8K8JlSz4++UBwysna3JBdUiU8VGjA8OFRGzDfS2JDEBRqEKVFQTRU6EUgbxKH2LiYps2etK7MkHsB4vMs4S009ko7cePK/X5hKcqCceS5WXQnkh9aOce3Efx91nXLSrv646tlaTNDtp/ywplBF6mg7DX7Or5+u5IK8sCsUDpb7eIGwitacemvtPoxxXvWMGe2t2uxQPvSyooBnPS03eAbjq/sS61Gv0XybuO7UIzuTF8PqiD6AM9Zd96mISGSb5tk/KzKRWhUDqSmpUqKj4/2TkgwyN34hTSDsltzPHP25vr0UbLXJbELcwEfVfMjx3DuBjcA+s+NK6gP5VlXRzYSexrxRjVnrhSTslTYiUSpPexzpRO0Eq/drKbTSX1tZgbqJsKmmOHMlCjtGhjTFbcLiSgv6lyV8xy3dXdSu792Iovo0u02RygB+TaDwVIlh0FqNpRqKyjrXB/YydE3JsmxCL+5pymDUXNs8b5wjln+H6GZmnDnfdWpG3IfRI0wvkuZW2na0iBhawGNlmWsJ5E6u1ffRi9OV38enX4099Jo2eZFW3yuj0Bamv6/0mCzFqJb7G80rlJ+ecfN7vnFwruEKUvELwRbAWg828S8xZIYSpmhF+K9sghrlVFR1MdTDVGzPVyed1vVso/SsrPTnLb1rrL9vAE2CInnKigmljs8lAQqtKhb64xtYLQAHqkVMJk2i8dN1O9fGlncqTm6H5oJOtRKCHhdUYegLf2E8TuQdrHaz1pqz1cXO/umBlA7m4adW+rp/sNdyVfEdG0RdXDZRAsoq70piw8Rgbv8aLzl6r7+o9R40XEx9MdTDV2zLV8b5qr7BQdAlLTU49zyYepBj7Ntb2lJbOXXzUrqWTFR45HrXIDG7S0fXvePhTPKqWodx7kr046wiP5zj0rUlHvFBCnemDkuusmQ6uAfM7vktqWS6BGYBKi9B04owwgeA0G8w+DNBEIxVfcU0/WCSwS4S1W207lcYxZ2UI9elggE3/qLQevB1pLSt5BL7zH/3cVhkX9AQWVZjHgWfdSnP3wO9YexFnassljxc3PF7cJAVGZaI+F2/ZmX3YQxgb1m9JV26aaTNz/B8ElqCZQpJ7I579YXWg+FVOpqgt1iIP88cvFuWw7LhWjQWfsXmhchOZk2+TSkf3hhVlXbTabvIxny40zOfktEP1FUuZ9lG1NXjEusCcJLnsqGpr4ov1Grwbmbof6CkMao2PKq4QW7dITb9ruWzbzhzzXWw9fk87paJR3F8OXyzG+Ez75vRyyY8hQceNxWVcK8fcRbS5UJ6vi9Vi8CLod6Mk3vfi50S/d3LpIRTJk5G64Ttc/qD5hvOWDwgtsfJii2G07dthnlMdNsbtbGlb9jk7vzy/PYen/gVqgdkg
sidebar_class_name: "delete 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={"Delete a file."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/openai/v1/files/{file_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete a file.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"file_id","in":"path","description":"The ID of the file to use for this request.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"An OpenAIFileDeleteResponse indicating successful deletion.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The file identifier that was deleted"},"object":{"type":"string","const":"file","default":"file","description":"The object type, which is always \"file\""},"deleted":{"type":"boolean","description":"Whether the file was successfully deleted"}},"additionalProperties":false,"required":["id","object","deleted"],"title":"OpenAIFileDeleteResponse","description":"Response for deleting a file in OpenAI Files API."}}}},"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>

71
docs/docs/api/delete-a-prompt.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: delete-a-prompt
title: "Delete a prompt."
description: "Delete a prompt."
sidebar_label: "Delete a prompt."
hide_title: true
hide_table_of_contents: true
api: eJztV8Fu2zgQ/RVCpxZI7DRo0a1v6SaLLTZFgsQ9LNJgMZbGFltK1JKUE8Pwv/cNKcd27BS+BnAupsQZzsyb94bKPHPsG1t79tlgnp2enMhPwT53ugna1tkgu/onWxxl73dtDUtWjv9v2Qf1QF7pekpGF8o6VZEZW1dxkR1lua0D10H8qWmMzkn8+z+8HDLPfF5yRbIKs4ZxrB394DzAsXG2YRd0ys4HCq1fs9M4dsIOhptp/T0cXqtkrXJbsOQfdDC85uuD0/Vky/XCOSQfjY8UKV9aF5Rvq4rcTNmxCqiYo81DqfNS6VS001QHhYIV1d1+jLOQ8wNps2/kZC2hja1Rmyrbiupjx1TQyLBa89lIRyLpGjXX+R5VvrmKKzJv1Zn6dnPZFZMj+RGr1nOhgkVn4c1TVpV1jDKln7Fzika2DTG4bzjXY50rm+etc4zwz/JCYlQUOsW7XmvomIzno0z4ox14MrhbdnjZrSfw7p/6l2B6Abwll9XY2SrmcHb9padubDspzQztMcY+eHXz15/q4x8nH3sCGj9S1SRmLPkFqq/ifaZC3SSKr/LZk/mLhVT//vTTbuXkRkMVqoS7l0WwFs71bHmwnAoiTPSU8VvZFjaCra74IKqDqF6ZqE4/reINwfSvwvROWX5dWv/aFpoAQvyYMxcCm4iNAiujKx166towIaEA9tCEIBKDTdfr9PbhpZvKs5ui+YBTpMSAR4jV1vwIvAOeuIPhIK2DtF6RtD6s31dfhNnIXN0mtq/id/I626b8Eoyip65aMIGpirfSiHHx1DYAMOx18ip4TK0J2xL73cEHUR1E9bpEdbIr2h4SiioRqtHESzUotmpwwd0/z/acDeNKI9VEi54wnRxVeOnEc57VeIBh2v9Pi4i0eDYUyq3i5YLTBQQmYnVL+JOv9LGI4STKCuvgWmC/pbyOL4sFckY6pYVplvxjkog+yPrTd/10uu/Pn1JcwCBds6mE1gleZQjNoN/HhX9cWg/Mjo2hio6Bdf6zl9sqk1CegaAOs+h4vpwyd/eyJ7yLGXYtuRR/dSv+6rZjX2Ql4kvwhMn03Q6YRKx+g7a0LqT1k0NJQSCcAlj/vVbP/jAZOH6Rc100FnPIQ/jxa0U7jByXmFgASyVDyo0pZ58OJcffa2GTdVFm24eP5D8LA+E5miyz+ooxZnxkbAMcMRMEk44mO/i0Ufp8NYF32Xa9D/wY+o3BR5VEie2bdy2/S3h2TcdqsGImWiSdFaP5fISPs2/OLBbyGt93TlqKZZyQI+kfGlxoL+viaQS8mOybm46wb9X+JN9ZTvcSPBSakGnlCcufPNvQ2eIexiWmLa4VyTXtn+U5N2HNc+sa2xDM+cXlxfACKvoFc4kO+Q==
sidebar_class_name: "delete 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={"Delete a prompt."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/prompts/{prompt_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete a prompt.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"prompt_id","in":"path","description":"The identifier of the prompt to delete.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"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>

71
docs/docs/api/delete-a-vector-store-file.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: delete-a-vector-store-file
title: "Delete a vector store file."
description: "Delete a vector store file."
sidebar_label: "Delete a vector store file."
hide_title: true
hide_table_of_contents: true
api: eJztWGtPGzkU/SvWfGolSABt1S3f2IVqkahAPHa1oqhyZm4ybj321PYEoij/ved6ZpLJA0pVviAFCWUmtu/j3HOu7UwTR760xpNPDqfJwd4ef2TkU6fKoKxJDpMj8S+lwbor/NNHpemYNAW6bBYKZTKVyqDMSIScRMajWCl8kKHyvWQnSa0JZAKblmWp42xr+l89258mPs2pkPwUJiXBox18hUcsLJ0tyQVVR6eyzhwfHDxiznKwN0Z9rxBTBn9qqMgJO1yERZkYIoFkttP62GhwKCuNoWQc8/7iOfEeL+w1Vtbcnkdrgk11fQ+tW8akRZsjaG0tQhhYq0mabgzBVbTq7L+cYHTFMgMVYRX30gtfpSl5P6x0MoMrmWWKx6S+6CA6lNrDuKPvlXIcyC1DvLOAv43wbicJKmgO8UkqrMEy58jQ2aKJFTSRokZWRGRjSXqIkyP9YxMDr5EoR0k+xOyUGUutMgELhdQAuYgleSGa1bztzFMwOyK3lt0/19cXDctFarNY1Aann9H0xDmmBk/eARw+ty6gaEUh3aRlLMU597lKc6HqpJ2SJkRWSdOMRz+RTUEq/VzP9Wx2ra1BbiKvCml2HclMDjTTar5mKRz2pAxyNukzsnxzXtaseyuOxM3lWZNMiuAHJCoPOQaLymI1jUkUTAZluJ41k+XAViE69yWlkFQqbJpWzhHcr8T1KyxvKtxWaw5eh+cRpkfAc0us5hiOLk574tJWo1xPUB6t7b0Xlx//Fu//3HvfY9DoQRZlzYyWX6D6wt9fMhOXNcUX8TyT+Y1yDj5sVk6qFVQhcm4L/BCsxWIzaQ2zVRBhpMaEz8JWmMPYqoK2otqK6pWJ6uDDwt81mP6Jmd4oy3el9b+toAkgRA8pUcawsdhkIKFVoUJPXGAzRkAB7JEjCZFoDLp2p3r32E7lyY1RfMDJUiLAw8SqDD0Abz6CUAPDVlpbab0iab3r7lenzGxELq5qti/8N/I6Wqd8C0bWE+cVmECyiLvSgLDxGBvPzFkrr/kJeO068oThrai2onpdotrb5O0ZEooqYarJkeds6nvZ6TmHvxxufUXbfOcC66WTBcYdW5kmBi8rF98v8U6o2FQpQ74GB295p8dtIZacsBaxb7a/DLBPrnV9rWTvi3rU99w1dTacQqbz2NjKr8X0O34BJ+DJLaY21+EIGnweJv3xfh8UM1LxUxcz35+uQDjrcxT4vgl/BjP1QaEGvnJc8TyE8rDfx5FlN7ceVd/VWhZyF2xJv/VSWyQckCdwQIVJXHjc9snbOx5j5cQ8GlKd8XpxxevFVaOfqCv4Z+c1XuP9DRByu/FLwpPdVtC1HHIZBBroWMHIZyNW/tDbKN4pyGSlRSf1aF3xvKUcSOJqLWXME26zbihT8rVR6egzk0hbFxvFuvEB3400WoeTozaqT2jE2kfNlcARXY0xaQj0tCCWUJgutpOfLGt4E+gh9EsN0rPvWNRpQ5fbGuWaMIz+fixBhzR4P1xXXuQND7XER5WZHGxxOh3ghHrj9GzGX+OQ65gVeIzbxIApAI5kyvNzNu+Djyb55rJRxlvxO7reiEbzJcjNiUtd8Rsev9FkQ8thxb9A3C8SW4v87A5Tc2yPOAcwrvXoUZpSGTrr1s4dS13k+OTs5PoEreUHtyqAjw==
sidebar_class_name: "delete 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={"Delete a vector store file."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/openai/v1/vector_stores/{vector_store_id}/files/{file_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete 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 delete.","required":true,"schema":{"type":"string"}},{"name":"file_id","in":"path","description":"The ID of the file to delete.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A VectorStoreFileDeleteResponse indicating the deletion status.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the deleted file"},"object":{"type":"string","default":"vector_store.file.deleted","description":"Object type identifier for the deletion response"},"deleted":{"type":"boolean","default":true,"description":"Whether the deletion operation was successful"}},"additionalProperties":false,"required":["id","object","deleted"],"title":"VectorStoreFileDeleteResponse","description":"Response from deleting a vector store file."}}}},"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>

71
docs/docs/api/delete-a-vector-store.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: delete-a-vector-store
title: "Delete a vector store."
description: "Delete a vector store."
sidebar_label: "Delete a vector store."
hide_title: true
hide_table_of_contents: true
api: eJztV11v2zYU/SuEnlrAsZNgRde8ZUuGBUiRwEk2DGlQ0NK1xZYiVZJyYhj+7zuXkmL5a/OAvQRwgMCyxft17jmX5Dxx5EtrPPnkbJ6cHh/zR0Y+daoMyprkLDkXf1AarLvDP12QpkDDxkgok6lUBmUmIuQkMn4LK+GDDJXvJ70ktSaQCexWlqWOq60ZfPPse574NKdC8lOYlYRodvQN0WBYOluSC6rOTGWdNT44RMSa1UQfjPpRIacM8dRYkRN2vEyLMjGNdSA5FJIsem2srY7HstJ4ldQ2X6NNv3G0EfkmOhLspRt+jGArsLRgc/DW1zL6yFpN0nTDB1fRerA/c4LTNc+MVURWPEsvfJWm5P240skCoWSWKX4n9W0H1LHUHs4d/aiU40QeGeXesgNthk+9JKigOcWdTNiA5JUiY2eLJk+wRK40oY/0OMGftvHuHvVxcuRDLEqZqdQqEzAupAa2RezE/0SwmrGddQpuJ+Q2Cvv9/v624bdIbRZ72cDzbwS9dI4ZwYt7QMLn1gX0qiikm7VcpbjmOVdpLlRdtFPShEgmaZr3MU4kUZBK7xu5Xs2htTWoTeRVIc2RI5nJkWY2vdqspMORlEHNJt2jync3ZU229+JcPAyvm2JSJD8iUXkIMVh0FtY0JVGAByiT+1kTWI5sFWJwX1IKJaXCpmnlHCH8Wl7/hdxNh9tuvYLXoXeEaQd4boXQnMP57VVfDG01yfUM7dHaPnsx/O1X8fHn4499Bo1eZFHWzGj5Baov4/0iMzGsKb7MZ0/mN8o5/bRdOalWUIXIeRrwQ7AWxmbWOmavIMJETQmfha2whrFVBR1EdRDVGxPV6adlvHsw/TMzvVGW70rrL1tBE0CIXlKijGFjsclAQqtChb64xR6MhALYIycSItF46dqd6sOuncqTm6L5gJOlRICHiVUZegHefPigBoaDtA7SekPS+tDdr66Y2chc3NVsX8Zv5HW+SfkWjKwvbiowgWQRd6URYeMxNh6Vs1ZerwffjUvIPzg+iOogqrclquNt0faQUFQJU01OPFdTX8eubjj91XTr29nGdQuEl04WeOXYwTwx+LJ2y/0ab4GKvZQy5BtI8G53ddH2oOufW1pfGjnSEvb6FrshwoY6iwWyR0q5xdLm0hkTReyzZDA9GaCjRip+6ubpB/O1tBcwq/fhurjKMaB5COXZYIATwVFuPUA90loW8gjNSL/3U1sknIAnQKzCLBpetGPo8YnfMTFj3k3Prtle3LG9uGvoGWmL+By8xml6sgU6VrNf4bXsKq3rOeQyCMynqYKTL0as/WF0UDyyk8lKi0HlMRnicUY5zCRXUzXjSzdPMTeWKfnaqXT0xTDdrIs63HQ+4quHhjKdnLRZfcac0z5SugSOGBqMSUOgnXxbAWC+HNS7LRp2BHoJg1LjBMYRYyvnDSkea2xrWjDmJxH4DjXw/Wyd02gk95/N5/MRzngPTi8W/DOOiY4bj8c4aEfcZdAgU56fs9dJsrOYd8OG7O/FvvLYWmbzI7jKFUld8Tc8fqfZFpUunmCSY3Bjh+J861XnaUpl6Nhv7Igrgru4vL68v4QK/wazgwQF
sidebar_class_name: "delete 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={"Delete a vector store."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/openai/v1/vector_stores/{vector_store_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete 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 delete.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A VectorStoreDeleteResponse indicating the deletion status.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the deleted vector store"},"object":{"type":"string","default":"vector_store.deleted","description":"Object type identifier for the deletion response"},"deleted":{"type":"boolean","default":true,"description":"Whether the deletion operation was successful"}},"additionalProperties":false,"required":["id","object","deleted"],"title":"VectorStoreDeleteResponse","description":"Response from deleting 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>

71
docs/docs/api/delete-an-agent-by-its-id-and-its-associated-sessions-and-turns.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: delete-an-agent-by-its-id-and-its-associated-sessions-and-turns
title: "Delete an agent by its ID and its associated sessions and turns."
description: "Delete an agent by its ID and its associated sessions and turns."
sidebar_label: "Delete an agent by its ID and its associated sessions and turns."
hide_title: true
hide_table_of_contents: true
api: eJztV01vGzcQ/SuDPSWALTlGgjS6qbWLGnVgw1YOhWMUFHekZcJdbkmubEHQf+8b7sqSIrn1IRcD0kVckfP15r3hapF5DrWrAodssMhOT07kK+egvamjcVU2yK7+zJZH2ft9W6OCyfM/DYdIDyqQqWbKmpycp1LZifMl59lRpl0VuYpir+raGq3Evv8tiJNFFnTBpZJVnNcMt278jXWEYe1dzT6aNrsQVWzCxjkDt1P2OLid1h+j0TW1p0m7nCX/aKLlDdsQvammO6bn3iP5dPiIFIXC+UihKUvl5+QmFFExpzMPhdEFmbZob1QVCQWTqrr9FGcp/qMy9qWR29MS2roKtVHRlKo69qxyNbZMGzZb6UgkU6HmSr+gyjdXaaXsWxrSl5vLrhiN5MdMTeCcokNnYc0zptJ5RpnSz9Q5UmPXxBQ81KzNxGhyWjfeM8L/kBcSU3lu2njXGw2dKBv4KBP+GA+eDO5WHV516wm8+6f+tTA9A96KyzTxrkw5DK8venTjmmlh52iPte4h0M3vv9HHX04+9gQ0flRl3TJjxS9QfR3vV5XTTUvxdT4vZP5yKdW/P/20XznaGqiCCpgHWUTnYFzNV47FK4gwNTPGd+kanBFsTckHUR1E9cpEdfppHW8Epn8WpnfKCpvS+ss10AQQ4kfNnAtsIjYVmawpTezRtWWFhCLYo6YKIrHY9L1Obx+eu6kC+xmaDzhFSgx4hFhNxY/AO+KJOxgO0jpI6xVJ68PmfXUhzEbmdNuyfR2/k9dwl/IrMPIeXTVgAqsy3UpjxsVTuQjAsNfJK+eJamzcldh/OT6I6iCq1yWqk33RXiChpBKhmpoGqWY4BemDJL+d7Blbxo0GsJWcoPGcDN74Ls7wU56WKgSnjZIQ+HsWYBbSXmx8FXoiDOVVCSdeAi2yCg9wnNz9bURyRgLVKhY7UMl1iFBdk9oM0Ow8JSW+1w2JvkGDduTZkWq5RGVIonA4mrX2KTUEHWT92bt+ch76i1VeS2y3N3GbduMF0iLGetDv453guHABNR9bq0p1jHbo7z3tykwCBQbIJs6T4dlqEN3dy55QM+XXde1S7OlW7Om2I2giLuJL8BaI2bs92Iiewxaz1abWNj3HQkXChJoZOPla0Q8fDA9OL+1c5bXDqOpaWLDxmEq+JWsOJEnmmJ8ozaF1qjx/rYRwzicl7jofy58PC216YNtl9RmTzoZE6ho4YmwIJh01fgLntqBarIf6z/DdMSvyY+zXFu91UkWix6Ij1F3br5ZSWAyeyA4CCG/kyGIxxtvhF2+XS/kZL5heCINlGtFjYQfok5sg6/xpBj1b2pubTgxv6X91s7eG7keQW7inbCNPWH7n+aZgl/c4W2DI4zaTDNvtodZcxw3DndtzS4Jn55fno3Po8l+1wjZW
sidebar_class_name: "delete 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={"Delete an agent by its ID and its associated sessions and turns."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/agents/{agent_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete an agent by its ID and its associated sessions and turns.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","description":"The ID of the agent to delete.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"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>

71
docs/docs/api/delete-an-agent-session-by-its-id-and-its-associated-turns.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: delete-an-agent-session-by-its-id-and-its-associated-turns
title: "Delete an agent session by its ID and its associated turns."
description: "Delete an agent session by its ID and its associated turns."
sidebar_label: "Delete an agent session by its ID and its associated turns."
hide_title: true
hide_table_of_contents: true
api: eJztV11v2zYU/SuEnlogsdOgRVe/eUuGBUuRwHEfhjQYaOraYkuJGkk5MQT/955LybZcO4O77iWA8xLa5P0695xLuk4c+dIWnnwyqJPzszP+l5JXTpdB2yIZJDd/JsuT5O2+rXFGwtE/FfkgHqUXuphLo1NhncilmVqXU5qcJMoWgYrA9rIsjVaS7ftfPDupE68yyiWvwqIkuLWTL6QCDEtnS3JBN9n5IEPlO+c03M7I4eB2Wn+Mx7eiOS2UTYnzDzoY6tj64HQx2zG9dA7Jx8MnQgqfWReEr/JcuoWwUxFQMcUzj5lWmdBN0U7LIggULGTR7sc4S/YfpDaHRm5Oc2hjC9QmsiqXxakjmcqJIdGx2UqHI+kCNRfqgCpf3cSVNK/FUHwaXbfFKCQ/IVF5SkWw6CysaU4it45QJvczdk7Iia1CDO5LUnqqlbBKVc4Rwn+XFxKTaaqbeLedhk6l8XSSMH+0A08G96sOr7q1Bu9h3b8GpmfAW3FZTJ3NYw7D26ueGNlqlpkF2mOMffRi9Ptv4v0vZ+97DBo9ybxsmLHiF6i+iferTMWoofgmnwOZv1xy9W/PP+xXjjIaqhAZzD0vgrUwLhYrx+wVRJjpOeF/biucYWx1TkdRHUX1wkR1/mETbwymf2Smt8ryXWn9ZStoAgjRkyJKGTYWmwwkjM516IlbQxIJBbBHziREYrDpeq3e3j13U3lyczQfcLKUCPAwsaqCnoB3wCdqYThK6yitFyStd9376oqZjczFXcP2TfxWXsNdyq/ASHvipgITSObxVpoQLp7CBgCGvVZeKU1lZcKuxP7N8VFUR1G9LFGd7Yt2gISiSphqcua5muEMpPec/HayF2QINxrAlnwCl5P3jOpkITReflcX2ErjUnpvlZYcKlSu8D3WhHQyh73jGHVS4AM3uvHxt2a9aY5SypDt4MR3Ify3HVoFRq/TmBP73/QjuAr92VFnyylUuo4e6/ix2E3p68hb+YBoP5YJIAYkmcXRpPEXgUISg6Q/f9OPwXy/XuW57Leh+vUGuCVsmndCg2zluOFZCOWg38eL5TSzHp04NUbm8hRkUV97yuYJR/cECuiwiIYXqzF5/8B7LJyYdMupa7YXd2wv7lr5RFkhPgdv0Jq/2QMgTxu/pTvZnQRdzyGTQWB+zjWcfC7Ed38YbRR/UlCRlhaD1EfSwYt2mJmukVIKeAVPWTeVinzjVDr6XLAcrItzYtf5hH8aGUwOB8DbrD5iDhsfJVcCRww1xqTlz88pYgulenPb/KTblmSBnkK/NHhrcu6RFHXLrfumSw27sBh0dNDG4m872gQdmEVsWtcTvGQ/ObNc8td4DDumD5bxOpkwV0CmVHtep+t5+Wy1r0atXl6LA2S+t7r2S5CduShNxZ+w/EqL7RnD2v8fMjtgCPyHPNddWD7gbIarE28ExrLZHipFZegY7rxJtubJxeX15fgSQ+YbyWqsPA==
sidebar_class_name: "delete 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={"Delete an agent session by its ID and its associated turns."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/agents/{agent_id}/session/{session_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete an agent session by its ID and its associated turns.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"session_id","in":"path","description":"The ID of the session to delete.","required":true,"schema":{"type":"string"}},{"name":"agent_id","in":"path","description":"The ID of the agent to delete the session for.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"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>

71
docs/docs/api/delete-an-open-ai-response-by-its-id.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: delete-an-open-ai-response-by-its-id
title: "Delete an OpenAI response by its ID."
description: "Delete an OpenAI response by its ID."
sidebar_label: "Delete an OpenAI response by its ID."
hide_title: true
hide_table_of_contents: true
api: eJztWF1P4zgU/StWnmak0gLa0ezw1l1YLRIjUCkPK0ArN7ltPOPYGdspVFX/+57rJG2gZbcj7QtSeSFtfH3PPfccf3SZOPKlNZ58crZMTo+P+V9GPnWqDMqa5CwZGnFdkhlenpOmQKMm4HryjdKQ9JLUmkAmcKAsS61SyYGDb56jl4lPcyokP4VFSZjPtoGlsyW5oOrcKuuM8cEpM8OYl1DujPpRkVAZ8qmpIifsVIScRBahZaKtJln12jw7JgVijxfr2mOeqaz01pfd5HXBgifrIOgJqZ/kwouHdeRDwukbSJ38E2s1SdPNFlxFr/NEmvEoAHOqXBHpFFMtZ+tcY4QlKySRWab4tdQ3HTKnUntM6+hHpRxDuGd2exvmW2yPvSSooBncv7b4JcD2tajna3GC27oPDBd9ka1u1l3pAzOj/mWXzMZoIyMmH8ST9EKZudQqE9aJQuqpdQVl/5/afJCh8p1xCtPOyG0V++d4fCPq0Sg0i8pqOPsvtV44B/BxMDonfG5dEL4qCukWrXApjnnKVZoLVRftlDRBoGBmsH4f80RNBan0vpnr0ZxaW4PaRF4V0hw5kpmcaDbNOuYFHM6k4BBp0j2q/HBd1gr8KIbibnTVFJMC/IRE5eHKYNFZRNOcRGEd7GO4n7Ww5cRWISb3JaXwVCpsmlbOEdK/wvUzim863HZrTV5H85GmN8hrNSumzhYRw/Dmsi9GtprleoH2aG2fvBj98bv4/Ovx5z6TRs+yKGtltPqC1Df5fpOZGNUS3+DZU/mNc06/7HZOqhVcIXKEe34I1iLYLNqJeVYIYabmhP+FrTCGuVUFHUx1MNU7M9Xpl02+MZT+lZXeOMt3rfWXreAJMETPKVHGtLHZZCChVaFCX9xgSwagAPXImYRJNF66dqf69NZO5cnN0XzQyVYi0MPCqgw9g28+iVBDw8FaB2u9I2t96u5Xl6xsIBe3tdo3+Rt7Dbcl35KR9cV1BSWQLOKuNCFsPMbGQ3PW2mt9Dt5x53hz4oOpDqZ6X6Y63pVtDwtFl7DU5MxzNcMZRO8Z/I4bI+24cInJQiic/S7P+yx+6WSBgY4nWyYGHzr33b/jFVHxfKUM+RYjvOtdnre9eJ0I3a0vlZxo04H6frvlx0ZFqxVKAaLcYmhzKY04kf4sGcxPBmiukYqf1r9TDJYdxCsMr7fiuqbKMad5COXZYIBDwVFuPXg90loW8gj9SL/3U1sknNgTWFZhEQPP25Xo/pHfsTYj3qZtVxwvbjle3DYKjcpFfk5eUzQ/2cEaG9q/kLbsmq07c8hlEFii5gqTPBjx6g+rB8VTO5mstFirPFoeTzTKYVlyNS8Z38N5IXNTmZKvJ5WOHgwrzrpoxe3JJ3z70DCnk7MW1VcsddpHVZfgEesGc9LoZk/RvaBjuVm5941vFBPoOQxKjQMao4ltXjZCua95r6XC/TiJEmx/1uolZ12Jo7msCQ5bLic4+t05vVrx1zg9OhYDHuP6O+HOQxqZ8vycrReYN0v6MGqE/1H8hFt2Vth8CQlzRVJX/AmP32nxyrOrRwzPsZxj32K49YhhmlIZOrFb++QL751fXF2ML2DIfwCjd/6V
sidebar_class_name: "delete 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={"Delete an OpenAI response by its ID."}
>
</Heading>
<MethodEndpoint
method={"delete"}
path={"/v1/openai/v1/responses/{response_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Delete an OpenAI response by its ID.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"response_id","in":"path","description":"The ID of the OpenAI response to delete.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"An OpenAIDeleteResponseObject","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the deleted response"},"object":{"type":"string","const":"response","default":"response","description":"Object type identifier, always \"response\""},"deleted":{"type":"boolean","default":true,"description":"Deletion confirmation flag, always True"}},"additionalProperties":false,"required":["id","object","deleted"],"title":"OpenAIDeleteResponseObject","description":"Response object confirming deletion of an OpenAI response."}}}},"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>

71
docs/docs/api/describe-a-chat-completion-by-its-id.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/describe-an-agent-by-its-id.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

20
docs/docs/api/eval.tag.mdx Normal file
View file

@ -0,0 +1,20 @@
---
id: eval
title: "Llama Stack Evaluation API for running evaluations on model and agent candidates."
description: "Llama Stack Evaluation API for running evaluations on model and agent candidates."
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

71
docs/docs/api/evaluate-a-list-of-rows-on-a-benchmark.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

20
docs/docs/api/files.tag.mdx Normal file
View file

@ -0,0 +1,20 @@
---
id: files
title: "Files"
description: "Files"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

71
docs/docs/api/generate-a-chat-completion-for-the-given-messages-using-the-specified-model.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/generate-a-completion-for-the-given-content-using-the-specified-model.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/generate-an-open-ai-compatible-chat-completion-for-the-given-messages-using-the-specified-model.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/generate-an-open-ai-compatible-completion-for-the-given-prompt-using-the-specified-model.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/generate-chat-completions-for-a-batch-of-messages-using-the-specified-model.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/generate-completions-for-a-batch-of-content-using-the-specified-model.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/generate-embeddings-for-content-pieces-using-the-specified-model.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: generate-embeddings-for-content-pieces-using-the-specified-model
title: "Generate embeddings for content pieces using the specified model."
description: "Generate embeddings for content pieces using the specified model."
sidebar_label: "Generate embeddings for content pieces using the specified model."
hide_title: true
hide_table_of_contents: true
api: eJztWdtuGzcQ/RViX5oCtuQGvToPhdu4bYAkNmznoXCMgNqltEx2yS3JlS0I+veeGXKl1cWxk+ahAeQHS+JlOHN4ZjhDzjOnfGONVz47nmdPj47oo1A+d7oJ2prsODsxQjonZ8KOhapHqii0mfgDYY0SY+uEknkpcmuCMmEgTunXcpjQXkhRaR9o9riyMviBuCqVKHStjMcKstKBZQe0rk2sbaGqQ9+oXI91/kzMbCtyaUReqvxD7BW1CrKQQYrW06wht/rhnD/f6WIxyA6ypByZJpum0rkk04bvPdk3zzwE1pK+hVmjYLEdvVd5wMTG2Ua5oCM6K+N7YxkaDNVB1Y9pNy2kuGyxONiA+WUCaQXBFEpYl5CGHkKbpg3/X6jZKAmZgdc674E3lpVXByDbP612qsiOr/to3hxkQYeK4Dldtl4kYmabQHUdDITUhpSZKKOcDKroMXQAfUij73eRmnAhbRTgupUe0E6BTiHA51pWoHUNLb8Yc3yQoe2zQEPsBDTYtO2vq6tzEUfDvEJliyU0y7k+OJi3NfXUOSjPgw9ABF9aF4Rv61q61Z7zmNtSgzg6Gu20NIH9GNsd+3kd5ifgrR67chxNS1fWwDZRtrU0h06BNKMKLFzNWVOHVtIGNpv8EVY+OWsiu74VJ+LNxctkDHF1pMBMMCBY7Cxmq6kCc52CmbSfvHNCjixciBbvyC5snrfOKSy/odensDntcLdbS/D61Gapu8HrorAYO1uzDifnLwbiwraTspphe6rK3npx8cfv4qefj34aEGjqTtZNZEbHL1B9td5vshAXkeIrfR7J/OQ5T3/Z7Tl5peEVosR0T1+CtZhsZp1gkgoiTPRU4bO2reGgFBCI9k61d6qvzKme/rJa7wpMf0VMT57l+671N07NUgIhdZcrVRBs5Gw4l3Au1xpH9nmlJBQKYI+c4OwSFTpdd1L9cN9J5ZWbYvMBJ7mSAjxErNaoO+DNp16CYe9ae9f6ilzrh/559YKYDc3FZWT7av3kXifblO/AKAbirAUTlKz5VBopHDzGBgCGvuRehRrLtgo7K5x7Be+dau9UX5dTHe1a7REuxF5CVJNU4F7DH8eKESH91/X9M5VbvWqL2ZM8RTRa5cqnQrGHM9bkapGK8kY6iZJSOVrsJgKJA/U3W8zImi/kdF1x+jCp6JzVBZYkPV3Hglj6gk1gVaymUzHcIn0G2chfloV07HJqgiKcD+lbHUrxspK1FJdBopKWBif3FHvB3jDVkhdJpTTO96KxiAq8swkAtsIadTYGTA/eLiTbsI33D90Sdg90sXcbNiiGigLhq5aTSPIUVnstfWCfa/pVayNDiisduB1dSLWBOKlu5cyLt1HM24xjAkt8cJdbV+2I6hwa0lIsiGocvsGgDiRf1BGjAg2jnmMeN5zTcotnI+RqP35/MKeexUC8tmB8KDGa5iMVq4qY7lXKTLDRnON54vZD2urH0ZGWid2CecHeZGNSqbxtHXzzkwIUrdwLRpDPIR7m3bPRtD2nyDqJ3uiKgGzpGps5PaWkN2LNQFOBuKTkx/VcF/mCZUi60tqQngCJZxVb8CkIsI0dr3pQ8Hq/R4NfgI5bNp4ks/qczXpu9plOFNRdWPOhZcN/ciGSEj2I5T3MNozqZH0WoLxMD08S+HE4Q2/JhCadM31LSe8E5+w1DguCJy5X40xgSs4fGyL20WwfzfbR7IFothkt9kHtvwe1xWKjxK0UvKzoy1kstjLs7jWoywLJUya7s+70ENStmqoguU6t3SuLJ5SQllz2pHk1dkwjH0VxFfPdkUJU0FzbNUhQvbCmlxnTfJBjiswZilzaOnV4UdOLoUHd4tumoTKUsBl0u/cuuNbEnH7XRirT1rQRBskqfqK0cYGbi+1ipFcNwrSxnnApUtpbji5xGRV3hp8rl+n6LQyP7SiDU72KgNgz7xsy4054Kk0Ioxga2QhUkE0b3i3f1h5R1/cUPePZmy9zpN7a05wfiLMehIgXo5l4JYObWV9+kAnqCKr0H97d55gdnDDDUS1Q2LytySs+BuZfQBDArL8VjhT9pxL7V7CDrg/82i5HFaWf1TWV3/lmdcSvcp/gicv6rVcQ3fNcGF862N9WErD/Cg1QprT4mTWWX0MaGUr8Gk6/G+quzB32XiRBOb6E8lwn8YGclSE0x8OhNLPDElJUcVhRZXfoqbIb5DYmMF6hmsZm8sTnXQS8vqE+Kl4vVmXu6ap2X5WpWweWjzcL3Hizw3k6H9km5NEaK9Lm80XL2DJLEoj9AvUyXYhE4QcZYRCXmX6341SPBOjfpMj+3U5fMqcaKVT4t0Zs/CFeqfj+nYpgz7EFUjTdK7h4ORLfqymWjSXdMLBQ6dRbegmurOObn23hI3rsqhSMoUMvavVq5TtEilqyC5uYZn6JC441rHoXGl9EeNpTYsOwqaQ2ZEdKHCO5r+OOLelNYWDtyZ1ITMPmc8pJ3rhqsaDmSBO+kuGLwRFxBPzFBCUR5ZnYHxSGZOkkObyKx+VUVi3fOGze11CZFGec5LlqwkfH3vS89fzs8gqDR+lOiKxHq5O3aKT/xxkRnyHmxITb5lklzaTlVDuLMunvX0laQdg=
sidebar_class_name: "post 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={"Generate embeddings for content pieces using the specified model."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/inference/embeddings"}
context={"endpoint"}
>
</MethodEndpoint>
Generate embeddings for content pieces using the specified model.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"model_id":{"type":"string","description":"The identifier of the model to use. The model must be an embedding model registered with Llama Stack and available via the /models endpoint."},"contents":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"image","default":"image","description":"Discriminator type of the content item. Always \"image\""},"image":{"type":"object","properties":{"url":{"description":"A URL of the image or data URL in the format of data:image/{type};base64,{data}. Note that URL could have length limits.","type":"object","properties":{"uri":{"type":"string","description":"The URL string pointing to the resource"}},"additionalProperties":false,"required":["uri"],"title":"URL"},"data":{"type":"string","contentEncoding":"base64","description":"base64 encoded image data as string"}},"additionalProperties":false,"description":"Image as a base64 encoded string or an URL"}},"additionalProperties":false,"required":["type","image"],"title":"ImageContentItem","description":"A image content item"},{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Discriminator type of the content item. Always \"text\""},"text":{"type":"string","description":"Text content"}},"additionalProperties":false,"required":["type","text"],"title":"TextContentItem","description":"A text content item"}],"discriminator":{"propertyName":"type","mapping":{"image":{"type":"object","properties":{"type":{"type":"string","const":"image","default":"image","description":"Discriminator type of the content item. Always \"image\""},"image":{"type":"object","properties":{"url":{"description":"A URL of the image or data URL in the format of data:image/{type};base64,{data}. Note that URL could have length limits.","type":"object","properties":{"uri":{"type":"string","description":"The URL string pointing to the resource"}},"additionalProperties":false,"required":["uri"],"title":"URL"},"data":{"type":"string","contentEncoding":"base64","description":"base64 encoded image data as string"}},"additionalProperties":false,"description":"Image as a base64 encoded string or an URL"}},"additionalProperties":false,"required":["type","image"],"title":"ImageContentItem","description":"A image content item"},"text":{"type":"object","properties":{"type":{"type":"string","const":"text","default":"text","description":"Discriminator type of the content item. Always \"text\""},"text":{"type":"string","description":"Text content"}},"additionalProperties":false,"required":["type","text"],"title":"TextContentItem","description":"A text content item"}}},"title":"InterleavedContentItem"}}],"description":"List of contents to generate embeddings for. Each content can be a string or an InterleavedContentItem (and hence can be multimodal). The behavior depends on the model and provider. Some models may only support text."},"text_truncation":{"type":"string","enum":["none","start","end"],"description":"(Optional) Config for how to truncate text for embedding when text is longer than the model's max sequence length."},"output_dimension":{"type":"integer","description":"(Optional) Output dimensionality for the embeddings. Only supported by Matryoshka models."},"task_type":{"type":"string","enum":["query","document"],"description":"(Optional) How is the embedding being used? This is only supported by asymmetric embedding models."}},"additionalProperties":false,"required":["model_id","contents"],"title":"EmbeddingsRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"An array of embeddings, one for each content. Each embedding is a list of floats. The dimensionality of the embedding is model-specific; you can check model metadata using /models/{model_id}.","content":{"application/json":{"schema":{"type":"object","properties":{"embeddings":{"type":"array","items":{"type":"array","items":{"type":"number"}},"description":"List of embedding vectors, one per input content. Each embedding is a list of floats. The dimensionality of the embedding is model-specific; you can check model metadata using /models/{model_id}"}},"additionalProperties":false,"required":["embeddings"],"title":"EmbeddingsResponse","description":"Response containing generated embeddings."}}}},"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>

71
docs/docs/api/generate-open-ai-compatible-embeddings-for-the-given-input-using-the-specified-model.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/generate-synthetic-data-based-on-input-dialogs-and-apply-filtering.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/get-a-benchmark-by-its-id.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-a-benchmark-by-its-id
title: "Get a benchmark by its ID."
description: "Get a benchmark by its ID."
sidebar_label: "Get a benchmark by its ID."
hide_title: true
hide_table_of_contents: true
api: eJztWE1v2zgQ/SuETi2Q2GmwRbe5pZtuN0CDBEl6WLRBQEljiy1FqiTlxDD83/uGkmzJdtIssJcA8cX64HBm3rw3FLlIHPnKGk8+OVokhwcH/JeTz5yqgrImOUqOxQcyWVFK92OU7CWZNYFM4HGyqrTKJI8bf/c8eJH4rKBS8lWYVwRzm36nLMCwcrYiF1TjSuWYRE0Uud5YH5wy02QZB88wxN0iPlu7jG5V/vjAB943DzZf7CVk6jI5+pqUNieNe18o0jkuZojWuts8xXUug/TEwfvMsuHtpDZZxGUvSTtUcB2s1e3f7dTZumryLauQ3ETIPAAbWOQ0kbXeftpH/rog0eUvOIE9IfWdnHuxtlmuotyJwOaUpyvYhZ2IAAettQhW1J7ExLr4eOVB0EzqOhaZnW0C4Xs+pXNyDpcqUOl3VmMYzGflA4fRzim6OcWaHJ7jYp7NRV7HQcNwSgqSM9hFOJnnisdJfTGgnjV0PkHtVxam1hqTre5TlJGk6T8CW1JQtfdkldRG+r0HbSTLm63Mz9qwW7iV76UlUA/UdflQAhOpPe1BuD9r5ShnEvfENFREy/8BR3bVsAck+BpU0Bz/hweZedzjx4qhnEuXBgoVlSUQNp6X0mQ0QlKc1h+7ukzD9Z81gRJ30gtlMJPKBeYspeYpKP//uo8PMtR9iipMO43wDcP65/r6QjSjRYaEYktp4Pmd1D46x8XlwdCt8IV1Qfi6BGjzTnwUx9wVKiuEapJ2SpoQsZSmfR/9RA4FqfRTPTej2bW2BrmJokYZ9h2hzqmG8Nc2g3DYk0LD4pL93ter86qh6GtxLL5cfm6TyRB8StxRclawI1jTjEAKR0gzUiJ6lqmtQ3TuK8rA4UzYLKudA79oI67/Iom2wl21VuD16B1hegC8blkUE3TxGMPxxelIXNp6WqAXTazW9s6Ly7//Eu/+PHg3YtDoXpZVw4yOX6B6T04yF5cNxdfxPJH5rXIO3+9WTqYVVCEKmHu+wEIEYzPvJuZZQYSpmhH+S1ub2HiDKulFVC+iemaiOny/9ncNpp8x01tl+b60/rU1NAGE6D4jyhk2FpsMJLQqVRiJCyz0CCiAPXIqIRKNl65bqd4+tFJ5cjMUH3CylAjwMLFqQ/fAO+COWhhepPUirWckrbf99eqUmY3IxVXD9rX/Vl7H25TvwMhH4rwGE0iWcVVKCQuPsfEjNe/ktdoDbW05H5n4RVQvonpeojrY5e0JEooqYarJqedsVtsxzwkMA/6EHbzsbcrSuVD46js94SObSjqJ/R1203HXa3DTP3doNoWKp6lkKHYeQ5yedGVY+0BJpxTYwRrz4Gra21Zgt1le3sSdZmExNJnGk5Xo8igZz96MefM4Xs3vx4t+iEveuMZG1GRRO8avCKE6Go/xAbBfWA8M97WWpdwH9tmPUWbLhF16AqIqzKPhSdd1vt7wO+ZhjLQt0We2F1dsL65aNsr2yIedN5jM3uyAicXrBzSWfWH1Zw6FDKLdqftvRmz80CkofqGTySuLvuTRCOLXi3JoQa5hZs7bbG5abiIz8s2k0tE3w+yyLspue/KUdxoaQnRy2kV1xpt1HxlcAUf0CMakZcqj5BqAsFj35setWl4Eug/jSuPDiz3Hki5aRnxtMGZO9A/bWM1HA+qihlx6tlgsUnzNfXF6ueTH+CB0XHNcxpaacoHBgFx5vs5XPePBHF5dtsx+LX6vgp05dWdDhg/G+HCE73D5g+abGoznRAU6M5+JIsxmyHGWURV6xltL3kBUnz5eQ2a/AOHCoBg=
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 benchmark by its ID."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/eval/benchmarks/{benchmark_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get a benchmark by its ID.
<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 get.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A Benchmark.","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":"benchmark","default":"benchmark","description":"The resource type, always benchmark"},"dataset_id":{"type":"string","description":"Identifier of the dataset to use for the benchmark evaluation"},"scoring_functions":{"type":"array","items":{"type":"string"},"description":"List of scoring function identifiers to apply during evaluation"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Metadata for this evaluation task"}},"additionalProperties":false,"required":["identifier","provider_id","type","dataset_id","scoring_functions","metadata"],"title":"Benchmark","description":"A benchmark resource for evaluating model performance."}}}},"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>

71
docs/docs/api/get-a-dataset-by-its-id.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/get-a-model-by-its-identifier.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-a-model-by-its-identifier
title: "Get a model by its identifier."
description: "Get a model by its identifier."
sidebar_label: "Get a model by its identifier."
hide_title: true
hide_table_of_contents: true
api: eJztWE1v2zgQ/SuELk0Ax06DLbr1zbvtdgMkaJA4h0UaGJQ0lthQpEpSTgzD/31nSEmWbGfjBXoJkFxCyeR8vHlvRHIVGbClVhZsNF5FZ6en9C8FmxhROqFVNI4m7FKnIIfRIEq0cqAczeFlKUXCac7oh6WJq8gmORScRm5ZAi7V8Q9IHC4sjS7BOBHciBSNiLkA05lrnREqw7l977dK/KyAbZawuTbM5cIyDF1XJsEfFZOSF5xZx5OHaO39LXCJmTVzZiL9Zb5cDqxx0HN2iI/zz0zPeybwgTumH5XtuyLTwdauTVBVEY3vooIqg882FyBTHCwQb21maUyOueMWCH6baFo4m1cq8XEMohhUkhfcPODYaS3rf7PM6KoMFStKF937olsseesrhTmvZP9NN8Mp5tbCRYEPGJePfGnZO7/gnUfVD9t5lpItwHGKeR+BeJoKss/lVY9KWsG3OSLRrlCVlGisfY4xKeCq+wqxi33ltnHtvOHG8GX3RR3J+n69ne9ELdkmPNZkseFOgIkSpMGsqekGRymLvSjSTGJLwOro4uKSoU3A6NGdysL742jwLD2C4XYBVdMJJ2mu1/SU1q3Xz8E759LCAFvEz0oYSMliR7p94tdBdKrYy3fb806+ky1G4KDEMXnDTLlik/N2RiasAwyIxHjhhX9Dwh9iKpTMb/u6WGAlyts69sgtLl1wKVICtOASa1VA+us6HDYiV9nOPIFmMw9aP6y/p9MrFmazBNPzog9AvdRJvhhDDKPJqDBmc20cs1WBol42PQb8nMdcJDkTIWkjuHKenAhq+N378bx2XMhDPYfZ5FpqhbmxvCq4OjGA5Y8lsM6aXjjkSWBL4So5IMujb2Ug5jGbsNvrizqZBIOPgVUWWeA0VhZXwwKQIoZ6NNXTV47xWFfOO7clJMjchOkkqYzB/gdbcf0fIdQVbqrVgtchuofpGfCazy6bY5/1MUyuzofsWldZLpdYHin1o2XXf/3JPv5++nFIoMETL8rAjIZfSPWNvz94yq4DxTfxHMj8Wjlnn/YrJ5ECVcFyXE6SRMg1LsbGVxsmq0iETCwA/xe6wjmErSjgTVRvonplojr7tPE3RaZfEtNrZdmutP7RFWoCEYKnBCAl2Ehs3AGTohBuyK5w84EBOWQPzzhtVPFH03ypPjz3pbJgFlh8hJOk5L91WJtKwRPi7fAJahjepPUmrVckrQ/d79U5MZu2zDeB7Rv/tbwmu5RvwEiH7FuFTABe+K9SDPjhUdpvTdNGXu0Oe+dI+x+G30T1JqrXJarTfd4OkJBXCVGNZ5ay8QczS8H3g/0KDusbDl/xkgna7bXHQLoWKrnheOwDY/1JXOFDczsQjoaCzJTc5XuPuZ37lroUwReWNANHDjaYO1PBYFeBzQF+fe8PoLnGqVHm7z6823E0WrwfebN2tGoiW9PViO89IfDKEGS5c+V4NMJv/kmu8aCZnvjLpRN/uTRMdBGRFwsIonBLv/Bz02ju7uk3op4Prq5K54zKbmoC8voehpwHKBbv96BDerU95vKulrqW/TVSfSS33xXb+sPmAH5TDiotNbYii9r3GxZhsOuYQEZ/r0B9ysx5AjYY5Qa+KyKUNl5pu8ZjOlxI1J7hWRNVoJMnbYk4YlsgTGpyvMipHhCrTUt+eWVNCQdPblRK3HNRBL60q5oMdwHrQAccjFuqYvGo5jRltYpx53Zr5HpNr3HzZ6jYOPTtM6bKYulTYWmctv3h2cCPrmsWH7PDWL83keZ+Si2JPFxW9ITDB1h2NefvqXLswnTHimGGnydJAqXrLNz5vPUE9PXLFCX1LyW3t7w=
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 model by its identifier."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/models/{model_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get a model by its identifier.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"model_id","in":"path","description":"The identifier of the model to get.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A Model.","content":{"application/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string","description":"Unique identifier for this resource in llama stack"},"provider_resource_id":{"type":"string","description":"Unique identifier for this resource in the provider"},"provider_id":{"type":"string","description":"ID of the provider that owns this resource"},"type":{"type":"string","enum":["model","shield","vector_db","dataset","scoring_function","benchmark","tool","tool_group","prompt"],"const":"model","default":"model","description":"The resource type, always 'model' for model resources"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Any additional metadata for this model"},"model_type":{"default":"llm","description":"The type of model (LLM or embedding model)","type":"string","enum":["llm","embedding"],"title":"ModelType"}},"additionalProperties":false,"required":["identifier","provider_id","type","metadata","model_type"],"title":"Model","description":"A model resource representing an AI model registered in Llama Stack."}}}},"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>

78
docs/docs/api/get-a-paginated-list-of-rows-from-a-dataset.api.mdx Normal file
View file

@ -0,0 +1,78 @@
---
id: get-a-paginated-list-of-rows-from-a-dataset
title: "Get a paginated list of rows from a dataset."
description: "Get a paginated list of rows from a dataset."
sidebar_label: "Get a paginated list of rows from a dataset."
hide_title: true
hide_table_of_contents: true
api: eJztWGFvEzkQ/SvWfgIpTQo6xJFvvYPjKgGt2qLTiVbI2Z0kBq+9Z3vTRlX++72xvcm2CaU9IZ2QioSabOyZNzPvzax9XTjyjTWefDG+Lp7v7/OfinzpVBOUNcW4OBDHcqaMDFSd5MXDYlCU1gQygdfLptGqlLx+9MXzpuvCl3OqJX8Ky4Zgxk6+UBmwsXG2IRdUclnJ0F8lnZNLLFKBar9rt6wqxY6kPr5hxxo6mhbjT+sdptW6WA3W3yfWapKm/8i09YRc/4kPTplZ/0kC1HuQkawuVqvBrUydzUlo5YOwUxEDEFPrRMDTsnUOyRKNnBGMFXPpP9fWUS/CDt9to3/NCRaiGUdC4j9vzPblQiotJxo/TENcpLzwFNhH63TPfI5sF+SPJ+8iUFmW5D1WJTMcScFB7k75VGpPA/Dnn1Y5qpD6VMtecBeDIqig2f0WhbaQHIgZGXKq5CSltaIjJwDJAIxa20sELbyqG8QM0LUMQ4BkmL/sIi/HxxAJVbmUXiizkFpVAuHWUrMBQP9hZPZBhrZPWwWzM1DsdrB/np0di7RalLaKnMip+l7F3jjHpOLFA07F3LogfFvX0i2ZeEw3imsu56qcC5WCdkqakMps8u/RTyRxAIvu6zmtZtfaGsQm5m0tzZ4jWUUi9vbcgMOelEHMprxHlE+OmkS5p+IgEjQFUwL8hETrQY5gUVnspkUnCZMIwZ7lxLYhOvcNlWoKWtkyqbCkW7geQvFc4a5a6+T1qB7T9I3krQk9dbaOGA6OD4fixLazuV6uGX7yx+/i5a/7L4ecNLqSzPY+v0D1jb/fZCVOEsU3eO7J/Kyc5692K6fUirsWBI2mgg/BWmw2y84wWwURZmpB+Fvb1sTeF1RNj6J6FNVPJqrnrzb+zsD098z0rCzfl9bftoUmkCG6KokqThuLDSMLQ7NWYSiOMcp5bIE9ciYhEo0fXTepXnxrUnlyCxQf6WQpYd5XTKzW0BXyzQORchoepfUorZ9IWi/68+qQmQ3k4jSxfeM/y+tgm/JdMqqhOGrBBJJ1nEoTwuAxNiBh+C3Lq6KpbHXYcZK5w/CjqB5F9XOJan+Xt3tIKKqEqSZnnqN5jVMbjoyHR4z/Jt63FFDizXmsO9w6xhfRS1Gl7cNz89GTx69TfNubSK5O3sm1uOTj6/jc7DHjXfisTEVXYxGnHj/gY2d8Jp7sp91Ph+JwKj7gYD9IS7LLCcGowfohW4sDdyw+xKP85uCdeNE6szbCL757zwb5MU6RWqe1MHNu0ttyrosypW6RiQiX4xuLd9891kc03dF3LP7TsZ3vVRrpZE146uNthsEXVCJn+bPiRqW4No0M853H+cPXHbXzJk7GjJIQ1pVjVxtOB9eC41sdrrsO4euPDKRXvQ4JXpDccgvKYSwmep9d4+jSNlUO2QSUjGwoItFQkAhPpYLdRJhluAWxa659jJETd6PjRJk1Z6LbjOWBXqEZVGtusbjA9lhAFGZcjBbPRjlwZUeou2Mvo+tNJVdYnN74UqnjhU0xD6EZj0Z499ybWw/V7Wkta7mHxJdfh6WtC/bpCdxTYRk3vu4G3qcL/o1bYMSau8M73i9Oeb84zY0wihL+2XnKyOLZjiTx3PA3Oqjs9/S+5XhFg0m4UDBybsStf5L5zfvIVI1F/qACE1+clcP0c0l8VWoDSNZUluSTUYjn3HBjsy52/G3jEz7kaswAByFmVO8xUbWPzbNBHjGeOCeZIQ9pbLfTcr15UXhskP9Dg8wSDHQVRo3G4ap32Zm09ymTuVNfuk+O+sPHca+XQi0sMt5yfc1J/ej0asWPU9tgdVXKM5JNN/gmG35Iy9sZ3ldabvXehdQtr4yX0/cHeWfnu8N511Q3bi/4C14pJ9xlHpSoJye5wz4VD5tYO/F1N/Vm2YfX4e5Ve3XBV+94R0XnZsBpwUFZUtOPbOvl/0aTf/vmDG3/X3Z9zXc=
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 paginated list of rows from a dataset."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/datasetio/iterrows/{dataset_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get a paginated list of rows from a dataset.
Uses offset-based pagination where:
- start_index: The starting index (0-based). If None, starts from beginning.
- limit: Number of items to return. If None or -1, returns all items.
The response includes:
- data: List of items for the current page.
- has_more: Whether there are more items available after this set.
<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 the rows from.","required":true,"schema":{"type":"string"}},{"name":"start_index","in":"query","description":"Index into dataset for the first row to get. Get all rows if None.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"The number of rows to get.","required":false,"schema":{"type":"integer"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A PaginatedResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The list of items for the current page"},"has_more":{"type":"boolean","description":"Whether there are more items available after this set"},"url":{"type":"string","description":"The URL for accessing this list"}},"additionalProperties":false,"required":["data","has_more"],"title":"PaginatedResponse","description":"A generic paginated response that follows a simple format."}}}},"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>

71
docs/docs/api/get-a-prompt-by-its-identifier-and-optional-version.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-a-prompt-by-its-identifier-and-optional-version
title: "Get a prompt by its identifier and optional version."
description: "Get a prompt by its identifier and optional version."
sidebar_label: "Get a prompt by its identifier and optional version."
hide_title: true
hide_table_of_contents: true
api: eJztWO9v00gQ/VdG/kIrtU1BIKA6nVQ4jkMCUZWCdAKENvYkXrB3ze46bRTlf+fNep04TTgKui9I7ZdGyXh+vHlv1rOLzLFvrPHss5NFdu/4WP4V7HOnm6CtyU6yUzpztm4CwdS2Luej7CDLrQlsglirpql0rsR69NnLI4vM5yXXSj6FecNwYsefOQ94sHG2YRd0F7CJngd2PjhtprDbzOGiZPJzH7im7hEKfBXoUoeSZsppNa6YmkrlXNqqYOeP6F362pNyTNZUc/Jt01gXuKDLkg21HqEowPV5DwKdnr04ypYH2Qw+dFdLykyj4Cm7rdTedZa0lwzIB4X64FkFuntA2uSOa2CFsDDzasb7EqGr45Muflz9W6O/tky6gBc90Ygxsa5WQVwqT3cacfTH/UeHhZ7qcFgqX/55J1bRYzCIoZxTc4TQANNvx15eD/5S+0B20uO+QtuoGniFElXmytCYgSfy0SYiuupSja4EFrfafyp4otpq2O+xtRUrE0tOv01U5fl6Fk86O7gvItcAL3qISA7htKfUL9I+hk/OVl8Dr84uEW6JfFRRaPGuqrMBJ1N0x19b7RjNeb/iwrBnQ2w3Svt4kAUdKqmtk81WN097cHo94UODz9JcYQ0IZBGZXjdsTl/QU9ii4EjwTVAF65eVqhW9CSr/At4upa77u0QsApKaGM28BGe0malKg5GOalUJnbj4/2QNCYTW30A8/1xcnFFnTbktIk8SfD8SxTPnpKlifCCglVA2FF7Xys2Fr0IDjjaXpc5LYYYUjaaZEPkANnW/xziR90Hp6qaRO2sJXVkjui/bWplDx6qI+hg8s5FOlIJBzSa/QZV7r5uOo/t0Sm/PX6ZihooLFp3F0zxjqsEclNmNB4msxrYNMbhvOMfwyMnmeescI/y1vH5GE6nDfbdW4A3oH2H6Dnj9qUMTUDrmIIOXzm07LTGoJ7aq7KWn87+f0sNHxw/jSOYrBd7zkF+g+jreE1VgkEeKr/O5IfOTcu493q2cvNJQBWGwksgUkFs8bOa9Y/EKIkz1DMeKqm1r4sgMuuZbUd2K6jcT1b3H63gXYPorYXpSlh9K61/bQhNAiK9y5kJgE7HJ0VTpWocjOsOhjYQC2KOmCiKRc8v1J9WD751Unh0OXQKcIiWW0xC9aQ1fAW956+EEw620bqX1G0nrwfC8eiHMRub0pmP7On6S1+k25XswiiN63YIJrOp4Ko0ZB4+xcTsoenkN3ravvYH+h+NbUd2K6vcS1fGuaDeQUFSJUE1NvVTTrWtest/M9jkHNDgtX+M5aXnfW+/iyuBlMjWoXzjliqRRDisyNC7eF5nsy3A2XCG1eMdyV+687xiESC3q9z9LUw4SYt2M4Fo0Z0ua/VK/PFglsN5mY3ic6m6+M36/O+8KTntpuHj5Qg51H/Y3M0p82UqpnwLLJYAGPqWFcQafETJgcZKNZndHXTg/WqwAW8KgezHoAG2ddLgMoTkZjfCKclhajy4fVrISH/q4Eue2ziSOZ/Rch3l88K9+Lr7/KL+JUmJ+iUSDlZreJL1EHWWDa6FsdncHaDJe/IbQ1FD6Q8/x4gS1zdBm/8HQtT/MMo47BJuiscDMR57Bi3YYkq7TTiEXBgKom6i8v41Rjj8Y4X+8RQh22/lYdqEKo8KpaZ/VKwzeykeNNcARU0wwSZz5RQVswLNYnyu/6i8xSK7+Rk2F10nJNtJgkajzvutLIg8+naz1hlYLQ8RosRjjtfStq5ZL+brTgFCj0F7mdrH7FmpYwi8rZGcRX3i+IU2sqK1YRfL2N00/meHeedLiPt1wnOxMrb82NPNhXn3Ka3iXH2Fc4uCDtiXR7vfTPOd4B9Y/ufVGsTEGnj+7wGD4BmWx6Uc=
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 prompt by its identifier and optional version."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/prompts/{prompt_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get a prompt by its identifier and optional version.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"prompt_id","in":"path","description":"The identifier of the prompt to get.","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","description":"The version of the prompt to get (defaults to latest).","required":false,"schema":{"type":"integer"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A Prompt resource.","content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"type":"string","description":"The system prompt text with variable placeholders. Variables are only supported when using the Responses API."},"version":{"type":"integer","description":"Version (integer starting at 1, incremented on save)"},"prompt_id":{"type":"string","description":"Unique identifier formatted as 'pmpt_<48-digit-hash>'"},"variables":{"type":"array","items":{"type":"string"},"description":"List of prompt variable names that can be used in the prompt template"},"is_default":{"type":"boolean","default":false,"description":"Boolean indicating whether this version is the default version for this prompt"}},"additionalProperties":false,"required":["version","prompt_id","variables","is_default"],"title":"Prompt","description":"A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack."}}}},"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>

71
docs/docs/api/get-a-scoring-function-by-its-id.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/get-a-shield-by-its-identifier.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-a-shield-by-its-identifier
title: "Get a shield by its identifier."
description: "Get a shield by its identifier."
sidebar_label: "Get a shield by its identifier."
hide_title: true
hide_table_of_contents: true
api: eJztWE1v2zgQ/SuETi3g2GmwRbe+ebvdboEWDZL0sEiDYESOLTYUqZKUE8Pwf+8MJdmy43S9wF4C2BdT0pAz8+Y9fi0zj6FyNmDIxsvs7PSU/xQG6XUVtbPZOJuIy0KjUcNskElnI9rIRlBVRktgo9H3wJbLLMgCS+BWXFRIfV3+HWWkjpV3FfqoGz9a0SB6qtH3bEP02s6yVTKek4m/peBc7SXeavVrwye+Ny92PwwytHWZja+z0ik09BxSgtSYU7TO36qc2goiBOTgg3Tc8XZaW5lAGWQ5WlmU4O+oHZ0z7d/tzLu6avItq5jdJMhCZOedD4VTqM3Oqz7gVwWKLnPBoQ8EmHtYBNF24MzBQxn2IQ1KaR4IzPkW5s7ilyklve5ha2NoqPVzTvEj2P4rgimnGvXerLFdvwHvYdF/0UayulntJvbiS9VE9lK8c3aqZ7VP/BEpG4zog5g6LyIB0KW6eiqjKZiAA+Lvj1p7VFzOHq22udEygaoRdTQc5OV+6CciwBTjonXfK0MBUUiwIkdRB1QiOkFkl3eilcSQQuVgf9snoaaiP2oMUdxDENrOwWglKNcSDKVcovr/1BUixLrPDU3DzhIo22H9fXV1LhprSkNhkkwD0GPNbHd97z0Xio2JnQSX81GEuiRJLISbphJisrkvtCyEbpL2GmxMNSYom+/JT6JKBG0O9dxYs2vjLOUmiroEe+IRFOQGRa/PVjjsSZMgwcoDsuwRdiK+Xnxqk9nhgUfqjXMUpfNIaXI9G15D7urY0LlCScyUwklZe0+zB+7E9V+I3la4q9YavB7BE0xPgNfN+WJKs1SKYXL+cSguXD0rzILKY4y7D+Lir3fize+nb4YMGj5AWTXM6PhFVN/4+wOUuGgovonnQOa3yjl7u1850mhShSioe+AGTbTU2S66gXlUIsJMz5H+S1eTDWOrSzyK6iiqZyaqs7cbf1fE9M/M9FZZoS+tf1xNmiCE8EEiKoaNxQYRhdGljkNxTus5BRSJPTADEomhj75bqV4/tVIF9HMqPsHJUkKCh4lVW3wgvCM9YQvDUVpHaT0jab3ur1cfmdkUubhs2L7x38pr8pjyHRhqKL7UxASEMq1KOdLCY13aeqpOXutt/qPz1C8GPorqKKrnJarTfd4OkFBSCVMNZoGzaQ5kgaPfjvYDxsStdB7LF0Lzfm990ONLic3pMR1vLT0w3/uHQc0jVRCLvYftjWlXjtYd1XWGkX1sgI++xsFjGXYH4xUlQMEUjkyzWbo+SH7H2Wj+atSMG0bLjcsVXzCkOagJv/YMXRFjNR6NaO0/KVwg+E6MgRJOCHZ5N5SuzNhRQAJTx0Xq+Gc34Vzf8DemYIqvrc4n7i8uub+4bIkI7W0GO2/gmL/agxDrNmwxGPqa6o+czsnt0Tt8s2LnR4XEtDlHqypHU1KgOSBtXLSn2cc3pFSEpOD5yk9BYmgGBY/fLBPL+aS4x4PnfMgwpEEPsy6qz3zDExJ5K8KRpgfGpKXIv1NrC4nlZm4+oGvLi4gPcVQZ2n1xDKm4y5YR1w3aLSeoNe5xlirIhWer5TKnbdxXb1Yrfk07Qc8Vp2aaS3MuL9Vf6cBttZ4sngz+xUXL5pfiQPrvTaa7ALILphCYmp+oeYeLbf2lq6CCZmW+76NIG4OJlFjFXtdHy92Wlj68vyJ1/QRrXTc2
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 shield by its identifier."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/shields/{identifier}"}
context={"endpoint"}
>
</MethodEndpoint>
Get a shield by its identifier.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"identifier","in":"path","description":"The identifier of the shield to get.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A Shield.","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":"shield","default":"shield","description":"The resource type, always shield"},"params":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) Configuration parameters for the shield"}},"additionalProperties":false,"required":["identifier","provider_id","type"],"title":"Shield","description":"A safety shield resource that can be used to check content."}}}},"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>

71
docs/docs/api/get-a-span-by-its-id.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-a-span-by-its-id
title: "Get a span by its ID."
description: "Get a span by its ID."
sidebar_label: "Get a span by its ID."
hide_title: true
hide_table_of_contents: true
api: eJztWF1v2zYU/SuEnlogsdNgRVe/ZWvXBWuRIHEehrQoKOnaYkuRKkk5MQz/951LSbYc222y9iVAggBRJPJ+nnP4sUgc+coaTz4ZLZLjoyP+k5PPnKqCsiYZJSfispJmkBwkmTWBTOAhsqq0yiQPGX7xPG6R+KygUvJTmFeEmTb9QlnAxMrZilxQjRcPc59V3hvog1NmioGbnq+M+laTUDmcqokiJybWiVCQYBPJ8iAJTmb0k7aiDTwpH82KlLQ1Uy+CZQ+VdJjx+d4xPzuLT1I/F/tdNkajuwOhJo1z/EqRFUrnq/SMLOnHLv+uS2kOHclcppoETxLNiBTDo0Muf2xWL09HFZqPODy78kG68Dmo3Q4ReCnR+CSXgQ7jqLtRjPESRspK3BRk7nhNadpkRCb/GSe96n7X30QZ5QvKY3UzW1aaAuUcgAxwl9ahgeJdoMo8V42D8w3IWkNnk2R0vZphaq1hbvV/aq2mmGJvSJmS679pM+29kc7Jef9FG8ny0/I7qf9D88OZ1DUDSTkvmJcSGaPZ6wRESQGICFLI1NahR5vlvjwnUns6gCR8q5VDuUbXK672qNbCcgMyn/BdBc0ZsFhs9e3kDuRiqMLjj+637UYBngZforMBQuVgf9ulSmOkw4ECA+JGgj0GFVG5AMNKqRlKlP9CyQoy1H3EKJidortbXByPz0UzGm3JKYpUU5kf0fitcywPPPiAi1NYB4moy1K6ubCT2ECKY24KlRWsF5y0UxJSwsqCAjffo58IIMBC39dzM5pds/5BrYpNXenN2QiHPSmDnE12jyx7MD4RVxfv22SyKLyi9pRDeNFZzKYZidI6KKhppIE998FMGWQ1EzbLagdBhYpvxvUgoDcd7rq1Kl4P2bFMe4rXLaNi4mwZYzg5Px2IC1tPCz1He7S2N15c/PWnePX70atB1MJbycLUxxegvvb3h8zFRQPxdTz3RH7LnOPXu5mTacULUIHpTEeU3GKymXeG2SqAMFUzSKssbY0xXNtGk59I9USqx0Sq49drf2Mg/QMjvWWW71PrX1uDE6gQ3WZEOZeNyYbtiNCqVGEgzrHKe94zzoWcYs0VGh9dt1K93LdSeXIzNB/lZCoRysPAqg3dot7YmbTFfaLWE7UeFbVe9terU0Y27zwvG7Sv/bf0OtmGfFeMfCDOaiCBZBlXpZSw8Bgbz015R6+cJrLWYccR9TuGn0j1RKrHRaqjXd7uQaHIEoaanHrOZkyacAh0c45/M953FBhd8bpjLhT2e6dv+Iankg5nO9DYx8Nuc//QP/opnl3JUGyf/5Hu6Zuu+O2lihVTWh89Y13YzbrmwdXowRYDu5Myn4zbINYn0fvGEF02ITzMKcqFIhQWQxNMjnWBt1EynL0Yhq6qw5ijHy668iyH7BEv2lCXfEaOUthUs3bcwSKEajQcYgtyWFiPLh5qLUt5iO5nXweZLRP27wk9VWEeJ77pdO/6E39jJsSwW5C85/nikueLy5YPkSfwz86b2sxe7ChXc+3UJ5LsU7tvORQyCAjiTMHIRyPu/ABNFM8IZPLKQhk9pCjun5SDCLqGGzkf/Fk23YRr1xiVjj7yBYa2LhJ/23jKZx0NKXBy2kX1AcKqfeRQhTpCpbgmLVj24Xsj/8V6Ydg7oYVGoNswrDQ2fOwvNnLRguK6qewKFt1VCcvIqMeciA1+1wEZnWQAsIXFIsWu8srp5ZJfY2PquPN4jNKecpuBg1x5fs5X2rU3nWcXLdifi4fwcme23VWV4dTitRP+w+NXmve1gan6CwK8Q9r/EVFX33iHVmDhwgrN1Wu+nmQZVaE3b2tHsEH/d2/HEIT/AL47DvM=
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 span by its ID."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/telemetry/traces/{trace_id}/spans/{span_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get a span by its ID.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"trace_id","in":"path","description":"The ID of the trace to get the span from.","required":true,"schema":{"type":"string"}},{"name":"span_id","in":"path","description":"The ID of the span to get.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A Span.","content":{"application/json":{"schema":{"type":"object","properties":{"span_id":{"type":"string","description":"Unique identifier for the span"},"trace_id":{"type":"string","description":"Unique identifier for the trace this span belongs to"},"parent_span_id":{"type":"string","description":"(Optional) Unique identifier for the parent span, if this is a child span"},"name":{"type":"string","description":"Human-readable name describing the operation this span represents"},"start_time":{"type":"string","format":"date-time","description":"Timestamp when the operation began"},"end_time":{"type":"string","format":"date-time","description":"(Optional) Timestamp when the operation finished, if completed"},"attributes":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) Key-value pairs containing additional metadata about the span"}},"additionalProperties":false,"required":["span_id","trace_id","name","start_time"],"title":"Span","description":"A span representing a single operation within a trace."}}}},"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>

71
docs/docs/api/get-a-span-tree-by-its-id.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/get-a-tool-by-its-name.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/get-a-tool-group-by-its-id.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-a-tool-group-by-its-id
title: "Get a tool group by its ID."
description: "Get a tool group by its ID."
sidebar_label: "Get a tool group by its ID."
hide_title: true
hide_table_of_contents: true
api: eJztWE1v2zgQ/SuELm2BJE6DLdrm5t10swFaJEjcwyINAkocW2woUSUpJ4bh/75vKMmWY+ejwF4CxBdTEsmZefPe8GOeOPKVLT355HCeHOzv858inzldBW3L5DAZipG15tjZutpLdpLMloHKwP1kVRmdSe43+Om58zzxWU6F5FaYVYThNv1JWcDAytmKXNCNKa0wiR5rcr2+PjhdTpJF7DxFF3cN/2ztMrrW6vGOD3xvXtz/sJNQWRfJ4WVSWEUGzz7XZBQaU3hr3bVK0VYySE/svM8sD7we12UWcdlJUiqzvJDuBu0AhNq/6wkj1cRbVCG5ipB5ALb+WdFY1mbL6z72I3gt7Fh0KOwIaW7lzIs3q0FvOMwiq66pVJXVTWoeB792ehsm92znJL6ffxXNZxGn5kawIuBT51KygHmplOZh0pz1DI2l8bQDiv2qtSPFcLNlIBJ0MGwa82/YHUarjsbkgDCxPboL5DC5aMm3xyFLN/HbQt3uyzyxJZ2O4cNyRFkbg4mWzykgJVn2X4EkKRjae7Nk1vKNdE7O+i9aTxZXi/uhvT2tGs/eieHSS4FA6gJReTG2LmLLyRUNI34L3Z6o1pXR6qCH/FLTW/CPlhvaGRlIRX+8KGQpJ/FpQvDSIQsLdu+PbVVjFCnyqyYfxK30QpdTabQSiLCQBoEWpP6/auKDDHWfDeAqTSIM6279MxqdiaY3yKQologGkqf08MU5Tg93hgyFz60LwtcFSsCMweLEUexzm+ssF7oJ2mlZhphZWbbfo51IjiC1ea7lpjebNrZEbCKvkZFdR1LJ1JDojVlzhy1pFCAJMT1tq0/RKMQmmAzOpyRqH/OPzGI0TUkU1hHC5HzGzAmZ2jpE476iDFzMhM2y2jVaXvfrd6jdZrjL1hK8HqUjTA+A1y1zYoyqHH0Ynp3siXNbT3IzQ3qMsbdenP/9l/j4af9jLDB0J4uqYUbHL1B9Ze9PqcR5Q/GVP89kfqucg8/blZMZDVWIHMM9NyBAlt+sm5hnBREmekr4L2yNPoytLuhVVK+iemGiOvi8ti6Jb8z0Vlm+L61/bQ1NACG6y4gUw8ZiwxoljC502BNnWMHhUAB75ERCJLyALVeqDw+tVJ7cFMkHnCwlbDwUE6su6Q548wpILQyv0nqV1guS1of+enVStrvoi4btK/utvIablO/AUHvitAYTSBZxVUoJC09p42ZTdfJaHmk2jpCPTPwqqldRvSxR7W+z9gwJRZUw1SQfXC9XRzDPAaw7fEwBOV6dA0U6ExrbvpMjvoOppJMFQc0+nmdLPLT3CLFzc+LTPE8lQ771ZH9y1OWhZwRJxdGOLaxQD66mnU0NdufgBVyHK7lF12QS70qizcNkMH0/WLrkB/O+ewu+UolVqImgdgxeHkJ1OBhg9d/NrQeAu8bIQu4C+OxmL7NFwtY8AU4dZnHgUVdyLq/4G5MwOtnm5yuPFxc8Xly0VJTt/Q0bb/CYvt8CESvXr3FY9lXVnznkMoj2uO1/lOLeD2WC4va8u6DxqAJx66Id6o9raKn4boUrlhvLjHwzqXT0o2RqWRc1tzl5yscMAxU6nM1br77xnZaP9K2AIwoEY9Ky5HFmraEwX1XmJ4a1pAh0FwaVwb6Lbcekzls6XDYorwiBh8M1xiJ9nHXuOp+n2MV9d2ax4NfYCDpON5qxlKacWyRfac9ttawVD3r/9rzl8zvxDPJvjaa77SlnzB1pan5C84Zm97UXb35ylGS+3ISfTZdhllEVeoM31ro1LR1/GUFd/wG39Yt1
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 tool group by its ID."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/toolgroups/{toolgroup_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get a tool group by its ID.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"toolgroup_id","in":"path","description":"The ID of the tool group to get.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A ToolGroup.","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":"tool_group","default":"tool_group","description":"Type of resource, always 'tool_group'"},"mcp_endpoint":{"type":"object","properties":{"uri":{"type":"string","description":"The URL string pointing to the resource"}},"additionalProperties":false,"required":["uri"],"title":"URL","description":"A URL reference to external content."},"args":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) Additional arguments for the tool group"}},"additionalProperties":false,"required":["identifier","provider_id","type"],"title":"ToolGroup","description":"A group of related tools managed together."}}}},"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>

71
docs/docs/api/get-a-trace-by-its-id.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-a-trace-by-its-id
title: "Get a trace by its ID."
description: "Get a trace by its ID."
sidebar_label: "Get a trace by its ID."
hide_title: true
hide_table_of_contents: true
api: eJztWE1v2zgQ/SuETi3g2GmwRbe+eZtuN0CLBolzWKRBQEtjiy1FqiTlxDD83/uGkmI5ttssupcAziWyPJyPN+8NSS8TR760xpNPhsvk5PiY/2XkU6fKoKxJhslIjJ1MqZ/0ktSaQCawjSxLrVLJNoOvng2XiU9zKiQ/hUVJWGonXykNWFg6W5ILqg4T2N+tyjqWPjhlZrDcjH1l1PeKhMoQVU0VOTG1ToScRPSRrHqJszbc+lKa33TIfgT7wSeJpyBdoAwflF8Hi29vgypoVyi4KiTQSTIZ6ChaPY4/xks4KUpxl5NZVyImNJOGQ5DJfifAi8/xSeqXYm+sqTLK55T1hJqK1BalJpSarBBdZpmq1593WjaV2hOgpu+VcrAcXq97+KgDGxjd9JKgguYaIoe2sh01GTkqQUTuiZnFRNusBN1TWrG1KGXIhZ0KKTgPVCZk6qz3oqh0ULAWnHBkpO+jGC7nj12EHnO3Gxd30gtl5lKrTIAIhdSMMWX/H9kBR6h8x07B7YzcFhb/jMfnorZG+VnkW4Per1j93jlmMRv3gI/PrQODq6KQbsGQMaIUbe5yleZC1UU7JU2IAgDr6+9jnBX7D1Lpp0aurTm0tga1ibwqpDlyJDM5QWM6azbS4UjKoGaTPqHKDrVH4uriY1NMiuQnJCrParXoLFbTnERhHYRuas1wZDmxVYjBfUkp1J8Km6aVc4Twj/L6L1JoOtx26wG8DvsjTHvAayewmDpbxBxG52d9cWGrWa4XaI/W9s6Li7/fiTd/Hr/pxyFxL1kfXX6B6ut4f8lMXNQUX+fzROY3yjl5u1s5qVZQhcixnAULyC0Wm0XrmL2CCDM1x8yRha1gw9jWw+ogqoOonpOoTt52tjAw/RMzvVGW70rrX1tBE3PesFKiLJ4cIDbs00KrQoW+ONckPW/BCyFnEiLR+NK1O9XrfTuVJzdH8wEnS4kADxOrMnQPvPmEQg0MB2kdpPWMpPW6u1+dMbORubis2b6O38hrtE35FoysLz5XYALJIu5KE8LGY2w83metvDKaShwTd9xufuL4IKqDqJ6XqI53RXuChKJKmGpy5rmaMWkqgOGC89/M9wPh4tVeWhdC4cB3dso/DpTSSawhxx6WiZF8h+3eExUv51vc9q0Y9Z6dtujXvtHFGQV2vIY5uAqwb4muocpqhWSRQW5hmmBxTArhhslg/moQ2poGMYAfLNvcVnxrjYOnTr1yjFceQjkcDLDhH+XWA7MjrWUhj4B1+q2PC2rC8Tyup06FRVx42k6Z6xv+jnkX02xa8pHXi0teLy4b9kVWIj4Hr8GYv9qBD4vVb9BWdoXU9Rx/vsD4mSs4+WLEoz9MBooncjJZaTGHPIQfTyvKYeS4mokZX8R5SLkpY1U7lY6+GGaTdVFm284nfLPQEJ6TszarTxhj2kfGlsARM4Exaeixl00bACzXc3j/ioYMge7DoNQ4YHHE2MplQ4PrGtsHIvBzpAIehg9EReO432y+XE5wZLtyerXi1zj1OW40HuPcnHBX0fZMeX7OHgbD3uRfXDRcfil+zvmdxTQvwUgmjNQVf8LjN1p0lba6gW2OsYv9hdOrvx6lKZWhs3BrP9uQz4f3YwjqBxVdA6s=
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 trace by its ID."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/telemetry/traces/{trace_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get a trace by its ID.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"trace_id","in":"path","description":"The ID of the trace to get.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A Trace.","content":{"application/json":{"schema":{"type":"object","properties":{"trace_id":{"type":"string","description":"Unique identifier for the trace"},"root_span_id":{"type":"string","description":"Unique identifier for the root span that started this trace"},"start_time":{"type":"string","format":"date-time","description":"Timestamp when the trace began"},"end_time":{"type":"string","format":"date-time","description":"(Optional) Timestamp when the trace finished, if completed"}},"additionalProperties":false,"required":["trace_id","root_span_id","start_time"],"title":"Trace","description":"A trace representing the complete execution path of a request across multiple operations."}}}},"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>

71
docs/docs/api/get-a-vector-database-by-its-identifier.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-a-vector-database-by-its-identifier
title: "Get a vector database by its identifier."
description: "Get a vector database by its identifier."
sidebar_label: "Get a vector database by its identifier."
hide_title: true
hide_table_of_contents: true
api: eJztWNtu2zgQ/RVCL20Bx06DLbr1W9p0uwXabZC4BRZpYFDk2GJDkSpJOTEM//vOkJItX9JNgL4EsF+sy1zPnEOJWmQOfGWNB58NF9nJ8TH9SfDCqSooa7Jhdsq+gQjWnb3tZ71MWBPABDLjVaWV4GQ2+OHJdpF5UUDJ6SjMK0Bvm/9Ab3SsnK3ABZUyKYlB1ESB69j64JSZZstoPEMTN8bybO0EjJX8teE999OF7Ru9DExdZsOrrLQSNJ77QoGWeDCLvY5ljseSB+6BivfCkuN4UhsRYellORhRlNzd4HGwVjd/46mzdZX6LauQXUfIPAK2GRomvNa7V7vAj7BmZiesxaDHuL7lc8+erXyesYl1LJ0yKjfnNEpsHMocpKSaU4t7MNjM9g8vY7ZQAFs5s+jMgmW1h26uKRhwcfSbyaQqwXiVyNAkVMiYKQ56O+NZa7ubNmWJjax6HRuscM+Q0YajFwXl+rzDsgnXHnrI8J+1ciBp3B3abXKnYcoubvubw6kGFTSV0Ypjp71vm1NZjTHC6EMkFONGsp81uPm66zUMvo/dUX9/7NPlqKCY6OwDu+WeKTPjWkmGEUquMUkJ8vcJ1gceav+Aqf49Gp2zZM0EQhhVmLD6Pwq+dw6Lj8bIdeYL6wLzdYkqm684Em1uCyUKplLTTnETIqrcNPdjniXFD1w9gPwpc7Km1Noa7I0VdcnNkQMuea6BdXw2yqFMCjXOjXhAl8+/VImrL9gp+3rxqWlGYPE5kM4k6c0BesMMUIEOsE2aZ5wc47mtQ0zuKxBIZsGsELVzuCDBVl2P0UYz4XZaK/A6XI8w3QNe+yBhE1z4Yg2n5x/77MLW00LPcTxa21vPLv56x17/efy6H9eNO15WiRktv5Dq63xvuWQXieLreh7I/EY5J2/2K0dohapgBbp7OsC1G53NvA1MUZEIUzUD/C9tjTaELS4BB1EdRPXERHXyZp1vhEz/TExvlOW70vrX1qgJRAjuBIAk2EhsPADTqlShz8410NMsIHv4lKNINN507ZPq1X1PKg9uhsNHOElKgPAQsWoDd4h3wDNoYDhI6yCtJyStV93n1UdiNlbOLhPb1/kbeZ3uUr4FQ/bZlxqZALyMT6Uc8MFjbHxbla28VtuGnU3aLwIfRHUQ1dMS1fG+bA+QUFQJUY1PPXXT7s081b9Z7wcIOOKtnTPL50zRq99qm0ifPCrucOeJyqaYiyxtQzv70rh9VBS04qHY3cYjCuuA7Wy2M+O0pxAo3XocwdXQ2xXnauOLTWFdhUXTbBq/U8QChtlg9nKQEhzJ3A8W3VqX9DkjLk+pndoRqkUI1XAwwNeCo8J6RPZIa17yI5yIuOkLW2aUzQPirMI8Op61a9HVNd0jdsYim8F9In92Sf7ssuEob76dUPIEzuzlHrxI0n6D3Lwrt27kUPDAmo28/27Y1g/XD4jv7WBkZXG18nHHjVGUw4XJJb7GTw60lLkJF+BTUO7guyHOWRfFuBs8p/2HRnk6Pm2r+kwfDXzkdYU44spBmDSUeQTnNiBZrNfvx8Ro6BLgLgwqja9qVFUc96IhylXCf00VPBluEBsHS3wg08WCUn11ermky/GrBQ0f/Wn1zWnqSAupPB3L1fJybyvPLxqmv2CP1cje1pqLyGHqieuazvDwBubbel1eo32BSzp9f8Sik8mpEFCFjvPOs3JDch/ej1CE/wFfGnAx
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 vector database by its identifier."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/vector-dbs/{vector_db_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get a vector database by its identifier.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"vector_db_id","in":"path","description":"The identifier of the vector database to get.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A VectorDB.","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":"vector_db","default":"vector_db","description":"Type of resource, always 'vector_db' for vector databases"},"embedding_model":{"type":"string","description":"Name of the embedding model to use for vector generation"},"embedding_dimension":{"type":"integer","description":"Dimension of the embedding vectors"},"vector_db_name":{"type":"string"}},"additionalProperties":false,"required":["identifier","provider_id","type","embedding_model","embedding_dimension"],"title":"VectorDB","description":"Vector database resource for storing and querying vector embeddings."}}}},"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>

71
docs/docs/api/get-all-training-jobs.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-all-training-jobs
title: "Get all training jobs."
description: "Get all training jobs."
sidebar_label: "Get all training jobs."
hide_title: true
hide_table_of_contents: true
api: eJztWNtu2zgQ/ZWBnlrAlzTYotu8ZbvdbhctGjjuwyINihE1tphSpJaknBiG/70zlFzLzqUpsC8BnBdJIc9cz+HFq8xTqJ0NFLKTVXZ8dCSPgoLyuo7a2ewkO4UPOsQzF+LUo7bazv9xeZh0uFE2yJSzkWwUKNa10QoFOr4Kgl9lQZVUobzFZU1s0eVXpCIDa+9q8lG33guM/VnoPS55ko5UhZ+jr1z+tWl00ZsZoudos/V6kGFRaAkKzVkPNUMTaMA1+K/Rnhh6sTVzOciijkbs7OXOBn/FYkqrZ+2haopptv3bXX2YlgRil0KEawyg7QKNLsB5qNDMnK/Y3//WjBAxNv2yazY7J88Td8P6ezo9g3Y2KFdwCj9S3W/EPvSt9xx8mjwAhFA6HyE0VYV+CW4GkTOmNOe61KoE3SbtNdoInDCg7caTn7XYj6jNYz23s8W1cZZzg7Kp0A49YYG5IehhdsIRT9pyzlY9Istnn+qWJ8/hFD5PPnTJKA4+J2gCFRAdd5bRtCConCdOU/qZOgeYuyYm56EmpWdagVOq8Z7Y/V5cv8LLrsObbv0oXo+qqUz3FG+zcMDMuyrFcHr2fgQT18xLs+T2GOOuA0z+egOvfj96NZKi0Q1WdcuMDb+Y6lt/f2ABk5bi23geyfxOOcev71aOMppVASXDg7xE5xhslxvDYpWJMNcL4mflGp4jtdUVHUR1ENUTE9Xx662/KTP9ozC9U1boS+tf17AmuEJ0o4gKKZuIDSOB0ZWOIzgzhBxQZPbgnHcsMDzoR53eXt63UwXyC24+l1OkRFweIVZj6YbrHfmLujIcpHWQ1hOS1sv+fvVemM2Rw3nL9q3/Tl6ntym/KUYxgk8NM4GwSrtSTrzxWBe5YDzWyaugGTYm3nEof8DwQVQHUT0tUR3d5e0REkoqEarhPEg2/WsVPHvjKnmeO2efS0K7CbyjCGgMb2zdfL75BbnN1uixIha2mGQYv5eOi5XNKSkEY8kf48WLcc3uhhv8WPA83m58gl1ljZcMyhjrk/GYt+BhyQgqhsZghUPOXn0bKVdl60vBcU46LhPwz43uLy5lTJiQOLa5QgoezgUP5x0fEk/YvzhvM1y8uNW1aSnyCTtEwj61+5ZjiRF4QVhoNvLFwt4fa5XSGZlsUTteGQJLMZ0ftOdFwLfcKKS0smz4GSoKrVH09MVKf51PxL9tPJezvmEpeJxvovrIC4sJiUNSeVap1MRysx5q504BVtuV8X5Ep+RIN3FcGx4Uj6mVq677F21td/rP34kB3C7pskxarXI+On32Zr2Wf/Ppyy9bTqX1K5decoMZwIsNr6rS+W+0FNIrRbWwjS86TfoxZH8VX/eZ+e7tlKXwHYyVOH0=
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 all training jobs."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/post-training/jobs"}
context={"endpoint"}
>
</MethodEndpoint>
Get all training jobs.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A ListPostTrainingJobsResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"job_uuid":{"type":"string"}},"additionalProperties":false,"required":["job_uuid"],"title":"PostTrainingJob"}}},"additionalProperties":false,"required":["data"],"title":"ListPostTrainingJobsResponse"}}}},"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>

71
docs/docs/api/get-detailed-information-about-a-specific-provider.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-detailed-information-about-a-specific-provider
title: "Get detailed information about a specific provider."
description: "Get detailed information about a specific provider."
sidebar_label: "Get detailed information about a specific provider."
hide_title: true
hide_table_of_contents: true
api: eJztWE1v2zgQ/SuELtsCiZ0GW3TrW7btdgO0SJCPwyINFrQ0tthSpEpSTgzD/33fUJIt2c7WW+wlgH2xPobDmTfvDUUuEke+tMaTT0aL5PTkhP8y8qlTZVDWJKPkTFw6O1MZuXMzscKOv1IaRGpNkMooMxUhJ1E2Jr94kRFeaD9IjhI2IhPYpyxLrVLJPodfPTteJD7NqZB8FeYlYaraNwbCXUkuqDosWaqOkQ8Os8KoH+YNoji7PBdGFoSQlF/FJFRRaioQiE+W0Xd8/LfKfuz11qjvFQnYm6AmCs4m1vUy7rmsne0TKlsIO9kRZMSIvQK9iZrugkdmmWIrqS97QFlDF5NkdLcaYSqt4Wp1P7ZWkzTdR6YqxjGLzag7T6Rzct590ESyvF9u5vYuBl25mIUopUM5Ajm/E7ecpA75c8uwcg5lEnXwwqNgledS9rNbPpXERGpPRxDe90o5AgfvIsH7xNzk1IoNK9Duj5KgguZYu/rcIhs/dEVdDjm2VRBSOJoqj6pQ1uGfSXWVsZ5V8CLtlVGarJ/uAPlxhr/uahhMb86OfBAP0sPzTGqVCRCgkJqjoez/aw51QB07BbdTVGATiD9vbi7baqU2IyZgg+CPBPvBOWYvGx8BPp9bF4SvikK6eVt5ijYPuUpzoeqknZLgCRNfmuZ9nCdSipvkvjPX1jy1tga5ibwqpDl2JDM51iQ6Y3rh8EzKIGeT7pHli4uyZutLcSZurz41yaQIfkyi8mBLsKgsRtOMRGEdGuMWu3hyX1KKbpkKm6ZRLSltxPVf1NFUuK3WCryOAiJMT4DXrnBi4mwRY8AyMRBXtprmeo7yaG0fvLj6451489vJmwGDRo+S23GXX6D6er7fZSauaoqv49mT+Y1yTt/uVk6qVewuGO75IliLwWbeOmavIMJUzQj/ha1gw9iqgg6iOojqmYnq9O16vhsw/TMzvVGW70rrL1tBE0CIHlOijGFjsclAQqtChYG4xLqPgALYI6f4NBUaL127Ur1+aqXy5GYoPuBkKcU1EbWpDD0C74A7amA4SOsgrWckrdfd9eqcmY3IxXXN9vX8jbzOtinfgpENxEUFJpAs4qo0Jiw8xsbtUNbKK6OJrHTYsXv8F8cHUR1E9bxEdbJrtj0kFFXCVJNTz9m0OzbP8ffj/UihKTW8bCMr17i2Wzc+aVlvtOPmmA9B4Ku/o1TsvpTYO+46kDh/v7mH5UKDOJwQT7GuRnAVqrOlzXZXvUROiCW3ME2mFNXKs46S4ezVsPXuh4tOeEsY1StxnUDlGNI8hHI0HOKb4Di32LBmx1rLQh6jHOm3QWqLhOfyBJBVmMeB79tGdHfP7xjAGGJTtU88XlzzeHHdAFkfuBwlPHmNx+zVDohYz77HbNnVWtdzyGVoYfRfjNj4oYYUP9rJZKVFq/Jxhw0vyqEruZqs9V6cG/dEpuRrp9LRFz5409ZFJW47H/PmQ0ObTk7bqD6j0/GJHB9VAUe0DcakIcnPEa6HzmLdx3/SXUOhQI9hWGp8vXGskQSLhjx3dVVW9MH1qMtvFJs5woaLxRhfgrdOL5f8GB+TjsmBy9iOx8wEUCVTnq+zVb95MqcXVw33X4q9pLIzm/akycyZa1JXfIfLbzTfkGo8dMrR17GAcaC1xVmaUhk6Y7cWzJ7wPn64gRT/ARQUq/0=
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 detailed information about a specific provider."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/providers/{provider_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get detailed information about a specific provider.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"provider_id","in":"path","description":"The ID of the provider to inspect.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A ProviderInfo object containing the provider's details.","content":{"application/json":{"schema":{"type":"object","properties":{"api":{"type":"string","description":"The API name this provider implements"},"provider_id":{"type":"string","description":"Unique identifier for the provider"},"provider_type":{"type":"string","description":"The type of provider implementation"},"config":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Configuration parameters for the provider"},"health":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Current health status of the provider"}},"additionalProperties":false,"required":["api","provider_id","provider_type","config","health"],"title":"ProviderInfo","description":"Information about a registered provider including its configuration and health status."}}}},"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>

71
docs/docs/api/get-the-artifacts-of-a-training-job.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/get-the-current-health-status-of-the-service.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-the-current-health-status-of-the-service
title: "Get the current health status of the service."
description: "Get the current health status of the service."
sidebar_label: "Get the current health status of the service."
hide_title: true
hide_table_of_contents: true
api: eJztWE1v2zgU/CuETlvAsdOgRbe5pd1ua7TdBIl7WKQ50NSzxZYitSTlxDD833ceJcVynF24BXoI4FxEi3xf82ZIKqvMU6icDRSy01V2cnzMj5yC8rqK2tnsNPtA0sRCaDtzvpT8EuNcKwztXOiZiAWJQH6hFQkdhKvIp2XSDLNBppyNZCP7lVVlkp2zo2+Bna+yoAoqJY/isiKEc9NvpCIMK8+eom5SC1HGOvTWhegRH+vI1mV2ep2df8SPd947j+dfLopxWRkqEZvy7GbwoKq3tfeYEkVTXeNeuK1qsvV6kMk81001F72EZtIEGgC9f2rt4R/x2wwRKepo6B65MYDLHob/sBW2jy1G/RyGSILTePFYayZYxylQiOJWsp+FNDoXcFFKwz6R2q9rgYbbOfnd4iaTi6405XLgeI/Jbvu2TVP/RFo8EFKEwvkoQl2W0i+77lBac1toVTDfuGivJXrJ0Enbzqc4a/YfpTb7Rm5Wc2jjLGoTRV1Ke+RJ5nJqSPRsttLhSNqiZqv2qPK386qh1DNxJr5cfmqLUUh+SqIOlIvo0FlY04JE6TxtcUROXR0bllSk9Ewr4ZRKjIYGt/P6CQp33boHr8fpTmCPgdftJWLmXZlyOLsYD8Wlq+eFWaI9xrjbIC7/fCte/X78asig0Z1kmfb5Bapv4r2RubhsKL7JZ0/mt8o5ef24cpTRaQeAeeBBdA7Gdtk5Zq8gwlwvCM/S1VjD2OqSDqI6iOqJierk9SbeBEz/zExvlRX60vrb1dAEEKI7RZQzbCw2GUkYXeo4FBeGJBKKYI+cS4jEYNJ3J9XL/zqp+ERD8wEnS4kADxOrtnQHvHFIt+AepHWQ1pOS1sv+eTVmZiNzcdWwfRO/ldfZLuU7MPKhOK/BBJJlOpWmhIPHugjAMNfKK6eZrE3cldj/OT6I6iCqpyWq48ei7SGhpBKmmpwHrmZsGZ24+wH4nhrw1B4fgvwdW0kvS4K42S28YVw4AJbNKalExgI/Rovno8YT3jUHHq9fZbXnzIsYq9PRCEfvUeECsj8yRpbyCFHV96FyZba+YTskpeMyGf7R6f36hueYAYlbLTif2F5csb24anmQ+IH4HLwpdvF8p1uTgmUTtggk+5Tue46FjAIbwULDyVcrHvxBo5TuxmTzymFHCJBgujdoD/H7hhN5+n8B748zqSg0TqWnr5b76nwi/K7zKd/xDSTg5bzL6jM2FBMSdyrgCHUyJhYN+onObuGy2myUP+yo1XukuziqDC5GnF9q/Krlx3XTiZYhaCezgF+vVlNcqb54s17za9zK/LLhWdrXptxrECCZ5thtmRnfacliUIoqZiA+gGoOv7O7r/tsff9uAon8C8EeSEg=
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 the current health status of the service."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/health"}
context={"endpoint"}
>
</MethodEndpoint>
Get the current health status of the service.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Health information indicating if the service is operational.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["OK","Error","Not Implemented"],"description":"Current health status of the service"}},"additionalProperties":false,"required":["status"],"title":"HealthInfo","description":"Health status information for the service."}}}},"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>

71
docs/docs/api/get-the-result-of-a-job.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
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: eJztWMFu2zgQ/RVCpxZw7DTYolvfsttst0CLBk56WLRFQUtjiylFqiTlxjD87/uGlGzZcYKk6GG7SC6RKc5w5s17Q1KrzJGvrfHks/EqOzk+5n8F+dypOihrsnF2WZLArEYHYWci4NeVnQ6zQZZbE8gEtpB1rVUu2WJ05dlslfm8pEryU1jWBEd2ekV5gGHtbE0uqLTonAy5aOp7k6Vzcom5KlDlDzmRRaHYSOrzHXfW0PtZNv64sTCN1tl6sPk9tVaTNP0h01RTcv0RH5wy8/5ICqg30Eay/rxeDw5A1ktLzJytInK0kLqJg0O4AkTW0YOyuxvK6O+Ls9//V0hyVnDRkXBmnSCZlwJ5DsVZ+ySUF1JUsmaS5lY3lRFGViSCFQw6RcDlfO5oLgMVX5K3/zog+3i8SwlWBCf5JsFtWinXjIE8nMVMak8DyP5boxwVyKbPmoMIfR5kQQXNgV2kUkzim2w/uNNDpZLCY0RTLFd2a4HpNpU8JJN+K9moqxf+WXJMk7bp3cig7XXxZYpHmr1wOKDfbu+T3xryQXyXXigDO1UIYFBJDSgqBPnTuqYPMjR99iq4nYNp+yn9fXl5LtJs6KIgLkGLxz4l903PnEPwcfKA61haF4Rvqkq6ZbcXUJzzvVSQoUpJOyVNW3vTvo/rxNoHqfR9V06zeWltDXITZVNJc+RIFnIKRvVsdsLhlZRBzia/R5ZP3teJXE/FqfgwedsmkyP4KYnGQ1SQmGPF0YJEBVIhTa5nrJyQU9uEuLivKVcz6NLmeeMcYfm9uB4ky1Thrlob8Pp8jl4Pg7dLY47h9PzNUExsMy/1EuXRGooXk7/+FC9+P34RpUnXsqoTMzp+gerb9f6QhZgkim/juSfzW+WcvDysnFwrqEKUMPf8EKyFsVl2jtkriDBXC8L/yjYmHUdURY+iehTVLyaqk5fb9S7B9HfM9FZZvi+tf2wDTQAhus6JCoaNxYY9TGhVqTAU5zhxIKAA9si5hEg0Xrpup3p+207lyS1QfMDJUiLAw8RqDF0Dbz5IUAvDo7QepfULSet5f796w8xG5OIisX27fiuv05uU78AohuJ9AyaQrOKuNCVsPMYGAIZ3rbwKmkk+Cd+Q2F2OH0X1KKpfS1THh1a7h4SiSphqcu45G75/cei7ob6mhNz2I5PsPjHV0uGKCxH7eO3m+y5fswFqCf59/aJYTIqd1DKUB69zb1518G/MYikbs3fXFHy/66MfXEODm1rs7u98X28DQrQPCwUGHMR8P/OHBQAkAU5pMRVX39geeOlxNlo8G3Fio03KfrTqo7YeIQKMpcDXI9dd6NOxIKHdOK5vGUI9Ho1wQDkqrUeNj7SWlTwCN/Kvw9xWGcfhCRVXYRkNX3Vd8eNnfsc6ieG3FHrL9uKC7cVFq5ZYAazPiyfAFs8OYMjNxe/ITPaF3/ccShkE2uVCwcknI/b+0Mkoco1MUVv0TY9GFU9XyqFFuqScgj9mcFN1M5mTT06lo0+G2W9dbAs3nU/5JqTRKJycd1G9Q9vVPiqsBo7oYYxJS6A7JLADwWq7c9xl0xIl0HUY1RqHQl41lnPVUuRjwpdJgn9bmuDHeE9ezBQe3pC8JQsqy4RgX6vVFGfQD06v1zyMY6xjJuAxbgRTLjt4USjPz8Wm092a25NJK4Kn4kc0fDD/7mOb4Y+h6TPZOMPjV1ru9xSW9k8I9i6V/0CIbQHiV8ES2x/2eUY1vTzNc6pDz+zGuWKnXbw+u0QD+Rd4ilyJ
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 the result of a job."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/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>

71
docs/docs/api/get-the-status-of-a-job.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-the-status-of-a-job
title: "Get the status of a job."
description: "Get the status of a job."
sidebar_label: "Get the status of a job."
hide_title: true
hide_table_of_contents: true
api: eJztV01v2zgQ/SuETi2Q2GmwRbe+pW3azaJFg3wcFmlQ0NLYYkKRKkk5Ngz/931DSbZsJ2la9BLAvlhfnHl8896QnCeOfGmNJ58M5snhwQH/ZeRTp8qgrEkGyUVOwgcZKi/sSATc0UTqSvJrcWOHvWQvSa0JZAIPlmWpVRrf9m88R5gnPs2pkHwVZiUhph3eUBowsHS2JBdUnR/Rvqus850PTpkxvluHdGnUj4qEypBTjRQ5MbIuQkOEZLGX1HjvC0SmKpLBFRAXpaZAGZ4p8x04xqDC424klY6PGXVW1depNClpvr7eBPO+cg44BE0prSIp62xFSMAks0zxa6lPO5MeSe1pD2X4USmH8IDWsLCcBTIGFTRP41/E2sx/xBk62ZXBOKAVdyrkLZbgZHoLBnqAwmD+eqjSDIR8EHfSIxIKrTIBbgupQXFRc/Fnir1VI4WwY3JbE/zn4uK0nUdqM+ICN4T8TCjHzrEw+OM9IYXPrQvCV0Uh3Wyp5vjNXa7SXKh60k5JFJQ1JU3zPuZZcPwAfTw1c/01p9bWYG4irwpp9h3JTA41ic6YNTicqa3jz3O9+FrWwnopjsTl2edmMtCsGJKoPGUiWFQWo2lCorAO3jFcz9rEcmirEJP7klIYKhU2TaOsIaN1XL8i5KbCbbWW5HUEHWl6gLy2NYmRs0XEcHR60hNnthrneobyaG3vvDj7+F68+fvgTY9Jo6lkX3f1Bamv8r2TmTirJb7C80TlN845fHu/c1KtuA3kGO75IliLwWbWBuaoEMJYTQj/ha3wDXOrCtqZameqZ2aqw7erfBdQ+hdWeuMs37XWf7aCJ8AQTVOijGljs8lAQqtChZ441SQBKEA9cixhEo2Xrl2pXj+4JyE3QfFBJ1uJQA8LqzI0Bd9Y2Btyd9baWetZWet1d706YWUDuTiv1b7K39jraFvyLRlZT3ytoASSRVyVhoSFx9i4Y85ae2U0kpUO2xZ7LPDOVDtTPS9THdyX7QkWii5hqcmx59kcY1+4fQT8RA1zy4OfbE/GpXSywDnT8fB5YnCDAUOQmkN/t/VBT3GQUoZ8iwRe6E4+tPQvh8VSVmbzNG4Np1yxH1xFe9tebBSEeS0BLc+cT4XCZ06AGG/O/NcAgEmQk1t8miBU5AupB0l/8qrPE+svp+z78y5riz4Q4FkNfMGn5dgha5orx4XNQygH/T52Jvu59SjuvtaykPsAm972UlskDMDj4OxUmMWBH9p2eHXN79ggEXejnc88XpzzeHHe2CRSj/ycvGZq8uoe8rir+DV/ya7ju5FDLoNAn5woBPlmxMYPLYzi0YFMVlo0TI8OFbdVyqE3utoyGRgW3E3dSKbk66DS0TfDsrcu9oPt4EM+Aml0CCfHLaov6LfaR2uV4BHNizlplPOI9tcomK+WjMfGNAoJNA39UmM3yFljOeeNNq5qflkd+FvpAzeDDV+xRPhxo24UlHXAIebzIfacl04vFvwY21bHAsBlbPxDrjbkkCnP19mysz04pRdnjehfit/x7L3Tbh5CvywvjOA7XN7SbLOHsJX/ANjHXP0bEBveF9f4Msdyh3WdWa1fHqUplaEzbGsfsdYePh1foGH8D2pVMVk=
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 the status of a job."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/eval/benchmarks/{benchmark_id}/jobs/{job_id}"}
context={"endpoint"}
>
</MethodEndpoint>
Get the status 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 status of.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The status of the evaluation job.","content":{"application/json":{"schema":{"type":"object","properties":{"job_id":{"type":"string","description":"Unique identifier for the job"},"status":{"type":"string","enum":["completed","in_progress","failed","scheduled","cancelled"],"description":"Current execution status of the job"}},"additionalProperties":false,"required":["job_id","status"],"title":"Job","description":"A job execution instance with status tracking."}}}},"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>

71
docs/docs/api/get-the-status-of-a-training-job.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/get-the-version-of-the-service.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: get-the-version-of-the-service
title: "Get the version of the service."
description: "Get the version of the service."
sidebar_label: "Get the version of the service."
hide_title: true
hide_table_of_contents: true
api: eJztWMtuGzcU/RViVi0gS47RII13bpumBhLEsJUChePFFedKw4RDTkmOYkHQv+fceVijyG5VoBsD0kbUzH3x3HP40DoLHCvvIsfsfJ2dnZ7KV85RB1Ml4112nv3JIWKkjJv7UJI8Vdq7RMYZt1CpYBU5LI1mtexMXV3OOIyzUSaG7JJEpaqyRjf+k89RQq+zqAsuSUZpVTGS+dln1gmOVfAVh2TawrrAA8OYArLD8PFi2wqUnw/ryzabUUZ5bsSY7NUgxZxs5BHQ+Ls2gfPs/PYh590oSyZZ3ka/BBJPZh7ChNEw/xgFSAk/PQbzFHaSnmNSXykizpKsyRVClGQlJsr63wCNiVIdB3YGYRcc9qb1x3R6pVprdD0Hhg9w/Fsv3oQg8xfjkSIVCx+SinVZUlj1neHG5mthdKFMO+lgyKUGOnLd+ybPRuKDdfbQzK21pLbeYW6qqEtyJ4Epp5llNfDZKUcyGYc5O33ALH/4ULV0+lFdqI/X77rJaBQ/Y1VHzlXy6Cy8ecmq9IF3OEIzX6eWJRVrMzdaea3rEBjpv6vrv9C363DfrQfwBnRuYHoCvH5dUPPgy6aGi6vLsbr29aKwK7THWv81quvff1Wvfj59NRbQ+J7KqmVGzy9QfZvvF8rVdUvxbT0HMr9Tztnrx5WjrYEqVAH3KIPkPZzdqg8sUUGEhVkyvktfw0awNSUfRXUU1TMT1dnrbb4pmP5emN4pKw6l9ZevoQkgxPeaORfYRGyUWFlTmjRWV5YJBSWwhxbY0pXFy9DvVC+f2qlkR0PzAadIiQGPEKt2fA+8E35xB8NRWkdpPSNpvRzuV5fCbFSublq2b/N38rrYp3wPRj5WH2owgalsdqUZY+NxPgEwvOvklfOcapv2JfZPgY+iOorqeYnq9LFsB0ioUYlQjRZRZnPpBJ0k1e9W+5Zb8Pr75+61T+6hFQUqGXKWQPDHuPCAKFtwowtKBX5Mli8m/bVvlLV7nDisszpIsUVK1flkgt32pPARBZ9YSyWdYKL6y1j7MtvciR/KN2nVOP7WS/z2Tt5J0xs6dXi8E391I/7qpmt9Qwnkf7j0ZssXew2aFqKUuMMZGrJ4GDkVlBS0vzQI8smp7z6QJTfHYXZ55bEIRKiuOSqYAL2Hlga53PZlhQhz0hzboBT4k/wVYH1oOL4ffCbHegvWB1r0Vb3HGmJjQ5cKOEKQgolDhw5q5g4S6+1qeIBrJ+PE92lSWZx3pIamueuOBLct2oPbv7Ranq/XMxyVPga72chjnLbCqmVTs17NpKHoMhywuGAVlfZ/4ZWQXGuuhGe42NSSf2/V3gw5+fbNFNT/Bjr+KPc=
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 the version of the service."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/version"}
context={"endpoint"}
>
</MethodEndpoint>
Get the version of the service.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Version information containing the service version number.","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string","description":"Version number of the service"}},"additionalProperties":false,"required":["version"],"title":"VersionInfo","description":"Version information for the service."}}}},"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>

71
docs/docs/api/index-documents-so-they-can-be-used-by-the-rag-system.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

22
docs/docs/api/inference.tag.mdx Normal file
View file

@ -0,0 +1,22 @@
---
id: inference
title: "Llama Stack Inference API for generating completions, chat completions, and embeddings."
description: "Llama Stack Inference API for generating completions, chat completions, and embeddings."
custom_edit_url: null
---
This API provides the raw interface to the underlying models. Two kinds of models are supported:
- LLM models: these models generate "raw" and "chat" (conversational) completions.
- Embedding models: these models generate embeddings to be used for semantic search.
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

71
docs/docs/api/insert-chunks-into-a-vector-database.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

20
docs/docs/api/inspect.tag.mdx Normal file
View file

@ -0,0 +1,20 @@
---
id: inspect
title: "Inspect"
description: "Inspect"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

71
docs/docs/api/list-all-agents.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: list-all-agents
title: "List all agents."
description: "List all agents."
sidebar_label: "List all agents."
hide_title: true
hide_table_of_contents: true
api: eJztWG1v2zYQ/iuEPm2AY6fBiq755m3dViBFgiTFMKRBcabOFluK1EjKiWH4v/eOpG3FVtME2JcADhDYlo738tzz8EQtC4e+scajL06XxcnxMX+U6KVTTVDWFKfFWFzATBkIWF5m42ExKKQ1AU1ge2garSSw/eiL50XLwssKa+BvYdEgubGTLygDLWycbdAFlUKWELpW4BwsyEgFrH3faihLxYFAXzzwYw2eT4vTm80K02pdrAab3xNrNYLpXjJtPUHXveKDU2bWvZIS6lzImaxuV6vBDlLXFQqtfBB2KmIBYmqdCHRVts4RWKKBGZKzogL/ubYOOxWu89t1+k+F5CG6cSiA/nlh9g9zUBommm5MQzRSXngMHKN1uuM+V9aX8sfLs5goSInek1Vyw5UUXGQ/5FPQHgfEn/9a5bAk6FMvO8XdDoqggubwexTay2QsZmjQKckgJVuxJiclBIFy1NreUdHCq7qhminpGsKQkuQ0f+kjL9fHKSJ15Q68UGYOWpWCyq1BswNK/X8jsw8Q2i5tFbmdEcV2i/37+vpCJGshbRk5kaH6UcfeOcekYuMBQ1FZF4Rv6xrcgonHdMNoc1cpWQmVinYKTEhtNvl+jBNJHIhFT42crDm0toZqE1VbgzlyCGUkYmfNg3Q4kjJUs5FPqPKn8yZR7mcxjgRNxUhKfoKi9USOYKmztBrna0mYRAiODBPbhhjcNyjVlGhlZVKhxJ28nkPx3OF1tzbgdageYfoOeBtCT52tYw7ji/dDcWnbWaUXG4Zf/vm7ePPr8Zshg4b3wGzv8ouovo33G5TiMlF8m88TmZ+Vc/K2XzlSK961SNC0qdCXYC0tNou1Y/ZKRJipOdJnbVsT976gajyI6iCqFyaqk7fbeNfE9A/M9Kws35XWv7YlTRBCeC8RS4aNxUYji4ZmrcJQXNAo57FF7IEZkEg03XTrSfX6e5PKo5tT8wlOlhLN+5KJ1Rq8J7x5IGKG4SCtg7RekLRed+fVe2Y2ZS6uEtu38bO8xvuUX4NRDsV5S0xAqONUmiANHmMDAUb3srxKnEKrQ89J5hHHB1EdRPWyRHXcF+0JEooqYarBzHM1Yzp30Xy73U32jE+yoDVNMDbgM38DDmok+fp40jb0I3YPXPisTIn3fHLntTQz3aL3sBnNuG1xVaw+n/e4Y4wIB9qineHfE99aVCs+mudE4vD9cQrp2M/9T5VlErXOPDc0YUZwVJaMixnGrQBCRT9G81ej5JyupameIIuH8qIKoTkdjej54qiynlp0pDXUcESYyK9DaeuCXXukhqmwiAv/WG9qN7d8j2keU8oMOOP14orXi6tM9ggpxefgqfr5qx5AeG/wD1QCXd12PcdjOO12c0VOPhmx8wf86oHXoSkbqxhaMPHhSDna4VwifslvGBhDNwWJPjkFh58Mk9e6qOp95xM+yGjSuSNgc1YfaNfUPgqkIRxpC2JMMht6+Pug9OV2w++zzc0OeB9GjaZnuM47ldTlm4QnbPTDveTLy+WEnv4+Or1a8eXERG5iqTxvj1tufTehp0ulN8+vuNgTJh3/WraML7Oel8njinkkg7Uit7Fv+QfNoQnTlrhMqNHQIDUxPmnRWEpsuqv2pvED4f317pqk+A0PSD+w
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 all agents."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/agents"}
context={"endpoint"}
>
</MethodEndpoint>
List all agents.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"start_index","in":"query","description":"The index to start the pagination from.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"The number of agents to return.","required":false,"schema":{"type":"integer"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A PaginatedResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The list of items for the current page"},"has_more":{"type":"boolean","description":"Whether there are more items available after this set"},"url":{"type":"string","description":"The URL for accessing this list"}},"additionalProperties":false,"required":["data","has_more"],"title":"PaginatedResponse","description":"A generic paginated response that follows a simple format."}}}},"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>

71
docs/docs/api/list-all-available-api-routes-with-their-methods-and-implementing-providers.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: list-all-available-api-routes-with-their-methods-and-implementing-providers
title: "List all available API routes with their methods and implementing providers."
description: "List all available API routes with their methods and implementing providers."
sidebar_label: "List all available API routes with their methods and implementing providers."
hide_title: true
hide_table_of_contents: true
api: eJztWF1v2zYU/SuEnjbAidNgRde8ZVu3BWjRIEkfhjQYaOraYkuRGkk5MQz/951LSrEcO00K9CWA/WLLvJ+H55Ail4Wn0DgbKBQny+L46Ii/SgrK6yZqZ4uT4qKzEMrZKLXVdia0nTpfS7YQcuLaKKQxQs6lNnJiSHj8ReGwGBXsRDZyWNk0RqvkNP4SOPayCKqiWvKvuGgI2dzkC6kIx8a7hnzUubJSxqGV9F4uYKQj1eFp71TOwCxEjy5gttnpVUXi9PxMkC0bp20UjYxVsRoVNcXKlU8H+Pvq6lxkYwGARKw6KDgISprrkvy/HCM8o5kuyephlvc6ROGmog8oUkAkk1HoujFUA3A86tAnRwhZlpr9pTkfQDOVJtAIJPiv1Z7Q4XWH1X3PW3XfjIqoo+ECL9j0DFTYAuJsmx82QZuigz7KtGUiUgwJ5VEH2wiG5boLNunzg06PQvGAeRv8zJwI34dC4tugVU6U2g29HLZ63qUTKUxf4YY+7qHgplZc2S+7pMeE5KoIMW5lQFtzaXQpQK1aGm6Ryh+nsRBlbIcEhARoRn43zbM1mi0TuzugnlLIO+9ZF2yMqRahcj6K0Na19AuGiRVDyea20qoSOjfttQSlWVLgUR5PeRIhALZ5buZszamNs+hNVG0t7YEnWaaJGfhslMOZtEXPVj2jy58+NpllP4tT8enifdeMQvETEm2gUkSHmYU3zUnUztOOJZWTh4aUnmolnFKt94T0D+r6HlZ3M9zP1j14A6InmB4Br98rxNS7OtUAHh8K6GJWmQWmxxh3G8TFn7+LN78evUl6pTvJYh7yC1Rf5/tNluIiU3xdzzOZ3ynn+O1u5SijeSGs4B7SiugcnO2iD8xRQYSZnhO+a9fapNSoa9qLai+qFyaq47frfFdg+gdmeqesMJTWP66FJoAQ3SmikmFjsUlsm0bXOh6Kc0MSBUWwR86wkwmDQd/vVK8f26kC+TkmH3CylAjwMLFaS3fAO+KJOhj20tpL6wVJ6/VwvzpjZqNycZnZvs7fyet0m/I9GOWh+NiCCSTrtCtNCBuPdRGAYayTV0lT2Zq4LbFvBd6Lai+qlyWqo13ZniGhpBKmmpwF7ubMMjqRq99xNHzs1CVuday4eO27g2f45sETKpFewhJPyHqzvhIoZpRExDcFJ8V4/mqsc0XjnAljeV9kv2XRem6wirE5GY+xQx9ULqDJA2NkLQ8Ajvp6qFxdrG7YDy3ruEiOf/TLwvUNjzFREgX78yn7i0v2F5cdXRKNkJ+TZ0zmr3bcebC6wgbP5JD5w8jpiqGDJXy24sEHUqb0Ct1foGRQM8zK+UydfO7nZXQqVX9vIT195lOzcT7pYjv4hI8CBkrxctZX9QHrjsn3Ag1whIgZE4uJ+vEE2IBtuV5uf3SeblGJdBfHjcHbF3eXaLPsWHad57HjGX51TAMtmE1ssFxO8Ab3yZvViv/GS6BfZN6mZXTCnAGR4IA1D4s7M+wrLVh7SlHDQXHeatPt1MPNZDVk/1/vrqDI/wF+Mx5E
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 all available API routes with their methods and implementing providers."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/inspect/routes"}
context={"endpoint"}
>
</MethodEndpoint>
List all available API routes with their methods and implementing providers.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Response containing information about all available routes.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"route":{"type":"string","description":"The API endpoint path"},"method":{"type":"string","description":"HTTP method for the route"},"provider_types":{"type":"array","items":{"type":"string"},"description":"List of provider types that implement this route"}},"additionalProperties":false,"required":["route","method","provider_types"],"title":"RouteInfo","description":"Information about an API route including its path, method, and implementing providers."},"description":"List of available route information objects"}},"additionalProperties":false,"required":["data"],"title":"ListRoutesResponse","description":"Response containing a list of all available API routes."}}}},"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>

71
docs/docs/api/list-all-available-providers.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: list-all-available-providers
title: "List all available providers."
description: "List all available providers."
sidebar_label: "List all available providers."
hide_title: true
hide_table_of_contents: true
api: eJztWN9v2zYQ/lcIPW1AYqfBiq55y7puC9AiQeI8DGkwnKmzxZYiVZJyYhj+33dHSo5kK4sL7CWA8xJb5v367vuOIleZQ19Z49FnZ6vs9OSE/+XopVNVUNZkZ9m5+KR8uHJ2oXJ0/roxENKaAMooMxfKzKwrgQ0ETG0dBGgtqtZklB1lvBpNYPdQVVrJuHr81XOMVeZlgSXwp7CskKLa6VeUgQzJS4UuqJRhDqG7CpyDJS1SAUv/sjVUqrPIB0fJ06J+vZMCxfnVhTBQogiF8ptChCorjSWV4bN19B0f/6Pyl73eGvW9RkHrTVAzRc4IMnKPG+89l8nZPqnyCmFnA0lGhNkrYT9T8yF4IM8VrwJ91QPKGrycZWd3GwtTa02uNt+n1moE031k6nIaq9jOuvMk9avzoMlkfb/eru1DTLp2iVUVOGpHIDIN4lYg6FC8tgpr56hNIiUvPDWs9tzKfnXr54qYgfZ4RAr+XiuHxMG7SPA+Mbc5tWHDBrT7oyyooDnXVuQXpOcdsl3silw4nNNsQIre4Z+Rus7jWAheyF4bweT9ckfZDiw8bfqE7gROaPofQyUOjU6Zg/Nsp96hQQdCN9nxgIMFKA1Tjd1Rt15zbr8MTVKWK+eF5OIBPBW2AK1yQYQuQXORmP9/ozIB3FmnyO2cGLVd6F+TyVXLPmlz5JY0UL00gD46x2rkxUcEji+sC8LXZQlu2TIZ45qHQslCqFS0U0C8ZyGDaX6PcSIXCGu9b+S0mkNra6g2UdQlmGOHkMe+dGx66XAkZahmI/eo8qfLKvHsZ3Eubq8/NcVISn6KovbE/mCps2SNCxSldTiwJXJwX6Gk6S+FlTKqX+JWXj/C66bDbbc24HWoHmF6Brx26xczZ8uYA217I3Ft63mhl9Qere2DF9d/fBDvfj15F6WKj8DbS5dfRPWneL9BLq4TxZ/y2ZP5jXJO3w8rR2oVpyWZe/4QrCVjs2wds1ciwlwtkP6XtjZRqEGVeBDVQVSvTFSn75/iTYjpn5npjbJ8V1p/25o0QQjho0TMGTYWGwSkvapUYSSu6D2GEgrEHpjTRiY0/ejanertczuVR7eg5hOcLKW4x1NvaoOPhHegb9jAcJDWQVqvSFpvu/vVBTObMhc3ie1P8Rt5ne9SvgUjH4nLmpiAUMZdaYq08Rgbj3d5K68cZ1DrMHCs/g/HB1EdRPW6RHUyFG0PCUWVMNVg7rmazbGM8x84Fz577CLib64IyBFZ0+fCEkTZHKMugC8IsvHizXhjRo/TLufjTUDtON0ihOpsPKb99riwdLjNj7WGEo6pVPltJG1JZ3m2owJUWEbD31uR393zb9z2SKj2vMn24obtxU3T/HQ5c5Rx8FTf4s3A/Q5rxfdYA10edz2HAkKLiP9ixNYfCRPjCzGavLI0Bnw8jZMX5UjxLhEhndt5KM5Aok9OweEXPgJr6yLLd51P+cVeE+8dzNusPtMU0emAXxGOJEnGhG/V9mhmD4fV0zR80bARccDHMK40ve1w/NjYVUOBu4R01WUaN5p/Wa2m9Kp06/R6zY/pbcstE5vivJpyO+/u04UTX85w87/hkkkuJVbMMzrY1PEiaHtqr7uc/PPjhKj/L5yajXk=
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 all available providers."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/providers"}
context={"endpoint"}
>
</MethodEndpoint>
List all available providers.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A ListProvidersResponse containing information about all providers.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"api":{"type":"string","description":"The API name this provider implements"},"provider_id":{"type":"string","description":"Unique identifier for the provider"},"provider_type":{"type":"string","description":"The type of provider implementation"},"config":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Configuration parameters for the provider"},"health":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Current health status of the provider"}},"additionalProperties":false,"required":["api","provider_id","provider_type","config","health"],"title":"ProviderInfo","description":"Information about a registered provider including its configuration and health status."},"description":"List of provider information objects"}},"additionalProperties":false,"required":["data"],"title":"ListProvidersResponse","description":"Response containing a list of all available providers."}}}},"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>

71
docs/docs/api/list-all-benchmarks.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: list-all-benchmarks
title: "List all benchmarks."
description: "List all benchmarks."
sidebar_label: "List all benchmarks."
hide_title: true
hide_table_of_contents: true
api: eJztWF1v2zYU/SuEnjYgsdNgRde8pVu3BWjQIEkfhjQIaOraYkORKkk5MQz/951LSbbs2E0K7CWA/WKJ4uX9OueSl/PMU6icDRSyk3l2fHTEfzkF5XUVtbPZSXYqPukQP5BVRSn9fbhsJQbZQaacjWQjC8mqMlpJFhp+Cyw5z4IqqJT8FGcVYS03+kYqQrDyriIfdaM3l7E/S3ovZ5ikI5XheWmdwwQ91uR7c0P02k6yRZo8xRR/B1dd7RXd6fzHE3d8bwY2PxxkZOsyO7nJSpeTwXsoNJkcD1NY6/xdPsIzuxiIjQ/KseDduLYqhfggG3XBxXN0zrR/dxPv6qrxt6xidpsCHhDuNYmcxrI2T0f7SbwuSHT+C3bgQEjzIGdBrGQWSyu3RmBzybNl2IUbiwgFrbSITtSBxNj5NLzUIGgqTZ0gwso2AxFeAIFVNtaNYYiyGe2aoltTrMAR2C5G6UzkdZq0bk5JUW4AcQk4meea50lzsQY9Z+nzGLlfStjaGCy2fB8hjSRtfwhoGQGqvZGlUxvu9wZaSxa3Tzw/b81uw61Dzy2BfCCvi10OjKUJdIAa8L3WnnIGcY9M64xo8b+GkW057AUSeI06Grb/w05knvbwsUQo+9K5gUQlZgmYjfFSWoXas/gprzbN2V7ReFGs+tu2KtgQ6HtNwNmDDEJbmKdzAUNLadguyv+/ghiijHUf9xrLTlJO1s365/r6QjSzhUKUUp1qnHyOvx+9Z8TwZBQDEQrnowh1iZDMOkZTmvNQaFUI3TjttbQxJUja9nvSk4AZpTYv1dzMZtXGWfgmihq5PfQE8IwMqslKZs0c1qRRBRkHz+v65XPVIORXcSq+XH5qnVEwfkRcpnIuC54gTVMC0jzBzYSzpFmOXB2T8lCRAjGUcErV3gM9tGHXzyCyzXCXrWXweiBNYdoRvG7bFmNsDcmG04uzgbh09aRAgRs7Y9xDEJd//SHe/X70bsBBo0dZVg0yOnwB6j2OylxcNhBf2fNC5LfMOX6/nTnKaLBCFBAP/IDdDcJ21i3MqwIIEz0l/JeutqmaR13SnlR7Ur0yUh2/X+m7BtLPGekts0KfWv+6GpxAhOhREeUcNiabjCSMLnUciAucHmBQBHrkRIIkBh/9oOXb2107VSA/RfIRTqYSITwMrNrSI+Id8UZtGPbU2lPrFVHrbX+/OmNkw3Jx1aB9pb+l1+lTyHfByAficw0kkCzTrjQibDzWpZNv3tFr2Vg9aYl/sPCeVHtSvS5SHW3T9gIKJZYw1OQksDerhood2NKfS2NWzV7g+6NKeol2Ec05FrhNrWPhEJpskq5KKhkLvAynb4bcDQ5Xwtx6JtaH1H3Xno0tYqxOhkPstoeFCzD40BhZykM4qu4HypXon1kO5us4S4J/dhS/ueVvnPQEp65PZHlxxfLiqk29bC9tWHnj3PTNlvsWZkpYw4zso7i/cixkFG2vHb5asfEDLSkdh8nmlUMRCGBdOipoD777BgY5N8pcIfxYKgrNotLTV8updD5h/OniIz7WG6Dey0ln1Tm32yHBpUIcQUiOiUWmdmdyzf35qgTumt8SNtJjHFYGJxvWltI4b9N+08SVE9+/Ikvg4vTyjPl8hOPRF28WCx7GCcvPGiSlGjXiJN7wnUmBgsL3g0j5Pc0Y2EpRxRjjW4Z05bJZqRd9PP798Rpw/w81U2uU
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 all benchmarks."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/eval/benchmarks"}
context={"endpoint"}
>
</MethodEndpoint>
List all benchmarks.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A ListBenchmarksResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"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":"benchmark","default":"benchmark","description":"The resource type, always benchmark"},"dataset_id":{"type":"string","description":"Identifier of the dataset to use for the benchmark evaluation"},"scoring_functions":{"type":"array","items":{"type":"string"},"description":"List of scoring function identifiers to apply during evaluation"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Metadata for this evaluation task"}},"additionalProperties":false,"required":["identifier","provider_id","type","dataset_id","scoring_functions","metadata"],"title":"Benchmark","description":"A benchmark resource for evaluating model performance."}}},"additionalProperties":false,"required":["data"],"title":"ListBenchmarksResponse"}}}},"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>

71
docs/docs/api/list-all-chat-completions.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/list-all-datasets.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/list-all-models.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: list-all-models
title: "List all models."
description: "List all models."
sidebar_label: "List all models."
hide_title: true
hide_table_of_contents: true
api: eJztWE1v2zgQ/SuELm2BxEmDLbrNzbvt7gZI0CBND4s0CGhpbLGlSJWknBiG//u+ISVbcpxtCvQSIL5YH/M9741ILjNHvrbGk8+Ol9nR4SH/FeRzp+qgrMmOs7E4VT6c2YK0v2ilR9lellsTyARWkHWtVS5Z4eCrZ61l5vOSKslXYVET7NjJV8oDFGtna3JBJZ+FDH0p6ZxcQEgFqvyPtVWBENRUkevJ+uCUmUF2mMhno743JDYqYmqdCKXyAlWwjcvx0gitZSWFDzL/lq2ivzlU3E0nc6OKX+YrlCQ6BwNnj/Fx8l7Y6cAEbmQQ9tb4oSs2nWzdt0mmqbLjq6ziBuPel4p0gYs56m3dTTFhx2iSJy6/zy0r3kwbk8c49rIJmbyspPuG62Ctbv9uZs42depYVYfsOkLGAzBrXwVNZaOHT/oZXiK3dbk48D0h9a1cePEiKryIVY2XaznPyVYU5Baw1gCSRaHYvtTnAyhZQx+nqMRawzRaw9j6foKkSJr+I9RuEju3Xdfek4To3oM2ktX1ajvfsVmITXiiy2KDnVQmTpAvbrqebuqodbWziizJaEm1enl6eiZgkxA93JlZev4q23sQHsnwWoG7GVTQLBtHwyXrrVYPlXcqtac9TJvvjXJUsMUedYfAb4PodXGQ77bne/mOtxCBixrX7A2ZSiPGJ2uJGUYbISAm42kk/icm/gip/EwuMcpeYPcnJhuExd92TdgEc8wLH8St9IhlLrUquEOV1Gh+RcWvG7iYbKHpj1YFs7PYhWFY/1xenoskLXIkE6dISvBHo+mDcwxZFgZlhS+tC8I3FabEohtaFGVuS5WXQqWknZImRLSjS+l99BOJEqTSj/WcpNm1tga5ibKppNl3BDxNNImeziAc9qQwo6TJH5Hly491QscrMRafL07bZHIEPyHReMAqWHQW2jQnYM7x0Od+xs4JObFNiM59TTmokAub541zGKi0FdfPoLHtcNetdfF6AI1leqB43ZJATDG4Ywzj85ORuLDNrNQLtEdre+vFxV9/ire/H74dcdHoTlZ1QkaHL0B94+8PWYiLBPFNPI9Efsuco3e7mZNrBVaIEurMcZTcQhmTtDXMVgGEmZoT/ivbQIZrqyp6JtUzqZ4YqY7ebfxdAulnjPSWWb5PrX9tA06gQnSXExVcNiabDCS0qlQYiXOsZhBQAHrkTPLKFy/dqOXbm4e+VJ7cHM1HOZlK8eOJ3jSG7lDvgDtqy/BMrWdqPSFqvel/r04Y2bwG/5TQvvHf0mt8H/JdMYqR+NgACSSr+FWaED48xsa1btHRa71kv7fd/h/Dz6R6JtXTItXhLm+PoFBkCUNNzjxnkzZTHPwwWN5oCal12tB5PpeqpZPYOZJjxeu4iywtSpLN4gFGLUOJm4P564Okw4cakeQ+bv4bx7GVIdTHBwf4uO6XFlvEYj8eC+3HY6FRbits31kP0aqwiIrvO0ZfXfM77nFET7cl3Owuxae207I9QWHnKZ/56x3bdyaGH0BE9kHbtxwPgNrNtP9ixNYPLKS4+iVT1Bac9yBZXBkoB3q71PV4IsADwU1lTj4ZlY6+GO6cdRHS941PeBWvAXInZ11UZ21b+GwLdQT/uCYGDdrdvEHqy8202yXb8jLQXTioNRYw7CW2b9l2+SrVs1qDh3vJj5fLCZY+n51erfgxVk9ukdAS58+EO3bF5zMlhgWfLaK/32jBoM1zqhlH2Kg08Xhnewqv+pj7+8MloPwfVuN5TA==
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 all models."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/models"}
context={"endpoint"}
>
</MethodEndpoint>
List all models.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A ListModelsResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string","description":"Unique identifier for this resource in llama stack"},"provider_resource_id":{"type":"string","description":"Unique identifier for this resource in the provider"},"provider_id":{"type":"string","description":"ID of the provider that owns this resource"},"type":{"type":"string","enum":["model","shield","vector_db","dataset","scoring_function","benchmark","tool","tool_group","prompt"],"const":"model","default":"model","description":"The resource type, always 'model' for model resources"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Any additional metadata for this model"},"model_type":{"default":"llm","description":"The type of model (LLM or embedding model)","type":"string","enum":["llm","embedding"],"title":"ModelType"}},"additionalProperties":false,"required":["identifier","provider_id","type","metadata","model_type"],"title":"Model","description":"A model resource representing an AI model registered in Llama Stack."}}},"additionalProperties":false,"required":["data"],"title":"ListModelsResponse"}}}},"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>

71
docs/docs/api/list-all-open-ai-responses.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/list-all-prompts.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: list-all-prompts
title: "List all prompts."
description: "List all prompts."
sidebar_label: "List all prompts."
hide_title: true
hide_table_of_contents: true
api: eJztWG2P0zgQ/iujfAGkfQOBgNXppIXj7pBAu9oXpNOCkJtMG4NjB9vpblX1v98zTtJmu+Uo0n1B6n7ZNBnP6/PM2J5nnkPtbOCQHc+zJ0dH8q/gkHtdR+1sdpyd0Dsd4pl3VR3DeSdOubNRaavthJQxVLefD7K9TL6wjaJI1bXRuRJFh1+CaJtnIS+5UvIUZzVDvxt94TxiIXTU7KNufSlUHEop79UMQjpyFX68uvVnIBeih6+QuxvcZckUZgFKuxAo8m2kGx1Lmiqv1cgw1UblXDpTsA8H9KF7HUh5JmfNjEJT185HLuimZEtNkLREqO7TFejk7O1BttjLptCh20x0nmmka8L+nmsfWkl62AlQiArxScIjPd4jbXPPFTINsxALasqPxEIbx2dd/Dj6K6u/NUy6gBY91rAxdr5SUVSqQA9qUfTb0xf7hZ7ouF+qUP7+IEXR52CLCnW2F+vGBVXkxn3el9m2qkK+Yokoc2VpxMgn/NE2ZXRZpQpViSxqdfhc8Fg1ZljvkXOGlU0hd9/GygRe9+JVKwf1RUIq0osawpKHOR2oqxfpkMx3ypavka9WrgPcAv6ootCiXZmzASY7656/NdozinO9xMKwZsPc3gnt014WdTQSW8vFe9U86ZMDTrvG54yHGs9SXEENAORgmU5rtidv6TVkEXAC+N2kSq7fGVUpuogq/wrc/lRYibkDdze0j3u+L/tK5Qo2FB0ZgceyrSySC0839SehsJhnyN8AtdpOldHghKdKGQE0F/9fWwIJYxO2oO/fl5dn1EqjWRYJqV1GfkTLN94LrER4T8pWoregx1SV8jNhjACRk8xNqfNSsClBAzY2JkQCz+33ZCcxD83abGu5lRbTxlnpPGVTKbvvWRWJoYM1d9xJZLSI2eZbRPnwtG7h9IhO6Or8XRfMkPOAgWes5qkAwwsw2wYlltXINTEZDzXnaF85uTxvvGeYX/PrZ+DbVbiv1jJ5A0SnNH0nef1ApTGwm3yQ1k/nrpmUGBVjZ4y7CXT+52t6/uLoeRoKfKvAPB7iC1Bf2XulCoySBPGVP1siv2POk5ebmZMbDVYQWjtJo0DKHRbbWa9YtAIIEz3FYFOVa2xq2lFXvCPVjlS/GKmevFzZuwTS3wvSO2aFIbX+cQ04gQzxbc5cSNqEbDIcja50PKAzbBvgUAR61AQ7YZLJ6ftJ9ex7kyqwx9gnpFOoxDKPUZvG8i3yLfsu7tKwo9aOWr8QtZ4N59VbQTY8p4sW7Sv7Hb1O7kO+T0ZxQKcNkMCqSlNpxBg81qXzSdHTa7DfX9sD/4fiHal2pPq1SHW0ydoWFEosEaipSZBoutOXeL/hDL52f1MrjxM4CCxLsQLPpUNSsgknJqhY4sfh9PFhtwgv26kmC+ZZ48W9Msb6+PAQ83W/dAEu7hs5Ue6HdKLMXZUtPsk6OKzjLC38oyf19Sf5JmVOAOqPkasTKV10xU4gyAa3Ktn08YY7HuFGuIMSNcTtUHO6d0BgUw0lHy2t/YGInDbAbIvagfYBPEubA+3BcN8WvpDztvQEP1Z5f5mhPH+UOzOTDuHR3Vc+ko28Ac69mvRevZfzcEgAqZFHUFByInck3ynfndjnq463Ubgjp9x5HeLor63YSQWcd4W+bjNarxAk5ZT38/kIG6ArbxYLeY09lJ+1iOlvMFIlsQAtA71RSvyVZwLdPOd0f4HjSpOujtZ78WKIu7/eXALQ/wLZ60Bm
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 all prompts."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/prompts"}
context={"endpoint"}
>
</MethodEndpoint>
List all prompts.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A ListPromptsResponse containing all prompts.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"prompt":{"type":"string","description":"The system prompt text with variable placeholders. Variables are only supported when using the Responses API."},"version":{"type":"integer","description":"Version (integer starting at 1, incremented on save)"},"prompt_id":{"type":"string","description":"Unique identifier formatted as 'pmpt_<48-digit-hash>'"},"variables":{"type":"array","items":{"type":"string"},"description":"List of prompt variable names that can be used in the prompt template"},"is_default":{"type":"boolean","default":false,"description":"Boolean indicating whether this version is the default version for this prompt"}},"additionalProperties":false,"required":["version","prompt_id","variables","is_default"],"title":"Prompt","description":"A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack."}}},"additionalProperties":false,"required":["data"],"title":"ListPromptsResponse","description":"Response model to list prompts."}}}},"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>

71
docs/docs/api/list-all-scoring-functions.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/list-all-session-s-of-a-given-agent.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: list-all-session-s-of-a-given-agent
title: "List all session(s) of a given agent."
description: "List all session(s) of a given agent."
sidebar_label: "List all session(s) of a given agent."
hide_title: true
hide_table_of_contents: true
api: eJztWFFv2zYQ/iuEnhLAsdNgRVe/eWu3BUiRIEkxDKlRnKWzxZYiNZJyYxj+77sjJVu2lcYB9hLAAQLbEnn33d338UguE4uuNNqhS4bL5OL8nD8ydKmVpZdGJ8NkJG5gJjV4zG7rwf2kl6RGe9Sex0NZKpkCjx98czxpmbg0xwL4m1+USGbM5BumniaW1pRovYwuM/DtUWAtLGiQ9Fi4rtmQZZIdgbrZsmM0Xk+T4cN6hq6USla99e+JMQpBtx/pqpigbT9x3ko9az+JgFoPaiSr8WrV28nUfY5CSeeFmYoQgJgaKzw9TStrKVmihBmSsSQH97UwFlsRNvh2jf6dI1kIZiwKoH+eWNuHOUgFE0Uvpj4Mkk449Oyjsqplvo6sC/Ln26sAFNIUnaNR0QxHknCQ3SmfgnLYI/78W0mLGaU+1rIV3LiXeOkVu9+j0B6SkZihRitTTlIcKxpyEiDwhFEp84OCFk4WJcVMoAvwfQLJMH/pIi/HxxCRqvIDnJB6DkpmgsItQLEBgv6/kdl58FWbtpLMzohiu8H+dX9/I+JokZoscKJO1XMV+2gtk4oH9zgVubFeuKoowC6YeEw3DGN+5DLNhYxBWwnaxzLr+n3wE0jsiUWHeo6j2bUymmITeVWAPrMIWSBia84WHPYkNcWs0wOiPLkuI+VOxSgQNAaTEvgJisoRObyhytJsnDeS0JEQ7BkmpvLBuSsxlVOilUmjClPcwfUSitcVbqq1Tl6L6iFNTyRvTeipNUXAMLq57ItbU81ytVgz/PaP38W7X8/f9Tlp+AjM9ja/iOobf79BJm4jxTd4DmR+rZyL993KSZXkVYsETYsKffHG0GS9aAyzVSLCTM6RPgtT6bD2eVngUVRHUb0yUV283/i7J6Z/YqbXynJtaf1jKtIEZQgfU8SM08Zio5ZFTbOQvi9uqJVz2yL2wAxIJIpe2qZTvX2qUzm0cyo+pZOlRP0+Y2JVGh8p39wQsU7DUVpHab0iab1t96tLZjYhF3eR7Rv/tbxG+5RvkpH1xXVFTEAoQleaIDUebTwljN7V8spwCpXyHSeZnxg+iuooqtclqvMubwdIKKiEqQYzx9GM6NxF/W28C/aKT7KgFHUlOhUafeJOOWfr7R5P44uAEiwUSJp24fit6Qefm/n1V8m6kmytBJ93nj4vPzSVCFO4ouEMXXsNZ2h2symAtxUVZE+Ozdmdz+o1CEqVJRA6w8cGB3Vzu+gEEoax+zArIKpPoswlrtU2jJoYezgaubeBhG3B8xDihQTnYx19JHhl9UudUz2pKrmhwckMwzLFJRgmg/mbQUi1GyybKq0GjUMaF3chsZrhEiHJvS+HgwHth85y44hSZ0pBAWeUqfR7PzVFwu4cEsGkX4SJH5pF+GHM71iWAWbN2CueL+54vrirxRkSTf7ZeczJ/E1Hmngtc1uqhvY607Ycrg1odZ5LMvJFi50/4KsSnoc6Kw2lztG6GDZz0tKKbKNQM74R4bzaKaToolGw+EWz2IwNq9C+8QkfvBStS5aSXKP6RKu8ckHQJeWRlkzOSc2RQ/W2lY/lpmsdbKCmisdHPygV7U5bt0WRIw8x85El9GXYUvOaKFRVJgOPXi4ntN39bNVqxY8jwZkFmXTcDzaEfRL84QrshP8dF3t6p/NuxSPD7d3LkDwnxJ9gaKS+8T7mH9R6J8z8FyXl5LYW/Kl4yVLZia65z9SLNrgG9brAqzFfT1Ifp0WEwcbXozTFsh3V3gZpa7358+M9rUD/AT/nyfA=
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 all session(s) of a given agent."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/agents/{agent_id}/sessions"}
context={"endpoint"}
>
</MethodEndpoint>
List all session(s) of a given agent.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"agent_id","in":"path","description":"The ID of the agent to list sessions for.","required":true,"schema":{"type":"string"}},{"name":"start_index","in":"query","description":"The index to start the pagination from.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"The number of sessions to return.","required":false,"schema":{"type":"integer"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A PaginatedResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]}},"description":"The list of items for the current page"},"has_more":{"type":"boolean","description":"Whether there are more items available after this set"},"url":{"type":"string","description":"The URL for accessing this list"}},"additionalProperties":false,"required":["data","has_more"],"title":"PaginatedResponse","description":"A generic paginated response that follows a simple format."}}}},"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>

71
docs/docs/api/list-all-shields.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: list-all-shields
title: "List all shields."
description: "List all shields."
sidebar_label: "List all shields."
hide_title: true
hide_table_of_contents: true
api: eJztWE1vGzcQ/SvEnlrAlhyjQRrf3DRtAySwYTmHwjGMWe5Iy5hLbvghWxD03zPD5VorWU4doBcD0kW7XA5n5s17/FoWDn1rjUdfnCyL46Mj/qvQS6faoKwpTopT8VH5MKkV6spf5O6j4qCQ1gQ0gS2gbbWSwBbjr57NloWXNTbAT2HRIg1ky68oAxm2zrboguqcVhCGvcA5WFAnFbDx/22tKgpBTRW6QV8fnDKzYpU6z6mLu6E8bXQSb1T1445PfO8atj8cFGhiU5xcFY2tUNO7TzjRw5yite6mKumZU/TIwXtp2fBmGo1M+B4UJRpZN+Bu6TlYq/PfzczZ2Hb5Nm0orhPgPrDz3keFU4h6q2lYu8saRZ+54NAPBOg7WHiRDThzcLAbaagqxQOBPt/A3Bo8m1LSDxYmak1DPbyXFD+CGTYRTCXVaNDygO1W6QcNOZLV9Wo7sV/O2i6yX8U7a6ZqFl1in0jZYEDnxdQ6EQiAPtXVUxlNQXs8ICl8i8phxeUc0GqTG5kJVI2gguYgJ7uhPxUephgW2f2gDDUEIcGIEkX0WIlgBUlF3oosqBGF+jOxJgENAtohVx6Rhvxtl747jnyL6IO4Ay+UmYNWlSD0GtAEYoPV/6d2HyDEIdsUDTtLMG+G9c/l5bnoehMwFSYRdhk+VuGm6XvnuPTcmfhOBbAuCB8bEtlC2GkiBaY+d7WStVBd0k6BCYk1VJzue/KTyBdA6ed67nqza20N5Sbq2IA5dAgVlBrFwGYjHPakSOJg5DOyHEjgVHy++JiT2WKWQ7LGOYrGOqQ0uZ6dUqC0MXQCaVES16WwUkbnaD7Crbh+ho65wn21HsAbMDTB9AR4/YIkpjTvpRhOzz+MxIWNs1ovqDxa2zsvLv56J978fvRmxKDhPTRtx4yeX0T1tb8/oBIXHcXX8TyT+Vk5x293K0dqRaoQNZl7fqCpm4zNoh+YRyUizNQc6b+xkfowtqrBvaj2onphojp+u/Z3SUz/xEzPyvJDaf1rI2mCEMJ7iVgxbCw2CCi0alQYiXPaIVBAgdgDMyCRaProRllvr59aqTy6ORWf4GQpIcHDxIoG7wnvQG+YYdhLay+tFySt18P16gMzmyIXk47ta/9ZXqePKd+DUY3EWSQmIDRpVSqRFh5j02a26uX1cHB4dNj7wcB7Ue1F9bJEdbTL2zMklFTCVIOZ52zyaYqj34yWj1p0otb5kOf5WmR9AiVTsqDn2hIoxSzdALQQanoZz1+NsxFfCySd+3Smjo7Dq0NoT8ZjWl8Pa+spxEOtoYFDSk3ejqRt6FTMdhSwCotk+Gcv6qtr/sZlTgTqj4VsLyZsLya52JDvINh5l9H81Y5LBNaG32AJDHk7HDmdbvOB2X8xYutHQsS0AUZTtZZk70lnaXOgHCncdYWviOqC5wQ3BYm+GxQcfjFcPOsSqx8PXvJGXhPPHcz6qD7xvYxPBGkJR5IgY2KoQk+UbyP35XrG29k5izPgfRi3mnYx7CcVcJkLfdUh6tcM4nJy+3JZ0gbos9OrFTfTHsotOsakWajkol3xzUdNUwZfb1GJb3HB1JUSW+YSHVdiujjZnotXQ979/f6SCP0dVpv0tw==
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 all shields."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/shields"}
context={"endpoint"}
>
</MethodEndpoint>
List all shields.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A ListShieldsResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"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":"shield","default":"shield","description":"The resource type, always shield"},"params":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) Configuration parameters for the shield"}},"additionalProperties":false,"required":["identifier","provider_id","type"],"title":"Shield","description":"A safety shield resource that can be used to check content."}}},"additionalProperties":false,"required":["data"],"title":"ListShieldsResponse"}}}},"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>

71
docs/docs/api/list-all-tools-in-the-runtime.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/list-all-vector-databases.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: list-all-vector-databases
title: "List all vector databases."
description: "List all vector databases."
sidebar_label: "List all vector databases."
hide_title: true
hide_table_of_contents: true
api: eJztWN9v2zYQ/lcIvXQDEjsNVnTNW7p0W4F2DRK3wJAGxok6W2woUiUpJ4bh/313pGTLsZOmwF4C2C/WDx7v7rvvO4pcZA59bY1Hn50ssuOjI/4r0Eun6qCsyU6yU/FB+fAFZbDu7K2/aA0G2UEmrQloAttAXWslgW2G3zwbLjIvS6yAr8K8RprK5t9oGjKsna3RBZXcFhD6o8A5mNMgFbDyP7ZWBYWgJgpdb6wPTplptoyDZzTEjSlT2ziJY1U8PvCB9+nB/RcHGZqmyk6ussoWqOnelwp1QRezCNm4yOmaU/TIwXtp2XA8aYyMCB9kORpZVuBu6DpYq9u/8dTZpk75VnXIriPgnuDenBon0Ojtp/0ajihmYSeiw+BAgL6FuRcvVjYvxMQ6kW4Fh5sDs4ISxyrHouCYU4o7MNj09g9U0VsoUayMRTQWwYrGY9/XFA26SJxNZ4Wq0HiVqNQ6VMS3KRX6vsezbuy22+QlJrLKdWwowh1FpjFAVjwp6PMeyyagPR6QWL43ymHB5e7RbpM7LVO2cdudHFU1qKA5jE5jW+l92azKqowRRh8ioQSYQnxv0M3XWa9h8AMGYHNWljXjtV3zn8EhireXxM5msZVR90JMiNtCk00v6lUkFPSSg/ltV18alQwEZUxZ3IIXysxAq0LQBBVoQqbC4v/rUT5AaPwTqPj3aHQu0mghqe6xdSRsfqSbd85R8HEwCVT40rogfFNRa5iviB3H3JZKlkKlpJ0CEyIVwLTvo59Y8ADqCYpNntNodq2todxE2VRgDh1CAblG0bPZCIc9KWpMYOQTsvzlU52I9as4FZ8vPrTJSAo+R24OBTcJh2SNM6S24ZDS5HrGygnIbROic1+jJAVKYaVsnKMuivfi+hkitxXuqrUCr8ftCNMD4LkNRnMMp+fvB+LCNtNSz6k8WttbLy7+/EO8/v3oddQj3kFVJ2Z0/CKqr/29hUJcJIqv43ki81vlHL/ZrRypFalClGTu+YIWHDI2825inpWIMFUzpP/KNib2ikB9ay+qvaiemaiO36z9jYjpH5nprbJ8X1r/2oY0QQjhnUQsGDYWGwSkRapSYSDONfISHIg9MAUSiaaXrlupXj20Unl0Myo+wclSQoKHidUYvCO8A91hC8NeWntpPSNpveqvV++Z2RS5uExsX/tv5XW6TfkOjGIgPjXEBIQqrko50sJjbPzELjp5rfY6W5vURybei2ovquclqqNd3p4goagSphpMPWez2odx/Ds2f6D1jj0XsR4cbZBJyzwLmdJ1aQmfbBqPMGoIJd0MZy+HyfqwyBmztMaxzSJrHAdbhlCfDIe02h6W1lPAh1pDBYeUqLwZSFtly2u2o/BVmEfDs07iV9f8jose6dRtL9leXLK9uGxLD+05CjtP2c1ebh+BlKwUv8EZ6LO4P3MoIYh2U++/GnHvR7LE+DmMpqgtNQEfd980i3Kkd5doEI8fuEO4CUj0aVJw+NVwKa2LHN+ePOfPek2sdzDtovrIBwhpD18TjiRIxiSdYjxeyg0QFutG+LhVK96Ad2FYa/rKYc+xpIu2+lcJ4179qVhcY361WPBMn51eLvlxPJVITIqNKudKUnnJgLoKn9tR3W9wzuyWEmvmGO1omngYeL9dL/t8/OvdiDj/HxqUR5U=
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 all vector databases."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/vector-dbs"}
context={"endpoint"}
>
</MethodEndpoint>
List all vector databases.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A ListVectorDBsResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"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":"vector_db","default":"vector_db","description":"Type of resource, always 'vector_db' for vector databases"},"embedding_model":{"type":"string","description":"Name of the embedding model to use for vector generation"},"embedding_dimension":{"type":"integer","description":"Dimension of the embedding vectors"},"vector_db_name":{"type":"string"}},"additionalProperties":false,"required":["identifier","provider_id","type","embedding_model","embedding_dimension"],"title":"VectorDB","description":"Vector database resource for storing and querying vector embeddings."},"description":"List of vector databases"}},"additionalProperties":false,"required":["data"],"title":"ListVectorDBsResponse","description":"Response from listing vector databases."}}}},"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>

71
docs/docs/api/list-all-versions-of-a-specific-prompt.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: list-all-versions-of-a-specific-prompt
title: "List all versions of a specific prompt."
description: "List all versions of a specific prompt."
sidebar_label: "List all versions of a specific prompt."
hide_title: true
hide_table_of_contents: true
api: eJztWF1vEzkU/SvWvFCktmkrEFCtVgosu1sJRFVapFWpkDNzkzF47MH2pI2i/HfO9XiSSROWsNoXpPLCNHPnfhyfc23feebI19Z48tnpPDs5OuL/CvK5U3VQ1mSn2VC8UT6cO1vVwV8kc5FbE6QyykyE1FpMyXmYe2HHIpQk6mh+mO1nbEgmsF9Z11rlkv0OPnt2Ps98XlIl+SnMakI4O/pMecCHcFGTC6pNrZChbyWdkzMYqUCV//HXbTo9Ox8cUofdeq2XSN3PPJymCkSguyBuVSjFVDolRxq1aZlTaXWBmg/Fh/SzF9KRsEbPhG/q2rpAhbgtyYjGM0qMSoeeF8Pzs8NssZ8l3HqZKcA1IbeR2ofWUuwlA+GDRH2MfxDH+0KZ3FEFpBEWZl5O6TFHaOv4pIofV39l1NeGhCrgRY0VYoytq2Rgl9KLRzU7+u3J84NCTVQ4KKUvf38Uq+gw2GGFUuzF/eBMMmZPwn2JtpEV8AolqsylESMCnshHmR7PsEoVViUQu1X+U0Fj2ej+eo+s1SRNLDm9G0vt6X4WL1s7uC8iUwEv1hCRHMIp3/FcKB/DJ2fLn4FXa5cIt0A+sigUe5f6vMfJFN3R10Y5wuJcL7nQX7M+tmul3exnQQXNtbXS3FjNYQcOJG4blxMeajzz4jJrQCCLyOJdTWZ4Jl7BFgVHgq+Dyli/0bKS4n2Q+Rfw9qfKisrtpbulm2zkvmwzlS1Ii2CFZnq0ifmYAVJ4sq1dsYQ5PMH+FqxVZiq1giacqKRmQlPx/7UliDA0fgf5/n15eS5aa/TOIjI1IfIjWb52jmnFxvu8bCV6C3pMVUk36/otRZvbUuUlc5OLBm1MiIwEn9v3MU5UHnq33jVya82htTXcecqmkubAkSyiQnvfrKUTxWhQs8l3qHLvXd3S6bEYiquLN6mYvuZBA0f4mqZMDMfEbBsUR5Yj24QY3NeUo33lwuZ54xwh/L28foa+aYW71VqC12N0hOk74HX7qxiDuzEHbv3iwjaTElvF2Gptb724+POVePb86FncFOhOQnnU5xeovor3UhbYSiLFV/nsyPyknJMX25WTawVVCLR2wY0CkFt8bGadY/YKIkzUFBubrGxjYtMOqqIHUT2I6hcT1cmLVbxLMP0tMz0py/el9Y9toAkgRHc5UcGwsdh4c9SqUuFQnOPYgIQC2CMnOBgL3jldt1M9/d5O5clh2xeAk6VEvB9jbRpDd8Cbz12UYHiQ1oO0fiFpPe3vV2fMbGQu3rdsX8VP8hpuUr4DozgU7xowgWQVd6URYeMxNt5Pik5evfP+vTPwvzh+ENWDqH4tUR1ti7aDhKJKmGpy4rmadPvi7Lfcwe+Pc+QKy9VUp5YO93LImh3OM76k4/v+vVWxQ9woy61Dlt6MYW1itLzqLTPA4nLA1WoE12B1NrTZzRUWqAqZlRam2YSiWjmL02wwPR6kG+Rgvkx1MehCwbLdjtuaGse4liHUp4MBDgYHpfXA9kDzVfjAx6twbquMA3oC0irM4od/dN3o+obfMT9jnt39d3WVFu8TspG9WW8clE2Pt+DGovZr9JZ9wfU9x4EJipwCaf/RiHv/sKgUT+5kitqiX3k0iHiqUQ6tybWMLXhQwM3MjWXeTWGko488+9NxehDspvMR30A0BOrkpMvqLV/kfWR2DRzROxiTxJvdebeGyHzVwH/CReILD/YGtcZRjXOKiz1PTLlu0U9cwdPp2kCmowvWlinB9vP5CKe/K6cXC/4ZB0jHXLhZjW8iMwrl+bnYPnzql7N3kfj+WPwnuWwtspvMmVmcK+mG/8LjF5qtiXdxA+MSnR1bGKfdvh/mOcUxU/flxpa5Jr2/Xl9CjN8AanfbTA==
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 all versions of a specific prompt."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/prompts/{prompt_id}/versions"}
context={"endpoint"}
>
</MethodEndpoint>
List all versions of a specific prompt.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"prompt_id","in":"path","description":"The identifier of the prompt to list versions for.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A ListPromptsResponse containing all versions of the prompt.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"prompt":{"type":"string","description":"The system prompt text with variable placeholders. Variables are only supported when using the Responses API."},"version":{"type":"integer","description":"Version (integer starting at 1, incremented on save)"},"prompt_id":{"type":"string","description":"Unique identifier formatted as 'pmpt_<48-digit-hash>'"},"variables":{"type":"array","items":{"type":"string"},"description":"List of prompt variable names that can be used in the prompt template"},"is_default":{"type":"boolean","default":false,"description":"Boolean indicating whether this version is the default version for this prompt"}},"additionalProperties":false,"required":["version","prompt_id","variables","is_default"],"title":"Prompt","description":"A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack."}}},"additionalProperties":false,"required":["data"],"title":"ListPromptsResponse","description":"Response model to list prompts."}}}},"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>

71
docs/docs/api/list-files-in-a-vector-store.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/list-input-items-for-a-given-open-ai-response.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/list-models-using-the-open-ai-api.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: list-models-using-the-open-ai-api
title: "List models using the OpenAI API."
description: "List models using the OpenAI API."
sidebar_label: "List models using the OpenAI API."
hide_title: true
hide_table_of_contents: true
api: eJztWF1v2zYU/SuEnjbAsdNgRde8ZVu3BUiQIHEfhjQYaOraYkuRGkk5MQz/955LyrEcp5sL7CWA/WLJ5P085/DDy8JTaJwNFIrTZXFyfMxfJQXldRO1s8VpcSauGrJn5xc6xEtXkgk3nc2wGBTK2Ug2splsGqOVZLPR58C2yyKoimrJT3HRELy5yWdSEYaNdw35qHPkUsb+LOm9XGCSjlSH/7bWZW9OiF7bWbEarGfvDKWsAwaKmuvBe0lT2ZrNLzBWnmSkvmONSmfkk+cHS+Xfk8ULYTEqy1JzF6S57qU5lSbQAA3/p9WeHd9x3oNNTeuIPff3gyLqaNh/BuHyKeFtiFLaYupd3aE1RCbfk0oCYCfcLubsFn5/eokp44oE+6QQxYMMQtu5NLoUzotamqnzdaruf6JMiDK24QV8nnfnz/H4WuTZQqEYBrArc5cZ26YfvEfyafJASBEq56MIbV1LvxBuKiIqpjTnodKqEjoX7bW0UaBgIW03nuKs2H+U2uwbOc/m0MZZ1Caqtpb2CEQp5cSQ6NlspcORNCgurdqjyh+umsyRH8WZ+Hhz0RWjkPyERBuoFNEBWVjTnMA1TyiT8UzICTlxbUzBQ0NKT7USTqnWe0L4Z3l9Dyc7hNdoPTWvR9PUpm80b720ZVlwDmfX50Nx49pZZRaAxxj3EMTN77+Kdz8fvxty0+hR1k1mxppfoPom3i+yFDeZ4pt89mR+p5yT9y8rRxkNVYgK5oEfonMwtou1Y/YKIsz0nPBduxZzuLe6poOoDqJ6ZaI6eb+JNwbTL5npnbJCX1p/uRaaQIfoURGV3DYWG3ZKYXSt41BcG5JIKII9ciYhEoNBP+z09vZbO1UgPwf4aCdLidAeJlZr6RH9xj7cNfcgrYO0XpW03vb3q3NmNjIXt5ntm/idvM52Kb9uRjkUVy2YQLJOu9KEsPFYF9EwjHXyejo571wb/sXxQVQHUb0uUR2/FG0PCSWVMNXkLHA1+TLFyW8nyxetfIkL6DXwSanmS1jKmJkvvawJemZP8IDnyqFHxYySMGSs8DKavxmhoVZqfsouMZp3O7ZcFq3ntKsYm9PRCPvuUeUCUj8yRtbyCCWrL0Pl6mJ1z3YoRMdFMvxtLfa7ex5j+BOxus5csL24ZXtx25EgkQPxOXgudf5mB6pxxZoJW+yRfT73PcdKRoFVYK7h5JMVzz4QKKWDMdmycVgOAvSXDg3aQ/k+E6LkFvNa4adSUchOpadPlkF1PrF91/mED/gG/Pdyts4qQ5qI06CPkCb3xAKqPXHd6sVyszLuZdyJOtJjHDUGpx/OIwG87BhxlzueOcFI8Fv9xEPGnictlxOcoj56s1rxzziI+UXmWVrKJowwYIcB1h0ssMyHL7Rg/itFDTMQd542/XvzfEFf9dn6x4cxVPEVs+ptEQ==
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 models using the OpenAI API."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/openai/v1/models"}
context={"endpoint"}
>
</MethodEndpoint>
List models using the OpenAI API.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A OpenAIListModelsResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","const":"model","default":"model"},"created":{"type":"integer"},"owned_by":{"type":"string"}},"additionalProperties":false,"required":["id","object","created","owned_by"],"title":"OpenAIModel","description":"A model from OpenAI."}}},"additionalProperties":false,"required":["data"],"title":"OpenAIListModelsResponse"}}}},"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>

71
docs/docs/api/list-tool-groups-with-optional-provider.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: list-tool-groups-with-optional-provider
title: "List tool groups with optional provider."
description: "List tool groups with optional provider."
sidebar_label: "List tool groups with optional provider."
hide_title: true
hide_table_of_contents: true
api: eJztWNtu2zgQ/RVCL90FHDsNtug2b9ndbrdAiwSJ+7BIA4OWxhYbSlRJyolh+N/3DCnZ8iU3YF8COC+RJQ5n5sw5w8siseQqUzpyyekiOTk+5n8ZudSqyitTJqfJmfiinB8aoz9ZU1fusrHoJ70kNaWn0rORrCqtUslGgx+OLReJS3MqJD/5eUWYy4x/UOphWFlTkfUq+s2k746S1so5BilPhXvaWmUIQU0U2c5Y560qp8kyDJ5hiB0hVVPblEYqe3zgA9/ji+0PvYTKukhOr5PCZKTx2+WKdIaHGaI1dpSN8cwpOuLgXWrYcDSpyzRA3EvGVKZ5Ie0tnj2Abv6Npgx4zLeofHITAHeAe/NzRhNZ6z2vu2UcImphJqJFoSekvpNzJ96sjd5wmkVajajMKqNiYR8Hv7ZqHyZbvnMS3y6/iPhZhKn5wRvh8akNKVnCvcwyxWZSX3QcTaR21ANbf9bKUsZws2cg4pXX7Brz7/g9C14tTcgCYWJ/dO/JYnLRULfPKUs73cuz/bEsElPS+QQxrCzKWmtMtPo9BqQky+4rkGQMhnberJi1RfzOiyaS5c1yO7VfzqsY2a/ibBWlQCJ1gaycmBgbsOXiisiIF6HbEdWmMhoddJBftYY9+AfPkXZaespCPE4UspTT8GtKiNKGKmzactNhw3UC7mUZhKbSCXN/F9uJuf0QCCJVyTyVQu9Gg5iXHNBv+5rmMND6Z00wu5NOqHImtcoEqlJIjeIUlP1//dN56esug6EvmobSbYb1z3B4IeJo5JdRaGsRn6c0/NFaphQPRusQLjfWC1cXaFvzgAwypjDmLldpLlRM2ipZ+sBGWTbfg59Qb+Crn+s5jmbX2pTITeQ1WHRkSWZyrEl0bDbCYU8KTVOiATztqyur0DxiMimCH5OoXeAsKgtrmpEojCWkyfUMlRNybGofnLuKUugnFSZNaxv7z2ZcLyFzU+G2WivwOvwOMD0AXrvKiwlWkhDD2cXnvrg09TTXc5RHa3PnxOXff4r3vx+/D3Kke1lUkRktv0D1tb8/ZCYuI8XX8TyT+Y1yTj7sV06qFVQhcpg7foDquGXM24l5VhBhqmaE/4WpyyhOVdBBVAdRvTJRnXzYWEvFV2Z6oyzXlda/poYmgBDdp0QZw8Ziw7qK9alQvi8usOtAQB7skVMsXoIXXduuVO8eWqkc2RmKDzhZStgsZUysuqR74M2rNjUwHKR1kNYrkta77nr1uWx2/leR7Wv/jbzOdinfgpH1xXkNJpAswqo0Jiw8pQkb5KyV1+oYtnOCfmTig6gOonpdojre5+0ZEgoqYapJPmxfr4+NjhPYc/jrnLXEnfK5ME1ZRHse5SuoSlpZEKTNk2IiPOcGcCXTcNtSSZ/jx2D2dsDzNQfJXhKXPBcO8bXl2HPvq9PBAIvvUW4c4j/SWhbyCHmnt/3UFDiGsx2yUX4eDP9qFX99w9+YA4Fd7YmT7cUV24urhgmyufJh5zHX2ds99yUsHLdBIdkldXdmn0vfIuK+l2LrDyqlsDtu73QcRBh2DspC/jayIuNjLjcMO5EpuTiptPSdz8Da2ED53cnHvMvXEIHFcb6J6itfg7nAngo4Qp+MSYkivaywG5As1l3yJXM0Ovd07weVxoaIowrlXjTMuI74d7iBQnL9+dNiMcZ26pvVyyW/xo7MziPLQk8bc5Wv+W4mRwPi60dw4pbmLIQ0pYr5h8NPHa52tjv7ssvVTx+HkMd/gcyOFw==
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 tool groups with optional provider."}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/v1/toolgroups"}
context={"endpoint"}
>
</MethodEndpoint>
List tool groups with optional provider.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A ListToolGroupsResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"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":"tool_group","default":"tool_group","description":"Type of resource, always 'tool_group'"},"mcp_endpoint":{"type":"object","properties":{"uri":{"type":"string","description":"The URL string pointing to the resource"}},"additionalProperties":false,"required":["uri"],"title":"URL","description":"A URL reference to external content."},"args":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) Additional arguments for the tool group"}},"additionalProperties":false,"required":["identifier","provider_id","type"],"title":"ToolGroup","description":"A group of related tools managed together."},"description":"List of tool groups"}},"additionalProperties":false,"required":["data"],"title":"ListToolGroupsResponse","description":"Response containing a list of tool groups."}}}},"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>

71
docs/docs/api/list-tools-with-optional-tool-group.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

45
docs/docs/api/llama-stack-specification.info.mdx Normal file
View file

@ -0,0 +1,45 @@
---
id: llama-stack-specification
title: "Llama Stack Specification"
description: "This is the specification of the Llama Stack that provides"
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---
import ApiLogo from "@theme/ApiLogo";
import Heading from "@theme/Heading";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";
<span
className={"theme-doc-version-badge badge badge--secondary"}
children={"Version: v1"}
>
</span>
<Export
url={"https://raw.githubusercontent.com/meta-llama/llama-stack/main/docs/static/llama-stack-spec.yaml"}
proxy={undefined}
>
</Export>
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Llama Stack Specification"}
>
</Heading>
This is the specification of the Llama Stack that provides
a set of endpoints and their corresponding interfaces that are
tailored to
best leverage Llama Models.

71
docs/docs/api/log-an-event.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

20
docs/docs/api/models.tag.mdx Normal file
View file

@ -0,0 +1,20 @@
---
id: models
title: "Models"
description: "Models"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

20
docs/docs/api/post-training-coming-soon.tag.mdx Normal file
View file

@ -0,0 +1,20 @@
---
id: post-training-coming-soon
title: "PostTraining (Coming Soon)"
description: "PostTraining (Coming Soon)"
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

20
docs/docs/api/prompts.tag.mdx Normal file
View file

@ -0,0 +1,20 @@
---
id: prompts
title: "Protocol for prompt management operations."
description: "Protocol for prompt management operations."
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

20
docs/docs/api/providers.tag.mdx Normal file
View file

@ -0,0 +1,20 @@
---
id: providers
title: "Providers API for inspecting, listing, and modifying providers and their configurations."
description: "Providers API for inspecting, listing, and modifying providers and their configurations."
custom_edit_url: null
---
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

71
docs/docs/api/query-chunks-from-a-vector-database.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/query-metrics.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: query-metrics
title: "Query metrics."
description: "Query metrics."
sidebar_label: "Query metrics."
hide_title: true
hide_table_of_contents: true
api: eJztWF1PGzkU/SveeWolSGi1VbdIfaAfq60EKgvhYdUi5Mw4Gbcee2p7gAjR377n2p7MhAkQupVWleAhTDK+3+dc2/cqs8LVRjvhst2r7PnODv0rhMutrL00OtvN9tjfjbCLA+GtzN1RWj/KtrLcaC+0JxFe10rmnETGXxzJXWUuL0XF6ckvagFNZvpF5B6CtTW1sF5GqwX3/VXcWr7AIulF5e6XroJfvXUO3/Uc61bDmJSCaV4JZmbM4znJXW9lik+Fcj/uAWl9uP1glcyfc9VsKB+W3lAADbwoJK3i6rDn2IwrJ7ZQ4G+NtKLIdj9FT1uLp1uZl16RyVjb/aDwpt29aIhx50wuuRcFu5C+ZDxlcEQxrIrsS+fJy5jYgaQvpUvCzAlLzrZp+A9V8LISzvOq7i2VwOdc2EFMJ1pesqUAuyiF7mEipfmCO2ZFbmyB5K2pk26q6Rrdoc5NJTpFK4Bj3McEdP5Cd6OlH0LgQbXt9LWuJrWDOr8D3w4NcrOm1g52lWBESVbTGib1stTB51SyO8reCTuSzktrtFFmjv6gGKXTPiyyxNQlUZdYGUR2HNE0DKvnOHmYwuk5ekc4K0hlFfd5iSSFkn6jxsgg4/GSPyyq0PV6EaxrsoNI2heMWi+XmhwZ1iYEhoiuyaHf1/V0Aik5A8QEnEuNlMoC1UGAamZsBSd/WoMHLH3jNuDlX5PJIYurEWEhqCgpP/e1x/fWwvmweAuAdaWxnrmmqjgqlBgowpqLUuYlkzFolA0YR8CM6/Q+2AloQIbVppbjajKtjEZsrGwqrret4AWfEqM6mRV3yJLUiFnnG0T55GMdwfWU7bGTo/0UTA7np4I1Di3WG1QW0uIcLcdYgTCpnqFyjE9N44NxV4tczoAbk+eNtQLmb/j1EDCnCrfVWiavh++QpluS1x5C2MyaKviwd/hhxI5MMy/VAuVRylw4dvTnW/byj52XgaziEr0uIqPFF6De2XvDC3YUId75syHyE3Oev1rPnFxJsIKVEHf04I2BsF60il1smnN5jn2FV6bRoZEQQx9J9UiqX4xUz1919iZA+gEhPTHL9an1j2nACWRIXOZCFJQ2IhsOfkzJSvoRO1SCwyEP9PA5ti+cELFztjvVi9t2Kuxq5yg+0klUEkgPAavR4hL5pmOlSGl4pNYjtX4har3o71cfCNnwnB1HtHf2E732hpBvk1GM2McGSBC8CrvSVGDj0cYjYXiX6FWIGW+UX3PBv0PxI6keSfVrkWpnnbUNKBRYQlDjc0fRTIQSdLVakP+r/oarWrp3ORqE1dxyfBWWJNuBULq3nqWhiyTJmvtyw8kU1TDcL8lAl2ZvG6R9QLrlxOA0Lsbe/MYUC1rx8/hr/Vk4w97P4bBrk0C8lt4WGFVQFw9RiuX3qpxbrhsFVvvFZmO1nsBdesPTWVQ3VCt0UxFuoGse60189kP0kEUSJlNxgAArSDQRdLScR56FQUNA1P8wlySXggM/NKBsheMhD/cvKCHHuAcd70jdazz/Rh+vv9PT9/W5y00FvklHPTQpJYsNdY5wi4sDmqy340Hzj89Je76vH5kexEqtGTulGga/ZlLRlGg5sMEuvUjJjuOsNSOoybIeLRooUmJxAE0H1NGDO3XL5RVY3zqOitfo0B9XWxF+gAelKai5mXDVDj1uNxufPxv7toeOU8zjq15TvMbieLSPbbOx1KNL7+vd8RiXjO0SCkWxrRSv+DZ8zr+OUPyMepwT6NqB4BB819b50ym9o8521PXA9yt7xLKH7fR7z86NrtFhs0/6JbdvMrTr+Uu5RJruh44AhMbTsOPPTJxcx5TvU5zsmOJkx2lnDr2a1MFOxMT5szXMo4OMW9nSef+Q0dfsS+4ZGsW5hJLPmt34w6lJhGkFkpNmuFyHm5y0oJ6Nu3RBOKY+bWc8Fy4q5VZ8pqmkMjYcQYbKpzR1UTiUWD5vvTrAEU9F8BOAcF7qetdwp10JvLe3DVemknlx6ce1Qh8Kc3YbznIRop9iLpcgzbbSlk1nmN3+7g1QERZJ5OpqiivsiVXX1/RzgAcBjyqOc+SUKgk4FNLRc7Gk362OPzlKhHrKNjgIrI2q3R70ogc8PH4VixvHkIC7EsdRtCtyM654G53ZnpCeTsPgtHC91Urs5bmo/Z1rT3ud4fDj8QSLp+lEUtGpnth0QUcbfAZvTUhO2LnCb1egmZ43QAreR5309y/D+gg3
sidebar_class_name: "post 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={"Query metrics."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/telemetry/metrics/{metric_name}"}
context={"endpoint"}
>
</MethodEndpoint>
Query metrics.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"metric_name","in":"path","description":"The name of the metric to query.","required":true,"schema":{"type":"string"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"start_time":{"type":"integer","description":"The start time of the metric to query."},"end_time":{"type":"integer","description":"The end time of the metric to query."},"granularity":{"type":"string","description":"The granularity of the metric to query."},"query_type":{"type":"string","enum":["range","instant"],"description":"The type of query to perform."},"label_matchers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the label to match"},"value":{"type":"string","description":"The value to match against"},"operator":{"type":"string","enum":["=","!=","=~","!~"],"description":"The comparison operator to use for matching","default":"="}},"additionalProperties":false,"required":["name","value","operator"],"title":"MetricLabelMatcher","description":"A matcher for filtering metrics by label values."},"description":"The label matchers to apply to the metric."}},"additionalProperties":false,"required":["start_time","query_type"],"title":"QueryMetricsRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A QueryMetricsResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string","description":"The name of the metric"},"labels":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the label"},"value":{"type":"string","description":"The value of the label"}},"additionalProperties":false,"required":["name","value"],"title":"MetricLabel","description":"A label associated with a metric."},"description":"List of labels associated with this metric series"},"values":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Unix timestamp when the metric value was recorded"},"value":{"type":"number","description":"The numeric value of the metric at this timestamp"},"unit":{"type":"string"}},"additionalProperties":false,"required":["timestamp","value","unit"],"title":"MetricDataPoint","description":"A single data point in a metric time series."},"description":"List of data points in chronological order"}},"additionalProperties":false,"required":["metric","labels","values"],"title":"MetricSeries","description":"A time series of metric data points."},"description":"List of metric series matching the query criteria"}},"additionalProperties":false,"required":["data"],"title":"QueryMetricsResponse","description":"Response containing metric time series 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>

71
docs/docs/api/query-spans.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: query-spans
title: "Query spans."
description: "Query spans."
sidebar_label: "Query spans."
hide_title: true
hide_table_of_contents: true
api: eJztWFtv2zYU/iuEnjYgtxYrtuYt7TqsWItkifswpIFBS8cWW4pUSCqJYeS/7zukZMu3xFkLDAUSBLEjkef6feeQZ5Y58rU1nnx2PMteHh3xR0E+d6oOyprsODsRfzfkphe1NP68XX2Q7WW5NYFM4A2yrrXKJW84/OJ51yzzeUmV5G9hWhPk2NEXygM21s7W5IJKOgsZ+qukc3KKRSpQ5R/f7WHVUBW9hT44ZSZYuOzFJ6OuGxKqgMlqrMiJsXUilCRYRHa/lwUnc/pGWVEGvikfxYoRaWsmXgTLGmrpsGO4s80/ncZvUv8stqtMQqO6PaHGSTl+pchLpYu5e0ZW9LjKP5tKmn1HspAjTYI3ibRihOVRIYc/prrnp6MaQIIdnlX5IF0YBrVZIQyvJGDDmaf9uGrVigEeQkhVi9uSzIrWEU2SR2SKb1HSi+6D+sbKKF9SEaOb26rWFKhgA2SAulETaCNQZVGopOBsCbLW0Ok4O76c7zCN1hA3/39kraboYm9JNSLXf9J62nuSmNN70Fpyf3X/gOt/0XT/RuqGgaScF8xqCY+R7IUDoqIgmahCjmwTerS53+bnWGpPeygv141yCNfx5ZyrPaq1sFyCzBXeq6DZA645a3k7WYFcNFV4fOh+2m4V4GnwJio7yNaC8EH5IOw4SvMCaAFfWohfc8ETWBvIKfk0L2M96/mwXjzXPOpeLAVf6L59sP+ezfhlU4UewGQ2ARgWtxLsN8ioKgQqRCU1U4GK71ewkarQ9BGvIHYCdK7VksHgTKTV8KygWGRTVB4rQ++c4/LGi/c4uaV1KHFNVUnkxY5jkiiuuS1VXnK9Y6eRLJRCrowASHof9cTcI7J6V81pNavm+o1qWy7Xxd6eJXNYkzLw2eQ7eNmj4Yn4dP6hdSaPjUM0ngo0DmQWu+mGRGUdOoBJpY0198lIOdpCLmyeNw4NAV1o2a4nETVluMvWPHg9VMcwbQled6QQY2eraMPJ2fsDcW6bSamnSI/W9taL8z/eil9/O/o1UpPuJBfWPr4A9YW+N7IQ5wniC3t2RH7LnJevNzMn14obaIntXE4QcovNZtoJZqkAwkTdoDXIyjYm0rLtKc+keibVj0Sql68X+gZA+kdGesss36fWP7YBJxAhusuJCg4bkw3HKXSmSoUDcYZTiucz71TICdqW0Hjpuk71alun8uRukHyEk6lECA8DqzF0h3jjZNUG95laz9T6oaj1qt+v3jOy+eR8kdC+0N/S62Qd8l0wigNx2gAJJKvYlUaExmNsvPcVHb0KGstGhw3X9QcEP5PqmVQ/FqmONmnbgUKRJQw1OfHszYA04RLrpmz/sr3xgtbdsuKQBldSsJf3XaWYoDe+scWUDftO/JmPDoZjpZOy/zoC+0rTx1HGjXeuU2ALgyqpFjZOU2y95XhsK4REeQZ5vFwzn6xg59nIVbVkmooDTtd8uWfcTNhkVKrVO/FbaxIUT2vWH4cQ/898ZFOw0kwEjib/KR1xcPt4Eok4NzG0nX9bg7BhzJF372IxS8ni0UCaToBgqP9+w2BjOdctvuY54y/d/CbtXoyxhsEOUWkaZ3aA4zzCD6n3bfGCSL5GLSuu5N2woDqUO/QRlor1qmoqEfd0pS044unOU7KyTr4tQdgyxknX0FhfFmKDa4h9olBa/JvVNl5Va8nuZYc3Lw5DV4MOYwh46hUPBz6CvXFc08oQ6uPDQxzK90sIoGJfa1nJfdTD/OsBsBjh6glVToVp3Ph7dxK4vOJ3XInOFzXr3aKmbqg5l235WPCXywCTl0VtBsZlt/hqKYNHseuNbcxlG7QPbLu4YNvFRdudZIt2djyl9ubFhmynIXa/rcl+o+1LDqUMAjXxRkHIZyNWfnByoHhjJ1PUFvjyOBjE24xy4JhLnapgZjH43FjmDFsWCt5/5omcti624XXhI548aDRmJyedVR9xzNEJ4QwCnBk4Jmn+vtptltzudZfVdS07At2Fw1qjErH0CJlZC7HLFMc5yBheEWZIE0OJV8xmI9zYPjl9f8+PYyFJXS4em0actEseF5c444CEC3y8TYbtD9iOebFeb4FcXtOOkzwHMB5ce9Wjy9npxQCLR22brfioeJw5eYuH/Pc4i+Dk3bEIxWezTEszaRB6vE8y+edfq5VqwQ==
sidebar_class_name: "post 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={"Query spans."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/telemetry/spans"}
context={"endpoint"}
>
</MethodEndpoint>
Query spans.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"attribute_filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The attribute key to filter on"},"op":{"description":"The comparison operator to apply","type":"string","enum":["eq","ne","gt","lt"],"title":"QueryConditionOp"},"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}],"description":"The value to compare against"}},"additionalProperties":false,"required":["key","op","value"],"title":"QueryCondition","description":"A condition for filtering query results."},"description":"The attribute filters to apply to the spans."},"attributes_to_return":{"type":"array","items":{"type":"string"},"description":"The attributes to return in the spans."},"max_depth":{"type":"integer","description":"The maximum depth of the tree."}},"additionalProperties":false,"required":["attribute_filters","attributes_to_return"],"title":"QuerySpansRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A QuerySpansResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"span_id":{"type":"string","description":"Unique identifier for the span"},"trace_id":{"type":"string","description":"Unique identifier for the trace this span belongs to"},"parent_span_id":{"type":"string","description":"(Optional) Unique identifier for the parent span, if this is a child span"},"name":{"type":"string","description":"Human-readable name describing the operation this span represents"},"start_time":{"type":"string","format":"date-time","description":"Timestamp when the operation began"},"end_time":{"type":"string","format":"date-time","description":"(Optional) Timestamp when the operation finished, if completed"},"attributes":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) Key-value pairs containing additional metadata about the span"}},"additionalProperties":false,"required":["span_id","trace_id","name","start_time"],"title":"Span","description":"A span representing a single operation within a trace."},"description":"List of spans matching the query criteria"}},"additionalProperties":false,"required":["data"],"title":"QuerySpansResponse","description":"Response containing a list of spans."}}}},"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>

71
docs/docs/api/query-the-rag-system-for-context-typically-invoked-by-the-agent.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/query-traces.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: query-traces
title: "Query traces."
description: "Query traces."
sidebar_label: "Query traces."
hide_title: true
hide_table_of_contents: true
api: eJztWE1v2zgQ/SuETrtAEqfFFt3mlna72AItkk3cwyINAkoaW2wpUiEpJ4aR/943pGTLsdO4214KJIfWkobz+d4MyUXmyDfWePLZ0SJ7fnjI/5XkC6eaoKzJjrJj8W9Lbj52siB/1okfZHtZYU0gE3iFbBqtCskrRp89L1tkvqiolvwrzBuCIpt/piJgYeNsQy6oZLSUYSglnZNzCKlAtX98dWC3rlQ5kPTBKTOF5HocH426bkmoEj6riSInJtaJUJGIOrK7vcxZG658I80PKmQ9gvXgSeJXkC5QiQflV8bi26ugatpmCqpqidxyemg/St23P8ZLKKkbcVORWUUicppKwybIlD9i4LeT+Evq38WDtibKKF9RuSfURBS2bjQh1OwO1mVZqrT+dFCyidSekGq6bpWD5NHFqob3KrCWo8u9LKigOYYIxQ1vjzuPHDUANdfETKOjvVeCbqloWVo0MlTCToQU7AciE7Jw1ntRtzooSAt2OOLZH3Am1029V1iB5dEgFslQVL21ayaLgHAgp+T3JSJSYRDoFuJthN1/EExHiWrADyn0mocI4Y4d+WMbv8cM2C4LN9ILZWZSq1IAy7XUDBMqfx7bUdHQDnmtoHZKbiOuf8bjU5GkEVoZKdPl5TFivnWOicjCe8iFr6wDCdu6lqgMJwURU5S5qVRRCZWCRrlMiBwGcdP3aCeWH6nVu1pO0mxaW4PYRNXW0uw7kqXMga3BmjV32JIyiNkUO0Q5YOex+Hj2vgumgPM5idZzw7GoLFbTjERtHXqVSbRnyzK3bYjGfUMFGlghbFG0zhHM3/Pre0DcVbiv1jJ5A1zHND2QvH4giYmzdfTh+PTdgTiz7bTSc5RHa3vjxdnfb8TLPw9fRnbSrWSKD/EFqK/svZalOEsQX/mzI/I75jx/tZ05hVZghaiwnHsOUm6x2Mx7xawVQJiqGdqmrG1rEi9Tv30i1ROpfiVSPX81mMJA+gdGescsP6TWf7YFJ2Y8cwuiMm5+QDZsNTCaahUOxKkm6XkXMRdyirklND66flK9eGhSeXIzFB/pZCoR0sPAag3dIt+8yaIuDU/UeqLWL0StF8N59Y6RDc/FeUL7yn5Hr+NNyPfJKA/ESQskkKzjVMoJg8fYeEIpe3qVNJHY6W457H1D8ROpnkj1a5HqcJu1HSgUWcJQk1PP0YxJU40cztn/dX/jEW15zALQpZMQJccLL1NSMBxf23LOnv0kAsmAguZtoKuJ0snY/71A+ULzx2HGk3dpU2AJoyqZFjZeNdjmgf0xDt8glWeUxyM1E8oKDp6dvG+WTFtzxukaD4aBM2WX0aruH4vfWJOweNKwfezc21h7a+hkAhXLkEyrNSSWz7m12HqY4SsYzckN33QODd6ktA5edPm824AEhx3d4UBT/JT2ODh+fBeLuDYxtX18DyZhy21I0X+L3SwViy8H0gUFGIYBsO1yY73WHb6WNeMfy9uftDxu6HZo5qw4yg6uTlJzap2Jmuxk4mlXVUm471Hb9bmS3FU+34Edy4Jvs8RqRD7/hq3Hqrr1RicdSGOnWVU9uJbwAj2ksnjMGhsPrXxjhafR7Nko9N1olBzhe7K4T/AR9q3j9laF0ByNRtif71fQQOW+1rKW+2iNxZcDoDIC1xMangrzuPCvflNwccnfuCedrbrX21V73dJ9LrpGsmIyNwSmMavqEHK4qvDhsDgX/arLOPsmNtaly9h7dlucs9vivJtRsoM8x5zKNHu2BSM80v3acJPDcTvUHO9p0RhnCko+GXHvD/uHBDUyZWOBSo/tQTzTKAeiuTSvSqYXQ9ZNEkBYKcj/iS/mtHVxGG8qz/n+QWM8OzntvfqAzY5O9GIAYOfAOTGyXoJoMHPW4h7MmA3BDuuBbsOo0WhIrD/iZdEB7CJlcgkx/p1AhjIykFhkschxdPvo9N0dv44NJU27uH/KuW4XXMsKmx2wd4WON8m1/TE7smzam6OQ22xacVwU1IRvyl4O2HJ6cj6GcN6N25r3jEeZkzd8t4x/j7IIzXixywLx3SLT0kxbZB/fk07++woxv8sn
sidebar_class_name: "post 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={"Query traces."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/telemetry/traces"}
context={"endpoint"}
>
</MethodEndpoint>
Query traces.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"attribute_filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The attribute key to filter on"},"op":{"description":"The comparison operator to apply","type":"string","enum":["eq","ne","gt","lt"],"title":"QueryConditionOp"},"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}],"description":"The value to compare against"}},"additionalProperties":false,"required":["key","op","value"],"title":"QueryCondition","description":"A condition for filtering query results."},"description":"The attribute filters to apply to the traces."},"limit":{"type":"integer","description":"The limit of traces to return."},"offset":{"type":"integer","description":"The offset of the traces to return."},"order_by":{"type":"array","items":{"type":"string"},"description":"The order by of the traces to return."}},"additionalProperties":false,"title":"QueryTracesRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A QueryTracesResponse.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"trace_id":{"type":"string","description":"Unique identifier for the trace"},"root_span_id":{"type":"string","description":"Unique identifier for the root span that started this trace"},"start_time":{"type":"string","format":"date-time","description":"Timestamp when the trace began"},"end_time":{"type":"string","format":"date-time","description":"(Optional) Timestamp when the trace finished, if completed"}},"additionalProperties":false,"required":["trace_id","root_span_id","start_time"],"title":"Trace","description":"A trace representing the complete execution path of a request across multiple operations."},"description":"List of traces matching the query criteria"}},"additionalProperties":false,"required":["data"],"title":"QueryTracesResponse","description":"Response containing a list of traces."}}}},"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>

71
docs/docs/api/register-a-benchmark.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: register-a-benchmark
title: "Register a benchmark."
description: "Register a benchmark."
sidebar_label: "Register a benchmark."
hide_title: true
hide_table_of_contents: true
api: eJztWN9v2zYQ/lcIPW1AYqdBi65+S9oOK9YigeM+DKkRnKizxYYiNZJyYhj+33tHSZacOF627iWA/RDLJO/3991RWSUOfWmNR5+MVsnpyQl/ZeilU2VQ1iSj5OLPZH2UvN61NclROPy7Qh/EHXihzAK0yoR1ogA9s67ALDlKpDUBTWB5KEutJLD88LtnJavEyxwL4KewLJHU2vQ7ykCCpbMluqBq73yAUPneOUVq5+jo4LZbf0wml6I+LaTNkP0PKmjsyfrglJk/Ev3oHDkfDx8JED63LghfFQW4pbAzEShijGfuciVzoeqgnQITBAUswDT70c6a9QdQ+rmW69NsWltDsYm8KsAcO4QMUo2iJ7PlDltShmI28hlR/nIRn0D/Ks7E1/HnJhhJzqcoKo+ZCJYqS9K4QFFYhxQm1zNWTkBqqxCN+xKlmikprJSVc0jmH/hFjkGWqdreZa+gM9AejxLGj3KEk9F1W+G2WpvkTTf1q9P0RPJaLIuZs0X04ezy00CMbTXP9ZLKo7W982L8+3vx9reTtwNOGt5DUdbIaPFFUO/snUMmxjXEO3+eifz1mqN/ffpuN3OkVsQKkZO454dgLQmbZauYtRIQ5mqB9F3Yis5wblWBB1IdSPXCSHX6rrM3IaR/YaQ3zPJ9av1lK+IEZQjvJWLGaWOyQUChVaHCQFxqBHIoEHpgDkQSTZtu0PDtzVOTyqNbUPEpnUwlpPQwsCqD95TvQL+wScOBWgdqvSBqvenPq0+MbPJcXNVo7+w39Dp7DPk2GdlAXFSEBIQiTqUUafAYGyhhtNfQK8MZVDo8ptg+xQdSHUj1skh1ssvaMygUWcJQg7nnaM4pGzkB59ZzANsOj3GuPNGVCp22xwaMeHBQIG2whmmdHZqS5zZbsov/E5M2Jm9U9s9o4QH66UNb1o1sDZE6jJjKDALN5vAfdDaSrLHi8jF9+qaiei8tq7qZVUayln4nAOdgSUZUwMI/tr7eZb7RJzb69punDC5Uhu7mZ5LXKtnO4jOM/oSpvQYIa8DZ34WZ3bRdJdbgxYzguZEwldakbPM7tZauaaa/ZKoiRddf2ZTmQRF7C40n6+nO+rWu7wvw3zSfrbpuoXkX9notqeXyhu/tS2PsBp2J4CqsU55b+pmUNr5YlhBy+jVcvBoivUkO065tkOE4yn3MduW4A+UhlKPhkK7QxzkpwOxYayjgmLqXvB1IW1C+WI56kgrLKPihndvXU97jbjHu+srHrgNuQ7uHsx6zu9UdhLxud6dPEqaT3wJ3t9yD5DpOtZmN6Gyy/ZmjFVccrbhqpk/sgiTKqaoBsni1gx48rP3W2IL+IO1rDjmElkL+mxEPPnQzwPhGjiYrLd1DPA3++LaiHF05XD2JMm4vfElxM5Doa6Xg8JvhaWJdHLOPlaf8nwVNg9fBvPXqC11jtK97AlWd7gScE0OzYs8w2Yq/NzyeFGh4F/A+DEtNr1dsL8Ju1cD0us4sA5W+0q0Jx3DkE6tVSmj56vR6zcsENLesp1m8KKVcxmvmdE63GmoKDNFbpCPJ+9rD4wn7wcd1FRvDw1HHPaKWOJMSy7D37LRHucuLqwn73YzTgi+Ho8TBHS3y31FCD7bcjJe4tko0mHlFxaD9Wid/fgCv3m6r
sidebar_class_name: "post 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={"Register a benchmark."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/eval/benchmarks"}
context={"endpoint"}
>
</MethodEndpoint>
Register a benchmark.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"benchmark_id":{"type":"string","description":"The ID of the benchmark to register."},"dataset_id":{"type":"string","description":"The ID of the dataset to use for the benchmark."},"scoring_functions":{"type":"array","items":{"type":"string"},"description":"The scoring functions to use for the benchmark."},"provider_benchmark_id":{"type":"string","description":"The ID of the provider benchmark to use for the benchmark."},"provider_id":{"type":"string","description":"The ID of the provider to use for the benchmark."},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The metadata to use for the benchmark."}},"additionalProperties":false,"required":["benchmark_id","dataset_id","scoring_functions"],"title":"RegisterBenchmarkRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"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>

71
docs/docs/api/register-a-model.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: register-a-model
title: "Register a model."
description: "Register a model."
sidebar_label: "Register a model."
hide_title: true
hide_table_of_contents: true
api: eJztWEtv2zgQ/iuELm0Bx06DLbrNzX0sNkCCBI5zWKSBQUljiw1FqiRlxzD83ztDSpbkOFkXCBbIwjnEEjXvmW+G5CoyYAutLNjodBWdHB/TTwo2MaJwQqvoNBqyC52C7Ee9KNHKgXJEw4tCioQTzeCHJcJVZJMMck5PblkAsur4ByQOGQujCzBOBDUiRSFiKsC0aK0zQs2Qtqv9RomfJbCGhU21YS4TlqHpujQJflRMSp5zZh1P7qO11zdHFjOpaSYifTFdLgNWK+go20fH2Vempx0R+MId0wtlu6pIdJD1WCaoMo9Ob6OcMoPvNhMgU3yYY7y1maQxKeaOW6Dw20QT42RaqsTb0YtiUEmWc3OPz05rWf1MZkaXRchYXrjozifdYso3ulKY8lJ2V9oejtG3TbjI8B7jcsGXlr3xDG98VP3jhs6Sszk4TjbvKiCepoLkc3nVKSWt4HKKkdhwqFJKFLZ5j9Ep4Kq9hLGLfea249pa4cbwZXuhsmR9t972d6iWrDGP1V40tRPCRA7Sw6TOaRNHKfOdUSRKqpYQq7fn5xcMZQJaj+rULKy/i3pPlkcQvGGgbDrhJNF6TI+Jb71+KrxTLi30sEX8LIWBlCS2oNst/MqIVhY7/m5rfuTvcKsi8KHAZ9KGnnLFhmcbipmwDtAgAuO5B/41Ab+PrpAzf+zqYqEqEd7WsQW3yDrnUqQU0JxLzFUO6ct1OGxErrQtOoFiZz5oXbP+Ho+vWKBmCbrnQR8C9W+d5JsxVGFEjAhjNtPGMVvmCOpl3WPA0ywykWRMBKeN4Mr54sSghu9ej69rx4XcV3OgJtVSK/SNZWXO1ZEBTH8sgbV4OuaQJoEthatkDy/fXhahMN+xIbsZnVfOJGh8DKy0WAVOY2aRG+aAJWKoR1M+feYYj3XpvHJbQIKVmzCdJKUx2P9gy67fAUKV4Tpbm+C1Ct2H6Yng1WOXTbHPehuGV2d9NtLlLJNLTI+UemHZ6K8v7OOfxx/7FDR44HkRKqOuLyz1Rt9nnrJRKPHGnj0rv0LOyafdyEmkQFSwDNkJkhhyjczY+CrBJBULYSbmgL+5LpGGYityOIDqAKpXBqqTT42+MVb6BVV6hSzbhtY/ukRMYITgIQFIKWwENu6ASZEL12dXuPlAgxxWD59x2qjiR1NPqg9PTSoLZo7Jx3ASlPysw9yUCh4w3g7foArDAVoHaL0iaH1oz6szqmzaMl+Ham/0V/AaPi75Ohhpn12WWAnAcz+VYsDBo7TfmqY1vDY77EdH2mcEH0B1ANXrAtXxLm17QMijhEqNzyx54w9mlozvGjuqDlyY5Ly+CSq44XjSA0OcdyEqOB0/63RJpr0QgsIBcp9rFRqarXubKqXhwOhLI7jQ79zXvIz4rRuh/m9fCe0W3pH3v74a6e+6G3n+LqST0v/y/mNTMi1RNT68yPoA5pHVcDpTQshjpvE1KrQ/pBXcZfg2mL8f5AF9vSjs/azPXGkIxJlzxelggLvQowz5ID3y151H/rqzn+gcY098CGvhlp7xaz36bu/oGwFv1ED0W9NEGgw04dsBkB0fu8utCt3Kps+Cb/dT7eu3Clvr5oZdV22ZV7eTFICQ+/n7HXihKWY7/Zy3J0xbsr9crWy23xXb+sORCf6oCiotNA5oixPRb+OFwVlsQov2t200vc2UJ2CDUG7gu6I2q42fP4+Fx3TkljiRDJ/VVoUmG5oE5hKHJcVEYTN9otN2fG911p3EVcQdPLhBIfG8QXp8Ea2qWrsNEc03vZ4qipZXqxhPKjdGrte0jLVilqG3++1CTDm7JYhnONvp5h6r7B6QJPoSTDoahwvAOZel7xPbjZ9aRuAYJgkU7lnauxZYri6vx3RlXQ0Xsh1XDV/gIv0/jfBB+xD5zufXVpHkalZi5PF7kEl/vwA7HreT
sidebar_class_name: "post 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={"Register a model."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/models"}
context={"endpoint"}
>
</MethodEndpoint>
Register a model.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"model_id":{"type":"string","description":"The identifier of the model to register."},"provider_model_id":{"type":"string","description":"The identifier of the model in the provider."},"provider_id":{"type":"string","description":"The identifier of the provider."},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Any additional metadata for this model."},"model_type":{"description":"The type of model to register.","type":"string","enum":["llm","embedding"],"title":"ModelType"}},"additionalProperties":false,"required":["model_id"],"title":"RegisterModelRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A Model.","content":{"application/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string","description":"Unique identifier for this resource in llama stack"},"provider_resource_id":{"type":"string","description":"Unique identifier for this resource in the provider"},"provider_id":{"type":"string","description":"ID of the provider that owns this resource"},"type":{"type":"string","enum":["model","shield","vector_db","dataset","scoring_function","benchmark","tool","tool_group","prompt"],"const":"model","default":"model","description":"The resource type, always 'model' for model resources"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"Any additional metadata for this model"},"model_type":{"default":"llm","description":"The type of model (LLM or embedding model)","type":"string","enum":["llm","embedding"],"title":"ModelType"}},"additionalProperties":false,"required":["identifier","provider_id","type","metadata","model_type"],"title":"Model","description":"A model resource representing an AI model registered in Llama Stack."}}}},"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>

71
docs/docs/api/register-a-new-dataset.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/register-a-scoring-function.api.mdx Normal file
View file

File diff suppressed because one or more lines are too long

71
docs/docs/api/register-a-shield.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: register-a-shield
title: "Register a shield."
description: "Register a shield."
sidebar_label: "Register a shield."
hide_title: true
hide_table_of_contents: true
api: eJztWE1v2zgQ/SuETruAY6fBFt3m5ma72AItEtjuYZEGAUWNLDYUqfLDiWH4v+8MKdmy42RToJcAziGW+Dnz5r0ZkavMgmuMduCy81V2dnpKPwU4YWXjpdHZeTZm00qCKobZIBNGe9CeBvGmUVJwGjT67mjkKnOigprTk182gHNN/h2Ex4mNNQ1YL9M+ssBFZCnB9sY6b6WeZ+s4eIFD7C0aZ4IVcCuL5wc+0Z8a9jsGGehQZ+fXWW0KUPjuooP4sEBrjb0tcnwuuOcOyHgnDE28LYMWEZRBloMWVc3tHT57Y1T7czu3JjTJ37rx2U2EzHnavNujgJIHtdfUB3xWAes8Z2T6gHF1z5eOtRPIc2557Q4hzYtC0kJcXe1gbjRcluj0ZoYOSuFSm/cc7Qeu+00IU44x6rVssN20cGv5st/QWrK+We879ttlkyz7nV0YXcp5sJE/LHoDHqxjpbHMIwCdq+unPCq5cjBA/v4I0kJB4ezRapcbLRMwGl56RUZOD0M/Zo6X4Jft9r0wVNwzwTXLgQUHBfOGIdnFHWslMURTydg/DkkoRfRHAOfZPXdM6gVXsmDoa80VulxD8evU5Tz3oc8NicvOIyi7Zv0zm12xNBrdKCBKJgH0WDO7Uz9aS4GiwchOhMtYz1yoURJLZsoYQohj7ispKiaT01Zy7WOMEcrUH/eJVPFcqpfunEbT1spo9I1Voeb6xAIveK6A9ebsmEM7SRQk1+IFXvYIO2ZfJ59bZ/Z4YAFnwwJYbSygmxTPxGuem+ATnRsQyEzBjBDBWswesGfXzxC9jXAXrQ14PYJHmJ4Ar8v5rMQsFW0YX30asokJ80otMTxKmXvHJn9fsHd/nr4bEmjwwOsmMaPjF1J9u98HXrBJovjWnhcyv1XO2fvDyhFKoipYhdMdPWCixcl62S1MqyIR5nIB+FubgGMIW1nDUVRHUb0yUZ293+43Q6Z/Iaa3ynJ9af1rAmoCEYIHAVAQbCQ27oEpWUs/ZFdYz9Egj+zhc44iUdhpu0r19qlK5cAuMPgIJ0kJEB4iVtDwgHh7fIMWhqO0jtJ6RdJ6269Xn4jZaDmbJrZv92/lNX5M+Q6MYsguAzIBeB2rUg5YeLSJn55FJ6/NZ/6j89QzCx9FdRTV6xLV6aHdXiChqBKiGp878iYdyBxZv2vtBObSoVYjwbp7iO2BEefeJFywPn4wxZKM+1UaivsdvFw4dGbfHj+7qLanyEiP5MVw59riV22ApZ3eunWH/3s38rLVd9d7jTcO5FfvcmEHteFPym0Tq57AOnIm9nbnn0js7VxvA2AD2lAZfM0aE89IDfcVvo0Wb0auJf8gS99eLqIWLImo8r45H43wK/CkwolQnCjFa36CAhR3Q2Fq9JvmoaykX8aJf3Wl5/qG+oj2k61APvZEvOXflhmH2Hmgd6+5Y8c65tbSRKK0KH0mg9mUDGbTNgfy9iKNvE2xWrw5QEsqGW4nefJ+Ou+vHK9oWvPcN832/jB9QDwXgi4ag9XQYfmJ38zSYuGzKR8W6A6jUmlLLsClRbmFb5pymrEx2T9ePKfzrcL0b/m8s+oLXS66pB0MHFYmwkQjF5/KajvO97LY4dEt+T08+FGj8POedoqcWbXcuk6Yum1qJQZR+2qV48ngq1XrNTUjN+wyZdJYnnMK2zXJqcJaSre0yKo7wCHZRTLqZEa703AVoib30yzJM80YCwGNf3bsTU8dV5fTGV2wtqmcrmix1fJ7bKT/5xk+mAhSzDKxbZUprucBwcf+tCb9/Qcti/93
sidebar_class_name: "post 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={"Register a shield."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/shields"}
context={"endpoint"}
>
</MethodEndpoint>
Register a shield.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"shield_id":{"type":"string","description":"The identifier of the shield to register."},"provider_shield_id":{"type":"string","description":"The identifier of the shield in the provider."},"provider_id":{"type":"string","description":"The identifier of the provider."},"params":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"The parameters of the shield."}},"additionalProperties":false,"required":["shield_id"],"title":"RegisterShieldRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A Shield.","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":"shield","default":"shield","description":"The resource type, always shield"},"params":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"(Optional) Configuration parameters for the shield"}},"additionalProperties":false,"required":["identifier","provider_id","type"],"title":"Shield","description":"A safety shield resource that can be used to check content."}}}},"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>

71
docs/docs/api/register-a-tool-group.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: register-a-tool-group
title: "Register a tool group."
description: "Register a tool group."
sidebar_label: "Register a tool group."
hide_title: true
hide_table_of_contents: true
api: eJztV0tv20YQ/isLnlrAlhwjQRrdnEdbowlsyMqhcIxgRI7ETZa77D5kC4L+e2Z2SZGyZNcpejEgHWxyd+f9fTPLVWbR1UY7dNlolZ2enPC/Al1uZe2l0dkou/grWx9lL/dtTUoUFv8J6Ly4BSekXoCShTBWVKBmxlZYZEdZbrRH7Vke6lrJHFh++M2xklXm8hIr4Ce/rJHUmuk3zD0J1tbUaL1M3jkPPrjeOUlq52jp4LZbf04mlyKdFrkpkP330ivsyTpvpZ7viH6wlpyPh48ECFca64ULVQV2KcxMeIoY45nbUualkCloK0F7QQEL0M1+tLNm/R6keqrldJpNK6MpNlGGCvSxRShgqlD0ZLbcYUtSU8w6f0KUv1zEJ1C/ijPxefyxCSYn56cogsNCeEOVJWlcoKiMRQqT6xkrJ2Bqgo/GXY25nMlcmDwP1iKZv+cXOQZFIZO9y15BZ6AcHmWMH2kJJ6PrtsJttTbJu9nUL6XpgeS1WBYza6row9nl+UCMTZiXaknlUcrcOjH+/Z14/dvJ6wEnDe+gqhMyWnwR1Dt7b6EQ4wTxzp8nIn+95uhfnr7Zz5xcSWKFKEnc8YM3hoT1slXMWgkIc7lA+l+ZQGc4t7LCA6kOpHpmpDp909mbENI/MdIbZrk+tf42gThBGcK7HLHgtDHZwKNQspJ+IC4VAjnkCT0wByKJok07aPj26qFJ5dAuqPiUTqYSUnoYWEHjHeXb0xs2aThQ60CtZ0StV/15dc7IJs/FVUJ7Z7+h19ku5NtkFANxEQgJCFWcSlOkwaONp4TRXkOvAmcQlN+l2GOKD6Q6kOp5kepkn7UnUCiyhKEGc8fR0KhTf1gTascBbDs8xrl0RFcqNN39lJjzuQFDHixUSDus4ialh8bkW1Ms2cf/iUpsM5r8Kot/hwtP0PP3bV07fxNIUiAxmWRkIQu0/0FrK8o6A5eQKbRlLVqo8vor6qI2MiXh8TCDlU/zgzmQtkVUzQ/kSLx9oDPBEqt+CslsuYda0r9jNzHP4gwTbcge3jUdvClzDBns3O0Ldb8vq8xovJiRDxsJHZQiRZv3KaUUQfeXdKimaPsrTbJ6K2AtLPsLjSfrm/VuaIXMo2+pa1IIoaJ4HAdZg3Ntcreq+zP53QLwNvB6aW9ZtmFi+zkXedrp8zYggwt9aeg1q0385KvBl/Q2XLwYbuxxd0q3SRdzHCy3hdL7ejQc0r32uCRZLI6VggqOqaXk3we5qShLLEeNQvplFHzfDtPrG95jBo87rn/o2tI2VzsUb5GtW77PkMiBrpwtnNZxYMxMtNCk6yP7LK7YZ3HVNPbYX0gtB5yKu3ixh0I8B93WRID+jOpr9iX4lu7uixb3fjR0MX7stkE4mqnxQ0Ba4oVNTb5ghvL8tzPI0SWlYPGL5kZtbJxgu8qn/NGuaKZZmLdefaIbgnKpf1HtaNxyTjR14cf69FYCen35YYmGNZ5IPqwVfbuwxQifVYO065TbHtYIGIwn3lqtpvTl89mq9ZqXCSl2mUZEvH5MuYLXTMWS7grEZcbYd6Qj2bvk2/GEHeDjKkQ+358fTO0kcZbnWPtHz9706HJ5cTWhw9NmRlV85RplFm5pkf+OMnowMVexQ8W1VaZAzwPVgfaTTv79AKoiMwM=
sidebar_class_name: "post 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={"Register a tool group."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/toolgroups"}
context={"endpoint"}
>
</MethodEndpoint>
Register a tool group.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"toolgroup_id":{"type":"string","description":"The ID of the tool group to register."},"provider_id":{"type":"string","description":"The ID of the provider to use for the tool group."},"mcp_endpoint":{"type":"object","properties":{"uri":{"type":"string","description":"The URL string pointing to the resource"}},"additionalProperties":false,"required":["uri"],"title":"URL","description":"A URL reference to external content."},"args":{"type":"object","additionalProperties":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array"},{"type":"object"}]},"description":"A dictionary of arguments to pass to the tool group."}},"additionalProperties":false,"required":["toolgroup_id","provider_id"],"title":"RegisterToolGroupRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"OK"},"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>

71
docs/docs/api/register-a-vector-database.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: register-a-vector-database
title: "Register a vector database."
description: "Register a vector database."
sidebar_label: "Register a vector database."
hide_title: true
hide_table_of_contents: true
api: eJztWFtv2zYU/iuEXroBvqTBiq55S5oOK9AuQeIWGNLAoMRjiw1FqiTlxDDy33cOKVnyLXGL7qGA8xBLJM/9+3hELhILrjTagUtOFsnx0RH9CHCZlaWXRicnySn7DJk39vxskPSSzGgP2tMyXpZKZpyWDb86WrtIXJZDwenJz0tAaZN+RWkULK0pwXoZLUmBSuREgu2sdd5KPU0ew+IZLrFjdM9UNoOxFE8v3DEfB9YnegnoqkhObpLCCFD47nIJSuDDLMQ6Fik+C+65A3LeZYYEx5NKZyEtvSQFneUFt3f47I1R9c94ak1VxniL0ie3IWUOE7aqGia8Upuj3cSP0GdmJqzJQY9xdc/njr1YyrxgE2NZfGXkbsqplBg4FCkIQT7HELfkYNXaP7wI1nwObCnMgjDzhlUOuramoMGG0q8aE7IA7WQEQ21QImKmWOh1i+fN2k2z0UoIZBnrWKOHW4qMazhKkVKuLjsom3DloIcI/1ZJC4LK3YHdKnZqpGzmbXtwWFUvvSI3GnJshPd5tSrLMoY0Oh8AxbgW7FsFdt5G3abBDTA6iu+Pbbwc5aQThZ1n99wxqWdcScFQQ8EVGilA/DzCOs995fao6t+j0SWLq1mGKQwsjLl6DoLvrEXnw2LEOnO5sZ65qkCWzZcYCWvuc5nlTMagreTah6xyXc8HO4+k33O5B/ij5biaTCujMTaWVwXXfQtc8FQB68isuEOWJHKc62yPKH+7KCNWf2en7NPVhzqYDJ1PgXgmiG8WUBpmgAy0gGFSPUPlGE9N5YNxV0KGYM6YybLKWtyQYM2v7+FGXeGmWsvkdbAe0rQjeU0jYRPc+IIPp5fvB+zKVNNczbE8Spl7x67+este/3n0ehD2jQdelBEZDb4Q6q29My7YVYR468+eyK+Zc/xmO3MyJZEVLEdxRw+4d6OwnjeKSSsCYSpngL+FqXAN5Ra3gAOpDqT6xUh1/Ka1N0KkfySk18xyXWr9ayrkBGYIHjIAQWkjsnEPTMlC+gG7VEDdzCN6+JQjSRRO2qZTvdrVqRzYGRYf00lUAkwPAavS8ID59vgGdRoO1DpQ6xei1qtuv3pPyEbP2XVEe2u/ptfpJuSbZIgBu6gQCcCL0JVSwMajTfhaFQ29lseGjUPaE4oPpDqQ6tci1dE2a3tQKLCEoManjqJpzmaO/F/19wqm0iFbsc5rx2e65Si5xcMmTpOa25gibJVnRszJz59Ep/Zou+32YuM6ALPZnl+bGq85H1ETQxv80D3AaOf5f/DjR31SKnYf94OVwbP3OftlpFEx2Of2YJtK3bkJ2cBG18f/o374QbUWxPfQd8WjzeJ3WNzgv6ZI2hyzAn9ald5WgAPIhdzga1KacBQruc/xbTh7OYwm+yKlXSN+5RFpFkllia659+XJcIjfm/0cZUH0leIF7yPVs7tBZork8ZbkkMDSz4PgedPkbm5pjlh11fLvXbtdrOa/c7m3jvltUx34Hq3hrl2+Dp92ZgcIOlePtF0HVNQZ/0Bxs2uKm13XmzavLxMpaREls5dbgEM9zq3s9rzbf7qafc59gx73RbO1P2yoEA6yoEVpkK4uXEGhFmmxU9u4gQdSEpfthGfgolJu4YumTdjY0J02lad0IFfYryyfNl59pAq4yBusP7ZSykmdzac34ZUsdDbdZ8RqFnp48MNS4QmFbAcwLmrc3sQsd5CLMCN00tRiQYo+WfX4SMPhci42gfCRkVItEZgogF8EdH2NiL0DXJK8jQ72R/EmccZVRY5sdIjHXiNxmmVQ+ifX3nbId3lxPaKb57oLEbhx1PJ7HKT/Jwk+mJCw0F/C2CJRXE8rrAjOR5309x//dWs4
sidebar_class_name: "post 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={"Register a vector database."}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/v1/vector-dbs"}
context={"endpoint"}
>
</MethodEndpoint>
Register a vector database.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"vector_db_id":{"type":"string","description":"The identifier of the vector database to register."},"embedding_model":{"type":"string","description":"The embedding model to use."},"embedding_dimension":{"type":"integer","description":"The dimension of the embedding model."},"provider_id":{"type":"string","description":"The identifier of the provider."},"vector_db_name":{"type":"string","description":"The name of the vector database."},"provider_vector_db_id":{"type":"string","description":"The identifier of the vector database in the provider."}},"additionalProperties":false,"required":["vector_db_id","embedding_model"],"title":"RegisterVectorDbRequest"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"A VectorDB.","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":"vector_db","default":"vector_db","description":"Type of resource, always 'vector_db' for vector databases"},"embedding_model":{"type":"string","description":"Name of the embedding model to use for vector generation"},"embedding_dimension":{"type":"integer","description":"Dimension of the embedding vectors"},"vector_db_name":{"type":"string"}},"additionalProperties":false,"required":["identifier","provider_id","type","embedding_model","embedding_dimension"],"title":"VectorDB","description":"Vector database resource for storing and querying vector embeddings."}}}},"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>

Some files were not shown because too many files have changed in this diff Show more