Skip to content

Add Forced Alignment Client and Models (#120) #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

sourman
Copy link

@sourman sourman commented Jan 12, 2025

  • Introduced ForcedAlignmentClient for interacting with the Rev AI forced alignment API.
  • Added data models: ForcedAlignmentJob, ForcedAlignmentResult, ElementAlignment, and Monologue to handle alignment jobs.
  • Implemented methods for processing jobs in forced_alignment_client.
  • Created a module for forced alignment models to organize classes.

@sourman sourman requested a review from a team as a code owner January 12, 2025 14:39
@sourman sourman force-pushed the feature/add-forced-alignment-endpoint-support-to-sdk branch 3 times, most recently from f24036d to cd5e3b2 Compare January 14, 2025 20:16
* Introduced `ForcedAlignmentClient` for interacting with the Rev AI
  forced alignment API.
* Added data models: `ForcedAlignmentJob`, `ForcedAlignmentResult`,
  `ElementAlignment`, and `Monologue` to handle alignment jobs.
* Implemented methods for processing jobs in forced_alignment_client.
* Created a module for forced alignment models to organize classes.
* Updated generic_api_client get_result_object methods optionally
  specify the result route to accomodate the forced alignment endpoint
  which does NOT have a /result route. Instead it has a /transcript
  route as per [Get Forced Alignment Transcript By Id](https://docs.rev.ai/api/alignment/reference/#operation/GetAlignmentTranscriptById)

Signed-off-by: Ahmed Mansour <[email protected]>
* Introduced a new test module `test_forced_alignment_client.py` to
  validate the functionality of the `ForcedAlignmentClient`.
* Implemented various test cases to ensure correct behavior for job
  submission and result retrieval.
* Added tests for handling missing parameters and validating
  error messages.

Signed-off-by: Ahmed Mansour <[email protected]>
* Added `ForcedAlignmentJob`, `ForcedAlignmentResult`,
  and `ElementAlignment` to the import statements in the
  `__init__.py` files to expose at the top level of the sdk for easy
  import access.

Signed-off-by: Ahmed Mansour <[email protected]>
@sourman sourman force-pushed the feature/add-forced-alignment-endpoint-support-to-sdk branch from cd5e3b2 to 08383d9 Compare January 14, 2025 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant