Add docs for testbench-ai-service v1.0.0#7
Closed
LinddritAliu wants to merge 3 commits into
Closed
Conversation
Contributor
Comment on lines
+44
to
+48
| │ ├──────────┬─────────┬─────────┤ │ | ||
| │ │Test Case │Test Case│ Defect │ │ | ||
| │ │ Set │ Set │Expla- │ │ | ||
| │ │ Reviews │ Descr. │nations │ │ | ||
| │ └──────────┴────┬────┴─────────┘ │ |
There was a problem hiding this comment.
The spaces/ alignment of the text looks uneven in this section. In the first column there is a space after "Test Case" in the fist line, but in the second there is not.
Also the "Defect Explanations" cell is aligned to the left and not centered, with an extra space before the first line.
| | [**Test Case Set Descriptions**](use-cases/test-case-set-descriptions.md) | `/test-case-set-descriptions` | Automatic generation of descriptive summaries for test case sets. | | ||
| | [**Defect Explanations**](use-cases/defect-explanations.md) | `/defect-explanations` | AI-generated explanations for defects found during test execution. | | ||
|
|
||
| ## Where to Go Next |
There was a problem hiding this comment.
Suggested change
| ## Where to Go Next | |
| ## Where to go next |
|
|
||
| The service is built on [FastAPI](https://fastapi.tiangolo.com/) and [Uvicorn](https://www.uvicorn.org/), providing high-performance async request handling. | ||
|
|
||
| ## Built-in Use Cases |
There was a problem hiding this comment.
Suggested change
| ## Built-in Use Cases | |
| ## Built-in use cases |
|
|
||
| [**TestBench AI Service**](https://github.com/imbus/testbench-ai-service) is a proxy server for [imbus TestBench](https://www.testbench.com) that integrates external AI / LLM providers to support multiple AI-driven use cases during test design and test execution. | ||
|
|
||
| ## What It Does |
There was a problem hiding this comment.
Suggested change
| ## What It Does | |
| ## What it does |
| - Loads configurable prompt templates (YAML) and renders them with project data. | ||
| - Sends the rendered prompts to the configured LLM provider and writes the results back to TestBench. | ||
|
|
||
| ## Key Features |
There was a problem hiding this comment.
Suggested change
| ## Key Features | |
| ## Features |
|
|
||
| --- | ||
|
|
||
| ## Inspecting Prompts via API |
There was a problem hiding this comment.
Suggested change
| ## Inspecting Prompts via API | |
| ## Inspecting prompts via API |
| | `glossary` | Glossary content resolved from the `glossary` prompt config field (file path or inline text); falls back to a built-in default glossary | | ||
|
|
||
| ### Optional: Glossary | ||
|
|
There was a problem hiding this comment.
I think this subchapter needs a bit more information about what a glossary is and what it is used for. Maybe an example too, if you have one.
| --- | ||
|
|
||
| # Test Case Set Reviews | ||
|
|
There was a problem hiding this comment.
The three use case chapters are missing a "How to use" sort of section, maybe with an example.
| ```bash | ||
| testbench-ai-service start | ||
| ``` | ||
|
|
| ``` | ||
|
|
||
| 2. Open [http://127.0.0.1:8010/docs](http://127.0.0.1:8010/docs) in a browser — the Swagger UI should load. | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.