Documentation: examples of validators and config for create validator config endpoint
维护者通常 3 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 45/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
- 领域
- api, documentation
调研方向
首先检查运行防护措施和创建验证器配置的 API 端点，然后将它们的配置要求与仓库 README 进行比较。完成的标准是 API 文档包含示例请求体以及所有验证器各自的配置。
由索引模型根据 Issue 内容生成。
描述
Describe the current behaviour
Currently when we use the run guardrails endpoint or create validator config we don't have any documentation with api endpoints that we can refer to which tells us what configuration we have to set for each validator. users will have to read through repo's readme to get to know about validator specific configuration.
Describe the enhancement you'd like
Add documentation in the api itself about sample request body when saving or sending config of all the validators, with their respective config.
- 主要语言
- Python
- 星标
- 5
- 派生
- 4
- 平均合并
- 6 天 1 小时
- 30 天内合并 PR
- 10
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
ProjectTech4DevAI/kaapi-guardrails 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
ProjectTech4DevAI/kaapi-guardrails#94 ·
维护者通常 3 天内回复
-
难度 1/5 1 小时以内 新手友好度 65/100
ProjectTech4DevAI/kaapi-guardrails#23 ·
维护者通常 3 天内回复
-
PII Remover: Fix validator on_fail error可能已有人在做 @AkhileshNegi 于 5 天前认领。 未关闭bug
ProjectTech4DevAI/kaapi-guardrails#167 · 已指派 1 人 ·
维护者通常 3 天内回复
-
Callback Enhancement: Include intermediate responses可能重新可做 @Prajna1999 于 41 天前认领，目前没有进行中的 PR。 未关闭
ProjectTech4DevAI/kaapi-guardrails#158 · 已指派 1 人 ·
维护者通常 3 天内回复
-
难度 3/5 1-2 天 新手友好度 55/100
ProjectTech4DevAI/kaapi-guardrails#137 ·
维护者通常 3 天内回复
查看 ProjectTech4DevAI/kaapi-guardrails 的全部 Issue
相似的 Issue
-
Use mhctools predictor_required=False for saved-result rescoring可能已有人在做 @iskandr 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 79/100
-
难度 1/5 1 小时以内 新手友好度 85/100
521xueweihan/HelloGitHub#4051 · 1 条评论 ·
-
bug documentation
难度 2/5 1-3 小时 新手友好度 78/100
awslabs/visual-asset-management-system#514 ·
维护者通常 1 天内回复
-
backend bug spec:REQ-053
难度 2/5 1-3 小时 新手友好度 66/100
nolte/kamerplanter#2547 ·
维护者通常 1 天内回复