├── LICENSE
├── README.md
├── docs
├── code-of-conduct.md
└── contributing.md
└── src
├── ai.js
├── appsscript.json
├── main.js
├── slides.js
└── ui.js
/LICENSE:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
178 |
179 | APPENDIX: How to apply the Apache License to your work.
180 |
181 | To apply the Apache License to your work, attach the following
182 | boilerplate notice, with the fields enclosed by brackets "[]"
183 | replaced with your own identifying information. (Don't include
184 | the brackets!) The text should be enclosed in the appropriate
185 | comment syntax for the file format. We also recommend that a
186 | file or class name and description of purpose be included on the
187 | same "printed page" as the copyright notice for easier
188 | identification within third-party archives.
189 |
190 | Copyright [yyyy] [name of copyright owner]
191 |
192 | Licensed under the Apache License, Version 2.0 (the "License");
193 | you may not use this file except in compliance with the License.
194 | You may obtain a copy of the License at
195 |
196 | http://www.apache.org/licenses/LICENSE-2.0
197 |
198 | Unless required by applicable law or agreed to in writing, software
199 | distributed under the License is distributed on an "AS IS" BASIS,
200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 | See the License for the specific language governing permissions and
202 | limitations under the License.
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Slides Advisor
2 |
3 | Proof-of-concept Google Workspace Add-on using Gemini to analyze and provide feedback on presentations.
4 |
5 | ## How it works
6 |
7 | The add-on uses the Slides API to extract
8 | thumbnails and speaker notes for a presentations. That information is then sent to the `gemini-vision-pro` model along
9 | with a prompt asking it to review the material based on common best practices. The feedback is presented to the user in the add-on.
10 |
11 | The demo uses a zero-shot prompting approach -- no example slides or feedback are provided. Nor has any fine tuning of the base Gemini model been performed.
12 |
13 | ## Customizing & improving results
14 |
15 | Exploration and experimentation is encouraged. There are several ways to customize the add-on and improve the quality of the feedback.
16 |
17 | * Change the guidelines in the prompt. The current guidelines are generic and cover a subset of recommendations for slides. Change the prompt to fit your own guidelines.
18 | * Switch to few-shot prompting. Providing examples of slides that adhere to your guidelines or violate them may help Gemini
19 | provide more relevant feedback.
20 | * Use a fine-tuned model. If you have a large content library with feedback, consider fine-tuning your own model for the task.
21 |
22 | ## Setup
23 |
24 | These instructions assume some familiarity with Apps Script, Add-ons, and Google Cloud Platform.
25 |
26 |
27 | 1. Create and install an add-on following the [quickstart](https://developers.google.com/apps-script/add-ons/translate-addon-sample)
28 | 1. Update the add-on source code & script manifest with the code from the `src` folder.
29 | 1. Enable Vertex AI in the Google Cloud project for the script.
30 | 1. Create a service account in the same project and grant it the `Vertex AI User` role.
31 | 1. Create and export a JSON key for the service account.
32 | 1. Set the `SERVICE_ACCOUNT_KEY` script property with the JSON key contents.
33 |
34 | Open Google Slides to try the add-on. It should appear in the right hand side panel as an eye icon.
--------------------------------------------------------------------------------
/docs/code-of-conduct.md:
--------------------------------------------------------------------------------
1 | # Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as
6 | contributors and maintainers pledge to making participation in our project and
7 | our community a harassment-free experience for everyone, regardless of age, body
8 | size, disability, ethnicity, gender identity and expression, level of
9 | experience, education, socio-economic status, nationality, personal appearance,
10 | race, religion, or sexual identity and orientation.
11 |
12 | ## Our Standards
13 |
14 | Examples of behavior that contributes to creating a positive environment
15 | include:
16 |
17 | * Using welcoming and inclusive language
18 | * Being respectful of differing viewpoints and experiences
19 | * Gracefully accepting constructive criticism
20 | * Focusing on what is best for the community
21 | * Showing empathy towards other community members
22 |
23 | Examples of unacceptable behavior by participants include:
24 |
25 | * The use of sexualized language or imagery and unwelcome sexual attention or
26 | advances
27 | * Trolling, insulting/derogatory comments, and personal or political attacks
28 | * Public or private harassment
29 | * Publishing others' private information, such as a physical or electronic
30 | address, without explicit permission
31 | * Other conduct which could reasonably be considered inappropriate in a
32 | professional setting
33 |
34 | ## Our Responsibilities
35 |
36 | Project maintainers are responsible for clarifying the standards of acceptable
37 | behavior and are expected to take appropriate and fair corrective action in
38 | response to any instances of unacceptable behavior.
39 |
40 | Project maintainers have the right and responsibility to remove, edit, or reject
41 | comments, commits, code, wiki edits, issues, and other contributions that are
42 | not aligned to this Code of Conduct, or to ban temporarily or permanently any
43 | contributor for other behaviors that they deem inappropriate, threatening,
44 | offensive, or harmful.
45 |
46 | ## Scope
47 |
48 | This Code of Conduct applies both within project spaces and in public spaces
49 | when an individual is representing the project or its community. Examples of
50 | representing a project or community include using an official project e-mail
51 | address, posting via an official social media account, or acting as an appointed
52 | representative at an online or offline event. Representation of a project may be
53 | further defined and clarified by project maintainers.
54 |
55 | This Code of Conduct also applies outside the project spaces when the Project
56 | Steward has a reasonable belief that an individual's behavior may have a
57 | negative impact on the project or its community.
58 |
59 | ## Conflict Resolution
60 |
61 | We do not believe that all conflict is bad; healthy debate and disagreement
62 | often yield positive results. However, it is never okay to be disrespectful or
63 | to engage in behavior that violates the project’s code of conduct.
64 |
65 | If you see someone violating the code of conduct, you are encouraged to address
66 | the behavior directly with those involved. Many issues can be resolved quickly
67 | and easily, and this gives people more control over the outcome of their
68 | dispute. If you are unable to resolve the matter for any reason, or if the
69 | behavior is threatening or harassing, report it. We are dedicated to providing
70 | an environment where participants feel welcome and safe.
71 |
72 | Reports should be directed to *[PROJECT STEWARD NAME(s) AND EMAIL(s)]*, the
73 | Project Steward(s) for *[PROJECT NAME]*. It is the Project Steward’s duty to
74 | receive and address reported violations of the code of conduct. They will then
75 | work with a committee consisting of representatives from the Open Source
76 | Programs Office and the Google Open Source Strategy team. If for any reason you
77 | are uncomfortable reaching out to the Project Steward, please email
78 | opensource@google.com.
79 |
80 | We will investigate every complaint, but you may not receive a direct response.
81 | We will use our discretion in determining when and how to follow up on reported
82 | incidents, which may range from not taking action to permanent expulsion from
83 | the project and project-sponsored spaces. We will notify the accused of the
84 | report and provide them an opportunity to discuss it before any action is taken.
85 | The identity of the reporter will be omitted from the details of the report
86 | supplied to the accused. In potentially harmful situations, such as ongoing
87 | harassment or threats to anyone's safety, we may take action without notice.
88 |
89 | ## Attribution
90 |
91 | This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
92 | available at
93 | https://www.contributor-covenant.org/version/1/4/code-of-conduct/
--------------------------------------------------------------------------------
/docs/contributing.md:
--------------------------------------------------------------------------------
1 | # How to Contribute
2 |
3 | We would love to accept your patches and contributions to this project.
4 |
5 | ## Before you begin
6 |
7 | ### Sign our Contributor License Agreement
8 |
9 | Contributions to this project must be accompanied by a
10 | [Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
11 | You (or your employer) retain the copyright to your contribution; this simply
12 | gives us permission to use and redistribute your contributions as part of the
13 | project.
14 |
15 | If you or your current employer have already signed the Google CLA (even if it
16 | was for a different project), you probably don't need to do it again.
17 |
18 | Visit to see your current agreements or to
19 | sign a new one.
20 |
21 | ### Review our Community Guidelines
22 |
23 | This project follows [Google's Open Source Community
24 | Guidelines](https://opensource.google/conduct/).
25 |
26 | ## Contribution process
27 |
28 | ### Code Reviews
29 |
30 | All submissions, including submissions by project members, require review. We
31 | use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests)
32 | for this purpose.
--------------------------------------------------------------------------------
/src/ai.js:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2024 Google LLC
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | https://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 | */
16 | const MODEL_ID = "gemini-pro-vision";
17 | const LOCATION = "us-west1";
18 |
19 | const SYSTEM_PROMPT = `
20 | Your task is to provide constructive feedback on a presentation.
21 |
22 | Begin by stating the main message of the slide.
23 |
24 | For each of the following categories evaluate the given slide. Score each category on a scale of 0 to 100 and concisely explain the reasoning. Do not suggest improvements if the score is 80 or above.
25 |
26 | * Simplicity -- Slides should focus on one main idea per slides and any text or images should be consistent with the idea. Slides should have either a few brief bullet points or 1 to two sentances to make an impactful statement. Score the slide
27 | lower if the main message is not clear.
28 |
29 | * Color and typography -- Slides should have consistent fonts that are large enough to read. Colors can be used for emphasis and should always have a high contrast ratio. Slides with low contrast ratios
30 | or font sizes that are too small should be scored lower. No more than 3 different fonts should be used on a slide.
31 |
32 | * Structure and whitespace -- Slides should have a clear structure and adequate whitespace to not feel cluttered or crowded.
33 |
34 | * Graphics & icons -- Bold imagery or charts to emphasize the message are encouraged and should be scored higher. Icons should be used instead of bullet points. It is OK if a slide contains no graphics if the
35 | text is simple and focuses on a single message.
36 |
37 | Format the response as markdown with headers, bullets, and new lines.
38 |
39 | The slide to review is below:
40 | `;
41 |
42 | function analyzeSlides(slide) {
43 |
44 | const generationConfig = {
45 | temperature: 0.1,
46 | maxOutputTokens: 1024 * 2,
47 | };
48 |
49 | const safetySettings = [
50 | {
51 | category: "HARM_CATEGORY_HARASSMENT",
52 | threshold: "BLOCK_MEDIUM_AND_ABOVE",
53 | },
54 | {
55 | category: "HARM_CATEGORY_HATE_SPEECH",
56 | threshold: "BLOCK_MEDIUM_AND_ABOVE",
57 | },
58 | {
59 | category: "HARM_CATEGORY_SEXUALLY_EXPLICIT",
60 | threshold: "BLOCK_MEDIUM_AND_ABOVE",
61 | },
62 | {
63 | category: "HARM_CATEGORY_DANGEROUS_CONTENT",
64 | threshold: "BLOCK_MEDIUM_AND_ABOVE",
65 | },
66 | ];
67 |
68 | const slideParts = [
69 | {
70 | inlineData: {
71 | mimeType: 'image/png',
72 | data: slide.thumbnail,
73 | }
74 | }
75 | ];
76 | if (slide.notes) {
77 | slideParts.push({
78 | text: `Speaker notes: ${slide.notes ?? ''}\n`
79 | });
80 | }
81 |
82 | const contents = [
83 | {
84 | role: "user",
85 | parts: [
86 | {
87 | text: SYSTEM_PROMPT,
88 | },
89 | ...slideParts,
90 |
91 | ]
92 | }
93 | ];
94 |
95 | const body = {
96 | generationConfig,
97 | safetySettings,
98 | contents,
99 | }
100 | const credentials = credentialsForVertexAI();
101 | const url = `https://${LOCATION}-aiplatform.googleapis.com/v1/projects/${credentials.projectId}/locations/${LOCATION}/publishers/google/models/${MODEL_ID}:streamGenerateContent`
102 | const response = UrlFetchApp.fetch(url, {
103 | method: "POST",
104 | contentType: "application/json",
105 | headers: {
106 | 'Authorization': `Bearer ${credentials.accessToken}`
107 | },
108 | payload: JSON.stringify(body),
109 | muteHttpExceptions: true
110 | })
111 |
112 | if (response.getResponseCode() >= 400) {
113 | console.log(response.getContentText());
114 | throw new Error(`Unable to analyze slides. Try again later. Error ${response.getResponseCode()}: ${response.getContentText()}`);
115 | }
116 |
117 | const parsedResponse = JSON.parse(response.getContentText());
118 | console.log(JSON.stringify(parsedResponse, null, 2));
119 |
120 | if (!parsedResponse.length === 0) {
121 | return 'Unable to analyze slides. Try again later.';
122 | }
123 |
124 | return parsedResponse.reduce((text, entry) => {
125 | return text + entry.candidates[0].content.parts[0].text;
126 | }, '');
127 | }
128 |
129 | function credentialsForVertexAI() {
130 | const credentials = PropertiesService.getScriptProperties().getProperty("SERVICE_ACCOUNT_KEY");
131 | if (!credentials) {
132 | throw new Error("SERVICE_ACCOUNT_KEY script property must be set.");
133 | }
134 |
135 | const parsedCredentials = JSON.parse(credentials);
136 |
137 | const service = OAuth2.createService("Vertex")
138 | .setTokenUrl('https://oauth2.googleapis.com/token')
139 | .setPrivateKey(parsedCredentials['private_key'])
140 | .setIssuer(parsedCredentials['client_email'])
141 | .setPropertyStore(PropertiesService.getScriptProperties())
142 | .setScope("https://www.googleapis.com/auth/cloud-platform");
143 | return {
144 | projectId: parsedCredentials['project_id'],
145 | accessToken: service.getAccessToken(),
146 | }
147 | }
--------------------------------------------------------------------------------
/src/appsscript.json:
--------------------------------------------------------------------------------
1 | {
2 | "timeZone": "America/Denver",
3 | "exceptionLogging": "STACKDRIVER",
4 | "runtimeVersion": "V8",
5 | "dependencies": {
6 | "enabledAdvancedServices": [
7 | {
8 | "userSymbol": "Slides",
9 | "serviceId": "slides",
10 | "version": "v1"
11 | }
12 | ],
13 | "libraries": [
14 | {
15 | "userSymbol": "OAuth2",
16 | "libraryId": "1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF",
17 | "version": "43",
18 | "developmentMode": false
19 | }
20 | ]
21 | },
22 | "oauthScopes": [
23 | "https://www.googleapis.com/auth/presentations.currentonly",
24 | "https://www.googleapis.com/auth/presentations.readonly",
25 | "https://www.googleapis.com/auth/script.external_request"
26 | ],
27 | "addOns": {
28 | "common": {
29 | "name": "Slides Advisor",
30 | "logoUrl": "https://raw.githubusercontent.com/webdog/octicons-png/main/black/eye.png"
31 | },
32 | "slides": {
33 | "homepageTrigger": {
34 | "runFunction": "onHomepageOpened"
35 | }
36 | }
37 | }
38 | }
--------------------------------------------------------------------------------
/src/main.js:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2024 Google LLC
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | https://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 | */
16 |
17 | /**
18 | * Main entry point for add-on when opened.
19 | *
20 | * @param e - Add-on event context
21 | */
22 | function onHomepageOpened(e) {
23 | const card = buildAnalyzeSlideCard();
24 | return {
25 | action: {
26 | navigations: [
27 | {
28 | pushCard: card
29 | }
30 | ]
31 | }
32 | };
33 | }
34 |
35 | /**
36 | * Handles button click in the add-on to analyze the current slide
37 | *
38 | * @param e - Add-on event context
39 | */
40 | function onAnalyzeSlideClicked(e) {
41 | const presentationId = getPresentationId();
42 | const pageId = getSelectedPageId();
43 | const thumbnail = fetchThumbnail(presentationId, pageId);
44 | const notes = fetchSpeakerNotes(presentationId, pageId);
45 | const analysis = analyzeSlides({
46 | thumbnail,
47 | notes,
48 | });
49 |
50 | return {
51 | renderActions: {
52 | action: {
53 | navigations: [
54 | {
55 | updateCard: buildAnalyzeSlideCard(analysis)
56 | }
57 | ]
58 | }
59 | }
60 | }
61 | }
--------------------------------------------------------------------------------
/src/slides.js:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2024 Google LLC
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | https://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 | */
16 |
17 | /**
18 | * Gets the ID of the currently viewed page.
19 | */
20 | function getSelectedPageId() {
21 | const presentation = SlidesApp.getActivePresentation();
22 | const selection = presentation.getSelection();
23 | if (!selection) {
24 | return null;
25 | }
26 | const currentPage = selection.getCurrentPage();
27 |
28 | if (!currentPage) {
29 | return null;
30 | }
31 | const pageId = currentPage.asSlide().getObjectId();
32 | return pageId
33 | }
34 |
35 | /**
36 | * Gets the ID of the currently viewed presentation.
37 | */
38 | function getPresentationId() {
39 | const presentation = SlidesApp.getActivePresentation();
40 | if (!presentation) {
41 | return null;
42 | }
43 | return presentation.getId();
44 | }
45 |
46 | /**
47 | * Fetches the thumbnail for the given slide.
48 | */
49 | function fetchThumbnail(presentationId, pageId) {
50 | const metadata = Slides.Presentations.Pages.getThumbnail(presentationId, pageId, {
51 | "thumbnailProperties.mimeType": "PNG",
52 | "thumbnailProperties.thumbnailSize": "LARGE"
53 | });
54 | if (!metadata) {
55 | return null;
56 | }
57 | const url = metadata.contentUrl;
58 | if (!url) {
59 | return null;
60 | }
61 | const mediaResponse = UrlFetchApp.fetch(url);
62 | const thumbnail = mediaResponse.getBlob();
63 | return Utilities.base64Encode(thumbnail.getBytes());
64 | }
65 |
66 | /**
67 | * Fetches the speaker notes for the given slide.
68 | */
69 | function fetchSpeakerNotes(presentationId, pageId) {
70 | const page = Slides.Presentations.Pages.get(presentationId, pageId);
71 | if (!page || !page.notesProperties || !page.pageElements) {
72 | return null;
73 | }
74 |
75 | const objectId = page.notesProperties.speakerNotesObjectId;
76 | if (!objectId) {
77 | return null;
78 | }
79 |
80 | const notesObject = page.pageElements.find(p => p.objectId === objectId);
81 | if (!notesObject || !notesObject.shape) {
82 | return null;
83 | }
84 |
85 | return flattenText(notesObject.shape.text);
86 | }
87 |
88 | /**
89 | * Simplistic method for flatting text elements into a string. Only considers
90 | * text content itself and ignores formatting/text runs.
91 | */
92 | function flattenText(text) {
93 | if (!text) {
94 | return null;
95 | }
96 | text = text.textElements.reduce((text, span) => {
97 | if (!span.textRun || !span.textRun.content) {
98 | return text;
99 | }
100 | return text + span.textRun.content;
101 | }, '');
102 | return text;
103 | }
--------------------------------------------------------------------------------
/src/ui.js:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2024 Google LLC
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | https://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 | */
16 |
17 | /**
18 | * Convert a subset of markdown into HTML tags for the text paragraph widget.
19 | */
20 | function formatOutput(str) {
21 | return str.replace(/#+\s+(.*)/g, "$1")
22 | .replace(/Score:\s*(\d+)/g, "Score: $1");
23 | }
24 |
25 | function buildAnalyzeSlideCard(results) {
26 | const widgets = [
27 | {
28 | buttonList: {
29 | buttons: [
30 | {
31 | text: "Evaluate slide",
32 | onClick: {
33 | action: {
34 | function: "onAnalyzeSlideClicked",
35 | },
36 | },
37 | },
38 | ],
39 | },
40 | },
41 | ];
42 |
43 | if (!results) {
44 | widgets.push(
45 | {
46 | textParagraph: {
47 | text: "To analyze the current slide, click the button below.",
48 | },
49 | },
50 | );
51 | } else {
52 | widgets.push(
53 | {
54 | textParagraph: {
55 | text: formatOutput(results),
56 | }
57 | },
58 | );
59 | }
60 |
61 | return {
62 | sections: [
63 | {
64 | widgets
65 | },
66 | ],
67 | };
68 | }
69 |
--------------------------------------------------------------------------------