🔗 Quick Links

• 📍 Overview
• 📂 Repository Structure
• 🧩 Modules
• 🚀 Getting Started
  • ⚙️ Installation
  • 🤖 Running sentira-common
• 🛠 Project Roadmap
• 🤝 Contributing
• 📄 License
• 👏 Acknowledgments

📍 Overview

sentira-common is a codebase that provides a common library for interacting with the Sentira AI platform. It includes functionality for transcribing audio files using the Sentira API. The core purpose of this project is to simplify the process of transcribing audio by providing a straightforward interface to the Sentira AI platform. The value proposition of sentira-common lies in its ability to handle the complexities of audio transcription, allowing developers to easily integrate the Sentira AI platform into their applications.

📦 Features

| | Feature | Description | |----|-------------------|---------------------------------------------------------------| | 🎵️ | Transcription | Transcribe audio files with ⚡️ fast speeds. | | 📄 | Summarization | Summarize any content while retaining key facts. |

📂 Repository Structure

└── sentira-common/
    ├── .github
    │   └── workflows
    │       └── release.yml
    ├── .releaserc
    ├── example.ts
    ├── index.ts
    ├── lib
    │   ├── types.js
    │   └── types.ts
    ├── package-lock.json
    ├── package.json
    ├── sentira_client.ts
    └── tsconfig.json

🧩 Modules

| File | Summary | | --- | --- | | sentira_client.ts | The sentira_client.ts code is a part of the sentira-common repository. It contains a shared API client for Sentira services. The code provides methods for summarizing text, transcribing audio, and creating API keys. It interacts with the SentiraAI API using the provided base URL and API key. The code handles requests, responses, error handling, and logging. | | | example.ts | The example.ts code snippet in the sentira-common repository demonstrates the usage of the SentiraAIClient class. It showcases three critical features: audio transcription, text summarization, and API key creation. Each feature is demonstrated with example inputs and desired outputs. | | index.ts | The code snippet in the index.ts file is responsible for exporting the sentira_client module and the types module from the sentira-common repository. It plays a critical role in providing access to these modules to other parts of the codebase. | | types.ts | The code snippet in lib/types.ts defines the interfaces used in the parent repository's architecture. These interfaces represent the request and response bodies for Transcription and Summary APIs, facilitating speech-to-text and text summarization functionalities. | | release.yml | The code snippet in .github/workflows/release.yml is responsible for automating the release process in the sentira-common repository. It sets up a workflow that runs whenever a new release is created. The workflow executes a series of steps, including building and testing the code, generating release notes, and publishing the release artifacts. |

🚀 Getting Started

Requirements

Ensure you have the following dependencies installed on your system:

• TypeScript

⚙️ Installation

1. Clone the sentira-common repository:

git clone https://github.com/Aunali321/sentira-common

2. Change to the project directory:

cd sentira-common

3. Install the dependencies:

npm install

🤖 Running sentira-common

Use the following command to run sentira-common:

npm run build && node dist/index.js

🧪 Tests

To execute tests, run:

npm test

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.
• Report Issues: Submit bugs found or log feature requests for Sentira-common.

1. Fork the Repository: Start by forking the project repository to your GitHub account.
2. Clone Locally: Clone the forked repository to your local machine using a Git client.

   git clone https://github.com/Aunali321/sentira-common

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to GitHub: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.