mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-04 04:04:14 +00:00
68 lines
7 KiB
Text
68 lines
7 KiB
Text
---
|
|
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>
|