> For the complete documentation index, see [llms.txt](https://autoedit.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://autoedit.gitbook.io/documentation/transcriptions/transcriptions-intro/transcriber/stt-api/gentle-stt.md).

# Gentle STT

## Component/part description

{% embed url="<https://trello.com/c/k9uJPfRQ>" %}

{% embed url="<https://trello.com/c/4BBwUS4c>" %}

## Related projects

## Implementations Options considered

Considered abstracting Gentle into it's own component that can more easily be packaged inside other apps.

## Current implementation

uses Gentle node SDK and requires Gentle OS X desktop app to run locally along side.

## What needs refactoring

Gentle needs to run as a desktop app  that can be connected to as REST API. This is a pretty big overhead when trying to packaging it inside another application.&#x20;

Biggest issue is that the port of the Gentle local server might change, and the [Gentle node SDK](https://github.com/OpenNewsLabs/gentle_stt_node) might not connect to it.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://autoedit.gitbook.io/documentation/transcriptions/transcriptions-intro/transcriber/stt-api/gentle-stt.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.