Adding a new prop to pre-process transcripts for human-readability.

malexanderlim commented 5 days ago

Added a new optional boolean prop returnSimplifiedTranscript to the Gong Retrieve Transcripts action that transforms the raw transcript data into a human-readable format. When enabled, the output presents the conversation in a clean, chronological format with simplified speaker identification (e.g., "Speaker 1"), timestamps in [MM:SS] format, and topic markers where available. The formatted transcript only shows speaker changes when they occur and maintains proper spacing and sectioning, making it much easier to read and analyze conversation flow. This enhancement simplifies downstream use cases where transcript readability is important, while still maintaining the original API response structure when the option is disabled.

Before:

After:

Summary by CodeRabbit

New Features
- Introduced an optional property returnSimplifiedTranscript for requesting simplified call transcripts.
- Added methods for converting milliseconds to timestamps and simplifying transcripts for better readability.
Improvements
- Enhanced the run method to support asynchronous operations and improved control flow for transcript retrieval.
Version Update
- Updated package version from 0.1.1 to 0.1.2.

vercel[bot] commented 5 days ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments

coderabbitai[bot] commented 5 days ago

Walkthrough

The pull request introduces enhancements to the retrieve-transcripts-of-calls.mjs file, updating its version and adding new functionality. A new optional property, returnSimplifiedTranscript, allows users to choose between detailed and simplified transcripts. Two methods, millisToTimestamp and simplifyTranscript, are added to support this functionality. The run method is modified to be asynchronous, checking the new property to determine the response format. Additionally, the package version in package.json is updated.

Changes

File	Change Summary
components/gong/actions/retrieve-transcripts-of-calls/retrieve-transcripts-of-calls.mjs	- Version updated from "0.0.2" to "0.0.3" - Added property `returnSimplifiedTranscript` (boolean) - Added methods: `millisToTimestamp(millis)` and `simplifyTranscript(originalResponse)` - Updated `run` method to be asynchronous and check `returnSimplifiedTranscript`
components/gong/package.json	- Version updated from "0.1.1" to "0.1.2"

Possibly related PRs

#14690: This PR introduces a new callIds prop filter for the Gong action related to retrieving transcripts of calls, which directly relates to the functionality of the retrieve-transcripts-of-calls.mjs file in the main PR.

Suggested labels

action

Suggested reviewers

lcaresia

Poem

In the land of calls, where transcripts flow,
A new option blooms, for details or a show.
With timestamps and names, our tales now sing,
Simplified or rich, oh what joy they bring!
So hop along, dear friends, let’s cheer and play,
For transcripts anew, brighten our day! 🐇✨

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?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

vunguyenhung commented 5 days ago

Hi everyone, all test cases are passed! Ready for release!

Test report https://vunguyenhung.notion.site/Adding-a-new-prop-to-pre-process-transcripts-for-human-readability-144bf548bb5e818cac3acb3dc86f4570

PipedreamHQ / pipedream