Skip to content
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

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

Merged
merged 2 commits into from
Nov 21, 2024

Conversation

malexanderlim
Copy link
Collaborator

@malexanderlim malexanderlim commented Nov 20, 2024

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:
Screenshot 2024-11-20 at 12 26 33 PM

After:
Screenshot 2024-11-20 at 12 26 44 PM

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.

Copy link

vercel bot commented Nov 20, 2024

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

3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Ignored (Inspect) Visit Preview Nov 20, 2024 9:48pm
pipedream-docs ⬜️ Ignored (Inspect) Nov 20, 2024 9:48pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Nov 20, 2024 9:48pm

Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

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

  • [FEATURE] New prop to Gong action #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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)
components/gong/actions/retrieve-transcripts-of-calls/retrieve-transcripts-of-calls.mjs (2)

54-60: Add input validation for millisToTimestamp.

The method should validate the input to handle edge cases gracefully.

Consider adding input validation:

 millisToTimestamp(millis) {
+  if (typeof millis !== 'number' || millis < 0) {
+    throw new Error('Invalid milliseconds value');
+  }
   const totalSeconds = Math.floor(millis / 1000);
   const minutes = Math.floor(totalSeconds / 60);
   const seconds = totalSeconds % 60;

   return `[${minutes.toString().padStart(2, "0")}:${seconds.toString().padStart(2, "0")}]`;
 }

62-126: Well-structured transcript simplification implementation.

The implementation effectively achieves the PR's objective of enhancing transcript readability through:

  • Clear speaker identification
  • Chronological ordering with timestamps
  • Topic change demarcation
  • Maintaining original data when simplified format isn't requested

This provides a good balance between maintaining the original detailed format and offering a more human-readable alternative.

🧰 Tools
🪛 Biome

[error] 81-81: Avoid the use of spread (...) syntax on accumulators.

Spread syntax should be avoided on accumulators (like those in .reduce) because it causes a time complexity of O(n^2).
Consider methods such as .splice or .push instead.

(lint/performance/noAccumulatingSpread)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8fe1c71 and fcf0fba.

📒 Files selected for processing (2)
  • components/gong/actions/retrieve-transcripts-of-calls/retrieve-transcripts-of-calls.mjs (3 hunks)
  • components/gong/package.json (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • components/gong/package.json
🧰 Additional context used
🪛 Biome
components/gong/actions/retrieve-transcripts-of-calls/retrieve-transcripts-of-calls.mjs

[error] 81-81: Avoid the use of spread (...) syntax on accumulators.

Spread syntax should be avoided on accumulators (like those in .reduce) because it causes a time complexity of O(n^2).
Consider methods such as .splice or .push instead.

(lint/performance/noAccumulatingSpread)

🔇 Additional comments (3)
components/gong/actions/retrieve-transcripts-of-calls/retrieve-transcripts-of-calls.mjs (3)

8-8: LGTM! Version bump is appropriate.

The version increment reflects the addition of the new transcript formatting feature.


38-44: LGTM! Well-defined property with clear documentation.

The new property is appropriately defined as optional with a default value, ensuring backward compatibility.


129-149: LGTM! Clean implementation of the simplified transcript feature.

The async/await usage and control flow are well-implemented.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
components/gong/actions/retrieve-transcripts-of-calls/retrieve-transcripts-of-calls.mjs (1)

54-60: Consider handling longer durations.

The timestamp conversion works well for minutes and seconds but might need to handle hours for longer recordings.

 millisToTimestamp(millis) {
   const totalSeconds = Math.floor(millis / 1000);
-  const minutes = Math.floor(totalSeconds / 60);
+  const hours = Math.floor(totalSeconds / 3600);
+  const minutes = Math.floor((totalSeconds % 3600) / 60);
   const seconds = totalSeconds % 60;
-
-  return `[${minutes.toString().padStart(2, "0")}:${seconds.toString().padStart(2, "0")}]`;
+  
+  return hours > 0
+    ? `[${hours}:${minutes.toString().padStart(2, "0")}:${seconds.toString().padStart(2, "0")}]`
+    : `[${minutes.toString().padStart(2, "0")}:${seconds.toString().padStart(2, "0")}]`;
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fcf0fba and 46dba5e.

📒 Files selected for processing (1)
  • components/gong/actions/retrieve-transcripts-of-calls/retrieve-transcripts-of-calls.mjs (3 hunks)
🔇 Additional comments (3)
components/gong/actions/retrieve-transcripts-of-calls/retrieve-transcripts-of-calls.mjs (3)

8-8: LGTM! Version bump is appropriate.

The version increment from 0.0.2 to 0.0.3 aligns with semantic versioning for feature additions.


38-44: LGTM! Well-defined prop with clear documentation.

The new prop is well-structured with appropriate type, default value, and clear description. Making it optional ensures backward compatibility.


128-148: LGTM! Clean implementation of the new feature.

The async conversion and conditional processing based on the feature flag are well implemented. The code maintains good separation of concerns.

Copy link
Collaborator

@jcortes jcortes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @malexanderlim lgtm! Ready for QA!

@vunguyenhung
Copy link
Collaborator

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

@malexanderlim malexanderlim merged commit da1f99f into master Nov 21, 2024
12 checks passed
@malexanderlim malexanderlim deleted the gong-simplify-transcript branch November 21, 2024 01:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants