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

Add samples for log prob and search grounding #273

Merged
merged 5 commits into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,6 @@ to comment out cases you do not want to run.
| [function_calling.js](./function_calling.js) | Using function calling |
| [safety_settings.js](./safety_settings.js) | Setting and using safety controls |
| [system_instruction.js](./system_instruction.js) | Setting system instructions |
| [search_grounding.js](./search_grounding.js) | Generate with google search grounding |
| [log_prob.js](./log_prob.js) | Generate with log probability for each token |
| [text_generation.js](./text_generation.js) | Generating text |
45 changes: 45 additions & 0 deletions samples/log_prob.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/**
* @license
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import {GoogleGenerativeAI} from "@google/generative-ai";

async function enableLogProb() {
// [START log_prob]
// Make sure to include these imports:
// import {GoogleGenerativeAI} from "@google/generative-ai";
const genAI = new GoogleGenerativeAI(process.env.API_KEY);
Copy link
Collaborator

Choose a reason for hiding this comment

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

For devsite snippets we add a comment like this about what imports the user will need, since the import at the top of the file will not be included in the includecode snippet: https://github.com/google-gemini/generative-ai-js/blob/add-samples/samples/text_generation.js#L43-L44

Copy link
Collaborator

Choose a reason for hiding this comment

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

I see this is resolved, but I don't see the comment added?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

const model = genAI.getGenerativeModel(
{
// Only 002 models + flash 1.5 8b models are enabled with log probs
// option.
model: "gemini-1.5-flash-002",
generationConfig: {
responseLogprobs: true
},
},
);
const prompt = "Hello!";
const result = await model.generateContent(prompt);
console.log(result.response.candidates[0].logprobsResult);
// [END log_prob]
}
async function runAll() {
// Comment out or delete any sample cases you don't want to run.
await enableLogProb();
}

runAll();
58 changes: 58 additions & 0 deletions samples/search_grounding.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/**
* @license
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import {
DynamicRetrievalMode,
GoogleGenerativeAI,
} from "@google/generative-ai";

async function searchGrounding() {
// [START search_grounding]
// Make sure to include these imports:
// import {
// DynamicRetrievalMode,
// GoogleGenerativeAI,
// } from "@google/generative-ai";
const genAI = new GoogleGenerativeAI(process.env.API_KEY);
const model = genAI.getGenerativeModel(
{
model: "gemini-1.5-flash",
tools: [
{
googleSearchRetrieval: {
dynamicRetrievalConfig: {
mode: DynamicRetrievalMode.MODE_DYNAMIC,
dynamicThreshold: 0.7,
},
},
},
],
},
{ apiVersion: "v1beta" },
);

const prompt = "What is the price of Google stock today?";
const result = await model.generateContent(prompt);
console.log(result.response.candidates[0].groundingMetadata);
// [END search_grounding]
}
async function runAll() {
// Comment out or delete any sample cases you don't want to run.
await searchGrounding();
}

runAll();
Loading