-
Notifications
You must be signed in to change notification settings - Fork 3.7k
feat(gong): align tools with official API spec + 4 new tools #5632
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
f60cbe1
feat(gong): align tools with official API spec, add ask-anything, bri…
waleedlatif1 4554be5
fix(gong): require custom-range dates and gate param remapping by ope…
waleedlatif1 f95748c
fix(gong): final spec-alignment pass, review fixes, and regenerated docs
waleedlatif1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| import type { GongAskAnythingParams, GongAskAnythingResponse } from '@/tools/gong/types' | ||
| import { getGongErrorMessage } from '@/tools/gong/utils' | ||
| import type { ToolConfig } from '@/tools/types' | ||
|
|
||
| export const askAnythingTool: ToolConfig<GongAskAnythingParams, GongAskAnythingResponse> = { | ||
| id: 'gong_ask_anything', | ||
| name: 'Gong Ask Anything', | ||
| description: | ||
| 'Ask a natural-language question about a CRM account, deal, contact, or lead. Gong answers from up to 60 calls and 500 emails associated with the entity. Consumes Gong credits.', | ||
| version: '1.0.0', | ||
|
|
||
| params: { | ||
| accessKey: { | ||
| type: 'string', | ||
| required: true, | ||
| visibility: 'user-only', | ||
| description: 'Gong API Access Key', | ||
| }, | ||
| accessKeySecret: { | ||
| type: 'string', | ||
| required: true, | ||
| visibility: 'user-only', | ||
| description: 'Gong API Access Key Secret', | ||
| }, | ||
| workspaceId: { | ||
| type: 'string', | ||
| required: true, | ||
| visibility: 'user-or-llm', | ||
| description: 'Gong workspace ID the entity belongs to', | ||
| }, | ||
| crmEntityType: { | ||
| type: 'string', | ||
| required: true, | ||
| visibility: 'user-or-llm', | ||
| description: 'Type of the CRM entity: ACCOUNT, CONTACT, DEAL, or LEAD', | ||
| }, | ||
| crmEntityId: { | ||
| type: 'string', | ||
| required: true, | ||
| visibility: 'user-or-llm', | ||
| description: 'The CRM ID of the entity the question is asked about', | ||
| }, | ||
| question: { | ||
| type: 'string', | ||
| required: true, | ||
| visibility: 'user-or-llm', | ||
| description: 'The natural-language question to ask about the entity', | ||
| }, | ||
| timePeriod: { | ||
| type: 'string', | ||
| required: true, | ||
| visibility: 'user-or-llm', | ||
| description: | ||
| 'Time period of conversations to consider: LAST_7DAYS, LAST_30DAYS, LAST_90DAYS, LAST_90_DAYS_SINCE_LAST_ACTIVITY, LAST_YEAR_SINCE_LAST_ACTIVITY, LAST_YEAR, THIS_WEEK, THIS_MONTH, THIS_YEAR, THIS_QUARTER, CUSTOM_RANGE, or ALL_CONVERSATIONS', | ||
| }, | ||
| fromDateTime: { | ||
| type: 'string', | ||
| required: false, | ||
| visibility: 'user-or-llm', | ||
| description: | ||
| 'Start date/time (UTC, ISO-8601) for calls and emails to include. Required when timePeriod is CUSTOM_RANGE.', | ||
| }, | ||
| toDateTime: { | ||
| type: 'string', | ||
| required: false, | ||
| visibility: 'user-or-llm', | ||
| description: | ||
| 'End date/time (UTC, ISO-8601) for calls and emails to include. Required when timePeriod is CUSTOM_RANGE.', | ||
| }, | ||
| }, | ||
|
|
||
| request: { | ||
| url: (params) => { | ||
| const timePeriod = params.timePeriod.trim().toUpperCase() | ||
| if ( | ||
| timePeriod === 'CUSTOM_RANGE' && | ||
| (!params.fromDateTime?.trim() || !params.toDateTime?.trim()) | ||
| ) { | ||
| throw new Error('fromDateTime and toDateTime are required when timePeriod is CUSTOM_RANGE') | ||
| } | ||
| const url = new URL('https://api.gong.io/v2/entities/ask-entity') | ||
| url.searchParams.set('workspaceId', params.workspaceId.trim()) | ||
| url.searchParams.set('crmEntityType', params.crmEntityType.trim().toUpperCase()) | ||
| url.searchParams.set('crmEntityId', params.crmEntityId.trim()) | ||
| url.searchParams.set('timePeriod', timePeriod) | ||
| url.searchParams.set('question', params.question.trim()) | ||
| if (timePeriod === 'CUSTOM_RANGE') { | ||
| url.searchParams.set('fromDateTime', params.fromDateTime?.trim() ?? '') | ||
| url.searchParams.set('toDateTime', params.toDateTime?.trim() ?? '') | ||
| } | ||
| return url.toString() | ||
| }, | ||
| method: 'GET', | ||
| headers: (params) => ({ | ||
| Authorization: `Basic ${btoa(`${params.accessKey}:${params.accessKeySecret}`)}`, | ||
| }), | ||
| }, | ||
|
|
||
| transformResponse: async (response: Response) => { | ||
| const data = await response.json() | ||
| if (!response.ok) { | ||
| throw new Error(getGongErrorMessage(data, 'Failed to ask about the entity')) | ||
| } | ||
| const answer = (data.answer ?? []).map((section: Record<string, unknown>) => ({ | ||
| answerItems: section.answerItems ?? [], | ||
| callFindings: section.callFindings ?? [], | ||
| emailFindings: section.emailFindings ?? [], | ||
| })) | ||
| return { | ||
| success: true, | ||
| output: { | ||
| requestId: data.requestId ?? null, | ||
| numOfCallsSearched: data.numOfCallsSearched ?? null, | ||
| numOfEmailsSearched: data.numOfEmailsSearched ?? null, | ||
| answer, | ||
| }, | ||
| } | ||
| }, | ||
|
|
||
| outputs: { | ||
| requestId: { | ||
| type: 'string', | ||
| description: 'A Gong request reference ID for troubleshooting purposes', | ||
| optional: true, | ||
| }, | ||
| numOfCallsSearched: { | ||
| type: 'number', | ||
| description: 'Number of calls used to generate the answer', | ||
| optional: true, | ||
| }, | ||
| numOfEmailsSearched: { | ||
| type: 'number', | ||
| description: 'Number of emails used to generate the answer', | ||
| optional: true, | ||
| }, | ||
| answer: { | ||
| type: 'array', | ||
| description: 'Sections of the generated answer with supporting evidence', | ||
| items: { | ||
| type: 'object', | ||
| properties: { | ||
| answerItems: { | ||
| type: 'array', | ||
| description: 'Text items that make up this part of the answer', | ||
| items: { type: 'string' }, | ||
| }, | ||
| callFindings: { | ||
| type: 'array', | ||
| description: 'Evidence from calls used to generate this answer item', | ||
| items: { type: 'object' }, | ||
| }, | ||
| emailFindings: { | ||
| type: 'array', | ||
| description: 'Evidence from emails used to generate this answer item', | ||
| items: { type: 'object' }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.