From 23465b9b4d906f0237fb72b54317846d24995b7e Mon Sep 17 00:00:00 2001 From: Curtis Man Date: Thu, 6 Feb 2025 20:31:18 -0800 Subject: [PATCH] Fix broken links in markdowns. (#683) --- python/README.md | 2 +- python/stt/whisperService/README.md | 2 +- python/tts/speechT5/README.md | 4 ++-- ts/README.md | 2 +- ts/packages/agents/email/README.md | 2 +- ts/packages/agents/greeting/README.md | 4 ++-- ts/packages/shell/README.md | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/python/README.md b/python/README.md index 1fcb53068..cf7b4352e 100644 --- a/python/README.md +++ b/python/README.md @@ -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. diff --git a/python/stt/whisperService/README.md b/python/stt/whisperService/README.md index 5a06d6fea..c3bc6883c 100644 --- a/python/stt/whisperService/README.md +++ b/python/stt/whisperService/README.md @@ -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` diff --git a/python/tts/speechT5/README.md b/python/tts/speechT5/README.md index 29635953c..b744dd2e0 100644 --- a/python/tts/speechT5/README.md +++ b/python/tts/speechT5/README.md @@ -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 @@ -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. diff --git a/ts/README.md b/ts/README.md index 7f83d5485..f01fef2b6 100644 --- a/ts/README.md +++ b/ts/README.md @@ -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 diff --git a/ts/packages/agents/email/README.md b/ts/packages/agents/email/README.md index d63374d8e..095eb9c78 100644 --- a/ts/packages/agents/email/README.md +++ b/ts/packages/agents/email/README.md @@ -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. diff --git a/ts/packages/agents/greeting/README.md b/ts/packages/agents/greeting/README.md index 10ed1292f..a6eaedde6 100644 --- a/ts/packages/agents/greeting/README.md +++ b/ts/packages/agents/greeting/README.md @@ -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** diff --git a/ts/packages/shell/README.md b/ts/packages/shell/README.md index 5eba90f0f..125205d3d 100644 --- a/ts/packages/shell/README.md +++ b/ts/packages/shell/README.md @@ -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.