Skip to content

Commit

Permalink
Fix broken links in markdowns. (#683)
Browse files Browse the repository at this point in the history
  • Loading branch information
curtisman authored Feb 7, 2025
1 parent 9d84fb3 commit 23465b9
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

This directory contain python code that support our **TypeAgent** implementation.

- [Local Whisper Service](./whisperService/) - an optional locally hosted whisper service for voice input.
- [Local Whisper Service](./stt/whisperService/) - an optional locally hosted whisper service for voice input.
2 changes: 1 addition & 1 deletion python/stt/whisperService/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Test if the installation worked by starting the backend `python faster-whisper.p

You can connect to the whisper service using the example "whisperClient" project in the `ts/examples` folder. To use it:

- Go to the repo's [ts/examples/whisperClient](../../ts/examples/whisperClient/) folder
- Go to the repo's [ts/examples/whisperClient](../../../ts/examples/whisperClient/) folder
- Build the project using `pnpm run build`
- Start the web UI using `pnpm run start`

Expand Down
4 changes: 2 additions & 2 deletions python/tts/speechT5/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Local TTS using SpeechT5 for TypeAgent shell

This directory contains an example of local Text to speech (TTS) server that works with the [TypeAgent shell](../../ts/packages/shell/). TTS is implemented using [SpeechT5](https://github.com/microsoft/SpeechT5) framework and the
This directory contains an example of local Text to speech (TTS) server that works with the [TypeAgent shell](../../../ts/packages/shell/). TTS is implemented using [SpeechT5](https://github.com/microsoft/SpeechT5) framework and the

## Setup

Expand All @@ -22,4 +22,4 @@ Option 2: Manual steps
### Usage

- Start the service `python speechT5.py`
- In [TypeAgent shell](../../ts/packages/shell/), change the TTS provider to local and choose a voice.
- In [TypeAgent shell](../../../ts/packages/shell), change the TTS provider to local and choose a voice.
2 changes: 1 addition & 1 deletion ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ To use the [Desktop Agent](./packages/agents/desktop/] for windows, follow the i

### Local Whisper Service (Optional)

If you want to use a local whisper service for voice input in the [TypeAgent Shell](./packages/shell), please follow instruction in the [README.md](../python/whisperService/README.md) in the python's [whisperService](../python/whisperService/) directory.
If you want to use a local whisper service for voice input in the [TypeAgent Shell](./packages/shell), please follow instruction in the [README.md](../python/stt/whisperService/README.md) in the python's [whisperService](../python/stt/whisperService/) directory.

## Running Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion ts/packages/agents/email/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Email agent is **sample code** that explores how to build a typed email agent with **TypeChat**. This package contains the schema defintion and implementation for building a Email Agent that interacts the Outlook mail client using Microsoft Graph API. This [article](https://learn.microsoft.com/en-us/graph/tutorials/typescript-app-only?tabs=aad) explores how to work with typescript and Microsoft Graph APIs. Please visit the [link](https://learn.microsoft.com/en-us/graph/api/resources/mail-api-overview?view=graph-rest-1.0) to learn about more about email specific Microsoft Graph APIs.

This agent depends on the utility library [graph-utils](../graphUtils/src/mailClient.ts) to implement different email actions.
This agent depends on the utility library [graph-utils](../agentUtils/graphUtils/src/mailClient.ts) to implement different email actions.

The email agent uses the Microsoft Graph API to interact with the user's email. The agent uses `@microsoft/microsoft-graph-client` library to interact with the Microsoft Graph API. The agent enables operations to compose, reply, and get email messages.

Expand Down
4 changes: 2 additions & 2 deletions ts/packages/agents/greeting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Greeting Agent is **sample code** that explores how to build a typed Greeting ag
The sample demonstrates:

- How to use schema to get a **structured** [Greeting Response](./src/greetingActionSchema.ts) from the LLM.
- How the Chat Response schema allows the LLM to generate several resposnes and select one at random from the generated options.
- How the [Greeting Action Handler](./src/greetingActionHandler.ts) may use a web search engine to augment the generated responses with personalized infomraiton.
- How the Chat Response schema allows the LLM to generate several responses and select one at random from the generated options.
- How the [Greeting Command Handler](./src/greetingCommandHandler.ts) may use a web search engine to augment the generated responses with personalized information.

The sample includes an example implementation of lookups with Bing. To experiment with lookups, please add your Bing API key to the root **.env** file with the following key:
**BING_API_KEY**
Expand Down
2 changes: 1 addition & 1 deletion ts/packages/shell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ del %LOCALAPPDATA%\.IdentityService\typeagent-tokencache

### Azure Speech to Text service (Optional)

Currently, TypeAgent Shell optionally supports voice input via Azure Speech Services or [Local Whisper Service](../../../python/whisperService/) beside keyboard input.
Currently, TypeAgent Shell optionally supports voice input via Azure Speech Services or [Local Whisper Service](../../../python/stt/whisperService/) beside keyboard input.

To set up Azure [Speech to Text service](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/index-speech-to-text), the following variables in the `.env` are needed.

Expand Down

0 comments on commit 23465b9

Please sign in to comment.