feat: enterprise api #42
Conversation
…ntification feature to provide users with guidance on usage and configuration 📝 (api-parameters): update API parameters documentation to include speaker reidentification settings for better clarity ♻️ (mint.json): refactor mint.json to include the new speaker reidentification page in the documentation structure
…ntification to maintain accuracy and clarity in API documentation
…or speaker reidentification The example code and output for speaker reidentification have been updated to reflect the changes in the API. The "filters" field in the "speaker_reidentification_config" object has been removed, as it is no longer necessary. Additionally, the "audio_url" field has been updated to use a different audio file for testing. The example output now includes two scenarios: one for a known speaker and one for an unknown speaker who has been newly enrolled. The output includes information such as the speaker's score, creation and update timestamps, last accessed timestamp, whether the speaker is new or not, and the speaker's UUID. These changes improve the clarity and accuracy of the example code and output for speaker reidentification.
This commit adds the Gladia Enterprise Portal API documentation. The documentation provides comprehensive functionality for managing subaccounts, API keys, usage monitoring, and data retention settings. It covers all available endpoints and their usage. The documentation includes the following sections: - Introduction: Provides an overview of the API and its functionality. - Base URL: Specifies the base URL that should be used for all API paths. - Authentication: Explains how authentication details should be provided. - API Endpoints: Describes all available API endpoints and their usage. - Error Handling: Explains how errors are handled and provides an example of the error response format. - Best Practices: Provides recommendations for using the API effectively. - Support: Provides contact information for additional support or questions about the API. This documentation will serve as a reference for developers using the Gladia Enterprise Portal API.
WalkthroughThe pull request introduces documentation for two new features: Speaker Reidentification in the Audio Intelligence section and the Gladia Enterprise Portal API. The Speaker Reidentification page explains an alpha feature for tracking speakers across audio files, while the Enterprise API documentation covers subaccount management, usage monitoring, API key management, and data retention. The Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (4)
chapters/enterprise/enterprise-api.mdx (1)
152-166: Enhance error handling documentation.Consider adding:
- List of specific error codes and their meanings
- Example error responses for common scenarios
- Handling of rate limits and throttling
- Retry strategies for different error types
chapters/audio-intelligence/pages/speaker-reidentification.mdx (2)
94-97: Update example timestamps to use past dates.The example outputs contain future dates (2025-01-09). Use past dates in the examples to avoid confusion.
Also applies to: 119-122
67-68: Fix typo in recommendation.-We recommand activating +We recommend activatingmint.json (1)
192-193: Maintain consistent path format in navigation.Other pages in the Audio Intelligence section use the format
chapters/audio-intelligence/pages/...while the new entry useschapters/audio-intelligence/speaker-reidentification. Update for consistency:- "chapters/audio-intelligence/speaker-reidentification" + "chapters/audio-intelligence/pages/speaker-reidentification"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
chapters/audio-intelligence/pages/speaker-reidentification.mdx(1 hunks)chapters/enterprise/enterprise-api.mdx(1 hunks)mint.json(1 hunks)
| ## Authentication | ||
|
|
||
| Authentication details should be provided by your system administrator. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Authentication section needs more details.
The authentication section should specify:
- Authentication method (e.g., Bearer token, API key)
- Where to obtain credentials
- How to include authentication in requests
- Token expiration and renewal process
| **Query Parameters:** | ||
| - `email` (required): The email of the user | ||
| - `emails` (required): Comma-separated list of email addresses to receive notifications |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider using path parameters instead of query parameters for resource identification.
The API consistently uses email in query parameters to identify resources. Consider using path parameters instead, following REST conventions:
GET /accounts/{accountId}/consumptioninstead ofGET /consumption?email=...GET /accounts/{accountId}/api-keysinstead ofGET /account-api-keys?email=...
This approach is more RESTful and allows for better resource hierarchy.
Also applies to: 53-55, 62-64, 73-74, 101-102, 109-110, 118-120, 128-130, 137-139, 148-150
| ## Limitations | ||
|
|
||
| - Speaker reidentification requires good quality audio for accurate matching | ||
| - Performance may vary based on audio quality and background noise | ||
| - The feature works best with clear speech and minimal overlapping voices |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add privacy and data retention information.
The limitations section should include information about:
- How long speaker signatures are retained
- Data privacy considerations
- Compliance with data protection regulations (GDPR, etc.)
Summary by CodeRabbit
New Documentation
Navigation Updates