Skip to content

Latest commit

 

History

History
135 lines (95 loc) · 5.72 KB

server_configuration.md

File metadata and controls

135 lines (95 loc) · 5.72 KB
Raw

Owl - Always-on Wearable AI

<< Home

Server Configuration

The minimal steps necessary to configure the server are listed here.

1. Create config.yaml in Project Root Directory

Copy sample_config.yaml to the root of the source tree, from where the server is run, and rename it to config.yaml. When running the server, this customized configuration file can be specified by adding the --config=config.yaml command line option.

Next, open config.yaml and configure it appropriately.

2. Configure User

  • Set your name so the AI knows who you are and choose a secret token (a string of any length) to prevent others from accessing conversations on your server. The token will also be entered into display client applications that access the server.
user:
  name: "Kramer"
  client_token: 123XYZ_this_is_my_secret_token

3. Configure LLM

  • LiteLLM is used as an interface to LLMs for summarization, etc. The llm section allows local (e.g., Ollama) or remote (e.g., OpenAI) LLMs to be specified.
  • OpenAI's GPT-4 is the easiest to get up and running. Sign up for a developer account, deposit some funds for usage (we recommend beginning with ~$10), and obtain an API key. Paste that into config.yaml.
llm:
  model: gpt-4-1106-preview
  api_base_url:
  api_key: sk-a1BCDEfGhI2JKlMNOPqRS3TuvwXY4ZaBCdEFghIJK5lmnO67

4. Select Providers for Speech-to-Text Transcription

  • Asynchronous transcription is used once a conversation has been detected and completed to transcribe the entire conversation.
  • Streaming transcription is used for real-time transcription of speech to support assistant-in-the-loop use cases. It is only used with streaming captures but not chunked uploads.
  • Deepgram is recommended for getting up and running quickly but Whisper may also be used locally if your server is capable of handling it.
streaming_transcription:
  provider: "deepgram"

async_transcription:
  provider: "deepgram"

5. Obtain a Deepgram API Key

  • Deepgram is an online transcription service that features speaker diarization and other features. It is easy to set up, inexpensive, and new accounts are provided an ample amount of credits that should last for a long time. Sign up for an account, obtain an API key, and paste it into config.yaml.
deepgram:
  api_key: "a1b2cd34ef56g7hi9012j34klmn56789012o34p5"
  model: "nova-2"
  language: "en-US"
  • The nova-2 model is recommended. Be aware that it has a limited number of supported languages.
  • Users requiring absolute control and privacy may elect to switch away from Deepgram but it is nevertheless the easiest way to get up and running initially.

6. Obtain a Hugging Face API Token for Whisper and Speaker Identification Models

  • Register a Hugging Face account and obtain a token (these are found under "Access Tokens" in "Settings").
  • Owl uses PyAnnote for diarization. Please visit the following Hugging Face model pages and accept the terms for each:
  • The Hugging Face token is needed for asynchronous Whisper transcription (if enabled) and the SpeechBrain speaker verification model. For example:
async_whisper:
  host: "127.0.0.1"
  port: 8010
  hf_token: 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
  device: cpu
  compute_type: int8
  batch_size: 16
  model: tiny
  verification_threshold: 0.1
  verification_model_source: speechbrain/spkrec-ecapa-voxceleb
  verification_model_savedir: pretrained_models/spkrec-ecapa-voxceleb

7. Run the Server

8. Environment Variables

Configuration file keys can be overridden with environment variables. The format is OWL_SECTION_KEY_NAME. For example, the Hugging Face token under the async_whisper section can be set in e.g. bash with:

export OWL_ASYNC_WHISPER_HF_TOKEN=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

On Windows, the equivalent command uses set and is:

set OWL_ASYNC_WHISPER_HF_TOKEN=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

However, this will create a variable that only persists in the current shell. To permanently add environment variables, press the ⊞ (Windows) key to bring up the start menu then type environment. Click the shortcut to the environment variable dialog.

System Properties shortcut in Start menu
Type "environment" in the Start menu to reveal a shortcut to the System Properties dialog.

This will bring up System Properties. Click the "Environment Variables..." button on the bottom.

System Properties dialog
The System Properties dialog. Environment variables are accessed at the bottom.

To add variables under your personal account, press the top-most "New..." button. To add them for all accounts, press the buttom one (under "System variables"). Enter each variable this way and then make sure to click OK. From now on, any new Command Prompt window will have these variables set.

Environment Variables dialog
Environment Variables dialog, allowing account-local or system-wide variables to be set.

Entering new environment variable
Entering an environment variable.

<< Home