CINXE.COM

<!doctype html> <html lang="en" dir="ltr"> <head> <meta name="google-signin-client-id" content="157101835696-ooapojlodmuabs2do2vuhhnf90bccmoi.apps.googleusercontent.com"> <meta name="google-signin-scope" content="profile email https://www.googleapis.com/auth/developerprofiles https://www.googleapis.com/auth/developerprofiles.award"> <meta property="og:site_name" content="Google AI for Developers"> <meta property="og:type" content="website"><meta name="theme-color" content="#1967d2"><meta charset="utf-8"> <meta content="IE=Edge" http-equiv="X-UA-Compatible"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="manifest" href="/_pwa/googledevai/manifest.json" crossorigin="use-credentials"> <link rel="preconnect" href="//www.gstatic.com" crossorigin> <link rel="preconnect" href="//fonts.gstatic.com" crossorigin> <link rel="preconnect" href="//fonts.googleapis.com" crossorigin> <link rel="preconnect" href="//apis.google.com" crossorigin> <link rel="preconnect" href="//www.google-analytics.com" crossorigin><link rel="stylesheet" href="//fonts.googleapis.com/css?family=Google+Sans:400,500|Roboto:400,400italic,500,500italic,700,700italic|Roboto+Mono:400,500,700&display=swap"> <link rel="stylesheet" href="//fonts.googleapis.com/css2?family=Material+Icons&family=Material+Symbols+Outlined&display=block"><link rel="stylesheet" href="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/googledevai/css/app.css"> <link rel="shortcut icon" href="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/googledevai/images/favicon-new.png"> <link rel="apple-touch-icon" href="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/googledevai/images/touchicon-180-new.png"><link rel="canonical" href="https://ai.google.dev/api/generate-content"><link rel="search" type="application/opensearchdescription+xml" title="Google AI for Developers" href="https://ai.google.dev/s/opensearch.xml"> <link rel="alternate" hreflang="en" href="https://ai.google.dev/api/generate-content" /><link rel="alternate" hreflang="x-default" href="https://ai.google.dev/api/generate-content" /><link rel="alternate" hreflang="ar" href="https://ai.google.dev/api/generate-content?hl=ar" /><link rel="alternate" hreflang="bn" href="https://ai.google.dev/api/generate-content?hl=bn" /><link rel="alternate" hreflang="zh-Hans" href="https://ai.google.dev/api/generate-content?hl=zh-cn" /><link rel="alternate" hreflang="zh-Hant" href="https://ai.google.dev/api/generate-content?hl=zh-tw" /><link rel="alternate" hreflang="fa" href="https://ai.google.dev/api/generate-content?hl=fa" /><link rel="alternate" hreflang="fr" href="https://ai.google.dev/api/generate-content?hl=fr" /><link rel="alternate" hreflang="de" href="https://ai.google.dev/api/generate-content?hl=de" /><link rel="alternate" hreflang="he" href="https://ai.google.dev/api/generate-content?hl=he" /><link rel="alternate" hreflang="hi" href="https://ai.google.dev/api/generate-content?hl=hi" /><link rel="alternate" hreflang="id" href="https://ai.google.dev/api/generate-content?hl=id" /><link rel="alternate" hreflang="it" href="https://ai.google.dev/api/generate-content?hl=it" /><link rel="alternate" hreflang="ja" href="https://ai.google.dev/api/generate-content?hl=ja" /><link rel="alternate" hreflang="ko" href="https://ai.google.dev/api/generate-content?hl=ko" /><link rel="alternate" hreflang="pl" href="https://ai.google.dev/api/generate-content?hl=pl" /><link rel="alternate" hreflang="pt-BR" href="https://ai.google.dev/api/generate-content?hl=pt-br" /><link rel="alternate" hreflang="ru" href="https://ai.google.dev/api/generate-content?hl=ru" /><link rel="alternate" hreflang="es-419" href="https://ai.google.dev/api/generate-content?hl=es-419" /><link rel="alternate" hreflang="th" href="https://ai.google.dev/api/generate-content?hl=th" /><link rel="alternate" hreflang="tr" href="https://ai.google.dev/api/generate-content?hl=tr" /><link rel="alternate" hreflang="vi" href="https://ai.google.dev/api/generate-content?hl=vi" /><title>Generating content  |  Gemini API  |  Google AI for Developers</title> <meta property="og:title" content="Generating content  |  Gemini API  |  Google AI for Developers"><meta property="og:url" content="https://ai.google.dev/api/generate-content"><meta property="og:image" content="https://ai.google.dev/static/site-assets/images/share-gemini-api.png"> <meta property="og:image:width" content="1200"> <meta property="og:image:height" content="675"><meta property="og:locale" content="en"><meta name="twitter:card" content="summary_large_image"><script type="application/ld+json"> { "@context": "https://schema.org", "@type": "BreadcrumbList", "itemListElement": [{ "@type": "ListItem", "position": 1, "name": "Gemini API", "item": "https://ai.google.dev/gemini-api" },{ "@type": "ListItem", "position": 2, "name": "Generating content", "item": "https://ai.google.dev/api/generate-content" }] } </script> <link rel="stylesheet" href="/extras.css"></head> <body class="docs" template="page" theme="googledevai-theme" type="reference" layout="docs" display-toc pending> <devsite-progress type="indeterminate" id="app-progress"></devsite-progress> <section class="devsite-wrapper"> <devsite-cookie-notification-bar></devsite-cookie-notification-bar><devsite-header role="banner" keep-tabs-visible> <div class="devsite-header--inner nocontent"> <div class="devsite-top-logo-row-wrapper-wrapper"> <div class="devsite-top-logo-row-wrapper"> <div class="devsite-top-logo-row"> <button type="button" id="devsite-hamburger-menu" class="devsite-header-icon-button button-flat material-icons gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Navigation menu button" visually-hidden aria-label="Open menu"> </button> <div class="devsite-product-name-wrapper"> <a href="/" class="devsite-site-logo-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Site logo" track-type="globalNav" track-name="geminiAPI" track-metadata-position="nav" track-metadata-eventDetail="nav"> <picture> <img src="https://ai.google.dev/_static/googledevai/images/lockup-new.svg" class="devsite-site-logo" alt="Gemini API"> </picture> </a> <ul class="devsite-breadcrumb-list" > <li class="devsite-breadcrumb-item "> </li> </ul> </div> <div class="devsite-top-logo-row-middle"> <div class="devsite-header-upper-tabs"> <devsite-tabs class="upper-tabs"> <nav class="devsite-tabs-wrapper" aria-label="Upper tabs"> <tab class="devsite-active"> <a href="https://ai.google.dev/gemini-api/docs" track-metadata-eventdetail="https://ai.google.dev/gemini-api/docs" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - gemini api" track-metadata-module="primary nav" aria-label="Gemini API, selected" data-category="Site-Wide Custom Events" data-label="Tab: Gemini API" track-name="gemini api" > Gemini API </a> </tab> <tab > <a href="https://aistudio.google.com" track-metadata-eventdetail="https://aistudio.google.com" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - google ai studio" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Google AI Studio" track-name="google ai studio" > Google AI Studio </a> </tab> <tab > <a href="https://ai.google.dev/gemma" track-metadata-eventdetail="https://ai.google.dev/gemma" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - gemma" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Gemma" track-name="gemma" > Gemma </a> </tab> <tab > <a href="https://ai.google.dev/edge" track-metadata-eventdetail="https://ai.google.dev/edge" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - google ai edge" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Google AI Edge" track-name="google ai edge" > Google AI Edge </a> </tab> <tab class="devsite-dropdown "> <span class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - tools" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Tools" track-name="tools" > Tools <a href="#" role="button" aria-haspopup="true" aria-expanded="false" aria-label="Dropdown menu for Tools" track-type="nav" track-metadata-eventdetail="" track-metadata-position="nav - tools" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Tools" track-name="tools" class="devsite-tabs-dropdown-toggle devsite-icon devsite-icon-arrow-drop-down"></a> <div class="devsite-tabs-dropdown" aria-label="submenu" hidden> <div class="devsite-tabs-dropdown-content"> <div class="devsite-tabs-dropdown-column "> <ul class="devsite-tabs-dropdown-section "> <li class="devsite-nav-item"> <a href="https://ai.google.dev/responsible" track-type="nav" track-metadata-eventdetail="https://ai.google.dev/responsible" track-metadata-position="nav - tools" track-metadata-module="tertiary nav" tooltip > <div class="devsite-nav-item-title"> Responsible GenAI Toolkit </div> </a> </li> <li class="devsite-nav-item"> <a href="https://colab.google/" track-type="nav" track-metadata-eventdetail="https://colab.google/" track-metadata-position="nav - tools" track-metadata-module="tertiary nav" tooltip > <div class="devsite-nav-item-title"> Colab </div> </a> </li> <li class="devsite-nav-item"> <a href="https://firebase.google.com/docs/genkit" track-type="nav" track-metadata-eventdetail="https://firebase.google.com/docs/genkit" track-metadata-position="nav - tools" track-metadata-module="tertiary nav" tooltip > <div class="devsite-nav-item-title"> Firebase Genkit </div> </a> </li> <li class="devsite-nav-item"> <a href="https://jax.readthedocs.io/" track-type="nav" track-metadata-eventdetail="https://jax.readthedocs.io/" track-metadata-position="nav - tools" track-metadata-module="tertiary nav" tooltip > <div class="devsite-nav-item-title"> JAX </div> </a> </li> <li class="devsite-nav-item"> <a href="https://keras.io/" track-type="nav" track-metadata-eventdetail="https://keras.io/" track-metadata-position="nav - tools" track-metadata-module="tertiary nav" tooltip > <div class="devsite-nav-item-title"> Keras </div> </a> </li> <li class="devsite-nav-item"> <a href="https://www.tensorflow.org/" track-type="nav" track-metadata-eventdetail="https://www.tensorflow.org/" track-metadata-position="nav - tools" track-metadata-module="tertiary nav" tooltip > <div class="devsite-nav-item-title"> TensorFlow </div> </a> </li> </ul> </div> </div> </div> </tab> <tab > <a href="https://discuss.ai.google.dev/" track-metadata-eventdetail="https://discuss.ai.google.dev/" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - community" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Community" track-name="community" > Community </a> </tab> </nav> </devsite-tabs> </div> <devsite-search enable-signin enable-search enable-suggestions enable-query-completion project-name="Gemini API" tenant-name="Google AI for Developers" > <form class="devsite-search-form" action="https://ai.google.dev/s/results" method="GET"> <div class="devsite-search-container"> <button type="button" search-open class="devsite-search-button devsite-header-icon-button button-flat material-icons" aria-label="Open search"></button> <div class="devsite-searchbox"> <input aria-activedescendant="" aria-autocomplete="list" aria-label="Search" aria-expanded="false" aria-haspopup="listbox" autocomplete="off" class="devsite-search-field devsite-search-query" name="q" placeholder="Search" role="combobox" type="text" value="" > <div class="devsite-search-image material-icons" aria-hidden="true"> </div> <div class="devsite-search-shortcut-icon-container" aria-hidden="true"> <kbd class="devsite-search-shortcut-icon">/</kbd> </div> </div> </div> </form> <button type="button" search-close class="devsite-search-button devsite-header-icon-button button-flat material-icons" aria-label="Close search"></button> </devsite-search> </div> <devsite-language-selector> <ul role="presentation"> <li role="presentation"> <a role="menuitem" lang="en" >English</a> </li> <li role="presentation"> <a role="menuitem" lang="de" >Deutsch</a> </li> <li role="presentation"> <a role="menuitem" lang="es_419" >Español – América Latina</a> </li> <li role="presentation"> <a role="menuitem" lang="fr" >Français</a> </li> <li role="presentation"> <a role="menuitem" lang="id" >Indonesia</a> </li> <li role="presentation"> <a role="menuitem" lang="it" >Italiano</a> </li> <li role="presentation"> <a role="menuitem" lang="pl" >Polski</a> </li> <li role="presentation"> <a role="menuitem" lang="pt_br" >Português – Brasil</a> </li> <li role="presentation"> <a role="menuitem" lang="vi" >Tiếng Việt</a> </li> <li role="presentation"> <a role="menuitem" lang="tr" >Türkçe</a> </li> <li role="presentation"> <a role="menuitem" lang="ru" >Русский</a> </li> <li role="presentation"> <a role="menuitem" lang="he" >עברית</a> </li> <li role="presentation"> <a role="menuitem" lang="ar" >العربيّة</a> </li> <li role="presentation"> <a role="menuitem" lang="fa" >فارسی</a> </li> <li role="presentation"> <a role="menuitem" lang="hi" >हिंदी</a> </li> <li role="presentation"> <a role="menuitem" lang="bn" >বাংলা</a> </li> <li role="presentation"> <a role="menuitem" lang="th" >ภาษาไทย</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_cn" >中文 – 简体</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_tw" >中文 – 繁體</a> </li> <li role="presentation"> <a role="menuitem" lang="ja" >日本語</a> </li> <li role="presentation"> <a role="menuitem" lang="ko" >한국어</a> </li> </ul> </devsite-language-selector> <devsite-user enable-profiles id="devsite-user"> Sign in </devsite-user> </div> </div> </div> <div class="devsite-collapsible-section "> <div class="devsite-header-background"> <div class="devsite-doc-set-nav-row"> <devsite-tabs class="lower-tabs"> <nav class="devsite-tabs-wrapper" aria-label="Lower tabs"> <tab > <a href="https://ai.google.dev/gemini-api/docs" track-metadata-eventdetail="https://ai.google.dev/gemini-api/docs" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - docs" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Docs" track-name="docs" > Docs </a> </tab> <tab class="devsite-active"> <a href="https://ai.google.dev/api" track-metadata-eventdetail="https://ai.google.dev/api" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - api reference" track-metadata-module="primary nav" aria-label="API Reference, selected" data-category="Site-Wide Custom Events" data-label="Tab: API Reference" track-name="api reference" > API Reference </a> </tab> <tab > <a href="https://ai.google.dev/pricing" track-metadata-eventdetail="https://ai.google.dev/pricing" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - pricing" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Pricing" track-name="pricing" > Pricing </a> </tab> </nav> </devsite-tabs> </div> </div> </div> </div> </devsite-header> <devsite-book-nav scrollbars > <div class="devsite-book-nav-filter" hidden> <input type="text" placeholder="Filter" aria-label="Type to filter" role="searchbox"> </div> <nav class="devsite-book-nav devsite-nav nocontent" aria-label="Side menu"> <div class="devsite-mobile-header"> <button type="button" id="devsite-close-nav" class="devsite-header-icon-button button-flat material-icons gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Close navigation" aria-label="Close navigation"> </button> <div class="devsite-product-name-wrapper"> <a href="/" class="devsite-site-logo-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Site logo" track-type="globalNav" track-name="geminiAPI" track-metadata-position="nav" track-metadata-eventDetail="nav"> <picture> <img src="https://ai.google.dev/_static/googledevai/images/lockup-new.svg" class="devsite-site-logo" alt="Gemini API"> </picture> </a> <ul class="devsite-breadcrumb-list" > <li class="devsite-breadcrumb-item "> </li> </ul> </div> </div> <div class="devsite-book-nav-wrapper"> <div class="devsite-mobile-nav-top"> <ul class="devsite-nav-list"> <li class="devsite-nav-item"> <a href="/gemini-api/docs" class="devsite-nav-title gc-analytics-event devsite-nav-active" data-category="Site-Wide Custom Events" data-label="Tab: Gemini API" track-name="gemini api" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Gemini API" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Gemini API </a> <ul class="devsite-nav-responsive-tabs"> <li class="devsite-nav-item"> <a href="/gemini-api/docs" class="devsite-nav-title gc-analytics-event devsite-nav-has-children " data-category="Site-Wide Custom Events" data-label="Tab: Docs" track-name="docs" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Docs" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Docs </a> </li> <li class="devsite-nav-item"> <a href="/api" class="devsite-nav-title gc-analytics-event devsite-nav-has-children devsite-nav-active" data-category="Site-Wide Custom Events" data-label="Tab: API Reference" track-name="api reference" data-category="Site-Wide Custom Events" data-label="Responsive Tab: API Reference" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> API Reference </a> </li> <li class="devsite-nav-item"> <a href="/pricing" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Tab: Pricing" track-name="pricing" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Pricing" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Pricing </a> </li> </ul> </li> <li class="devsite-nav-item"> <a href="https://aistudio.google.com" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Tab: Google AI Studio" track-name="google ai studio" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google AI Studio" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google AI Studio </a> </li> <li class="devsite-nav-item"> <a href="/gemma" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Tab: Gemma" track-name="gemma" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Gemma" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Gemma </a> </li> <li class="devsite-nav-item"> <a href="/edge" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Tab: Google AI Edge" track-name="google ai edge" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Google AI Edge" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Google AI Edge </a> </li> <li class="devsite-nav-item"> Tools <ul class="devsite-nav-responsive-tabs devsite-nav-has-menu "> <li class="devsite-nav-item"> More </li> </ul> </li> <li class="devsite-nav-item"> <a href="https://discuss.ai.google.dev/" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Tab: Community" track-name="community" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Community" track-type="globalNav" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Community </a> </li> </ul> </div> <div class="devsite-mobile-nav-bottom"> <ul class="devsite-nav-list" menu="_book"> <li class="devsite-nav-item"><a href="/api" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api" >Overview</a></li> <li class="devsite-nav-item"><a href="/gemini-api/docs/api-versions" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /gemini-api/docs/api-versions" track-type="bookNav" track-name="click" track-metadata-eventdetail="/gemini-api/docs/api-versions" >API versions</a></li> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> Capabilities </div></li> <li class="devsite-nav-item"><a href="/api/models" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/models" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/models" >Models</a></li> <li class="devsite-nav-item"><a href="/api/generate-content" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/generate-content" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/generate-content" >Generating content</a></li> <li class="devsite-nav-item"><a href="/api/tokens" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/tokens" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/tokens" >Tokens</a></li> <li class="devsite-nav-item"><a href="/api/files" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/files" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/files" >Files</a></li> <li class="devsite-nav-item"><a href="/api/caching" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/caching" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/caching" >Caching</a></li> <li class="devsite-nav-item"><a href="/api/embeddings" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/embeddings" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/embeddings" >Embeddings</a></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Tuning </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/api/tuning" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/tuning" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/tuning" >Tuning</a></li><li class="devsite-nav-item"><a href="/api/tuning/permissions" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/tuning/permissions" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/tuning/permissions" >Permissions</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Semantic retrieval </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/api/semantic-retrieval/question-answering" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/semantic-retrieval/question-answering" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/semantic-retrieval/question-answering" >Question answering</a></li><li class="devsite-nav-item"><a href="/api/semantic-retrieval/corpora" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/semantic-retrieval/corpora" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/semantic-retrieval/corpora" >Corpus</a></li><li class="devsite-nav-item"><a href="/api/semantic-retrieval/documents" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/semantic-retrieval/documents" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/semantic-retrieval/documents" >Document</a></li><li class="devsite-nav-item"><a href="/api/semantic-retrieval/chunks" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/semantic-retrieval/chunks" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/semantic-retrieval/chunks" >Chunk</a></li><li class="devsite-nav-item"><a href="/api/semantic-retrieval/permissions" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/semantic-retrieval/permissions" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/semantic-retrieval/permissions" >Permissions</a></li></ul></div></li> <li class="devsite-nav-item"><a href="/api/all-methods" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/all-methods" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/all-methods" >All methods</a></li> <li class="devsite-nav-item devsite-nav-expandable devsite-nav-deprecated"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Deprecated </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/api/palm" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /api/palm" track-type="bookNav" track-name="click" track-metadata-eventdetail="/api/palm" >PaLM (decomissioned)</a></li></ul></div></li> </ul> <ul class="devsite-nav-list" menu="Tools" aria-label="Side menu" hidden> <li class="devsite-nav-item"> <a href="/responsible" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Responsible GenAI Toolkit" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Responsible GenAI Toolkit </a> </li> <li class="devsite-nav-item"> <a href="https://colab.google/" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Colab" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Colab </a> </li> <li class="devsite-nav-item"> <a href="https://firebase.google.com/docs/genkit" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Firebase Genkit" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Firebase Genkit </a> </li> <li class="devsite-nav-item"> <a href="https://jax.readthedocs.io/" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: JAX" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> JAX </a> </li> <li class="devsite-nav-item"> <a href="https://keras.io/" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: Keras" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Keras </a> </li> <li class="devsite-nav-item"> <a href="https://www.tensorflow.org/" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Responsive Tab: TensorFlow" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> TensorFlow </a> </li> </ul> </div> </div> </nav> </devsite-book-nav> <section id="gc-wrapper"> <main role="main" class="devsite-main-content" has-book-nav has-sidebar > <div class="devsite-sidebar"> <div class="devsite-sidebar-content"> <devsite-toc class="devsite-nav" role="navigation" aria-label="On this page" depth="2" scrollbars ></devsite-toc> <devsite-recommendations-sidebar class="nocontent devsite-nav"> </devsite-recommendations-sidebar> </div> </div> <devsite-content> <article class="devsite-article"> <div class="devsite-article-meta nocontent" role="navigation"> <ul class="devsite-breadcrumb-list" aria-label="Breadcrumb"> <li class="devsite-breadcrumb-item "> <a href="https://ai.google.dev/" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="1" track-type="globalNav" track-name="breadcrumb" track-metadata-position="1" track-metadata-eventdetail="" > Home </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://ai.google.dev/gemini-api" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="2" track-type="globalNav" track-name="breadcrumb" track-metadata-position="2" track-metadata-eventdetail="Gemini API" > Gemini API </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://ai.google.dev/api" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="3" track-type="globalNav" track-name="breadcrumb" track-metadata-position="3" track-metadata-eventdetail="" > API Reference </a> </li> </ul> <devsite-thumb-rating position="header"> </devsite-thumb-rating> </div> <devsite-feedback position="header" project-name="Gemini API" product-id="5292923" bucket="documentation" context="" version="t-devsite-webserver-20241114-r00-rc02.464921008191574316" data-label="Send Feedback Button" track-type="feedback" track-name="sendFeedbackLink" track-metadata-position="header" class="nocontent" project-icon="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/googledevai/images/touchicon-180-new.png" > <button> Send feedback </button> </devsite-feedback> <h1 class="devsite-page-title" tabindex="-1"> Generating content </h1> <div class="devsite-page-title-meta"><devsite-view-release-notes></devsite-view-release-notes></div> <devsite-toc class="devsite-nav" depth="2" devsite-toc-embedded > </devsite-toc> <div class="devsite-article-body clearfix "> The Gemini API supports content generation with images, audio, code, tools, and more. For details on each of these features, read on and check out the task-focused sample code, or read the comprehensive guides. <ul> <li><a href="https://ai.google.dev/gemini-api/docs/text-generation">Text generation</a></li> <li><a href="https://ai.google.dev/gemini-api/docs/vision">Vision</a></li> <li><a href="https://ai.google.dev/gemini-api/docs/audio">Audio</a></li> <li><a href="https://ai.google.dev/gemini-api/docs/long-context">Long context</a></li> <li><a href="https://ai.google.dev/gemini-api/docs/code-execution">Code execution</a></li> <li><a href="https://ai.google.dev/gemini-api/docs/json-mode">JSON Mode</a></li> <li><a href="https://ai.google.dev/gemini-api/docs/function-calling">Function calling</a></li> <li><a href="https://ai.google.dev/gemini-api/docs/system-instructions">System instructions</a></li> </ul> <style> @media screen and (max-width: 2099px) { devsite-toc.devsite-toc,devsite-toc[visible].devsite-toc { display:none } devsite-toc.devsite-toc-embedded:not(:empty) { display: block; margin: 28px 0 24px } body[layout][concierge] devsite-toc.devsite-toc-embedded { display: none } devsite-toc.devsite-toc-embedded:not(:empty)~.devsite-article-body>:first-child { margin-top: 0 } body[template=landing] devsite-toc.devsite-toc-embedded:not(:empty) { margin: 20px 40px 24px } } body[layout=docs] .devsite-main-content[has-book-nav], body[layout=docs] .devsite-main-content[has-book-nav][has-sidebar], body[layout=docs][concierge] .devsite-main-content[has-book-nav], body[layout=docs][concierge] .devsite-main-content[has-book-nav][has-sidebar] { grid-template-columns: minmax(269px, 1fr) minmax(365px, 1600px) 1fr; } body[layout=docs] devsite-content, body[layout=docs][concierge] devsite-content { width: 100%; max-width: 1600px; } .prototype { code { padding: 0; word-break: break-all; } devsite-selector { font-size: 0.9rem; devsite-tabs tab > a { font-size: 0.9rem; } devsite-selector { margin: 12px -23px 0; } } devsite-code pre { margin: 0; padding-block: 12px; padding-inline: 12px; max-height: 600px; font-size: 0.8rem; code { font-size: 0.8rem; } } .code-shrink { zoom: 80%; } .endpoint { display: inline-flex; flex-wrap: nowrap; flex-direction: row; align-items: baseline; justify-content: flex-start; column-gap: 12px; padding: 4px 8px; color: var(--devsite-ref-palette--grey800, #3c4043); background: var(--devsite-ref-palette--grey100, #f1f3f4); border: 1px solid var(--devsite-ref-palette--grey500, #9aa0a6); border-radius: 4px; /* Sys > Typography > Core Composites - Desktop/Overline-s */ font-family: Roboto; font-size: 14px; font-style: normal; font-weight: 500; line-height: 16px; /* 145.455% */ letter-spacing: 0.8px; .http-method { color: var(--devsite-ref-palette--green900, #0d652d); font-size: 12px; text-transform: uppercase; } .endpoint-url { display: inline-block; } } .field-entry { display: flex; flex-direction: column; align-items: initial; justify-content: initial; overflow: hidden; margin: 24px 0 0 12px; p { margin: 0; font-family: Roboto; font-size: 14px; font-style: normal; font-weight: 400; line-height: 20px; /* 166.667% */ } .signature { display: flex; flex-direction: row; flex-wrap: wrap; align-items: flex-end; justify-content: initial; overflow: hidden; column-gap: 12px; row-gap: 0; .field-name { display: inline-block; padding-block: 2px; padding-inline: 0; font-weight: 500; } .field-type { display: inline-block; padding-block: 2px; padding-inline: 0; opacity: 0.66; font-size: 0.9em; } .field-nessesity { display: inline-block; padding: 2px 0; &.required { color: red; } &.optional { color: rgba(0, 0, 0, 0.66); } } } .field-description { display: inline-block; margin-top: 4px; } &.union-type { .union-type-preamble { display: flex; flex-direction: column; align-items: initial; justify-content: initial; row-gap: 12px; } /* nested field-entry styles */ .field-entry { border-left: solid 1px #a8a8a8; padding-inline: 12px 0; } } } .column-container { display: flex; flex-direction: row; flex-wrap: wrap; align-items: initial; justify-content: initial; max-width: 1600px; gap: 0 24px; .reference { flex: 1 1 0; min-width: 400px; } .second-column { flex: 1 1 0; min-width: 350px; position: sticky; top: 110px; height: 100%; } } } </style><div itemscope="" itemtype="http://developers.google.com/ReferenceObject"><h2 id="method:-models.generatecontent" data-text="Method: models.generateContent" tabindex="-1">Method: models.generateContent</h2><a name="v1beta.models.generateContent"></a> <meta content="generateContent" itemprop="name"/> <meta content="/api/rest/v1beta/models/generateContent" itemprop="path"/> <section class="prototype" id="/api/rest/v1beta/models/generateContent"> <ul class="toc"> <li><a href="#body.HTTP_TEMPLATE">Endpoint</a></li><li><a href="#body.PATH_PARAMETERS">Path parameters</a></li><li><a href="#body.request_body">Request body</a> <ul> <li><a href="#body.request_body.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#body.response_body">Response body</a></li><li><a href="#body.aspect">Authorization scopes</a></li><li><a href="#body.codeSnippets">Example request</a> <ul> <li><a href="#body.codeSnippets.group">Text</a></li><li><a href="#body.codeSnippets.group_1">Image</a></li><li><a href="#body.codeSnippets.group_2">Audio</a></li><li><a href="#body.codeSnippets.group_3">Video</a></li><li><a href="#body.codeSnippets.group_4">PDF</a></li><li><a href="#body.codeSnippets.group_5">Chat</a></li><li><a href="#body.codeSnippets.group_6">Cache</a></li><li><a href="#body.codeSnippets.group_7">Tuned Model</a></li><li><a href="#body.codeSnippets.group_8">JSON Mode</a></li><li><a href="#body.codeSnippets.group_9">Code execution</a></li><li><a href="#body.codeSnippets.group_10">Function Calling</a></li><li><a href="#body.codeSnippets.group_11">Generation config</a></li><li><a href="#body.codeSnippets.group_12">Safety Settings</a></li><li><a href="#body.codeSnippets.group_13">System Instruction</a></li> </ul> </li> </ul> <section id="google.ai.generativelanguage.v1beta.GenerativeService.GenerateContent"> </section> <section id="description"> Generates a model response given an input <code translate="no" dir="ltr">GenerateContentRequest</code>. Refer to the <a href="https://ai.google.dev/gemini-api/docs/text-generation">text generation guide</a> for detailed usage information. Input capabilities differ between models, including tuned models. Refer to the <a href="https://ai.google.dev/gemini-api/docs/models/gemini">model guide</a> and <a href="https://ai.google.dev/gemini-api/docs/model-tuning">tuning guide</a> for details. </section> <div class="column-container"> <div class="reference"> <section id="body.HTTP_TEMPLATE"> <h3 id="endpoint" data-text="Endpoint" tabindex="-1">Endpoint</h3> post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateContent </section> <section id="body.PATH_PARAMETERS"> <h3 id="path-parameters" data-text="Path parameters" tabindex="-1">Path parameters</h3> <section id="body.PATH_PARAMETERS.model"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">model</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Required. The name of the <code translate="no" dir="ltr">Model</code> to use for generating the completion.Format: <code translate="no" dir="ltr">name=models/{model}</code>. It takes the form <code translate="no" dir="ltr">models/{model}</code>. </div> </div> </section> </section> <section id="body.request_body"> <h3 id="request-body" data-text="Request body" tabindex="-1">Request body</h3> The request body contains data with the following structure: <section id="body.request_body.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="body.request_body.FIELDS.contents"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">contents[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/caching#Content">Content</a></code>)</code> </div> <div class="field-description"> Required. The content of the current conversation with the model.For single-turn queries, this is a single instance. For multi-turn queries like <a href="https://ai.google.dev/gemini-api/docs/text-generation#chat">chat</a>, this is a repeated field that contains the conversation history and the latest request. </div> </div> </section> <section id="body.request_body.FIELDS.tools"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">tools[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/caching#Tool">Tool</a></code>)</code> </div> <div class="field-description"> Optional. A list of <code translate="no" dir="ltr">Tools</code> the <code translate="no" dir="ltr">Model</code> may use to generate the next response.A <code translate="no" dir="ltr">Tool</code> is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the <code translate="no" dir="ltr">Model</code>. Supported <code translate="no" dir="ltr">Tool</code>s are <code translate="no" dir="ltr">Function</code> and <code translate="no" dir="ltr">codeExecution</code>. Refer to the <a href="https://ai.google.dev/gemini-api/docs/function-calling">Function calling</a> and the <a href="https://ai.google.dev/gemini-api/docs/code-execution">Code execution</a> guides to learn more. </div> </div> </section> <section id="body.request_body.FIELDS.tool_config"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">toolConfig</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/caching#ToolConfig">ToolConfig</a></code>)</code> </div> <div class="field-description"> Optional. Tool configuration for any <code translate="no" dir="ltr">Tool</code> specified in the request. Refer to the <a href="https://ai.google.dev/gemini-api/docs/function-calling#function_calling_mode">Function calling guide</a> for a usage example. </div> </div> </section> <section id="body.request_body.FIELDS.safety_settings"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">safetySettings[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.SafetySetting">SafetySetting</a></code>)</code> </div> <div class="field-description"> Optional. A list of unique <code translate="no" dir="ltr">SafetySetting</code> instances for blocking unsafe content.This will be enforced on the <code translate="no" dir="ltr">GenerateContentRequest.contents</code> and <code translate="no" dir="ltr">GenerateContentResponse.candidates</code>. There should not be more than one setting for each <code translate="no" dir="ltr">SafetyCategory</code> type. The API will block any contents and responses that fail to meet the thresholds set by these settings. This list overrides the default settings for each <code translate="no" dir="ltr">SafetyCategory</code> specified in the safetySettings. If there is no <code translate="no" dir="ltr">SafetySetting</code> for a given <code translate="no" dir="ltr">SafetyCategory</code> provided in the list, the API will use the default safety setting for that category. Harm categories HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT are supported. Refer to the <a href="https://ai.google.dev/gemini-api/docs/safety-settings">guide</a> for detailed information on available safety settings. Also refer to the <a href="https://ai.google.dev/gemini-api/docs/safety-guidance">Safety guidance</a> to learn how to incorporate safety considerations in your AI applications. </div> </div> </section> <section id="body.request_body.FIELDS.system_instruction"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">systemInstruction</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/caching#Content">Content</a></code>)</code> </div> <div class="field-description"> Optional. Developer set <a href="https://ai.google.dev/gemini-api/docs/system-instructions">system instruction(s)</a>. Currently, text only. </div> </div> </section> <section id="body.request_body.FIELDS.generation_config"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">generationConfig</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.GenerationConfig">GenerationConfig</a></code>)</code> </div> <div class="field-description"> Optional. Configuration options for model generation and outputs. </div> </div> </section> <section id="body.request_body.FIELDS.cached_content"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">cachedContent</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Optional. The name of the content <a href="https://ai.google.dev/gemini-api/docs/caching">cached</a> to use as context to serve the prediction. Format: <code translate="no" dir="ltr">cachedContents/{cachedContent}</code> </div> </div> </section> </section> </section> </div> <div class="second-column"> <h3 id="example-request" data-text="Example request" tabindex="-1">Example request</h3> <devsite-selector> <section> <h3 id="text" data-text="Text" tabindex="-1">Text</h3> <devsite-selector> <section> <h3 id="text_gen_text_only_prompt-PYTHON" track-metadata-position="text_gen_text_only_prompt" track-metadata-region-tag="text_gen_text_only_prompt" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/text_generation.py/HEAD/text_gen_text_only_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">model = genai.GenerativeModel("gemini-1.5-flash") response = model.generate_content("Write a story about a magic backpack.") print(response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/text_generation.py#L26-L28" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/text_generation.py#text_gen_text_only_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt">text_generation.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt-JAVASCRIPT" track-metadata-position="text_gen_text_only_prompt" track-metadata-region-tag="text_gen_text_only_prompt" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/text_generation.js/HEAD/text_gen_text_only_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI } from "@google/generative-ai"; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash" }); const prompt = "Write a story about a magic backpack."; const result = await model.generateContent(prompt); console.log(result.response.text());<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/text_generation.js#L29-L37" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/text_generation.js#text_gen_text_only_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt">text_generation.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt-GO" track-metadata-position="text_gen_text_only_prompt" track-metadata-region-tag="text_gen_text_only_prompt" data-text="Go" tabindex="-1">Go</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go/HEAD/text_gen_text_only_prompt" data-code-snippet="true" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt" dir="ltr" is-upgraded syntax="Go"><code translate="no" dir="ltr">model := client.GenerativeModel("gemini-1.5-flash") resp, err := model.GenerateContent(ctx, genai.Text("Write a story about a magic backpack.")) if err != nil { log.Fatal(err) } printResponse(resp)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google/generative-ai-go/blob/f453d2d6ca8c5e76e7d8b8615b3339ce68cd378c/genai/internal/samples/docs-snippets_test.go#L50-L56" class="gc-analytics-event" data-category="github_link" data-label="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go#text_gen_text_only_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt">docs-snippets_test.go</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt-SHELL" track-metadata-position="text_gen_text_only_prompt" track-metadata-region-tag="text_gen_text_only_prompt" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/text_generation.sh/HEAD/text_gen_text_only_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr">curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:generateContent?key=$GOOGLE_API_KEY" \ -H 'Content-Type: application/json' \ -X POST \ -d '{ "contents": [{ "parts":[{"text": "Write a story about a magic backpack."}] }] }' 2> /dev/null<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/text_generation.sh#L21-L29" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/text_generation.sh#text_gen_text_only_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt">text_generation.sh</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt-KOTLIN" track-metadata-position="text_gen_text_only_prompt" track-metadata-region-tag="text_gen_text_only_prompt" data-text="Kotlin" tabindex="-1">Kotlin</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt/HEAD/text_gen_text_only_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt" dir="ltr" is-upgraded syntax="Kotlin"><code translate="no" dir="ltr">val generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case modelName = "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" above) apiKey = BuildConfig.apiKey) val prompt = "Write a story about a magic backpack." val response = generativeModel.generateContent(prompt) print(response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt#L35-L44" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt#text_gen_text_only_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt">text_generation.kt</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt-SWIFT" track-metadata-position="text_gen_text_only_prompt" track-metadata-region-tag="text_gen_text_only_prompt" data-text="Swift" tabindex="-1">Swift</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-swift/samples/TextGeneration.swift/HEAD/text_gen_text_only_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-swift/samples/TextGeneration.swift" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt" dir="ltr" is-upgraded syntax="Swift"><code translate="no" dir="ltr">let generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case name: "gemini-1.5-flash", // Access your API key from your on-demand resource .plist file (see "Set up your API key" // above) apiKey: APIKey.default ) let prompt = "Write a story about a magic backpack." let response = try await generativeModel.generateContent(prompt) if let text = response.text { print(text) }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-swift/blob/44b8ce120425f9cf53ca756f3434ca2c2696f8bd/samples/TextGeneration.swift#L36-L49" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-swift/samples/TextGeneration.swift#text_gen_text_only_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-swift/samples/TextGeneration.swift" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt">TextGeneration.swift</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt-DART" track-metadata-position="text_gen_text_only_prompt" track-metadata-region-tag="text_gen_text_only_prompt" data-text="Dart" tabindex="-1">Dart</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart/HEAD/text_gen_text_only_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt" dir="ltr" is-upgraded syntax="Dart"><code translate="no" dir="ltr">// Make sure to include this import: // import 'package:google_generative_ai/google_generative_ai.dart'; final model = GenerativeModel( model: 'gemini-1.5-flash', apiKey: apiKey, ); final prompt = 'Write a story about a magic backpack.'; final response = await model.generateContent([Content.text(prompt)]); print(response.text);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-dart/blob/76ae8f89eed4789af0be9e7876d0089909abc419/samples/dart/bin/text_generation.dart#L30-L39" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart#text_gen_text_only_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt">text_generation.dart</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt-JAVA" track-metadata-position="text_gen_text_only_prompt" track-metadata-region-tag="text_gen_text_only_prompt" data-text="Java" tabindex="-1">Java</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java/HEAD/text_gen_text_only_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt" dir="ltr" is-upgraded syntax="Java"><code translate="no" dir="ltr">// Specify a Gemini model appropriate for your use case GenerativeModel gm = new GenerativeModel( /* modelName */ "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" // above) /* apiKey */ BuildConfig.apiKey); GenerativeModelFutures model = GenerativeModelFutures.from(gm); Content content = new Content.Builder().addText("Write a story about a magic backpack.").build(); // For illustrative purposes only. You should use an executor that fits your needs. Executor executor = Executors.newSingleThreadExecutor(); ListenableFuture<GenerateContentResponse> response = model.generateContent(content); Futures.addCallback( response, new FutureCallback<GenerateContentResponse>() { @Override public void onSuccess(GenerateContentResponse result) { String resultText = result.getText(); System.out.println(resultText); } @Override public void onFailure(Throwable t) { t.printStackTrace(); } }, executor);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java#L44-L74" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java#text_gen_text_only_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt">text_generation.java</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="image" data-text="Image" tabindex="-1">Image</h3> <devsite-selector> <section> <h3 id="text_gen_multimodal_one_image_prompt-PYTHON" track-metadata-position="text_gen_multimodal_one_image_prompt" track-metadata-region-tag="text_gen_multimodal_one_image_prompt" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/text_generation.py/HEAD/text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">import PIL.Image model = genai.GenerativeModel("gemini-1.5-flash") organ = PIL.Image.open(media / "organ.jpg") response = model.generate_content(["Tell me about this instrument", organ]) print(response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/text_generation.py#L42-L47" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/text_generation.py#text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt">text_generation.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt-JAVASCRIPT" track-metadata-position="text_gen_multimodal_one_image_prompt" track-metadata-region-tag="text_gen_multimodal_one_image_prompt" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/text_generation.js/HEAD/text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI } from "@google/generative-ai"; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash" }); function fileToGenerativePart(path, mimeType) { return { inlineData: { data: Buffer.from(fs.readFileSync(path)).toString("base64"), mimeType, }, }; } const prompt = "Describe how this product might be manufactured."; // Note: The only accepted mime types are some image types, image/*. const imagePart = fileToGenerativePart( `${mediaPath}/jetpack.jpg`, "image/jpeg", ); const result = await model.generateContent([prompt, imagePart]); console.log(result.response.text());<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/text_generation.js#L62-L84" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/text_generation.js#text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt">text_generation.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt-GO" track-metadata-position="text_gen_multimodal_one_image_prompt" track-metadata-region-tag="text_gen_multimodal_one_image_prompt" data-text="Go" tabindex="-1">Go</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go/HEAD/text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt" dir="ltr" is-upgraded syntax="Go"><code translate="no" dir="ltr">model := client.GenerativeModel("gemini-1.5-flash") imgData, err := os.ReadFile(filepath.Join(testDataDir, "organ.jpg")) if err != nil { log.Fatal(err) } resp, err := model.GenerateContent(ctx, genai.Text("Tell me about this instrument"), genai.ImageData("jpeg", imgData)) if err != nil { log.Fatal(err) } printResponse(resp)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google/generative-ai-go/blob/f453d2d6ca8c5e76e7d8b8615b3339ce68cd378c/genai/internal/samples/docs-snippets_test.go#L69-L83" class="gc-analytics-event" data-category="github_link" data-label="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go#text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt">docs-snippets_test.go</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt-SHELL" track-metadata-position="text_gen_multimodal_one_image_prompt" track-metadata-region-tag="text_gen_multimodal_one_image_prompt" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/text_generation.sh/HEAD/text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr"># Use a temporary file to hold the base64 encoded image data TEMP_B64=$(mktemp) trap 'rm -f "$TEMP_B64"' EXIT base64 $B64FLAGS $IMG_PATH > "$TEMP_B64" # Use a temporary file to hold the JSON payload TEMP_JSON=$(mktemp) trap 'rm -f "$TEMP_JSON"' EXIT cat > "$TEMP_JSON" << EOF { "contents": [{ "parts":[ {"text": "Tell me about this instrument"}, { "inline_data": { "mime_type":"image/jpeg", "data": "$(cat "$TEMP_B64")" } } ] }] } EOF curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:generateContent?key=$GOOGLE_API_KEY" \ -H 'Content-Type: application/json' \ -X POST \ -d "@$TEMP_JSON" 2> /dev/null<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/text_generation.sh#L41-L70" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/text_generation.sh#text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt">text_generation.sh</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt-KOTLIN" track-metadata-position="text_gen_multimodal_one_image_prompt" track-metadata-region-tag="text_gen_multimodal_one_image_prompt" data-text="Kotlin" tabindex="-1">Kotlin</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt/HEAD/text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt" dir="ltr" is-upgraded syntax="Kotlin"><code translate="no" dir="ltr">val generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case modelName = "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" above) apiKey = BuildConfig.apiKey) val image: Bitmap = BitmapFactory.decodeResource(context.resources, R.drawable.image) val inputContent = content { image(image) text("What's in this picture?") } val response = generativeModel.generateContent(inputContent) print(response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt#L66-L80" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt#text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt">text_generation.kt</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt-SWIFT" track-metadata-position="text_gen_multimodal_one_image_prompt" track-metadata-region-tag="text_gen_multimodal_one_image_prompt" data-text="Swift" tabindex="-1">Swift</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-swift/samples/TextGeneration.swift/HEAD/text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-swift/samples/TextGeneration.swift" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt" dir="ltr" is-upgraded syntax="Swift"><code translate="no" dir="ltr">let generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case name: "gemini-1.5-flash", // Access your API key from your on-demand resource .plist file (see "Set up your API key" // above) apiKey: APIKey.default ) guard let image = UIImage(systemName: "cloud.sun") else { fatalError() } let prompt = "What's in this picture?" let response = try await generativeModel.generateContent(image, prompt) if let text = response.text { print(text) }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-swift/blob/44b8ce120425f9cf53ca756f3434ca2c2696f8bd/samples/TextGeneration.swift#L76-L92" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-swift/samples/TextGeneration.swift#text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-swift/samples/TextGeneration.swift" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt">TextGeneration.swift</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt-DART" track-metadata-position="text_gen_multimodal_one_image_prompt" track-metadata-region-tag="text_gen_multimodal_one_image_prompt" data-text="Dart" tabindex="-1">Dart</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart/HEAD/text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt" dir="ltr" is-upgraded syntax="Dart"><code translate="no" dir="ltr">// Make sure to include this import: // import 'package:google_generative_ai/google_generative_ai.dart'; final model = GenerativeModel( model: 'gemini-1.5-flash', apiKey: apiKey, ); Future<DataPart> fileToPart(String mimeType, String path) async { return DataPart(mimeType, await File(path).readAsBytes()); } final prompt = 'Describe how this product might be manufactured.'; final image = await fileToPart('image/jpeg', 'resources/jetpack.jpg'); final response = await model.generateContent([ Content.multi([TextPart(prompt), image]) ]); print(response.text);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-dart/blob/76ae8f89eed4789af0be9e7876d0089909abc419/samples/dart/bin/text_generation.dart#L62-L79" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart#text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt">text_generation.dart</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt-JAVA" track-metadata-position="text_gen_multimodal_one_image_prompt" track-metadata-region-tag="text_gen_multimodal_one_image_prompt" data-text="Java" tabindex="-1">Java</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java/HEAD/text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt" dir="ltr" is-upgraded syntax="Java"><code translate="no" dir="ltr">// Specify a Gemini model appropriate for your use case GenerativeModel gm = new GenerativeModel( /* modelName */ "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" // above) /* apiKey */ BuildConfig.apiKey); GenerativeModelFutures model = GenerativeModelFutures.from(gm); Bitmap image = BitmapFactory.decodeResource(context.getResources(), R.drawable.image); Content content = new Content.Builder() .addText("What's different between these pictures?") .addImage(image) .build(); // For illustrative purposes only. You should use an executor that fits your needs. Executor executor = Executors.newSingleThreadExecutor(); ListenableFuture<GenerateContentResponse> response = model.generateContent(content); Futures.addCallback( response, new FutureCallback<GenerateContentResponse>() { @Override public void onSuccess(GenerateContentResponse result) { String resultText = result.getText(); System.out.println(resultText); } @Override public void onFailure(Throwable t) { t.printStackTrace(); } }, executor);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java#L124-L159" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java#text_gen_multimodal_one_image_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt">text_generation.java</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="audio" data-text="Audio" tabindex="-1">Audio</h3> <devsite-selector> <section> <h3 id="text_gen_multimodal_audio-PYTHON" track-metadata-position="text_gen_multimodal_audio" track-metadata-region-tag="text_gen_multimodal_audio" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/text_generation.py/HEAD/text_gen_multimodal_audio" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_audio" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">model = genai.GenerativeModel("gemini-1.5-flash") sample_audio = genai.upload_file(media / "sample.mp3") response = model.generate_content(["Give me a summary of this audio file.", sample_audio]) print(response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/text_generation.py#L93-L96" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/text_generation.py#text_gen_multimodal_audio" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_audio">text_generation.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_audio-JAVASCRIPT" track-metadata-position="text_gen_multimodal_audio" track-metadata-region-tag="text_gen_multimodal_audio" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/text_generation.js/HEAD/text_gen_multimodal_audio" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_audio" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI } from "@google/generative-ai"; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash" }); function fileToGenerativePart(path, mimeType) { return { inlineData: { data: Buffer.from(fs.readFileSync(path)).toString("base64"), mimeType, }, }; } const prompt = "Give me a summary of this audio file."; // Note: The only accepted mime types are some image types, image/*. const audioPart = fileToGenerativePart( `${mediaPath}/samplesmall.mp3`, "audio/mp3", ); const result = await model.generateContent([prompt, audioPart]); console.log(result.response.text());<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/text_generation.js#L192-L214" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/text_generation.js#text_gen_multimodal_audio" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_audio">text_generation.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_audio-SHELL" track-metadata-position="text_gen_multimodal_audio" track-metadata-region-tag="text_gen_multimodal_audio" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/text_generation.sh/HEAD/text_gen_multimodal_audio" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_audio" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr"># Use File API to upload audio data to API request. MIME_TYPE=$(file -b --mime-type "${AUDIO_PATH}") NUM_BYTES=$(wc -c < "${AUDIO_PATH}") DISPLAY_NAME=AUDIO tmp_header_file=upload-header.tmp # Initial resumable request defining metadata. # The upload url is in the response headers dump them to a file. curl "${BASE_URL}/upload/v1beta/files?key=${GOOGLE_API_KEY}" \ -D upload-header.tmp \ -H "X-Goog-Upload-Protocol: resumable" \ -H "X-Goog-Upload-Command: start" \ -H "X-Goog-Upload-Header-Content-Length: ${NUM_BYTES}" \ -H "X-Goog-Upload-Header-Content-Type: ${MIME_TYPE}" \ -H "Content-Type: application/json" \ -d "{'file': {'display_name': '${DISPLAY_NAME}'}}" 2> /dev/null upload_url=$(grep -i "x-goog-upload-url: " "${tmp_header_file}" | cut -d" " -f2 | tr -d "\r") rm "${tmp_header_file}" # Upload the actual bytes. curl "${upload_url}" \ -H "Content-Length: ${NUM_BYTES}" \ -H "X-Goog-Upload-Offset: 0" \ -H "X-Goog-Upload-Command: upload, finalize" \ --data-binary "@${AUDIO_PATH}" 2> /dev/null > file_info.json file_uri=$(jq ".file.uri" file_info.json) echo file_uri=$file_uri curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:generateContent?key=$GOOGLE_API_KEY" \ -H 'Content-Type: application/json' \ -X POST \ -d '{ "contents": [{ "parts":[ {"text": "Please describe this file."}, {"file_data":{"mime_type": "audio/mpeg", "file_uri": '$file_uri'}}] }] }' 2> /dev/null > response.json cat response.json echo jq ".candidates[].content.parts[].text" response.json<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/text_generation.sh#L174-L220" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/text_generation.sh#text_gen_multimodal_audio" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_audio">text_generation.sh</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="video" data-text="Video" tabindex="-1">Video</h3> <devsite-selector> <section> <h3 id="text_gen_multimodal_video_prompt-PYTHON" track-metadata-position="text_gen_multimodal_video_prompt" track-metadata-region-tag="text_gen_multimodal_video_prompt" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/text_generation.py/HEAD/text_gen_multimodal_video_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_video_prompt" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">import time # Video clip (CC BY 3.0) from https://peach.blender.org/download/ myfile = genai.upload_file(media / "Big_Buck_Bunny.mp4") print(f"{myfile=}") # Videos need to be processed before you can use them. while myfile.state.name == "PROCESSING": print("processing video...") time.sleep(5) myfile = genai.get_file(myfile.name) model = genai.GenerativeModel("gemini-1.5-flash") response = model.generate_content([myfile, "Describe this video clip"]) print(f"{response.text=}")<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/text_generation.py#L112-L126" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/text_generation.py#text_gen_multimodal_video_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_video_prompt">text_generation.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_video_prompt-JAVASCRIPT" track-metadata-position="text_gen_multimodal_video_prompt" track-metadata-region-tag="text_gen_multimodal_video_prompt" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/text_generation.js/HEAD/text_gen_multimodal_video_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_video_prompt" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI } from "@google/generative-ai"; // import { GoogleAIFileManager, FileState } from "@google/generative-ai/server"; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash" }); const fileManager = new GoogleAIFileManager(process.env.API_KEY); const uploadResult = await fileManager.uploadFile( `${mediaPath}/Big_Buck_Bunny.mp4`, { mimeType: "video/mp4" }, ); let file = await fileManager.getFile(uploadResult.file.name); while (file.state === FileState.PROCESSING) { process.stdout.write("."); // Sleep for 10 seconds await new Promise((resolve) => setTimeout(resolve, 10_000)); // Fetch the file from the API again file = await fileManager.getFile(uploadResult.file.name); } if (file.state === FileState.FAILED) { throw new Error("Video processing failed."); } const prompt = "Describe this video clip"; const videoPart = { fileData: { fileUri: uploadResult.file.uri, mimeType: uploadResult.file.mimeType, }, }; const result = await model.generateContent([prompt, videoPart]); console.log(result.response.text());<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/text_generation.js#L220-L255" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/text_generation.js#text_gen_multimodal_video_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_video_prompt">text_generation.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_video_prompt-GO" track-metadata-position="text_gen_multimodal_video_prompt" track-metadata-region-tag="text_gen_multimodal_video_prompt" data-text="Go" tabindex="-1">Go</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go/HEAD/text_gen_multimodal_video_prompt" data-code-snippet="true" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_video_prompt" dir="ltr" is-upgraded syntax="Go"><code translate="no" dir="ltr">model := client.GenerativeModel("gemini-1.5-flash") file, err := client.UploadFileFromPath(ctx, filepath.Join(testDataDir, "earth.mp4"), nil) if err != nil { log.Fatal(err) } defer client.DeleteFile(ctx, file.Name) // Videos need to be processed before you can use them. for file.State == genai.FileStateProcessing { log.Printf("processing %s", file.Name) time.Sleep(5 * time.Second) var err error if file, err = client.GetFile(ctx, file.Name); err != nil { log.Fatal(err) } } if file.State != genai.FileStateActive { log.Fatalf("uploaded file has state %s, not active", file.State) } resp, err := model.GenerateContent(ctx, genai.Text("Describe this video clip"), genai.FileData{URI: file.URI}) if err != nil { log.Fatal(err) } printResponse(resp)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google/generative-ai-go/blob/f453d2d6ca8c5e76e7d8b8615b3339ce68cd378c/genai/internal/samples/docs-snippets_test.go#L96-L124" class="gc-analytics-event" data-category="github_link" data-label="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go#text_gen_multimodal_video_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_video_prompt">docs-snippets_test.go</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_video_prompt-SHELL" track-metadata-position="text_gen_multimodal_video_prompt" track-metadata-region-tag="text_gen_multimodal_video_prompt" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/text_generation.sh/HEAD/text_gen_multimodal_video_prompt" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_video_prompt" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr"># Use File API to upload audio data to API request. MIME_TYPE=$(file -b --mime-type "${VIDEO_PATH}") NUM_BYTES=$(wc -c < "${VIDEO_PATH}") DISPLAY_NAME=VIDEO # Initial resumable request defining metadata. # The upload url is in the response headers dump them to a file. curl "${BASE_URL}/upload/v1beta/files?key=${GOOGLE_API_KEY}" \ -D "${tmp_header_file}" \ -H "X-Goog-Upload-Protocol: resumable" \ -H "X-Goog-Upload-Command: start" \ -H "X-Goog-Upload-Header-Content-Length: ${NUM_BYTES}" \ -H "X-Goog-Upload-Header-Content-Type: ${MIME_TYPE}" \ -H "Content-Type: application/json" \ -d "{'file': {'display_name': '${DISPLAY_NAME}'}}" 2> /dev/null upload_url=$(grep -i "x-goog-upload-url: " "${tmp_header_file}" | cut -d" " -f2 | tr -d "\r") rm "${tmp_header_file}" # Upload the actual bytes. curl "${upload_url}" \ -H "Content-Length: ${NUM_BYTES}" \ -H "X-Goog-Upload-Offset: 0" \ -H "X-Goog-Upload-Command: upload, finalize" \ --data-binary "@${VIDEO_PATH}" 2> /dev/null > file_info.json file_uri=$(jq ".file.uri" file_info.json) echo file_uri=$file_uri state=$(jq ".file.state" file_info.json) echo state=$state name=$(jq ".file.name" file_info.json) echo name=$name while [[ "($state)" = *"PROCESSING"* ]]; do echo "Processing video..." sleep 5 # Get the file of interest to check state curl https://generativelanguage.googleapis.com/v1beta/files/$name > file_info.json state=$(jq ".file.state" file_info.json) done curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:generateContent?key=$GOOGLE_API_KEY" \ -H 'Content-Type: application/json' \ -X POST \ -d '{ "contents": [{ "parts":[ {"text": "Transcribe the audio from this video, giving timestamps for salient events in the video. Also provide visual descriptions."}, {"file_data":{"mime_type": "video/mp4", "file_uri": '$file_uri'}}] }] }' 2> /dev/null > response.json cat response.json echo jq ".candidates[].content.parts[].text" response.json<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/text_generation.sh#L272-L331" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/text_generation.sh#text_gen_multimodal_video_prompt" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_video_prompt">text_generation.sh</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="pdf" data-text="PDF" tabindex="-1">PDF</h3> <devsite-selector> <section> <h3 id="text_gen_multimodal_pdf-PYTHON" track-metadata-position="text_gen_multimodal_pdf" track-metadata-region-tag="text_gen_multimodal_pdf" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/text_generation.py/HEAD/text_gen_multimodal_pdf" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_pdf" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">model = genai.GenerativeModel("gemini-1.5-flash") sample_pdf = genai.upload_file(media / "test.pdf") response = model.generate_content(["Give me a summary of this document:", sample_pdf]) print(f"{response.text=}")<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/text_generation.py#L153-L156" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/text_generation.py#text_gen_multimodal_pdf" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_pdf">text_generation.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_pdf-SHELL" track-metadata-position="text_gen_multimodal_pdf" track-metadata-region-tag="text_gen_multimodal_pdf" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/text_generation.sh/HEAD/text_gen_multimodal_pdf" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_pdf" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr">MIME_TYPE=$(file -b --mime-type "${PDF_PATH}") NUM_BYTES=$(wc -c < "${PDF_PATH}") DISPLAY_NAME=TEXT echo $MIME_TYPE tmp_header_file=upload-header.tmp # Initial resumable request defining metadata. # The upload url is in the response headers dump them to a file. curl "${BASE_URL}/upload/v1beta/files?key=${GOOGLE_API_KEY}" \ -D upload-header.tmp \ -H "X-Goog-Upload-Protocol: resumable" \ -H "X-Goog-Upload-Command: start" \ -H "X-Goog-Upload-Header-Content-Length: ${NUM_BYTES}" \ -H "X-Goog-Upload-Header-Content-Type: ${MIME_TYPE}" \ -H "Content-Type: application/json" \ -d "{'file': {'display_name': '${DISPLAY_NAME}'}}" 2> /dev/null upload_url=$(grep -i "x-goog-upload-url: " "${tmp_header_file}" | cut -d" " -f2 | tr -d "\r") rm "${tmp_header_file}" # Upload the actual bytes. curl "${upload_url}" \ -H "Content-Length: ${NUM_BYTES}" \ -H "X-Goog-Upload-Offset: 0" \ -H "X-Goog-Upload-Command: upload, finalize" \ --data-binary "@${PDF_PATH}" 2> /dev/null > file_info.json file_uri=$(jq ".file.uri" file_info.json) echo file_uri=$file_uri # Now generate content using that file curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:generateContent?key=$GOOGLE_API_KEY" \ -H 'Content-Type: application/json' \ -X POST \ -d '{ "contents": [{ "parts":[ {"text": "Can you add a few more lines to this poem?"}, {"file_data":{"mime_type": "application/pdf", "file_uri": '$file_uri'}}] }] }' 2> /dev/null > response.json cat response.json echo jq ".candidates[].content.parts[].text" response.json<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/text_generation.sh#L393-L441" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/text_generation.sh#text_gen_multimodal_pdf" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_pdf">text_generation.sh</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="chat" data-text="Chat" tabindex="-1">Chat</h3> <devsite-selector> <section> <h3 id="chat-PYTHON" track-metadata-position="chat" track-metadata-region-tag="chat" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/chat.py/HEAD/chat" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/chat.py" data-git-revision="HEAD" data-region-tag="chat" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">model = genai.GenerativeModel("gemini-1.5-flash") chat = model.start_chat( history=[ {"role": "user", "parts": "Hello"}, {"role": "model", "parts": "Great to meet you. What would you like to know?"}, ] ) response = chat.send_message("I have 2 dogs in my house.") print(response.text) response = chat.send_message("How many paws are in my house?") print(response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/chat.py#L26-L36" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/chat.py#chat" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/chat.py" data-indented-block="" data-regexp="" data-region-tag="chat">chat.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat-JAVASCRIPT" track-metadata-position="chat" track-metadata-region-tag="chat" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/chat.js/HEAD/chat" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/chat.js" data-git-revision="HEAD" data-region-tag="chat" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI } from "@google/generative-ai"; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash" }); const chat = model.startChat({ history: [ { role: "user", parts: [{ text: "Hello" }], }, { role: "model", parts: [{ text: "Great to meet you. What would you like to know?" }], }, ], }); let result = await chat.sendMessage("I have 2 dogs in my house."); console.log(result.response.text()); result = await chat.sendMessage("How many paws are in my house?"); console.log(result.response.text());<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/chat.js#L28-L47" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/chat.js#chat" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/chat.js" data-indented-block="" data-regexp="" data-region-tag="chat">chat.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat-GO" track-metadata-position="chat" track-metadata-region-tag="chat" data-text="Go" tabindex="-1">Go</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go/HEAD/chat" data-code-snippet="true" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-git-revision="HEAD" data-region-tag="chat" dir="ltr" is-upgraded syntax="Go"><code translate="no" dir="ltr">model := client.GenerativeModel("gemini-1.5-flash") cs := model.StartChat() cs.History = []*genai.Content{ { Parts: []genai.Part{ genai.Text("Hello, I have 2 dogs in my house."), }, Role: "user", }, { Parts: []genai.Part{ genai.Text("Great to meet you. What would you like to know?"), }, Role: "model", }, } res, err := cs.SendMessage(ctx, genai.Text("How many paws are in my house?")) if err != nil { log.Fatal(err) } printResponse(res)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google/generative-ai-go/blob/f453d2d6ca8c5e76e7d8b8615b3339ce68cd378c/genai/internal/samples/docs-snippets_test.go#L967-L989" class="gc-analytics-event" data-category="github_link" data-label="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go#chat" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-indented-block="" data-regexp="" data-region-tag="chat">docs-snippets_test.go</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat-SHELL" track-metadata-position="chat" track-metadata-region-tag="chat" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/chat.sh/HEAD/chat" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/chat.sh" data-git-revision="HEAD" data-region-tag="chat" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr">curl https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:generateContent?key=$GOOGLE_API_KEY \ -H 'Content-Type: application/json' \ -X POST \ -d '{ "contents": [ {"role":"user", "parts":[{ "text": "Hello"}]}, {"role": "model", "parts":[{ "text": "Great to meet you. What would you like to know?"}]}, {"role":"user", "parts":[{ "text": "I have two dogs in my house. How many paws are in my house?"}]}, ] }' 2> /dev/null | grep "text"<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/chat.sh#L7-L23" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/chat.sh#chat" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/chat.sh" data-indented-block="" data-regexp="" data-region-tag="chat">chat.sh</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat-KOTLIN" track-metadata-position="chat" track-metadata-region-tag="chat" data-text="Kotlin" tabindex="-1">Kotlin</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/chat.kt/HEAD/chat" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/chat.kt" data-git-revision="HEAD" data-region-tag="chat" dir="ltr" is-upgraded syntax="Kotlin"><code translate="no" dir="ltr">val generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case modelName = "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" above) apiKey = BuildConfig.apiKey) val chat = generativeModel.startChat( history = listOf( content(role = "user") { text("Hello, I have 2 dogs in my house.") }, content(role = "model") { text("Great to meet you. What would you like to know?") })) val response = chat.sendMessage("How many paws are in my house?") print(response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/chat.kt#L35-L52" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/chat.kt#chat" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/chat.kt" data-indented-block="" data-regexp="" data-region-tag="chat">chat.kt</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat-SWIFT" track-metadata-position="chat" track-metadata-region-tag="chat" data-text="Swift" tabindex="-1">Swift</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-swift/samples/ChatSnippets.swift/HEAD/chat" data-code-snippet="true" data-github-path="google-gemini/generative-ai-swift/samples/ChatSnippets.swift" data-git-revision="HEAD" data-region-tag="chat" dir="ltr" is-upgraded syntax="Swift"><code translate="no" dir="ltr">let generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case name: "gemini-1.5-flash", // Access your API key from your on-demand resource .plist file (see "Set up your API key" // above) apiKey: APIKey.default ) // Optionally specify existing chat history let history = [ ModelContent(role: "user", parts: "Hello, I have 2 dogs in my house."), ModelContent(role: "model", parts: "Great to meet you. What would you like to know?"), ] // Initialize the chat with optional chat history let chat = generativeModel.startChat(history: history) // To generate text output, call sendMessage and pass in the message let response = try await chat.sendMessage("How many paws are in my house?") if let text = response.text { print(text) }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-swift/blob/44b8ce120425f9cf53ca756f3434ca2c2696f8bd/samples/ChatSnippets.swift#L35-L57" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-swift/samples/ChatSnippets.swift#chat" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-swift/samples/ChatSnippets.swift" data-indented-block="" data-regexp="" data-region-tag="chat">ChatSnippets.swift</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat-DART" track-metadata-position="chat" track-metadata-region-tag="chat" data-text="Dart" tabindex="-1">Dart</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-dart/samples/dart/bin/chat.dart/HEAD/chat" data-code-snippet="true" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/chat.dart" data-git-revision="HEAD" data-region-tag="chat" dir="ltr" is-upgraded syntax="Dart"><code translate="no" dir="ltr">// Make sure to include this import: // import 'package:google_generative_ai/google_generative_ai.dart'; final model = GenerativeModel( model: 'gemini-1.5-flash', apiKey: apiKey, ); final chat = model.startChat(history: [ Content.text('hello'), Content.model([TextPart('Great to meet you. What would you like to know?')]) ]); var response = await chat.sendMessage(Content.text('I have 2 dogs in my house.')); print(response.text); response = await chat.sendMessage(Content.text('How many paws are in my house?')); print(response.text);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-dart/blob/76ae8f89eed4789af0be9e7876d0089909abc419/samples/dart/bin/chat.dart#L30-L45" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-dart/samples/dart/bin/chat.dart#chat" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/chat.dart" data-indented-block="" data-regexp="" data-region-tag="chat">chat.dart</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat-JAVA" track-metadata-position="chat" track-metadata-region-tag="chat" data-text="Java" tabindex="-1">Java</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/chat.java/HEAD/chat" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/chat.java" data-git-revision="HEAD" data-region-tag="chat" dir="ltr" is-upgraded syntax="Java"><code translate="no" dir="ltr">// Specify a Gemini model appropriate for your use case GenerativeModel gm = new GenerativeModel( /* modelName */ "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" // above) /* apiKey */ BuildConfig.apiKey); GenerativeModelFutures model = GenerativeModelFutures.from(gm); // (optional) Create previous chat history for context Content.Builder userContentBuilder = new Content.Builder(); userContentBuilder.setRole("user"); userContentBuilder.addText("Hello, I have 2 dogs in my house."); Content userContent = userContentBuilder.build(); Content.Builder modelContentBuilder = new Content.Builder(); modelContentBuilder.setRole("model"); modelContentBuilder.addText("Great to meet you. What would you like to know?"); Content modelContent = userContentBuilder.build(); List<Content> history = Arrays.asList(userContent, modelContent); // Initialize the chat ChatFutures chat = model.startChat(history); // Create a new user message Content.Builder userMessageBuilder = new Content.Builder(); userMessageBuilder.setRole("user"); userMessageBuilder.addText("How many paws are in my house?"); Content userMessage = userMessageBuilder.build(); // For illustrative purposes only. You should use an executor that fits your needs. Executor executor = Executors.newSingleThreadExecutor(); // Send the message ListenableFuture<GenerateContentResponse> response = chat.sendMessage(userMessage); Futures.addCallback( response, new FutureCallback<GenerateContentResponse>() { @Override public void onSuccess(GenerateContentResponse result) { String resultText = result.getText(); System.out.println(resultText); } @Override public void onFailure(Throwable t) { t.printStackTrace(); } }, executor);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/java/chat.java#L47-L98" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/chat.java#chat" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/chat.java" data-indented-block="" data-regexp="" data-region-tag="chat">chat.java</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="cache" data-text="Cache" tabindex="-1">Cache</h3> <devsite-selector> <section> <h3 id="cache_create-PYTHON" track-metadata-position="cache_create" track-metadata-region-tag="cache_create" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/cache.py/HEAD/cache_create" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/cache.py" data-git-revision="HEAD" data-region-tag="cache_create" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">document = genai.upload_file(path=media / "a11.txt") model_name = "gemini-1.5-flash-001" cache = genai.caching.CachedContent.create( model=model_name, system_instruction="You are an expert analyzing transcripts.", contents=[document], ) print(cache) model = genai.GenerativeModel.from_cached_content(cache) response = model.generate_content("Please summarize this transcript") print(response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/cache.py#L27-L38" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/cache.py#cache_create" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/cache.py" data-indented-block="" data-regexp="" data-region-tag="cache_create">cache.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="cache_create-JAVASCRIPT" track-metadata-position="cache_create" track-metadata-region-tag="cache_create" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/cache.js/HEAD/cache_create" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/cache.js" data-git-revision="HEAD" data-region-tag="cache_create" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleAICacheManager, GoogleAIFileManager } from "@google/generative-ai/server"; // import { GoogleGenerativeAI } from "@google/generative-ai"; const cacheManager = new GoogleAICacheManager(process.env.API_KEY); const fileManager = new GoogleAIFileManager(process.env.API_KEY); const uploadResult = await fileManager.uploadFile(`${mediaPath}/a11.txt`, { mimeType: "text/plain", }); const cacheResult = await cacheManager.create({ model: "models/gemini-1.5-flash-001", contents: [ { role: "user", parts: [ { fileData: { fileUri: uploadResult.file.uri, mimeType: uploadResult.file.mimeType, }, }, ], }, ], }); console.log(cacheResult); const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModelFromCachedContent(cacheResult); const result = await model.generateContent( "Please summarize this transcript.", ); console.log(result.response.text());<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/cache.js#L31-L65" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/cache.js#cache_create" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/cache.js" data-indented-block="" data-regexp="" data-region-tag="cache_create">cache.js</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="tuned-model" data-text="Tuned Model" tabindex="-1">Tuned Model</h3> <devsite-selector> <section> <h3 id="tuned_models_generate_content-PYTHON" track-metadata-position="tuned_models_generate_content" track-metadata-region-tag="tuned_models_generate_content" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/tuned_models.py/HEAD/tuned_models_generate_content" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/tuned_models.py" data-git-revision="HEAD" data-region-tag="tuned_models_generate_content" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">model = genai.GenerativeModel(model_name="tunedModels/my-increment-model") result = model.generate_content("III") print(result.text) # "IV"<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/tuned_models.py#L77-L79" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/tuned_models.py#tuned_models_generate_content" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/tuned_models.py" data-indented-block="" data-regexp="" data-region-tag="tuned_models_generate_content">tuned_models.py</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="json-mode" data-text="JSON Mode" tabindex="-1">JSON Mode</h3> <devsite-selector> <section> <h3 id="json_controlled_generation-PYTHON" track-metadata-position="json_controlled_generation" track-metadata-region-tag="json_controlled_generation" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/controlled_generation.py/HEAD/json_controlled_generation" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/controlled_generation.py" data-git-revision="HEAD" data-region-tag="json_controlled_generation" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">import typing_extensions as typing class Recipe(typing.TypedDict): recipe_name: str ingredients: list[str] model = genai.GenerativeModel("gemini-1.5-pro-latest") result = model.generate_content( "List a few popular cookie recipes.", generation_config=genai.GenerationConfig( response_mime_type="application/json", response_schema=list[Recipe] ), ) print(result)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/controlled_generation.py#L24-L37" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/controlled_generation.py#json_controlled_generation" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/controlled_generation.py" data-indented-block="" data-regexp="" data-region-tag="json_controlled_generation">controlled_generation.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="json_controlled_generation-JAVASCRIPT" track-metadata-position="json_controlled_generation" track-metadata-region-tag="json_controlled_generation" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/controlled_generation.js/HEAD/json_controlled_generation" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/controlled_generation.js" data-git-revision="HEAD" data-region-tag="json_controlled_generation" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI, SchemaType } from "@google/generative-ai"; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const schema = { description: "List of recipes", type: SchemaType.ARRAY, items: { type: SchemaType.OBJECT, properties: { recipeName: { type: SchemaType.STRING, description: "Name of the recipe", nullable: false, }, }, required: ["recipeName"], }, }; const model = genAI.getGenerativeModel({ model: "gemini-1.5-pro", generationConfig: { responseMimeType: "application/json", responseSchema: schema, }, }); const result = await model.generateContent( "List a few popular cookie recipes.", ); console.log(result.response.text());<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/controlled_generation.js#L25-L56" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/controlled_generation.js#json_controlled_generation" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/controlled_generation.js" data-indented-block="" data-regexp="" data-region-tag="json_controlled_generation">controlled_generation.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="json_controlled_generation-GO" track-metadata-position="json_controlled_generation" track-metadata-region-tag="json_controlled_generation" data-text="Go" tabindex="-1">Go</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go/HEAD/json_controlled_generation" data-code-snippet="true" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-git-revision="HEAD" data-region-tag="json_controlled_generation" dir="ltr" is-upgraded syntax="Go"><code translate="no" dir="ltr">model := client.GenerativeModel("gemini-1.5-pro-latest") // Ask the model to respond with JSON. model.ResponseMIMEType = "application/json" // Specify the schema. model.ResponseSchema = &genai.Schema{ Type: genai.TypeArray, Items: &genai.Schema{Type: genai.TypeString}, } resp, err := model.GenerateContent(ctx, genai.Text("List a few popular cookie recipes using this JSON schema.")) if err != nil { log.Fatal(err) } for _, part := range resp.Candidates[0].Content.Parts { if txt, ok := part.(genai.Text); ok { var recipes []string if err := json.Unmarshal([]byte(txt), &recipes); err != nil { log.Fatal(err) } fmt.Println(recipes) } }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google/generative-ai-go/blob/f453d2d6ca8c5e76e7d8b8615b3339ce68cd378c/genai/internal/samples/docs-snippets_test.go#L907-L927" class="gc-analytics-event" data-category="github_link" data-label="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go#json_controlled_generation" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-indented-block="" data-regexp="" data-region-tag="json_controlled_generation">docs-snippets_test.go</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="json_controlled_generation-SHELL" track-metadata-position="json_controlled_generation" track-metadata-region-tag="json_controlled_generation" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/controlled_generation.sh/HEAD/json_controlled_generation" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/controlled_generation.sh" data-git-revision="HEAD" data-region-tag="json_controlled_generation" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr">curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:generateContent?key=$GOOGLE_API_KEY" \ -H 'Content-Type: application/json' \ -d '{ "contents": [{ "parts":[ {"text": "List 5 popular cookie recipes"} ] }], "generationConfig": { "response_mime_type": "application/json", "response_schema": { "type": "ARRAY", "items": { "type": "OBJECT", "properties": { "recipe_name": {"type":"STRING"}, } } } } }' 2> /dev/null | head<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/controlled_generation.sh#L5-L25" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/controlled_generation.sh#json_controlled_generation" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/controlled_generation.sh" data-indented-block="" data-regexp="" data-region-tag="json_controlled_generation">controlled_generation.sh</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="json_controlled_generation-KOTLIN" track-metadata-position="json_controlled_generation" track-metadata-region-tag="json_controlled_generation" data-text="Kotlin" tabindex="-1">Kotlin</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/controlled_generation.kt/HEAD/json_controlled_generation" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/controlled_generation.kt" data-git-revision="HEAD" data-region-tag="json_controlled_generation" dir="ltr" is-upgraded syntax="Kotlin"><code translate="no" dir="ltr">val generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case modelName = "gemini-1.5-pro", // Access your API key as a Build Configuration variable (see "Set up your API key" above) apiKey = BuildConfig.apiKey, generationConfig = generationConfig { responseMimeType = "application/json" responseSchema = Schema( name = "recipes", description = "List of recipes", type = FunctionType.ARRAY, items = Schema( name = "recipe", description = "A recipe", type = FunctionType.OBJECT, properties = mapOf( "recipeName" to Schema( name = "recipeName", description = "Name of the recipe", type = FunctionType.STRING, nullable = false ), ), required = listOf("recipeName") ), ) }) val prompt = "List a few popular cookie recipes." val response = generativeModel.generateContent(prompt) print(response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/controlled_generation.kt#L33-L64" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/controlled_generation.kt#json_controlled_generation" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/controlled_generation.kt" data-indented-block="" data-regexp="" data-region-tag="json_controlled_generation">controlled_generation.kt</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="json_controlled_generation-SWIFT" track-metadata-position="json_controlled_generation" track-metadata-region-tag="json_controlled_generation" data-text="Swift" tabindex="-1">Swift</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-swift/samples/ControlledGeneration.swift/HEAD/json_controlled_generation" data-code-snippet="true" data-github-path="google-gemini/generative-ai-swift/samples/ControlledGeneration.swift" data-git-revision="HEAD" data-region-tag="json_controlled_generation" dir="ltr" is-upgraded syntax="Swift"><code translate="no" dir="ltr">let jsonSchema = Schema( type: .array, description: "List of recipes", items: Schema( type: .object, properties: [ "recipeName": Schema(type: .string, description: "Name of the recipe", nullable: false), ], requiredProperties: ["recipeName"] ) ) let generativeModel = GenerativeModel( // Specify a model that supports controlled generation like Gemini 1.5 Pro name: "gemini-1.5-pro", // Access your API key from your on-demand resource .plist file (see "Set up your API key" // above) apiKey: APIKey.default, generationConfig: GenerationConfig( responseMIMEType: "application/json", responseSchema: jsonSchema ) ) let prompt = "List a few popular cookie recipes." let response = try await generativeModel.generateContent(prompt) if let text = response.text { print(text) }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-swift/blob/44b8ce120425f9cf53ca756f3434ca2c2696f8bd/samples/ControlledGeneration.swift#L35-L63" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-swift/samples/ControlledGeneration.swift#json_controlled_generation" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-swift/samples/ControlledGeneration.swift" data-indented-block="" data-regexp="" data-region-tag="json_controlled_generation">ControlledGeneration.swift</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="json_controlled_generation-DART" track-metadata-position="json_controlled_generation" track-metadata-region-tag="json_controlled_generation" data-text="Dart" tabindex="-1">Dart</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-dart/samples/dart/bin/controlled_generation.dart/HEAD/json_controlled_generation" data-code-snippet="true" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/controlled_generation.dart" data-git-revision="HEAD" data-region-tag="json_controlled_generation" dir="ltr" is-upgraded syntax="Dart"><code translate="no" dir="ltr">// Make sure to include this import: // import 'package:google_generative_ai/google_generative_ai.dart'; final schema = Schema.array( description: 'List of recipes', items: Schema.object(properties: { 'recipeName': Schema.string(description: 'Name of the recipe.', nullable: false) }, requiredProperties: [ 'recipeName' ])); final model = GenerativeModel( model: 'gemini-1.5-pro', apiKey: apiKey, generationConfig: GenerationConfig( responseMimeType: 'application/json', responseSchema: schema)); final prompt = 'List a few popular cookie recipes.'; final response = await model.generateContent([Content.text(prompt)]); print(response.text);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-dart/blob/76ae8f89eed4789af0be9e7876d0089909abc419/samples/dart/bin/controlled_generation.dart#L30-L49" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-dart/samples/dart/bin/controlled_generation.dart#json_controlled_generation" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/controlled_generation.dart" data-indented-block="" data-regexp="" data-region-tag="json_controlled_generation">controlled_generation.dart</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="json_controlled_generation-JAVA" track-metadata-position="json_controlled_generation" track-metadata-region-tag="json_controlled_generation" data-text="Java" tabindex="-1">Java</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/controlled_generation.java/HEAD/json_controlled_generation" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/controlled_generation.java" data-git-revision="HEAD" data-region-tag="json_controlled_generation" dir="ltr" is-upgraded syntax="Java"><code translate="no" dir="ltr">Schema<List<String>> schema = new Schema( /* name */ "recipes", /* description */ "List of recipes", /* format */ null, /* nullable */ false, /* list */ null, /* properties */ null, /* required */ null, /* items */ new Schema( /* name */ "recipe", /* description */ "A recipe", /* format */ null, /* nullable */ false, /* list */ null, /* properties */ Map.of( "recipeName", new Schema( /* name */ "recipeName", /* description */ "Name of the recipe", /* format */ null, /* nullable */ false, /* list */ null, /* properties */ null, /* required */ null, /* items */ null, /* type */ FunctionType.STRING)), /* required */ null, /* items */ null, /* type */ FunctionType.OBJECT), /* type */ FunctionType.ARRAY); GenerationConfig.Builder configBuilder = new GenerationConfig.Builder(); configBuilder.responseMimeType = "application/json"; configBuilder.responseSchema = schema; GenerationConfig generationConfig = configBuilder.build(); // Specify a Gemini model appropriate for your use case GenerativeModel gm = new GenerativeModel( /* modelName */ "gemini-1.5-pro", // Access your API key as a Build Configuration variable (see "Set up your API key" // above) /* apiKey */ BuildConfig.apiKey, /* generationConfig */ generationConfig); GenerativeModelFutures model = GenerativeModelFutures.from(gm); Content content = new Content.Builder().addText("List a few popular cookie recipes.").build(); // For illustrative purposes only. You should use an executor that fits your needs. Executor executor = Executors.newSingleThreadExecutor(); ListenableFuture<GenerateContentResponse> response = model.generateContent(content); Futures.addCallback( response, new FutureCallback<GenerateContentResponse>() { @Override public void onSuccess(GenerateContentResponse result) { String resultText = result.getText(); System.out.println(resultText); } @Override public void onFailure(Throwable t) { t.printStackTrace(); } }, executor);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/java/controlled_generation.java#L42-L110" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/controlled_generation.java#json_controlled_generation" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/controlled_generation.java" data-indented-block="" data-regexp="" data-region-tag="json_controlled_generation">controlled_generation.java</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="code-execution" data-text="Code execution" tabindex="-1">Code execution</h3> <devsite-selector> <section> <h3 id="code_execution_basic-PYTHON" track-metadata-position="code_execution_basic" track-metadata-region-tag="code_execution_basic" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/code_execution.py/HEAD/code_execution_basic" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/code_execution.py" data-git-revision="HEAD" data-region-tag="code_execution_basic" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">model = genai.GenerativeModel(model_name="gemini-1.5-flash", tools="code_execution") response = model.generate_content( ( "What is the sum of the first 50 prime numbers? " "Generate and run code for the calculation, and make sure you get all 50." ) ) # Each `part` either contains `text`, `executable_code` or an `execution_result` for part in response.candidates[0].content.parts: print(part, "\n") print("-" * 80) # The `.text` accessor joins the parts into a markdown compatible text representation. print("\n\n", response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/code_execution.py#L23-L37" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/code_execution.py#code_execution_basic" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/code_execution.py" data-indented-block="" data-regexp="" data-region-tag="code_execution_basic">code_execution.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="code_execution_basic-KOTLIN" track-metadata-position="code_execution_basic" track-metadata-region-tag="code_execution_basic" data-text="Kotlin" tabindex="-1">Kotlin</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/code_execution.kt/HEAD/code_execution_basic" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/code_execution.kt" data-git-revision="HEAD" data-region-tag="code_execution_basic" dir="ltr" is-upgraded syntax="Kotlin"><code translate="no" dir="ltr"> val model = GenerativeModel( // Specify a Gemini model appropriate for your use case modelName = "gemini-1.5-pro", // Access your API key as a Build Configuration variable (see "Set up your API key" above) apiKey = BuildConfig.apiKey, tools = listOf(Tool.CODE_EXECUTION) ) val response = model.generateContent("What is the sum of the first 50 prime numbers?") // Each `part` either contains `text`, `executable_code` or an `execution_result` println(response.candidates[0].content.parts.joinToString("\n")) // Alternatively, you can use the `text` accessor which joins the parts into a markdown compatible // text representation println(response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/code_execution.kt#L31-L47" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/code_execution.kt#code_execution_basic" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/code_execution.kt" data-indented-block="" data-regexp="" data-region-tag="code_execution_basic">code_execution.kt</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="code_execution_basic-JAVA" track-metadata-position="code_execution_basic" track-metadata-region-tag="code_execution_basic" data-text="Java" tabindex="-1">Java</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/code_execution.java/HEAD/code_execution_basic" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/code_execution.java" data-git-revision="HEAD" data-region-tag="code_execution_basic" dir="ltr" is-upgraded syntax="Java"><code translate="no" dir="ltr">// Specify a Gemini model appropriate for your use case GenerativeModel gm = new GenerativeModel( /* modelName */ "gemini-1.5-pro", // Access your API key as a Build Configuration variable (see "Set up your API key" // above) /* apiKey */ BuildConfig.apiKey, /* generationConfig */ null, /* safetySettings */ null, /* requestOptions */ new RequestOptions(), /* tools */ Collections.singletonList(Tool.CODE_EXECUTION)); GenerativeModelFutures model = GenerativeModelFutures.from(gm); Content inputContent = new Content.Builder().addText("What is the sum of the first 50 prime numbers?").build(); // For illustrative purposes only. You should use an executor that fits your needs. Executor executor = Executors.newSingleThreadExecutor(); ListenableFuture<GenerateContentResponse> response = model.generateContent(inputContent); Futures.addCallback( response, new FutureCallback<GenerateContentResponse>() { @Override public void onSuccess(GenerateContentResponse result) { // Each `part` either contains `text`, `executable_code` or an // `execution_result` Candidate candidate = result.getCandidates().get(0); for (Part part : candidate.getContent().getParts()) { System.out.println(part); } // Alternatively, you can use the `text` accessor which joins the parts into a // markdown compatible text representation String resultText = result.getText(); System.out.println(resultText); } @Override public void onFailure(Throwable t) { t.printStackTrace(); } }, executor);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/java/code_execution.java#L46-L89" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/code_execution.java#code_execution_basic" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/code_execution.java" data-indented-block="" data-regexp="" data-region-tag="code_execution_basic">code_execution.java</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="function-calling" data-text="Function Calling" tabindex="-1">Function Calling</h3> <devsite-selector> <section> <h3 id="function_calling-PYTHON" track-metadata-position="function_calling" track-metadata-region-tag="function_calling" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/function_calling.py/HEAD/function_calling" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/function_calling.py" data-git-revision="HEAD" data-region-tag="function_calling" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">def add(a: float, b: float): """returns a + b.""" return a + b def subtract(a: float, b: float): """returns a - b.""" return a - b def multiply(a: float, b: float): """returns a * b.""" return a * b def divide(a: float, b: float): """returns a / b.""" return a / b model = genai.GenerativeModel( model_name="gemini-1.5-flash", tools=[add, subtract, multiply, divide] ) chat = model.start_chat(enable_automatic_function_calling=True) response = chat.send_message( "I have 57 cats, each owns 44 mittens, how many mittens is that in total?" ) print(response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/function_calling.py#L23-L46" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/function_calling.py#function_calling" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/function_calling.py" data-indented-block="" data-regexp="" data-region-tag="function_calling">function_calling.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="function_calling-JAVASCRIPT" track-metadata-position="function_calling" track-metadata-region-tag="function_calling" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/function_calling.js/HEAD/function_calling" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/function_calling.js" data-git-revision="HEAD" data-region-tag="function_calling" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI } from "@google/generative-ai"; async function setLightValues(brightness, colorTemperature) { // This mock API returns the requested lighting values return { brightness, colorTemperature, }; } const controlLightFunctionDeclaration = { name: "controlLight", parameters: { type: "OBJECT", description: "Set the brightness and color temperature of a room light.", properties: { brightness: { type: "NUMBER", description: "Light level from 0 to 100. Zero is off and 100 is full brightness.", }, colorTemperature: { type: "STRING", description: "Color temperature of the light fixture which can be `daylight`, `cool` or `warm`.", }, }, required: ["brightness", "colorTemperature"], }, }; // Executable function code. Put it in a map keyed by the function name // so that you can call it once you get the name string from the model. const functions = { controlLight: ({ brightness, colorTemperature }) => { return setLightValues(brightness, colorTemperature); }, }; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash", tools: { functionDeclarations: [controlLightFunctionDeclaration] }, }); const chat = model.startChat(); const prompt = "Dim the lights so the room feels cozy and warm."; // Send the message to the model. const result = await chat.sendMessage(prompt); // For simplicity, this uses the first function call found. const call = result.response.functionCalls()[0]; if (call) { // Call the executable function named in the function call // with the arguments specified in the function call and // let it call the hypothetical API. const apiResponse = await functions[call.name](call.args); // Send the API response back to the model so it can generate // a text response that can be displayed to the user. const result2 = await chat.sendMessage([ { functionResponse: { name: "controlLight", response: apiResponse, }, }, ]); // Log the text response. console.log(result2.response.text()); }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/function_calling.js#L22-L94" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/function_calling.js#function_calling" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/function_calling.js" data-indented-block="" data-regexp="" data-region-tag="function_calling">function_calling.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="function_calling-SHELL" track-metadata-position="function_calling" track-metadata-region-tag="function_calling" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/function_calling.sh/HEAD/function_calling" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/function_calling.sh" data-git-revision="HEAD" data-region-tag="function_calling" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr"> cat > tools.json << EOF { "function_declarations": [ { "name": "enable_lights", "description": "Turn on the lighting system.", "parameters": { "type": "object" } }, { "name": "set_light_color", "description": "Set the light color. Lights must be enabled for this to work.", "parameters": { "type": "object", "properties": { "rgb_hex": { "type": "string", "description": "The light color as a 6-digit hex string, e.g. ff0000 for red." } }, "required": [ "rgb_hex" ] } }, { "name": "stop_lights", "description": "Turn off the lighting system.", "parameters": { "type": "object" } } ] } EOF curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-pro-latest:generateContent?key=$GOOGLE_API_KEY" \ -H 'Content-Type: application/json' \ -d @<(echo ' { "system_instruction": { "parts": { "text": "You are a helpful lighting system bot. You can turn lights on and off, and you can set the color. Do not perform any other tasks." } }, "tools": ['$(source "$tools")'], "tool_config": { "function_calling_config": {"mode": "none"} }, "contents": { "role": "user", "parts": { "text": "What can you do?" } } } ') 2>/dev/null |sed -n '/"content"/,/"finishReason"/p'<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/function_calling.sh#L4-L61" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/function_calling.sh#function_calling" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/function_calling.sh" data-indented-block="" data-regexp="" data-region-tag="function_calling">function_calling.sh</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="function_calling-KOTLIN" track-metadata-position="function_calling" track-metadata-region-tag="function_calling" data-text="Kotlin" tabindex="-1">Kotlin</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/function_calling.kt/HEAD/function_calling" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/function_calling.kt" data-git-revision="HEAD" data-region-tag="function_calling" dir="ltr" is-upgraded syntax="Kotlin"><code translate="no" dir="ltr">fun multiply(a: Double, b: Double) = a * b val multiplyDefinition = defineFunction( name = "multiply", description = "returns the product of the provided numbers.", parameters = listOf( Schema.double("a", "First number"), Schema.double("b", "Second number") ) ) val usableFunctions = listOf(multiplyDefinition) val generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case modelName = "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" above) apiKey = BuildConfig.apiKey, // List the functions definitions you want to make available to the model tools = listOf(Tool(usableFunctions)) ) val chat = generativeModel.startChat() val prompt = "I have 57 cats, each owns 44 mittens, how many mittens is that in total?" // Send the message to the generative model var response = chat.sendMessage(prompt) // Check if the model responded with a function call response.functionCalls.first { it.name == "multiply" }.apply { val a: String by args val b: String by args val result = JSONObject(mapOf("result" to multiply(a.toDouble(), b.toDouble()))) response = chat.sendMessage( content(role = "function") { part(FunctionResponsePart("multiply", result)) } ) } // Whenever the model responds with text, show it in the UI response.text?.let { modelResponse -> println(modelResponse) }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/function_calling.kt#L38-L83" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/function_calling.kt#function_calling" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/function_calling.kt" data-indented-block="" data-regexp="" data-region-tag="function_calling">function_calling.kt</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="function_calling-SWIFT" track-metadata-position="function_calling" track-metadata-region-tag="function_calling" data-text="Swift" tabindex="-1">Swift</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-swift/samples/FunctionCalling.swift/HEAD/function_calling" data-code-snippet="true" data-github-path="google-gemini/generative-ai-swift/samples/FunctionCalling.swift" data-git-revision="HEAD" data-region-tag="function_calling" dir="ltr" is-upgraded syntax="Swift"><code translate="no" dir="ltr">// Calls a hypothetical API to control a light bulb and returns the values that were set. func controlLight(brightness: Double, colorTemperature: String) -> JSONObject { return ["brightness": .number(brightness), "colorTemperature": .string(colorTemperature)] } let generativeModel = GenerativeModel( // Use a model that supports function calling, like a Gemini 1.5 model name: "gemini-1.5-flash", // Access your API key from your on-demand resource .plist file (see "Set up your API key" // above) apiKey: APIKey.default, tools: [Tool(functionDeclarations: [ FunctionDeclaration( name: "controlLight", description: "Set the brightness and color temperature of a room light.", parameters: [ "brightness": Schema( type: .number, format: "double", description: "Light level from 0 to 100. Zero is off and 100 is full brightness." ), "colorTemperature": Schema( type: .string, format: "enum", description: "Color temperature of the light fixture.", enumValues: ["daylight", "cool", "warm"] ), ], requiredParameters: ["brightness", "colorTemperature"] ), ])] ) let chat = generativeModel.startChat() let prompt = "Dim the lights so the room feels cozy and warm." // Send the message to the model. let response1 = try await chat.sendMessage(prompt) // Check if the model responded with a function call. // For simplicity, this sample uses the first function call found. guard let functionCall = response1.functionCalls.first else { fatalError("Model did not respond with a function call.") } // Print an error if the returned function was not declared guard functionCall.name == "controlLight" else { fatalError("Unexpected function called: \(functionCall.name)") } // Verify that the names and types of the parameters match the declaration guard case let .number(brightness) = functionCall.args["brightness"] else { fatalError("Missing argument: brightness") } guard case let .string(colorTemperature) = functionCall.args["colorTemperature"] else { fatalError("Missing argument: colorTemperature") } // Call the executable function named in the FunctionCall with the arguments specified in the // FunctionCall and let it call the hypothetical API. let apiResponse = controlLight(brightness: brightness, colorTemperature: colorTemperature) // Send the API response back to the model so it can generate a text response that can be // displayed to the user. let response2 = try await chat.sendMessage([ModelContent( role: "function", parts: [.functionResponse(FunctionResponse(name: "controlLight", response: apiResponse))] )]) if let text = response2.text { print(text) }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-swift/blob/44b8ce120425f9cf53ca756f3434ca2c2696f8bd/samples/FunctionCalling.swift#L35-L106" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-swift/samples/FunctionCalling.swift#function_calling" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-swift/samples/FunctionCalling.swift" data-indented-block="" data-regexp="" data-region-tag="function_calling">FunctionCalling.swift</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="function_calling-DART" track-metadata-position="function_calling" track-metadata-region-tag="function_calling" data-text="Dart" tabindex="-1">Dart</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-dart/samples/dart/bin/function_calling.dart/HEAD/function_calling" data-code-snippet="true" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/function_calling.dart" data-git-revision="HEAD" data-region-tag="function_calling" dir="ltr" is-upgraded syntax="Dart"><code translate="no" dir="ltr">// Make sure to include this import: // import 'package:google_generative_ai/google_generative_ai.dart'; Map<String, Object?> setLightValues(Map<String, Object?> args) { return args; } final controlLightFunction = FunctionDeclaration( 'controlLight', 'Set the brightness and color temperature of a room light.', Schema.object(properties: { 'brightness': Schema.number( description: 'Light level from 0 to 100. Zero is off and 100 is full brightness.', nullable: false), 'colorTemperatur': Schema.string( description: 'Color temperature of the light fixture which can be `daylight`, `cool`, or `warm`', nullable: false), })); final functions = {controlLightFunction.name: setLightValues}; FunctionResponse dispatchFunctionCall(FunctionCall call) { final function = functions[call.name]!; final result = function(call.args); return FunctionResponse(call.name, result); } final model = GenerativeModel( model: 'gemini-1.5-pro', apiKey: apiKey, tools: [ Tool(functionDeclarations: [controlLightFunction]) ], ); final prompt = 'Dim the lights so the room feels cozy and warm.'; final content = [Content.text(prompt)]; var response = await model.generateContent(content); List<FunctionCall> functionCalls; while ((functionCalls = response.functionCalls.toList()).isNotEmpty) { var responses = <FunctionResponse>[ for (final functionCall in functionCalls) dispatchFunctionCall(functionCall) ]; content ..add(response.candidates.first.content) ..add(Content.functionResponses(responses)); response = await model.generateContent(content); } print('Response: ${response.text}');<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-dart/blob/76ae8f89eed4789af0be9e7876d0089909abc419/samples/dart/bin/function_calling.dart#L30-L80" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-dart/samples/dart/bin/function_calling.dart#function_calling" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/function_calling.dart" data-indented-block="" data-regexp="" data-region-tag="function_calling">function_calling.dart</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="function_calling-JAVA" track-metadata-position="function_calling" track-metadata-region-tag="function_calling" data-text="Java" tabindex="-1">Java</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/function_calling.java/HEAD/function_calling" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/function_calling.java" data-git-revision="HEAD" data-region-tag="function_calling" dir="ltr" is-upgraded syntax="Java"><code translate="no" dir="ltr">FunctionDeclaration multiplyDefinition = defineFunction( /* name */ "multiply", /* description */ "returns a * b.", /* parameters */ Arrays.asList( Schema.numDouble("a", "First parameter"), Schema.numDouble("b", "Second parameter")), /* required */ Arrays.asList("a", "b")); Tool tool = new Tool(Arrays.asList(multiplyDefinition), null); // Specify a Gemini model appropriate for your use case GenerativeModel gm = new GenerativeModel( /* modelName */ "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" // above) /* apiKey */ BuildConfig.apiKey, /* generationConfig (optional) */ null, /* safetySettings (optional) */ null, /* requestOptions (optional) */ new RequestOptions(), /* functionDeclarations (optional) */ Arrays.asList(tool)); GenerativeModelFutures model = GenerativeModelFutures.from(gm); // Create prompt Content.Builder userContentBuilder = new Content.Builder(); userContentBuilder.setRole("user"); userContentBuilder.addText( "I have 57 cats, each owns 44 mittens, how many mittens is that in total?"); Content userMessage = userContentBuilder.build(); // For illustrative purposes only. You should use an executor that fits your needs. Executor executor = Executors.newSingleThreadExecutor(); // Initialize the chat ChatFutures chat = model.startChat(); // Send the message ListenableFuture<GenerateContentResponse> response = chat.sendMessage(userMessage); Futures.addCallback( response, new FutureCallback<GenerateContentResponse>() { @Override public void onSuccess(GenerateContentResponse result) { if (!result.getFunctionCalls().isEmpty()) { handleFunctionCall(result); } if (!result.getText().isEmpty()) { System.out.println(result.getText()); } } @Override public void onFailure(Throwable t) { t.printStackTrace(); } private void handleFunctionCall(GenerateContentResponse result) { FunctionCallPart multiplyFunctionCallPart = result.getFunctionCalls().stream() .filter(fun -> fun.getName().equals("multiply")) .findFirst() .get(); double a = Double.parseDouble(multiplyFunctionCallPart.getArgs().get("a")); double b = Double.parseDouble(multiplyFunctionCallPart.getArgs().get("b")); try { // `multiply(a, b)` is a regular java function defined in another class FunctionResponsePart functionResponsePart = new FunctionResponsePart( "multiply", new JSONObject().put("result", multiply(a, b))); // Create prompt Content.Builder functionCallResponse = new Content.Builder(); userContentBuilder.setRole("user"); userContentBuilder.addPart(functionResponsePart); Content userMessage = userContentBuilder.build(); chat.sendMessage(userMessage); } catch (JSONException e) { throw new RuntimeException(e); } } }, executor); <div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/java/function_calling.java#L54-L140" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/function_calling.java#function_calling" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/function_calling.java" data-indented-block="" data-regexp="" data-region-tag="function_calling">function_calling.java</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="generation-config" data-text="Generation config" tabindex="-1">Generation config</h3> <devsite-selector> <section> <h3 id="configure_model_parameters-PYTHON" track-metadata-position="configure_model_parameters" track-metadata-region-tag="configure_model_parameters" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/configure_model_parameters.py/HEAD/configure_model_parameters" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/configure_model_parameters.py" data-git-revision="HEAD" data-region-tag="configure_model_parameters" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">model = genai.GenerativeModel("gemini-1.5-flash") response = model.generate_content( "Tell me a story about a magic backpack.", generation_config=genai.types.GenerationConfig( # Only one candidate for now. candidate_count=1, stop_sequences=["x"], max_output_tokens=20, temperature=1.0, ), ) print(response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/configure_model_parameters.py#L23-L35" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/configure_model_parameters.py#configure_model_parameters" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/configure_model_parameters.py" data-indented-block="" data-regexp="" data-region-tag="configure_model_parameters">configure_model_parameters.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="configure_model-JAVASCRIPT" track-metadata-position="configure_model" track-metadata-region-tag="configure_model" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/model_configuration.js/HEAD/configure_model" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/model_configuration.js" data-git-revision="HEAD" data-region-tag="configure_model" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI } from "@google/generative-ai"; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash", generationConfig: { candidateCount: 1, stopSequences: ["x"], maxOutputTokens: 20, temperature: 1.0, }, }); const result = await model.generateContent( "Tell me a story about a magic backpack.", ); console.log(result.response.text());<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/model_configuration.js#L22-L38" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/model_configuration.js#configure_model" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/model_configuration.js" data-indented-block="" data-regexp="" data-region-tag="configure_model">model_configuration.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="configure_model_parameters-GO" track-metadata-position="configure_model_parameters" track-metadata-region-tag="configure_model_parameters" data-text="Go" tabindex="-1">Go</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go/HEAD/configure_model_parameters" data-code-snippet="true" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-git-revision="HEAD" data-region-tag="configure_model_parameters" dir="ltr" is-upgraded syntax="Go"><code translate="no" dir="ltr">model := client.GenerativeModel("gemini-1.5-pro-latest") model.SetTemperature(0.9) model.SetTopP(0.5) model.SetTopK(20) model.SetMaxOutputTokens(100) model.SystemInstruction = genai.NewUserContent(genai.Text("You are Yoda from Star Wars.")) model.ResponseMIMEType = "application/json" resp, err := model.GenerateContent(ctx, genai.Text("What is the average size of a swallow?")) if err != nil { log.Fatal(err) } printResponse(resp)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google/generative-ai-go/blob/f453d2d6ca8c5e76e7d8b8615b3339ce68cd378c/genai/internal/samples/docs-snippets_test.go#L238-L249" class="gc-analytics-event" data-category="github_link" data-label="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go#configure_model_parameters" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-indented-block="" data-regexp="" data-region-tag="configure_model_parameters">docs-snippets_test.go</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="configure_model_parameters-SHELL" track-metadata-position="configure_model_parameters" track-metadata-region-tag="configure_model_parameters" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/configure_model_parameters.sh/HEAD/configure_model_parameters" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/configure_model_parameters.sh" data-git-revision="HEAD" data-region-tag="configure_model_parameters" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr">curl https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:generateContent?key=$GOOGLE_API_KEY \ -H 'Content-Type: application/json' \ -X POST \ -d '{ "contents": [{ "parts":[ {"text": "Write a story about a magic backpack."} ] }], "safetySettings": [ { "category": "HARM_CATEGORY_DANGEROUS_CONTENT", "threshold": "BLOCK_ONLY_HIGH" } ], "generationConfig": { "stopSequences": [ "Title" ], "temperature": 1.0, "maxOutputTokens": 800, "topP": 0.8, "topK": 10 } }' 2> /dev/null | grep "text"<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/configure_model_parameters.sh#L4-L29" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/configure_model_parameters.sh#configure_model_parameters" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/configure_model_parameters.sh" data-indented-block="" data-regexp="" data-region-tag="configure_model_parameters">configure_model_parameters.sh</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="configure_model_parameters-KOTLIN" track-metadata-position="configure_model_parameters" track-metadata-region-tag="configure_model_parameters" data-text="Kotlin" tabindex="-1">Kotlin</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/configure_model_parameters.kt/HEAD/configure_model_parameters" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/configure_model_parameters.kt" data-git-revision="HEAD" data-region-tag="configure_model_parameters" dir="ltr" is-upgraded syntax="Kotlin"><code translate="no" dir="ltr">val config = generationConfig { temperature = 0.9f topK = 16 topP = 0.1f maxOutputTokens = 200 stopSequences = listOf("red") } val generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case modelName = "gemini-1.5-flash", apiKey = BuildConfig.apiKey, generationConfig = config)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/configure_model_parameters.kt#L32-L45" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/configure_model_parameters.kt#configure_model_parameters" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/configure_model_parameters.kt" data-indented-block="" data-regexp="" data-region-tag="configure_model_parameters">configure_model_parameters.kt</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="configure_model_parameters-SWIFT" track-metadata-position="configure_model_parameters" track-metadata-region-tag="configure_model_parameters" data-text="Swift" tabindex="-1">Swift</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-swift/samples/GenerationConfig.swift/HEAD/configure_model_parameters" data-code-snippet="true" data-github-path="google-gemini/generative-ai-swift/samples/GenerationConfig.swift" data-git-revision="HEAD" data-region-tag="configure_model_parameters" dir="ltr" is-upgraded syntax="Swift"><code translate="no" dir="ltr">let config = GenerationConfig( temperature: 0.9, topP: 0.1, topK: 16, candidateCount: 1, maxOutputTokens: 200, stopSequences: ["red", "orange"] ) let generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case name: "gemini-1.5-flash", // Access your API key from your on-demand resource .plist file (see "Set up your API key" // above) apiKey: APIKey.default, generationConfig: config )<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-swift/blob/44b8ce120425f9cf53ca756f3434ca2c2696f8bd/samples/GenerationConfig.swift#L35-L52" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-swift/samples/GenerationConfig.swift#configure_model_parameters" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-swift/samples/GenerationConfig.swift" data-indented-block="" data-regexp="" data-region-tag="configure_model_parameters">GenerationConfig.swift</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="configure_model_parameters-DART" track-metadata-position="configure_model_parameters" track-metadata-region-tag="configure_model_parameters" data-text="Dart" tabindex="-1">Dart</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-dart/samples/dart/bin/configure_model_parameters.dart/HEAD/configure_model_parameters" data-code-snippet="true" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/configure_model_parameters.dart" data-git-revision="HEAD" data-region-tag="configure_model_parameters" dir="ltr" is-upgraded syntax="Dart"><code translate="no" dir="ltr">final model = GenerativeModel( model: 'gemini-1.5-flash', apiKey: apiKey, ); final prompt = 'Tell me a story about a magic backpack.'; final response = await model.generateContent( [Content.text(prompt)], generationConfig: GenerationConfig( candidateCount: 1, stopSequences: ['x'], maxOutputTokens: 20, temperature: 1.0, ), ); print(response.text);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-dart/blob/76ae8f89eed4789af0be9e7876d0089909abc419/samples/dart/bin/configure_model_parameters.dart#L30-L45" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-dart/samples/dart/bin/configure_model_parameters.dart#configure_model_parameters" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/configure_model_parameters.dart" data-indented-block="" data-regexp="" data-region-tag="configure_model_parameters">configure_model_parameters.dart</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="configure_model_parameters-JAVA" track-metadata-position="configure_model_parameters" track-metadata-region-tag="configure_model_parameters" data-text="Java" tabindex="-1">Java</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/configure_model_parameters.java/HEAD/configure_model_parameters" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/configure_model_parameters.java" data-git-revision="HEAD" data-region-tag="configure_model_parameters" dir="ltr" is-upgraded syntax="Java"><code translate="no" dir="ltr">GenerationConfig.Builder configBuilder = new GenerationConfig.Builder(); configBuilder.temperature = 0.9f; configBuilder.topK = 16; configBuilder.topP = 0.1f; configBuilder.maxOutputTokens = 200; configBuilder.stopSequences = Arrays.asList("red"); GenerationConfig generationConfig = configBuilder.build(); // Specify a Gemini model appropriate for your use case GenerativeModel gm = new GenerativeModel("gemini-1.5-flash", BuildConfig.apiKey, generationConfig); GenerativeModelFutures model = GenerativeModelFutures.from(gm);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/java/configure_model_parameters.java#L32-L45" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/configure_model_parameters.java#configure_model_parameters" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/configure_model_parameters.java" data-indented-block="" data-regexp="" data-region-tag="configure_model_parameters">configure_model_parameters.java</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="safety-settings" data-text="Safety Settings" tabindex="-1">Safety Settings</h3> <devsite-selector> <section> <h3 id="safety_settings_multi-PYTHON" track-metadata-position="safety_settings_multi" track-metadata-region-tag="safety_settings_multi" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/safety_settings.py/HEAD/safety_settings_multi" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/safety_settings.py" data-git-revision="HEAD" data-region-tag="safety_settings_multi" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">model = genai.GenerativeModel("gemini-1.5-flash") unsafe_prompt = "I support Martians Soccer Club and I think Jupiterians Football Club sucks! Write a ironic phrase about them." response = model.generate_content( unsafe_prompt, safety_settings={ "HATE": "MEDIUM", "HARASSMENT": "BLOCK_ONLY_HIGH", }, ) # If you want to set all the safety_settings to the same value you can just pass that value: response = model.generate_content(unsafe_prompt, safety_settings="MEDIUM") try: print(response.text) except: print("No information generated by the model.") print(response.candidates[0].safety_ratings)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/safety_settings.py#L36-L52" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/safety_settings.py#safety_settings_multi" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/safety_settings.py" data-indented-block="" data-regexp="" data-region-tag="safety_settings_multi">safety_settings.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="safety_settings_multi-JAVASCRIPT" track-metadata-position="safety_settings_multi" track-metadata-region-tag="safety_settings_multi" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/safety_settings.js/HEAD/safety_settings_multi" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/safety_settings.js" data-git-revision="HEAD" data-region-tag="safety_settings_multi" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI, HarmCategory, HarmBlockThreshold } from "@google/generative-ai"; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash", safetySettings: [ { category: HarmCategory.HARM_CATEGORY_HARASSMENT, threshold: HarmBlockThreshold.BLOCK_MEDIUM_AND_ABOVE, }, { category: HarmCategory.HARM_CATEGORY_HATE_SPEECH, threshold: HarmBlockThreshold.BLOCK_LOW_AND_ABOVE, }, ], }); const unsafePrompt = "I support Martians Soccer Club and I think " + "Jupiterians Football Club sucks! Write an ironic phrase telling " + "them how I feel about them."; const result = await model.generateContent(unsafePrompt); try { result.response.text(); } catch (e) { console.error(e); console.log(result.response.candidates[0].safetyRatings); }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/safety_settings.js#L57-L86" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/safety_settings.js#safety_settings_multi" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/safety_settings.js" data-indented-block="" data-regexp="" data-region-tag="safety_settings_multi">safety_settings.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="safety_settings_multi-GO" track-metadata-position="safety_settings_multi" track-metadata-region-tag="safety_settings_multi" data-text="Go" tabindex="-1">Go</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go/HEAD/safety_settings_multi" data-code-snippet="true" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-git-revision="HEAD" data-region-tag="safety_settings_multi" dir="ltr" is-upgraded syntax="Go"><code translate="no" dir="ltr">model := client.GenerativeModel("gemini-1.5-flash") model.SafetySettings = []*genai.SafetySetting{ { Category: genai.HarmCategoryDangerousContent, Threshold: genai.HarmBlockLowAndAbove, }, { Category: genai.HarmCategoryHarassment, Threshold: genai.HarmBlockMediumAndAbove, }, } resp, err := model.GenerateContent(ctx, genai.Text("I support Martians Soccer Club and I think Jupiterians Football Club sucks! Write a ironic phrase about them.")) if err != nil { log.Fatal(err) } printResponse(resp)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google/generative-ai-go/blob/f453d2d6ca8c5e76e7d8b8615b3339ce68cd378c/genai/internal/samples/docs-snippets_test.go#L305-L320" class="gc-analytics-event" data-category="github_link" data-label="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go#safety_settings_multi" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-indented-block="" data-regexp="" data-region-tag="safety_settings_multi">docs-snippets_test.go</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="safety_settings_multi-SHELL" track-metadata-position="safety_settings_multi" track-metadata-region-tag="safety_settings_multi" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/safety_settings.sh/HEAD/safety_settings_multi" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/safety_settings.sh" data-git-revision="HEAD" data-region-tag="safety_settings_multi" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr">echo '{ "safetySettings": [ {"category": "HARM_CATEGORY_HARASSMENT", "threshold": "BLOCK_ONLY_HIGH"}, {"category": "HARM_CATEGORY_HATE_SPEECH", "threshold": "BLOCK_MEDIUM_AND_ABOVE"} ], "contents": [{ "parts":[{ "text": "'I support Martians Soccer Club and I think Jupiterians Football Club sucks! Write a ironic phrase about them.'"}]}]}' > request.json curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:generateContent?key=$GOOGLE_API_KEY" \ -H 'Content-Type: application/json' \ -X POST \ -d @request.json 2> /dev/null<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/safety_settings.sh#L20-L33" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/safety_settings.sh#safety_settings_multi" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/safety_settings.sh" data-indented-block="" data-regexp="" data-region-tag="safety_settings_multi">safety_settings.sh</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="safety_settings_multi-KOTLIN" track-metadata-position="safety_settings_multi" track-metadata-region-tag="safety_settings_multi" data-text="Kotlin" tabindex="-1">Kotlin</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/safety_settings.kt/HEAD/safety_settings_multi" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/safety_settings.kt" data-git-revision="HEAD" data-region-tag="safety_settings_multi" dir="ltr" is-upgraded syntax="Kotlin"><code translate="no" dir="ltr">val harassmentSafety = SafetySetting(HarmCategory.HARASSMENT, BlockThreshold.ONLY_HIGH) val hateSpeechSafety = SafetySetting(HarmCategory.HATE_SPEECH, BlockThreshold.MEDIUM_AND_ABOVE) val generativeModel = GenerativeModel( // The Gemini 1.5 models are versatile and work with most use cases modelName = "gemini-1.5-flash", apiKey = BuildConfig.apiKey, safetySettings = listOf(harassmentSafety, hateSpeechSafety))<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/safety_settings.kt#L48-L57" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/safety_settings.kt#safety_settings_multi" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/safety_settings.kt" data-indented-block="" data-regexp="" data-region-tag="safety_settings_multi">safety_settings.kt</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="safety_settings_multi-SWIFT" track-metadata-position="safety_settings_multi" track-metadata-region-tag="safety_settings_multi" data-text="Swift" tabindex="-1">Swift</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-swift/samples/SafetySettings.swift/HEAD/safety_settings_multi" data-code-snippet="true" data-github-path="google-gemini/generative-ai-swift/samples/SafetySettings.swift" data-git-revision="HEAD" data-region-tag="safety_settings_multi" dir="ltr" is-upgraded syntax="Swift"><code translate="no" dir="ltr">let safetySettings = [ SafetySetting(harmCategory: .dangerousContent, threshold: .blockLowAndAbove), SafetySetting(harmCategory: .harassment, threshold: .blockMediumAndAbove), SafetySetting(harmCategory: .hateSpeech, threshold: .blockOnlyHigh), ] let generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case name: "gemini-1.5-flash", // Access your API key from your on-demand resource .plist file (see "Set up your API key" // above) apiKey: APIKey.default, safetySettings: safetySettings )<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-swift/blob/44b8ce120425f9cf53ca756f3434ca2c2696f8bd/samples/SafetySettings.swift#L52-L66" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-swift/samples/SafetySettings.swift#safety_settings_multi" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-swift/samples/SafetySettings.swift" data-indented-block="" data-regexp="" data-region-tag="safety_settings_multi">SafetySettings.swift</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="safety_settings_multi-DART" track-metadata-position="safety_settings_multi" track-metadata-region-tag="safety_settings_multi" data-text="Dart" tabindex="-1">Dart</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-dart/samples/dart/bin/safety_settings.dart/HEAD/safety_settings_multi" data-code-snippet="true" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/safety_settings.dart" data-git-revision="HEAD" data-region-tag="safety_settings_multi" dir="ltr" is-upgraded syntax="Dart"><code translate="no" dir="ltr">// Make sure to include this import: // import 'package:google_generative_ai/google_generative_ai.dart'; final model = GenerativeModel( model: 'gemini-1.5-flash', apiKey: apiKey, ); final prompt = 'I support Martians Soccer Club and I think ' 'Jupiterians Football Club sucks! Write an ironic phrase telling ' 'them how I feel about them.'; final response = await model.generateContent( [Content.text(prompt)], safetySettings: [ SafetySetting(HarmCategory.harassment, HarmBlockThreshold.medium), SafetySetting(HarmCategory.hateSpeech, HarmBlockThreshold.low), ], ); try { print(response.text); } catch (e) { print(e); for (final SafetyRating(:category, :probability) in response.candidates.first.safetyRatings!) { print('Safety Rating: $category - $probability'); } }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-dart/blob/76ae8f89eed4789af0be9e7876d0089909abc419/samples/dart/bin/safety_settings.dart#L60-L85" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-dart/samples/dart/bin/safety_settings.dart#safety_settings_multi" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/safety_settings.dart" data-indented-block="" data-regexp="" data-region-tag="safety_settings_multi">safety_settings.dart</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="safety_settings_multi-JAVA" track-metadata-position="safety_settings_multi" track-metadata-region-tag="safety_settings_multi" data-text="Java" tabindex="-1">Java</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/safety_settings.java/HEAD/safety_settings_multi" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/safety_settings.java" data-git-revision="HEAD" data-region-tag="safety_settings_multi" dir="ltr" is-upgraded syntax="Java"><code translate="no" dir="ltr">SafetySetting harassmentSafety = new SafetySetting(HarmCategory.HARASSMENT, BlockThreshold.ONLY_HIGH); SafetySetting hateSpeechSafety = new SafetySetting(HarmCategory.HATE_SPEECH, BlockThreshold.MEDIUM_AND_ABOVE); // Specify a Gemini model appropriate for your use case GenerativeModel gm = new GenerativeModel( "gemini-1.5-flash", BuildConfig.apiKey, null, // generation config is optional Arrays.asList(harassmentSafety, hateSpeechSafety)); GenerativeModelFutures model = GenerativeModelFutures.from(gm);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/java/safety_settings.java#L52-L66" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/safety_settings.java#safety_settings_multi" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/safety_settings.java" data-indented-block="" data-regexp="" data-region-tag="safety_settings_multi">safety_settings.java</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="system-instruction" data-text="System Instruction" tabindex="-1">System Instruction</h3> <devsite-selector> <section> <h3 id="system_instruction-PYTHON" track-metadata-position="system_instruction" track-metadata-region-tag="system_instruction" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/system_instruction.py/HEAD/system_instruction" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/system_instruction.py" data-git-revision="HEAD" data-region-tag="system_instruction" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">model = genai.GenerativeModel( "models/gemini-1.5-flash", system_instruction="You are a cat. Your name is Neko.", ) response = model.generate_content("Good morning! How are you?") print(response.text)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/system_instruction.py#L23-L28" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/system_instruction.py#system_instruction" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/system_instruction.py" data-indented-block="" data-regexp="" data-region-tag="system_instruction">system_instruction.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="system_instruction-JAVASCRIPT" track-metadata-position="system_instruction" track-metadata-region-tag="system_instruction" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/system_instruction.js/HEAD/system_instruction" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/system_instruction.js" data-git-revision="HEAD" data-region-tag="system_instruction" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI } from "@google/generative-ai"; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash", systemInstruction: "You are a cat. Your name is Neko.", }); const prompt = "Good morning! How are you?"; const result = await model.generateContent(prompt); const response = result.response; const text = response.text(); console.log(text);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/system_instruction.js#L22-L35" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/system_instruction.js#system_instruction" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/system_instruction.js" data-indented-block="" data-regexp="" data-region-tag="system_instruction">system_instruction.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="system_instruction-GO" track-metadata-position="system_instruction" track-metadata-region-tag="system_instruction" data-text="Go" tabindex="-1">Go</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go/HEAD/system_instruction" data-code-snippet="true" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-git-revision="HEAD" data-region-tag="system_instruction" dir="ltr" is-upgraded syntax="Go"><code translate="no" dir="ltr">model := client.GenerativeModel("gemini-1.5-flash") model.SystemInstruction = genai.NewUserContent(genai.Text("You are a cat. Your name is Neko.")) resp, err := model.GenerateContent(ctx, genai.Text("Good morning! How are you?")) if err != nil { log.Fatal(err) } printResponse(resp)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google/generative-ai-go/blob/f453d2d6ca8c5e76e7d8b8615b3339ce68cd378c/genai/internal/samples/docs-snippets_test.go#L262-L268" class="gc-analytics-event" data-category="github_link" data-label="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go#system_instruction" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-indented-block="" data-regexp="" data-region-tag="system_instruction">docs-snippets_test.go</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="system_instruction-SHELL" track-metadata-position="system_instruction" track-metadata-region-tag="system_instruction" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/system_instruction.sh/HEAD/system_instruction" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/system_instruction.sh" data-git-revision="HEAD" data-region-tag="system_instruction" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr">curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:generateContent?key=$GOOGLE_API_KEY" \ -H 'Content-Type: application/json' \ -d '{ "system_instruction": { "parts": { "text": "You are a cat. Your name is Neko."}}, "contents": { "parts": { "text": "Hello there"}}}'<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/system_instruction.sh#L4-L12" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/system_instruction.sh#system_instruction" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/system_instruction.sh" data-indented-block="" data-regexp="" data-region-tag="system_instruction">system_instruction.sh</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="system_instruction-KOTLIN" track-metadata-position="system_instruction" track-metadata-region-tag="system_instruction" data-text="Kotlin" tabindex="-1">Kotlin</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/system_instruction.kt/HEAD/system_instruction" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/system_instruction.kt" data-git-revision="HEAD" data-region-tag="system_instruction" dir="ltr" is-upgraded syntax="Kotlin"><code translate="no" dir="ltr">val generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case modelName = "gemini-1.5-flash", apiKey = BuildConfig.apiKey, systemInstruction = content { text("You are a cat. Your name is Neko.") }, )<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/system_instruction.kt#L31-L37" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/system_instruction.kt#system_instruction" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/system_instruction.kt" data-indented-block="" data-regexp="" data-region-tag="system_instruction">system_instruction.kt</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="system_instruction-SWIFT" track-metadata-position="system_instruction" track-metadata-region-tag="system_instruction" data-text="Swift" tabindex="-1">Swift</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-swift/samples/SystemInstructions.swift/HEAD/system_instruction" data-code-snippet="true" data-github-path="google-gemini/generative-ai-swift/samples/SystemInstructions.swift" data-git-revision="HEAD" data-region-tag="system_instruction" dir="ltr" is-upgraded syntax="Swift"><code translate="no" dir="ltr">let generativeModel = GenerativeModel( // Specify a model that supports system instructions, like a Gemini 1.5 model name: "gemini-1.5-flash", // Access your API key from your on-demand resource .plist file (see "Set up your API key" // above) apiKey: APIKey.default, systemInstruction: ModelContent(role: "system", parts: "You are a cat. Your name is Neko.") )<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-swift/blob/44b8ce120425f9cf53ca756f3434ca2c2696f8bd/samples/SystemInstructions.swift#L35-L43" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-swift/samples/SystemInstructions.swift#system_instruction" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-swift/samples/SystemInstructions.swift" data-indented-block="" data-regexp="" data-region-tag="system_instruction">SystemInstructions.swift</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="system_instructions-DART" track-metadata-position="system_instructions" track-metadata-region-tag="system_instructions" data-text="Dart" tabindex="-1">Dart</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-dart/samples/dart/bin/system_instructions.dart/HEAD/system_instructions" data-code-snippet="true" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/system_instructions.dart" data-git-revision="HEAD" data-region-tag="system_instructions" dir="ltr" is-upgraded syntax="Dart"><code translate="no" dir="ltr">// Make sure to include this import: // import 'package:google_generative_ai/google_generative_ai.dart'; final model = GenerativeModel( model: 'gemini-1.5-flash', apiKey: apiKey, systemInstruction: Content.system('You are a cat. Your name is Neko.'), ); final prompt = 'Good morning! How are you?'; final response = await model.generateContent([Content.text(prompt)]); print(response.text);<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-dart/blob/76ae8f89eed4789af0be9e7876d0089909abc419/samples/dart/bin/system_instructions.dart#L30-L40" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-dart/samples/dart/bin/system_instructions.dart#system_instructions" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/system_instructions.dart" data-indented-block="" data-regexp="" data-region-tag="system_instructions">system_instructions.dart</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="system_instruction-JAVA" track-metadata-position="system_instruction" track-metadata-region-tag="system_instruction" data-text="Java" tabindex="-1">Java</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/system_instruction.java/HEAD/system_instruction" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/system_instruction.java" data-git-revision="HEAD" data-region-tag="system_instruction" dir="ltr" is-upgraded syntax="Java"><code translate="no" dir="ltr">GenerativeModel model = new GenerativeModel( // Specify a Gemini model appropriate for your use case /* modelName */ "gemini-1.5-flash", /* apiKey */ BuildConfig.apiKey, /* generationConfig (optional) */ null, /* safetySettings (optional) */ null, /* requestOptions (optional) */ new RequestOptions(), /* tools (optional) */ null, /* toolsConfig (optional) */ null, /* systemInstruction (optional) */ new Content.Builder() .addText("You are a cat. Your name is Neko.") .build());<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/java/system_instruction.java#L31-L43" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/system_instruction.java#system_instruction" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/system_instruction.java" data-indented-block="" data-regexp="" data-region-tag="system_instruction">system_instruction.java</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> </devsite-selector> </div> </div> <div class="column-container"> <div class="reference"> <section id="body.response_body"> <h3 id="response-body" data-text="Response body" tabindex="-1">Response body</h3> If successful, the response body contains an instance of <code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.GenerateContentResponse">GenerateContentResponse</a></code>. </section> </div> </div> </section> </div><div itemscope="" itemtype="http://developers.google.com/ReferenceObject"><h2 id="method:-models.streamgeneratecontent" data-text="Method: models.streamGenerateContent" tabindex="-1">Method: models.streamGenerateContent</h2><a name="v1beta.models.streamGenerateContent"></a> <meta content="streamGenerateContent" itemprop="name"/> <meta content="/api/rest/v1beta/models/streamGenerateContent" itemprop="path"/> <section class="prototype" id="/api/rest/v1beta/models/streamGenerateContent"> <ul class="toc"> <li><a href="#body.HTTP_TEMPLATE">Endpoint</a></li><li><a href="#body.PATH_PARAMETERS">Path parameters</a></li><li><a href="#body.request_body">Request body</a> <ul> <li><a href="#body.request_body.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#body.response_body">Response body</a></li><li><a href="#body.aspect">Authorization scopes</a></li><li><a href="#body.codeSnippets">Example request</a> <ul> <li><a href="#body.codeSnippets.group">Text</a></li><li><a href="#body.codeSnippets.group_1">Image</a></li><li><a href="#body.codeSnippets.group_2">Audio</a></li><li><a href="#body.codeSnippets.group_3">Video</a></li><li><a href="#body.codeSnippets.group_4">PDF</a></li><li><a href="#body.codeSnippets.group_5">Chat</a></li> </ul> </li> </ul> <section id="google.ai.generativelanguage.v1beta.GenerativeService.StreamGenerateContent"> </section> <section id="description"> Generates a <a href="https://ai.google.dev/gemini-api/docs/text-generation?lang=python#generate-a-text-stream">streamed response</a> from the model given an input <code translate="no" dir="ltr">GenerateContentRequest</code>. </section> <div class="column-container"> <div class="reference"> <section id="body.HTTP_TEMPLATE"> <h3 id="endpoint_1" data-text="Endpoint" tabindex="-1">Endpoint</h3> post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:streamGenerateContent </section> <section id="body.PATH_PARAMETERS"> <h3 id="path-parameters_1" data-text="Path parameters" tabindex="-1">Path parameters</h3> <section id="body.PATH_PARAMETERS.model"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">model</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Required. The name of the <code translate="no" dir="ltr">Model</code> to use for generating the completion.Format: <code translate="no" dir="ltr">name=models/{model}</code>. It takes the form <code translate="no" dir="ltr">models/{model}</code>. </div> </div> </section> </section> <section id="body.request_body"> <h3 id="request-body_1" data-text="Request body" tabindex="-1">Request body</h3> The request body contains data with the following structure: <section id="body.request_body.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="body.request_body.FIELDS.contents"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">contents[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/caching#Content">Content</a></code>)</code> </div> <div class="field-description"> Required. The content of the current conversation with the model.For single-turn queries, this is a single instance. For multi-turn queries like <a href="https://ai.google.dev/gemini-api/docs/text-generation#chat">chat</a>, this is a repeated field that contains the conversation history and the latest request. </div> </div> </section> <section id="body.request_body.FIELDS.tools"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">tools[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/caching#Tool">Tool</a></code>)</code> </div> <div class="field-description"> Optional. A list of <code translate="no" dir="ltr">Tools</code> the <code translate="no" dir="ltr">Model</code> may use to generate the next response.A <code translate="no" dir="ltr">Tool</code> is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the <code translate="no" dir="ltr">Model</code>. Supported <code translate="no" dir="ltr">Tool</code>s are <code translate="no" dir="ltr">Function</code> and <code translate="no" dir="ltr">codeExecution</code>. Refer to the <a href="https://ai.google.dev/gemini-api/docs/function-calling">Function calling</a> and the <a href="https://ai.google.dev/gemini-api/docs/code-execution">Code execution</a> guides to learn more. </div> </div> </section> <section id="body.request_body.FIELDS.tool_config"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">toolConfig</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/caching#ToolConfig">ToolConfig</a></code>)</code> </div> <div class="field-description"> Optional. Tool configuration for any <code translate="no" dir="ltr">Tool</code> specified in the request. Refer to the <a href="https://ai.google.dev/gemini-api/docs/function-calling#function_calling_mode">Function calling guide</a> for a usage example. </div> </div> </section> <section id="body.request_body.FIELDS.safety_settings"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">safetySettings[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.SafetySetting">SafetySetting</a></code>)</code> </div> <div class="field-description"> Optional. A list of unique <code translate="no" dir="ltr">SafetySetting</code> instances for blocking unsafe content.This will be enforced on the <code translate="no" dir="ltr">GenerateContentRequest.contents</code> and <code translate="no" dir="ltr">GenerateContentResponse.candidates</code>. There should not be more than one setting for each <code translate="no" dir="ltr">SafetyCategory</code> type. The API will block any contents and responses that fail to meet the thresholds set by these settings. This list overrides the default settings for each <code translate="no" dir="ltr">SafetyCategory</code> specified in the safetySettings. If there is no <code translate="no" dir="ltr">SafetySetting</code> for a given <code translate="no" dir="ltr">SafetyCategory</code> provided in the list, the API will use the default safety setting for that category. Harm categories HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT are supported. Refer to the <a href="https://ai.google.dev/gemini-api/docs/safety-settings">guide</a> for detailed information on available safety settings. Also refer to the <a href="https://ai.google.dev/gemini-api/docs/safety-guidance">Safety guidance</a> to learn how to incorporate safety considerations in your AI applications. </div> </div> </section> <section id="body.request_body.FIELDS.system_instruction"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">systemInstruction</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/caching#Content">Content</a></code>)</code> </div> <div class="field-description"> Optional. Developer set <a href="https://ai.google.dev/gemini-api/docs/system-instructions">system instruction(s)</a>. Currently, text only. </div> </div> </section> <section id="body.request_body.FIELDS.generation_config"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">generationConfig</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.GenerationConfig">GenerationConfig</a></code>)</code> </div> <div class="field-description"> Optional. Configuration options for model generation and outputs. </div> </div> </section> <section id="body.request_body.FIELDS.cached_content"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">cachedContent</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Optional. The name of the content <a href="https://ai.google.dev/gemini-api/docs/caching">cached</a> to use as context to serve the prediction. Format: <code translate="no" dir="ltr">cachedContents/{cachedContent}</code> </div> </div> </section> </section> </section> </div> <div class="second-column"> <h3 id="example-request_1" data-text="Example request" tabindex="-1">Example request</h3> <devsite-selector> <section> <h3 id="text_1" data-text="Text" tabindex="-1">Text</h3> <devsite-selector> <section> <h3 id="text_gen_text_only_prompt_streaming-PYTHON" track-metadata-position="text_gen_text_only_prompt_streaming" track-metadata-region-tag="text_gen_text_only_prompt_streaming" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/text_generation.py/HEAD/text_gen_text_only_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt_streaming" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">model = genai.GenerativeModel("gemini-1.5-flash") response = model.generate_content("Write a story about a magic backpack.", stream=True) for chunk in response: print(chunk.text) print("_" * 80)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/text_generation.py#L33-L37" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/text_generation.py#text_gen_text_only_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt_streaming">text_generation.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt_streaming-JAVASCRIPT" track-metadata-position="text_gen_text_only_prompt_streaming" track-metadata-region-tag="text_gen_text_only_prompt_streaming" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/text_generation.js/HEAD/text_gen_text_only_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt_streaming" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI } from "@google/generative-ai"; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash" }); const prompt = "Write a story about a magic backpack."; const result = await model.generateContentStream(prompt); // Print text as it comes in. for await (const chunk of result.stream) { const chunkText = chunk.text(); process.stdout.write(chunkText); }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/text_generation.js#L43-L56" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/text_generation.js#text_gen_text_only_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt_streaming">text_generation.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt_streaming-GO" track-metadata-position="text_gen_text_only_prompt_streaming" track-metadata-region-tag="text_gen_text_only_prompt_streaming" data-text="Go" tabindex="-1">Go</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go/HEAD/text_gen_text_only_prompt_streaming" data-code-snippet="true" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt_streaming" dir="ltr" is-upgraded syntax="Go"><code translate="no" dir="ltr">model := client.GenerativeModel("gemini-1.5-flash") iter := model.GenerateContentStream(ctx, genai.Text("Write a story about a magic backpack.")) for { resp, err := iter.Next() if err == iterator.Done { break } if err != nil { log.Fatal(err) } printResponse(resp) }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google/generative-ai-go/blob/f453d2d6ca8c5e76e7d8b8615b3339ce68cd378c/genai/internal/samples/docs-snippets_test.go#L355-L366" class="gc-analytics-event" data-category="github_link" data-label="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go#text_gen_text_only_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt_streaming">docs-snippets_test.go</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt_streaming-SHELL" track-metadata-position="text_gen_text_only_prompt_streaming" track-metadata-region-tag="text_gen_text_only_prompt_streaming" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/text_generation.sh/HEAD/text_gen_text_only_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt_streaming" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr">curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:streamGenerateContent?alt=sse&key=${GOOGLE_API_KEY}" \ -H 'Content-Type: application/json' \ --no-buffer \ -d '{ "contents":[{"parts":[{"text": "Write a story about a magic backpack."}]}]}'<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/text_generation.sh#L33-L37" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/text_generation.sh#text_gen_text_only_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt_streaming">text_generation.sh</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt_streaming-KOTLIN" track-metadata-position="text_gen_text_only_prompt_streaming" track-metadata-region-tag="text_gen_text_only_prompt_streaming" data-text="Kotlin" tabindex="-1">Kotlin</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt/HEAD/text_gen_text_only_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt_streaming" dir="ltr" is-upgraded syntax="Kotlin"><code translate="no" dir="ltr">val generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case modelName = "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" above) apiKey = BuildConfig.apiKey) val prompt = "Write a story about a magic backpack." // Use streaming with text-only input generativeModel.generateContentStream(prompt).collect { chunk -> print(chunk.text) } <div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt#L50-L60" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt#text_gen_text_only_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt_streaming">text_generation.kt</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt_streaming-SWIFT" track-metadata-position="text_gen_text_only_prompt_streaming" track-metadata-region-tag="text_gen_text_only_prompt_streaming" data-text="Swift" tabindex="-1">Swift</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-swift/samples/TextGeneration.swift/HEAD/text_gen_text_only_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-swift/samples/TextGeneration.swift" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt_streaming" dir="ltr" is-upgraded syntax="Swift"><code translate="no" dir="ltr">let generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case name: "gemini-1.5-flash", // Access your API key from your on-demand resource .plist file (see "Set up your API key" // above) apiKey: APIKey.default ) let prompt = "Write a story about a magic backpack." // Use streaming with text-only input for try await response in generativeModel.generateContentStream(prompt) { if let text = response.text { print(text) } }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-swift/blob/44b8ce120425f9cf53ca756f3434ca2c2696f8bd/samples/TextGeneration.swift#L55-L70" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-swift/samples/TextGeneration.swift#text_gen_text_only_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-swift/samples/TextGeneration.swift" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt_streaming">TextGeneration.swift</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt_streaming-DART" track-metadata-position="text_gen_text_only_prompt_streaming" track-metadata-region-tag="text_gen_text_only_prompt_streaming" data-text="Dart" tabindex="-1">Dart</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart/HEAD/text_gen_text_only_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt_streaming" dir="ltr" is-upgraded syntax="Dart"><code translate="no" dir="ltr">// Make sure to include this import: // import 'package:google_generative_ai/google_generative_ai.dart'; final model = GenerativeModel( model: 'gemini-1.5-flash', apiKey: apiKey, ); final prompt = 'Write a story about a magic backpack.'; final responses = model.generateContentStream([Content.text(prompt)]); await for (final response in responses) { print(response.text); }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-dart/blob/76ae8f89eed4789af0be9e7876d0089909abc419/samples/dart/bin/text_generation.dart#L45-L56" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart#text_gen_text_only_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt_streaming">text_generation.dart</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_text_only_prompt_streaming-JAVA" track-metadata-position="text_gen_text_only_prompt_streaming" track-metadata-region-tag="text_gen_text_only_prompt_streaming" data-text="Java" tabindex="-1">Java</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java/HEAD/text_gen_text_only_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java" data-git-revision="HEAD" data-region-tag="text_gen_text_only_prompt_streaming" dir="ltr" is-upgraded syntax="Java"><code translate="no" dir="ltr">// Specify a Gemini model appropriate for your use case GenerativeModel gm = new GenerativeModel( /* modelName */ "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" // above) /* apiKey */ BuildConfig.apiKey); GenerativeModelFutures model = GenerativeModelFutures.from(gm); Content content = new Content.Builder().addText("Write a story about a magic backpack.").build(); Publisher<GenerateContentResponse> streamingResponse = model.generateContentStream(content); StringBuilder outputContent = new StringBuilder(); streamingResponse.subscribe( new Subscriber<GenerateContentResponse>() { @Override public void onNext(GenerateContentResponse generateContentResponse) { String chunk = generateContentResponse.getText(); outputContent.append(chunk); } @Override public void onComplete() { System.out.println(outputContent); } @Override public void onError(Throwable t) { t.printStackTrace(); } @Override public void onSubscribe(Subscription s) { s.request(Long.MAX_VALUE); } });<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java#L80-L118" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java#text_gen_text_only_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java" data-indented-block="" data-regexp="" data-region-tag="text_gen_text_only_prompt_streaming">text_generation.java</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="image_1" data-text="Image" tabindex="-1">Image</h3> <devsite-selector> <section> <h3 id="text_gen_multimodal_one_image_prompt_streaming-PYTHON" track-metadata-position="text_gen_multimodal_one_image_prompt_streaming" track-metadata-region-tag="text_gen_multimodal_one_image_prompt_streaming" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/text_generation.py/HEAD/text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt_streaming" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">import PIL.Image model = genai.GenerativeModel("gemini-1.5-flash") organ = PIL.Image.open(media / "organ.jpg") response = model.generate_content(["Tell me about this instrument", organ], stream=True) for chunk in response: print(chunk.text) print("_" * 80)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/text_generation.py#L52-L59" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/text_generation.py#text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt_streaming">text_generation.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt_streaming-JAVASCRIPT" track-metadata-position="text_gen_multimodal_one_image_prompt_streaming" track-metadata-region-tag="text_gen_multimodal_one_image_prompt_streaming" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/text_generation.js/HEAD/text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt_streaming" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI } from "@google/generative-ai"; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash" }); function fileToGenerativePart(path, mimeType) { return { inlineData: { data: Buffer.from(fs.readFileSync(path)).toString("base64"), mimeType, }, }; } const prompt = "Describe how this product might be manufactured."; // Note: The only accepted mime types are some image types, image/*. const imagePart = fileToGenerativePart( `${mediaPath}/jetpack.jpg`, "image/jpeg", ); const result = await model.generateContentStream([prompt, imagePart]); // Print text as it comes in. for await (const chunk of result.stream) { const chunkText = chunk.text(); process.stdout.write(chunkText); }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/text_generation.js#L90-L117" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/text_generation.js#text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt_streaming">text_generation.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt_streaming-GO" track-metadata-position="text_gen_multimodal_one_image_prompt_streaming" track-metadata-region-tag="text_gen_multimodal_one_image_prompt_streaming" data-text="Go" tabindex="-1">Go</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go/HEAD/text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt_streaming" dir="ltr" is-upgraded syntax="Go"><code translate="no" dir="ltr">model := client.GenerativeModel("gemini-1.5-flash") imgData, err := os.ReadFile(filepath.Join(testDataDir, "organ.jpg")) if err != nil { log.Fatal(err) } iter := model.GenerateContentStream(ctx, genai.Text("Tell me about this instrument"), genai.ImageData("jpeg", imgData)) for { resp, err := iter.Next() if err == iterator.Done { break } if err != nil { log.Fatal(err) } printResponse(resp) }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google/generative-ai-go/blob/f453d2d6ca8c5e76e7d8b8615b3339ce68cd378c/genai/internal/samples/docs-snippets_test.go#L379-L397" class="gc-analytics-event" data-category="github_link" data-label="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go#text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt_streaming">docs-snippets_test.go</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt_streaming-SHELL" track-metadata-position="text_gen_multimodal_one_image_prompt_streaming" track-metadata-region-tag="text_gen_multimodal_one_image_prompt_streaming" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/text_generation.sh/HEAD/text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt_streaming" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr">cat > "$TEMP_JSON" << EOF { "contents": [{ "parts":[ {"text": "Tell me about this instrument"}, { "inline_data": { "mime_type":"image/jpeg", "data": "$(cat "$TEMP_B64")" } } ] }] } EOF curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:streamGenerateContent?alt=sse&key=$GOOGLE_API_KEY" \ -H 'Content-Type: application/json' \ -X POST \ -d "@$TEMP_JSON" 2> /dev/null<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/text_generation.sh#L74-L94" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/text_generation.sh#text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt_streaming">text_generation.sh</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt_streaming-KOTLIN" track-metadata-position="text_gen_multimodal_one_image_prompt_streaming" track-metadata-region-tag="text_gen_multimodal_one_image_prompt_streaming" data-text="Kotlin" tabindex="-1">Kotlin</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt/HEAD/text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt_streaming" dir="ltr" is-upgraded syntax="Kotlin"><code translate="no" dir="ltr">val generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case modelName = "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" above) apiKey = BuildConfig.apiKey) val image: Bitmap = BitmapFactory.decodeResource(context.resources, R.drawable.image) val inputContent = content { image(image) text("What's in this picture?") } generativeModel.generateContentStream(inputContent).collect { chunk -> print(chunk.text) }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt#L86-L99" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt#text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/text_generation.kt" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt_streaming">text_generation.kt</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt_streaming-SWIFT" track-metadata-position="text_gen_multimodal_one_image_prompt_streaming" track-metadata-region-tag="text_gen_multimodal_one_image_prompt_streaming" data-text="Swift" tabindex="-1">Swift</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-swift/samples/TextGeneration.swift/HEAD/text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-swift/samples/TextGeneration.swift" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt_streaming" dir="ltr" is-upgraded syntax="Swift"><code translate="no" dir="ltr">let generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case name: "gemini-1.5-flash", // Access your API key from your on-demand resource .plist file (see "Set up your API key" // above) apiKey: APIKey.default ) guard let image = UIImage(systemName: "cloud.sun") else { fatalError() } let prompt = "What's in this picture?" for try await response in generativeModel.generateContentStream(image, prompt) { if let text = response.text { print(text) } }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-swift/blob/44b8ce120425f9cf53ca756f3434ca2c2696f8bd/samples/TextGeneration.swift#L98-L115" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-swift/samples/TextGeneration.swift#text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-swift/samples/TextGeneration.swift" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt_streaming">TextGeneration.swift</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt_streaming-DART" track-metadata-position="text_gen_multimodal_one_image_prompt_streaming" track-metadata-region-tag="text_gen_multimodal_one_image_prompt_streaming" data-text="Dart" tabindex="-1">Dart</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart/HEAD/text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt_streaming" dir="ltr" is-upgraded syntax="Dart"><code translate="no" dir="ltr">// Make sure to include this import: // import 'package:google_generative_ai/google_generative_ai.dart'; final model = GenerativeModel( model: 'gemini-1.5-flash', apiKey: apiKey, ); Future<DataPart> fileToPart(String mimeType, String path) async { return DataPart(mimeType, await File(path).readAsBytes()); } final prompt = 'Describe how this product might be manufactured.'; final image = await fileToPart('image/jpeg', 'resources/jetpack.jpg'); final responses = model.generateContentStream([ Content.multi([TextPart(prompt), image]) ]); await for (final response in responses) { print(response.text); }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-dart/blob/76ae8f89eed4789af0be9e7876d0089909abc419/samples/dart/bin/text_generation.dart#L85-L104" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart#text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/text_generation.dart" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt_streaming">text_generation.dart</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_one_image_prompt_streaming-JAVA" track-metadata-position="text_gen_multimodal_one_image_prompt_streaming" track-metadata-region-tag="text_gen_multimodal_one_image_prompt_streaming" data-text="Java" tabindex="-1">Java</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java/HEAD/text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_one_image_prompt_streaming" dir="ltr" is-upgraded syntax="Java"><code translate="no" dir="ltr">// Specify a Gemini model appropriate for your use case GenerativeModel gm = new GenerativeModel( /* modelName */ "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" // above) /* apiKey */ BuildConfig.apiKey); GenerativeModelFutures model = GenerativeModelFutures.from(gm); Bitmap image1 = BitmapFactory.decodeResource(context.getResources(), R.drawable.image1); Bitmap image2 = BitmapFactory.decodeResource(context.getResources(), R.drawable.image2); Content content = new Content.Builder() .addText("What's different between these pictures?") .addImage(image1) .addImage(image2) .build(); // For illustrative purposes only. You should use an executor that fits your needs. Executor executor = Executors.newSingleThreadExecutor(); Publisher<GenerateContentResponse> streamingResponse = model.generateContentStream(content); StringBuilder outputContent = new StringBuilder(); streamingResponse.subscribe( new Subscriber<GenerateContentResponse>() { @Override public void onNext(GenerateContentResponse generateContentResponse) { String chunk = generateContentResponse.getText(); outputContent.append(chunk); } @Override public void onComplete() { System.out.println(outputContent); } @Override public void onError(Throwable t) { t.printStackTrace(); } @Override public void onSubscribe(Subscription s) { s.request(Long.MAX_VALUE); } });<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java#L165-L213" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java#text_gen_multimodal_one_image_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/text_generation.java" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_one_image_prompt_streaming">text_generation.java</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="audio_1" data-text="Audio" tabindex="-1">Audio</h3> <devsite-selector> <section> <h3 id="text_gen_multimodal_audio_streaming-PYTHON" track-metadata-position="text_gen_multimodal_audio_streaming" track-metadata-region-tag="text_gen_multimodal_audio_streaming" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/text_generation.py/HEAD/text_gen_multimodal_audio_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_audio_streaming" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">model = genai.GenerativeModel("gemini-1.5-flash") sample_audio = genai.upload_file(media / "sample.mp3") response = model.generate_content(["Give me a summary of this audio file.", sample_audio]) for chunk in response: print(chunk.text) print("_" * 80)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/text_generation.py#L101-L107" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/text_generation.py#text_gen_multimodal_audio_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_audio_streaming">text_generation.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_audio_streaming-SHELL" track-metadata-position="text_gen_multimodal_audio_streaming" track-metadata-region-tag="text_gen_multimodal_audio_streaming" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/text_generation.sh/HEAD/text_gen_multimodal_audio_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_audio_streaming" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr"># Use File API to upload audio data to API request. MIME_TYPE=$(file -b --mime-type "${AUDIO_PATH}") NUM_BYTES=$(wc -c < "${AUDIO_PATH}") DISPLAY_NAME=AUDIO tmp_header_file=upload-header.tmp # Initial resumable request defining metadata. # The upload url is in the response headers dump them to a file. curl "${BASE_URL}/upload/v1beta/files?key=${GOOGLE_API_KEY}" \ -D upload-header.tmp \ -H "X-Goog-Upload-Protocol: resumable" \ -H "X-Goog-Upload-Command: start" \ -H "X-Goog-Upload-Header-Content-Length: ${NUM_BYTES}" \ -H "X-Goog-Upload-Header-Content-Type: ${MIME_TYPE}" \ -H "Content-Type: application/json" \ -d "{'file': {'display_name': '${DISPLAY_NAME}'}}" 2> /dev/null upload_url=$(grep -i "x-goog-upload-url: " "${tmp_header_file}" | cut -d" " -f2 | tr -d "\r") rm "${tmp_header_file}" # Upload the actual bytes. curl "${upload_url}" \ -H "Content-Length: ${NUM_BYTES}" \ -H "X-Goog-Upload-Offset: 0" \ -H "X-Goog-Upload-Command: upload, finalize" \ --data-binary "@${AUDIO_PATH}" 2> /dev/null > file_info.json file_uri=$(jq ".file.uri" file_info.json) echo file_uri=$file_uri curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:streamGenerateContent?alt=sse&key=$GOOGLE_API_KEY" \ -H 'Content-Type: application/json' \ -X POST \ -d '{ "contents": [{ "parts":[ {"text": "Please describe this file."}, {"file_data":{"mime_type": "audio/mpeg", "file_uri": '$file_uri'}}] }] }' 2> /dev/null > response.json cat response.json echo<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/text_generation.sh#L224-L268" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/text_generation.sh#text_gen_multimodal_audio_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_audio_streaming">text_generation.sh</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="video_1" data-text="Video" tabindex="-1">Video</h3> <devsite-selector> <section> <h3 id="text_gen_multimodal_video_prompt_streaming-PYTHON" track-metadata-position="text_gen_multimodal_video_prompt_streaming" track-metadata-region-tag="text_gen_multimodal_video_prompt_streaming" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/text_generation.py/HEAD/text_gen_multimodal_video_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_video_prompt_streaming" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">import time # Video clip (CC BY 3.0) from https://peach.blender.org/download/ myfile = genai.upload_file(media / "Big_Buck_Bunny.mp4") print(f"{myfile=}") # Videos need to be processed before you can use them. while myfile.state.name == "PROCESSING": print("processing video...") time.sleep(5) myfile = genai.get_file(myfile.name) model = genai.GenerativeModel("gemini-1.5-flash") response = model.generate_content([myfile, "Describe this video clip"]) for chunk in response: print(chunk.text) print("_" * 80)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/text_generation.py#L131-L148" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/text_generation.py#text_gen_multimodal_video_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_video_prompt_streaming">text_generation.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_video_prompt_streaming-JAVASCRIPT" track-metadata-position="text_gen_multimodal_video_prompt_streaming" track-metadata-region-tag="text_gen_multimodal_video_prompt_streaming" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/text_generation.js/HEAD/text_gen_multimodal_video_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_video_prompt_streaming" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI } from "@google/generative-ai"; // import { GoogleAIFileManager, FileState } from "@google/generative-ai/server"; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash" }); const fileManager = new GoogleAIFileManager(process.env.API_KEY); const uploadResult = await fileManager.uploadFile( `${mediaPath}/Big_Buck_Bunny.mp4`, { mimeType: "video/mp4" }, ); let file = await fileManager.getFile(uploadResult.file.name); while (file.state === FileState.PROCESSING) { process.stdout.write("."); // Sleep for 10 seconds await new Promise((resolve) => setTimeout(resolve, 10_000)); // Fetch the file from the API again file = await fileManager.getFile(uploadResult.file.name); } if (file.state === FileState.FAILED) { throw new Error("Video processing failed."); } const prompt = "Describe this video clip"; const videoPart = { fileData: { fileUri: uploadResult.file.uri, mimeType: uploadResult.file.mimeType, }, }; const result = await model.generateContentStream([prompt, videoPart]); // Print text as it comes in. for await (const chunk of result.stream) { const chunkText = chunk.text(); process.stdout.write(chunkText); }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/text_generation.js#L262-L301" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/text_generation.js#text_gen_multimodal_video_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/text_generation.js" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_video_prompt_streaming">text_generation.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_video_prompt_streaming-GO" track-metadata-position="text_gen_multimodal_video_prompt_streaming" track-metadata-region-tag="text_gen_multimodal_video_prompt_streaming" data-text="Go" tabindex="-1">Go</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go/HEAD/text_gen_multimodal_video_prompt_streaming" data-code-snippet="true" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_video_prompt_streaming" dir="ltr" is-upgraded syntax="Go"><code translate="no" dir="ltr">model := client.GenerativeModel("gemini-1.5-flash") file, err := client.UploadFileFromPath(ctx, filepath.Join(testDataDir, "earth.mp4"), nil) if err != nil { log.Fatal(err) } defer client.DeleteFile(ctx, file.Name) iter := model.GenerateContentStream(ctx, genai.Text("Describe this video clip"), genai.FileData{URI: file.URI}) for { resp, err := iter.Next() if err == iterator.Done { break } if err != nil { log.Fatal(err) } printResponse(resp) }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google/generative-ai-go/blob/f453d2d6ca8c5e76e7d8b8615b3339ce68cd378c/genai/internal/samples/docs-snippets_test.go#L410-L430" class="gc-analytics-event" data-category="github_link" data-label="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go#text_gen_multimodal_video_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_video_prompt_streaming">docs-snippets_test.go</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_video_prompt_streaming-SHELL" track-metadata-position="text_gen_multimodal_video_prompt_streaming" track-metadata-region-tag="text_gen_multimodal_video_prompt_streaming" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/text_generation.sh/HEAD/text_gen_multimodal_video_prompt_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_video_prompt_streaming" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr"># Use File API to upload audio data to API request. MIME_TYPE=$(file -b --mime-type "${VIDEO_PATH}") NUM_BYTES=$(wc -c < "${VIDEO_PATH}") DISPLAY_NAME=VIDEO_PATH # Initial resumable request defining metadata. # The upload url is in the response headers dump them to a file. curl "${BASE_URL}/upload/v1beta/files?key=${GOOGLE_API_KEY}" \ -D upload-header.tmp \ -H "X-Goog-Upload-Protocol: resumable" \ -H "X-Goog-Upload-Command: start" \ -H "X-Goog-Upload-Header-Content-Length: ${NUM_BYTES}" \ -H "X-Goog-Upload-Header-Content-Type: ${MIME_TYPE}" \ -H "Content-Type: application/json" \ -d "{'file': {'display_name': '${DISPLAY_NAME}'}}" 2> /dev/null upload_url=$(grep -i "x-goog-upload-url: " "${tmp_header_file}" | cut -d" " -f2 | tr -d "\r") rm "${tmp_header_file}" # Upload the actual bytes. curl "${upload_url}" \ -H "Content-Length: ${NUM_BYTES}" \ -H "X-Goog-Upload-Offset: 0" \ -H "X-Goog-Upload-Command: upload, finalize" \ --data-binary "@${VIDEO_PATH}" 2> /dev/null > file_info.json file_uri=$(jq ".file.uri" file_info.json) echo file_uri=$file_uri state=$(jq ".file.state" file_info.json) echo state=$state while [[ "($state)" = *"PROCESSING"* ]]; do echo "Processing video..." sleep 5 # Get the file of interest to check state curl https://generativelanguage.googleapis.com/v1beta/files/$name > file_info.json state=$(jq ".file.state" file_info.json) done curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:streamGenerateContent?alt=sse&key=$GOOGLE_API_KEY" \ -H 'Content-Type: application/json' \ -X POST \ -d '{ "contents": [{ "parts":[ {"text": "Please describe this file."}, {"file_data":{"mime_type": "video/mp4", "file_uri": '$file_uri'}}] }] }' 2> /dev/null > response.json cat response.json echo<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/text_generation.sh#L335-L389" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/text_generation.sh#text_gen_multimodal_video_prompt_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_video_prompt_streaming">text_generation.sh</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="pdf_1" data-text="PDF" tabindex="-1">PDF</h3> <devsite-selector> <section> <h3 id="text_gen_multimodal_pdf_streaming-PYTHON" track-metadata-position="text_gen_multimodal_pdf_streaming" track-metadata-region-tag="text_gen_multimodal_pdf_streaming" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/text_generation.py/HEAD/text_gen_multimodal_pdf_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_pdf_streaming" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">model = genai.GenerativeModel("gemini-1.5-flash") sample_pdf = genai.upload_file(media / "test.pdf") response = model.generate_content(["Give me a summary of this document:", sample_pdf]) for chunk in response: print(chunk.text) print("_" * 80)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/text_generation.py#L161-L167" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/text_generation.py#text_gen_multimodal_pdf_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/text_generation.py" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_pdf_streaming">text_generation.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="text_gen_multimodal_pdf_streaming-SHELL" track-metadata-position="text_gen_multimodal_pdf_streaming" track-metadata-region-tag="text_gen_multimodal_pdf_streaming" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/text_generation.sh/HEAD/text_gen_multimodal_pdf_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-git-revision="HEAD" data-region-tag="text_gen_multimodal_pdf_streaming" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr">MIME_TYPE=$(file -b --mime-type "${PDF_PATH}") NUM_BYTES=$(wc -c < "${PDF_PATH}") DISPLAY_NAME=TEXT echo $MIME_TYPE tmp_header_file=upload-header.tmp # Initial resumable request defining metadata. # The upload url is in the response headers dump them to a file. curl "${BASE_URL}/upload/v1beta/files?key=${GOOGLE_API_KEY}" \ -D upload-header.tmp \ -H "X-Goog-Upload-Protocol: resumable" \ -H "X-Goog-Upload-Command: start" \ -H "X-Goog-Upload-Header-Content-Length: ${NUM_BYTES}" \ -H "X-Goog-Upload-Header-Content-Type: ${MIME_TYPE}" \ -H "Content-Type: application/json" \ -d "{'file': {'display_name': '${DISPLAY_NAME}'}}" 2> /dev/null upload_url=$(grep -i "x-goog-upload-url: " "${tmp_header_file}" | cut -d" " -f2 | tr -d "\r") rm "${tmp_header_file}" # Upload the actual bytes. curl "${upload_url}" \ -H "Content-Length: ${NUM_BYTES}" \ -H "X-Goog-Upload-Offset: 0" \ -H "X-Goog-Upload-Command: upload, finalize" \ --data-binary "@${PDF_PATH}" 2> /dev/null > file_info.json file_uri=$(jq ".file.uri" file_info.json) echo file_uri=$file_uri # Now generate content using that file curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:streamGenerateContent?alt=sse&key=$GOOGLE_API_KEY" \ -H 'Content-Type: application/json' \ -X POST \ -d '{ "contents": [{ "parts":[ {"text": "Can you add a few more lines to this poem?"}, {"file_data":{"mime_type": "application/pdf", "file_uri": '$file_uri'}}] }] }' 2> /dev/null > response.json cat response.json echo<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/text_generation.sh#L445-L491" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/text_generation.sh#text_gen_multimodal_pdf_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/text_generation.sh" data-indented-block="" data-regexp="" data-region-tag="text_gen_multimodal_pdf_streaming">text_generation.sh</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> <section> <h3 id="chat_1" data-text="Chat" tabindex="-1">Chat</h3> <devsite-selector> <section> <h3 id="chat_streaming-PYTHON" track-metadata-position="chat_streaming" track-metadata-region-tag="chat_streaming" data-text="Python" tabindex="-1">Python</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/chat.py/HEAD/chat_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/chat.py" data-git-revision="HEAD" data-region-tag="chat_streaming" dir="ltr" is-upgraded syntax="Python"><code translate="no" dir="ltr">model = genai.GenerativeModel("gemini-1.5-flash") chat = model.start_chat( history=[ {"role": "user", "parts": "Hello"}, {"role": "model", "parts": "Great to meet you. What would you like to know?"}, ] ) response = chat.send_message("I have 2 dogs in my house.", stream=True) for chunk in response: print(chunk.text) print("_" * 80) response = chat.send_message("How many paws are in my house?", stream=True) for chunk in response: print(chunk.text) print("_" * 80) print(chat.history)<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/chat.py#L41-L57" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/chat.py#chat_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/chat.py" data-indented-block="" data-regexp="" data-region-tag="chat_streaming">chat.py</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat_streaming-JAVASCRIPT" track-metadata-position="chat_streaming" track-metadata-region-tag="chat_streaming" data-text="Node.js" tabindex="-1">Node.js</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-js/samples/chat.js/HEAD/chat_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-js/samples/chat.js" data-git-revision="HEAD" data-region-tag="chat_streaming" dir="ltr" is-upgraded syntax="JavaScript"><code translate="no" dir="ltr">// Make sure to include these imports: // import { GoogleGenerativeAI } from "@google/generative-ai"; const genAI = new GoogleGenerativeAI(process.env.API_KEY); const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash" }); const chat = model.startChat({ history: [ { role: "user", parts: [{ text: "Hello" }], }, { role: "model", parts: [{ text: "Great to meet you. What would you like to know?" }], }, ], }); let result = await chat.sendMessageStream("I have 2 dogs in my house."); for await (const chunk of result.stream) { const chunkText = chunk.text(); process.stdout.write(chunkText); } result = await chat.sendMessageStream("How many paws are in my house?"); for await (const chunk of result.stream) { const chunkText = chunk.text(); process.stdout.write(chunkText); }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-js/blob/2df2af03bb07dcda23b07af1a7135a8b461ae64e/samples/chat.js#L53-L78" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-js/samples/chat.js#chat_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-js/samples/chat.js" data-indented-block="" data-regexp="" data-region-tag="chat_streaming">chat.js</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat_streaming-GO" track-metadata-position="chat_streaming" track-metadata-region-tag="chat_streaming" data-text="Go" tabindex="-1">Go</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go/HEAD/chat_streaming" data-code-snippet="true" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-git-revision="HEAD" data-region-tag="chat_streaming" dir="ltr" is-upgraded syntax="Go"><code translate="no" dir="ltr">model := client.GenerativeModel("gemini-1.5-flash") cs := model.StartChat() cs.History = []*genai.Content{ { Parts: []genai.Part{ genai.Text("Hello, I have 2 dogs in my house."), }, Role: "user", }, { Parts: []genai.Part{ genai.Text("Great to meet you. What would you like to know?"), }, Role: "model", }, } iter := cs.SendMessageStream(ctx, genai.Text("How many paws are in my house?")) for { resp, err := iter.Next() if err == iterator.Done { break } if err != nil { log.Fatal(err) } printResponse(resp) }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google/generative-ai-go/blob/f453d2d6ca8c5e76e7d8b8615b3339ce68cd378c/genai/internal/samples/docs-snippets_test.go#L1002-L1030" class="gc-analytics-event" data-category="github_link" data-label="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go#chat_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google/generative-ai-go/genai/internal/samples/docs-snippets_test.go" data-indented-block="" data-regexp="" data-region-tag="chat_streaming">docs-snippets_test.go</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat_streaming-SHELL" track-metadata-position="chat_streaming" track-metadata-region-tag="chat_streaming" data-text="Shell" tabindex="-1">Shell</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-python/samples/rest/chat.sh/HEAD/chat_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-python/samples/rest/chat.sh" data-git-revision="HEAD" data-region-tag="chat_streaming" dir="ltr" is-upgraded syntax="Bash"><code translate="no" dir="ltr">curl https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:streamGenerateContent?alt=sse&key=$GOOGLE_API_KEY \ -H 'Content-Type: application/json' \ -X POST \ -d '{ "contents": [ {"role":"user", "parts":[{ "text": "Hello"}]}, {"role": "model", "parts":[{ "text": "Great to meet you. What would you like to know?"}]}, {"role":"user", "parts":[{ "text": "I have two dogs in my house. How many paws are in my house?"}]}, ] }' 2> /dev/null | grep "text"<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-python/blob/a04fcd185eefeb13955f0468c86c927d52436590/samples/rest/chat.sh#L27-L43" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-python/samples/rest/chat.sh#chat_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-python/samples/rest/chat.sh" data-indented-block="" data-regexp="" data-region-tag="chat_streaming">chat.sh</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat_streaming-KOTLIN" track-metadata-position="chat_streaming" track-metadata-region-tag="chat_streaming" data-text="Kotlin" tabindex="-1">Kotlin</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/chat.kt/HEAD/chat_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/chat.kt" data-git-revision="HEAD" data-region-tag="chat_streaming" dir="ltr" is-upgraded syntax="Kotlin"><code translate="no" dir="ltr">// Use streaming with multi-turn conversations (like chat) val generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case modelName = "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" above) apiKey = BuildConfig.apiKey) val chat = generativeModel.startChat( history = listOf( content(role = "user") { text("Hello, I have 2 dogs in my house.") }, content(role = "model") { text("Great to meet you. What would you like to know?") })) chat.sendMessageStream("How many paws are in my house?").collect { chunk -> print(chunk.text) }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/chat.kt#L58-L75" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/chat.kt#chat_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/chat.kt" data-indented-block="" data-regexp="" data-region-tag="chat_streaming">chat.kt</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat_streaming-SWIFT" track-metadata-position="chat_streaming" track-metadata-region-tag="chat_streaming" data-text="Swift" tabindex="-1">Swift</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-swift/samples/ChatSnippets.swift/HEAD/chat_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-swift/samples/ChatSnippets.swift" data-git-revision="HEAD" data-region-tag="chat_streaming" dir="ltr" is-upgraded syntax="Swift"><code translate="no" dir="ltr">let generativeModel = GenerativeModel( // Specify a Gemini model appropriate for your use case name: "gemini-1.5-flash", // Access your API key from your on-demand resource .plist file (see "Set up your API key" // above) apiKey: APIKey.default ) // Optionally specify existing chat history let history = [ ModelContent(role: "user", parts: "Hello, I have 2 dogs in my house."), ModelContent(role: "model", parts: "Great to meet you. What would you like to know?"), ] // Initialize the chat with optional chat history let chat = generativeModel.startChat(history: history) // To stream generated text output, call sendMessageStream and pass in the message let contentStream = chat.sendMessageStream("How many paws are in my house?") for try await chunk in contentStream { if let text = chunk.text { print(text) } }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-swift/blob/44b8ce120425f9cf53ca756f3434ca2c2696f8bd/samples/ChatSnippets.swift#L63-L87" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-swift/samples/ChatSnippets.swift#chat_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-swift/samples/ChatSnippets.swift" data-indented-block="" data-regexp="" data-region-tag="chat_streaming">ChatSnippets.swift</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat_streaming-DART" track-metadata-position="chat_streaming" track-metadata-region-tag="chat_streaming" data-text="Dart" tabindex="-1">Dart</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-dart/samples/dart/bin/chat.dart/HEAD/chat_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/chat.dart" data-git-revision="HEAD" data-region-tag="chat_streaming" dir="ltr" is-upgraded syntax="Dart"><code translate="no" dir="ltr">// Make sure to include this import: // import 'package:google_generative_ai/google_generative_ai.dart'; final model = GenerativeModel( model: 'gemini-1.5-flash', apiKey: apiKey, ); final chat = model.startChat(history: [ Content.text('hello'), Content.model([TextPart('Great to meet you. What would you like to know?')]) ]); var responses = chat.sendMessageStream(Content.text('I have 2 dogs in my house.')); await for (final response in responses) { print(response.text); print('_' * 80); } responses = chat.sendMessageStream(Content.text('How many paws are in my house?')); await for (final response in responses) { print(response.text); print('_' * 80); }<div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-dart/blob/76ae8f89eed4789af0be9e7876d0089909abc419/samples/dart/bin/chat.dart#L51-L72" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-dart/samples/dart/bin/chat.dart#chat_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-dart/samples/dart/bin/chat.dart" data-indented-block="" data-regexp="" data-region-tag="chat_streaming">chat.dart</a></div></code></pre></devsite-code> </div> </section> <section> <h3 id="chat_streaming-JAVA" track-metadata-position="chat_streaming" track-metadata-region-tag="chat_streaming" data-text="Java" tabindex="-1">Java</h3> <div class="github-docwidget-gitinclude-code"> <div></div><devsite-code><pre suppresswarning="suppresswarning" translate="no" class="devsite-click-to-copy" track-metadata-position="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/chat.java/HEAD/chat_streaming" data-code-snippet="true" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/chat.java" data-git-revision="HEAD" data-region-tag="chat_streaming" dir="ltr" is-upgraded syntax="Java"><code translate="no" dir="ltr">// Specify a Gemini model appropriate for your use case GenerativeModel gm = new GenerativeModel( /* modelName */ "gemini-1.5-flash", // Access your API key as a Build Configuration variable (see "Set up your API key" // above) /* apiKey */ BuildConfig.apiKey); GenerativeModelFutures model = GenerativeModelFutures.from(gm); // (optional) Create previous chat history for context Content.Builder userContentBuilder = new Content.Builder(); userContentBuilder.setRole("user"); userContentBuilder.addText("Hello, I have 2 dogs in my house."); Content userContent = userContentBuilder.build(); Content.Builder modelContentBuilder = new Content.Builder(); modelContentBuilder.setRole("model"); modelContentBuilder.addText("Great to meet you. What would you like to know?"); Content modelContent = userContentBuilder.build(); List<Content> history = Arrays.asList(userContent, modelContent); // Initialize the chat ChatFutures chat = model.startChat(history); // Create a new user message Content.Builder userMessageBuilder = new Content.Builder(); userMessageBuilder.setRole("user"); userMessageBuilder.addText("How many paws are in my house?"); Content userMessage = userMessageBuilder.build(); // Use streaming with text-only input Publisher<GenerateContentResponse> streamingResponse = model.generateContentStream(userMessage); StringBuilder outputContent = new StringBuilder(); streamingResponse.subscribe( new Subscriber<GenerateContentResponse>() { @Override public void onNext(GenerateContentResponse generateContentResponse) { String chunk = generateContentResponse.getText(); outputContent.append(chunk); } @Override public void onComplete() { System.out.println(outputContent); } @Override public void onSubscribe(Subscription s) { s.request(Long.MAX_VALUE); } @Override public void onError(Throwable t) {} }); <div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/google-gemini/generative-ai-android/blob/b5d2e5610d19522ad10e6dc7e98236689aaa3587/samples/src/main/java/com/google/ai/client/generative/samples/java/chat.java#L104-L162" class="gc-analytics-event" data-category="github_link" data-label="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/chat.java#chat_streaming" data-code-snippet="true" data-git-revision="HEAD" data-github-path="google-gemini/generative-ai-android/samples/src/main/java/com/google/ai/client/generative/samples/java/chat.java" data-indented-block="" data-regexp="" data-region-tag="chat_streaming">chat.java</a></div></code></pre></devsite-code> </div> </section> </devsite-selector> </section> </devsite-selector> </div> </div> <div class="column-container"> <div class="reference"> <section id="body.response_body"> <h3 id="response-body_1" data-text="Response body" tabindex="-1">Response body</h3> If successful, the response body contains a stream of <code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.GenerateContentResponse">GenerateContentResponse</a></code> instances. </section> </div> </div> </section> </div><div itemscope="" itemtype="http://developers.google.com/ReferenceObject"><h2 id="generatecontentresponse" data-text="GenerateContentResponse" tabindex="-1">GenerateContentResponse</h2><a name="v1beta.GenerateContentResponse"></a> <meta content="GenerateContentResponse" itemprop="name"/> <meta content="/api/rest/v1beta/GenerateContentResponse" itemprop="path"/> <section class="prototype" id="/api/rest/v1beta/GenerateContentResponse"> <ul class="toc"> <li><a href="#SCHEMA_REPRESENTATION">JSON representation</a></li><li><a href="#PromptFeedback">PromptFeedback</a> <ul> <li><a href="#PromptFeedback.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#BlockReason">BlockReason</a></li><li><a href="#UsageMetadata">UsageMetadata</a> <ul> <li><a href="#UsageMetadata.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> </ul> <div class="column-container"> <div class="reference"> <section id="description"> Response from the model supporting multiple candidate responses.Safety ratings and content filtering are reported for both prompt in <code translate="no" dir="ltr">GenerateContentResponse.prompt_feedback</code> and for each candidate in <code translate="no" dir="ltr">finishReason</code> and in <code translate="no" dir="ltr">safetyRatings</code>. The API: - Returns either all requested candidates or none of them - Returns no candidates at all only if there was something wrong with the prompt (check <code translate="no" dir="ltr">promptFeedback</code>) - Reports feedback on each candidate in <code translate="no" dir="ltr">finishReason</code> and <code translate="no" dir="ltr">safetyRatings</code>. </section> <section id="FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="FIELDS.candidates"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">candidates[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.Candidate">Candidate</a></code>)</code> </div> <div class="field-description"> Candidate responses from the model. </div> </div> </section> <section id="FIELDS.prompt_feedback"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">promptFeedback</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#PromptFeedback">PromptFeedback</a></code>)</code> </div> <div class="field-description"> Returns the prompt's feedback related to the content filters. </div> </div> </section> <section id="FIELDS.usage_metadata"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">usageMetadata</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#UsageMetadata">UsageMetadata</a></code>)</code> </div> <div class="field-description"> Output only. Metadata on the generation requests' token usage. </div> </div> </section> </section> </div> <div class="second-column"> <section id="SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "candidates": [ { object (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.Candidate">Candidate</a></code>) } ], "promptFeedback": { object (<code translate="no" dir="ltr"><a href="/api/generate-content#PromptFeedback">PromptFeedback</a></code>) }, "usageMetadata": { object (<code translate="no" dir="ltr"><a href="/api/generate-content#UsageMetadata">UsageMetadata</a></code>) } }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="PromptFeedback" data-text="PromptFeedback" tabindex="-1">PromptFeedback</h2> <div class="column-container"> <div class="reference"> <section id="PromptFeedback.description"> A set of the feedback metadata the prompt specified in <code translate="no" dir="ltr">GenerateContentRequest.content</code>. </section> <section id="PromptFeedback.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="PromptFeedback.FIELDS.block_reason"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">blockReason</code></td> <code translate="no" dir="ltr">enum (<code translate="no" dir="ltr"><a href="/api/generate-content#BlockReason">BlockReason</a></code>)</code> </div> <div class="field-description"> Optional. If set, the prompt was blocked and no candidates are returned. Rephrase the prompt. </div> </div> </section> <section id="PromptFeedback.FIELDS.safety_ratings"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">safetyRatings[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.SafetyRating">SafetyRating</a></code>)</code> </div> <div class="field-description"> Ratings for safety of the prompt. There is at most one rating per category. </div> </div> </section> </section> </div> <div class="second-column"> <section id="PromptFeedback.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "blockReason": enum (<code translate="no" dir="ltr"><a href="/api/generate-content#BlockReason">BlockReason</a></code>), "safetyRatings": [ { object (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.SafetyRating">SafetyRating</a></code>) } ] }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="BlockReason" data-text="BlockReason" tabindex="-1">BlockReason</h2> <section id="BlockReason.description"> Specifies the reason why the prompt was blocked. </section> <section id="BlockReason.ENUM_VALUES"> <table class="constants responsive fixed" id="BlockReason.ENUM_VALUES-table"> <colgroup> <col width="25%"/> <col/> </colgroup> <thead> <tr> <th colspan="2">Enums</th> </tr> </thead> <tbody> <tr id="BlockReason.ENUM_VALUES.BLOCK_REASON_UNSPECIFIED"> <td><code class="apitype" translate="no" dir="ltr">BLOCK_REASON_UNSPECIFIED</code></td> <td>Default value. This value is unused.</td> </tr> <tr id="BlockReason.ENUM_VALUES.SAFETY"> <td><code class="apitype" translate="no" dir="ltr">SAFETY</code></td> <td>Prompt was blocked due to safety reasons. Inspect <code translate="no" dir="ltr">safetyRatings</code> to understand which safety category blocked it.</td> </tr> <tr id="BlockReason.ENUM_VALUES.OTHER"> <td><code class="apitype" translate="no" dir="ltr">OTHER</code></td> <td>Prompt was blocked due to unknown reasons.</td> </tr> <tr id="BlockReason.ENUM_VALUES.BLOCKLIST"> <td><code class="apitype" translate="no" dir="ltr">BLOCKLIST</code></td> <td>Prompt was blocked due to the terms which are included from the terminology blocklist.</td> </tr> <tr id="BlockReason.ENUM_VALUES.PROHIBITED_CONTENT"> <td><code class="apitype" translate="no" dir="ltr">PROHIBITED_CONTENT</code></td> <td>Prompt was blocked due to prohibited content.</td> </tr> </tbody> </table> </section> <h2 id="UsageMetadata" data-text="UsageMetadata" tabindex="-1">UsageMetadata</h2> <div class="column-container"> <div class="reference"> <section id="UsageMetadata.description"> Metadata on the generation request's token usage. </section> <section id="UsageMetadata.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="UsageMetadata.FIELDS.prompt_token_count"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">promptTokenCount</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Number of tokens in the prompt. When <code translate="no" dir="ltr">cachedContent</code> is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. </div> </div> </section> <section id="UsageMetadata.FIELDS.cached_content_token_count"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">cachedContentTokenCount</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Number of tokens in the cached part of the prompt (the cached content) </div> </div> </section> <section id="UsageMetadata.FIELDS.candidates_token_count"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">candidatesTokenCount</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Total number of tokens across all the generated response candidates. </div> </div> </section> <section id="UsageMetadata.FIELDS.total_token_count"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">totalTokenCount</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Total token count for the generation request (prompt + response candidates). </div> </div> </section> </section> </div> <div class="second-column"> <section id="UsageMetadata.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "totalTokenCount": integer }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> </section> </div><div itemscope="" itemtype="http://developers.google.com/ReferenceObject"><h2 id="candidate" data-text="Candidate" tabindex="-1">Candidate</h2><a name="v1beta.Candidate"></a> <meta content="Candidate" itemprop="name"/> <meta content="/api/rest/v1beta/Candidate" itemprop="path"/> <section class="prototype" id="/api/rest/v1beta/Candidate"> <ul class="toc"> <li><a href="#SCHEMA_REPRESENTATION">JSON representation</a></li><li><a href="#FinishReason">FinishReason</a></li><li><a href="#GroundingAttribution">GroundingAttribution</a> <ul> <li><a href="#GroundingAttribution.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#AttributionSourceId">AttributionSourceId</a> <ul> <li><a href="#AttributionSourceId.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#GroundingPassageId">GroundingPassageId</a> <ul> <li><a href="#GroundingPassageId.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#SemanticRetrieverChunk">SemanticRetrieverChunk</a> <ul> <li><a href="#SemanticRetrieverChunk.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#GroundingMetadata">GroundingMetadata</a> <ul> <li><a href="#GroundingMetadata.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#SearchEntryPoint">SearchEntryPoint</a> <ul> <li><a href="#SearchEntryPoint.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#GroundingChunk">GroundingChunk</a> <ul> <li><a href="#GroundingChunk.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#Web">Web</a> <ul> <li><a href="#Web.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#GroundingSupport">GroundingSupport</a> <ul> <li><a href="#GroundingSupport.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#Segment">Segment</a> <ul> <li><a href="#Segment.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#RetrievalMetadata">RetrievalMetadata</a> <ul> <li><a href="#RetrievalMetadata.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#LogprobsResult">LogprobsResult</a> <ul> <li><a href="#LogprobsResult.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#TopCandidates">TopCandidates</a> <ul> <li><a href="#TopCandidates.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li><li><a href="#Candidate">Candidate</a> <ul> <li><a href="#Candidate.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> </ul> <div class="column-container"> <div class="reference"> <section id="description"> A response candidate generated from the model. </section> <section id="FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="FIELDS.content"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">content</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/caching#Content">Content</a></code>)</code> </div> <div class="field-description"> Output only. Generated content returned from the model. </div> </div> </section> <section id="FIELDS.finish_reason"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">finishReason</code></td> <code translate="no" dir="ltr">enum (<code translate="no" dir="ltr"><a href="/api/generate-content#FinishReason">FinishReason</a></code>)</code> </div> <div class="field-description"> Optional. Output only. The reason why the model stopped generating tokens.If empty, the model has not stopped generating tokens. </div> </div> </section> <section id="FIELDS.safety_ratings"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">safetyRatings[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.SafetyRating">SafetyRating</a></code>)</code> </div> <div class="field-description"> List of ratings for the safety of a response candidate.There is at most one rating per category. </div> </div> </section> <section id="FIELDS.citation_metadata"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">citationMetadata</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.CitationMetadata">CitationMetadata</a></code>)</code> </div> <div class="field-description"> Output only. Citation information for model-generated candidate.This field may be populated with recitation information for any text included in the <code translate="no" dir="ltr">content</code>. These are passages that are "recited" from copyrighted material in the foundational LLM's training data. </div> </div> </section> <section id="FIELDS.token_count"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">tokenCount</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Output only. Token count for this candidate. </div> </div> </section> <section id="FIELDS.grounding_attributions"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">groundingAttributions[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#GroundingAttribution">GroundingAttribution</a></code>)</code> </div> <div class="field-description"> Output only. Attribution information for sources that contributed to a grounded answer.This field is populated for <code translate="no" dir="ltr">GenerateAnswer</code> calls. </div> </div> </section> <section id="FIELDS.grounding_metadata"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">groundingMetadata</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#GroundingMetadata">GroundingMetadata</a></code>)</code> </div> <div class="field-description"> Output only. Grounding metadata for the candidate.This field is populated for <code translate="no" dir="ltr">GenerateContent</code> calls. </div> </div> </section> <section id="FIELDS.avg_logprobs"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">avgLogprobs</code></td> <code translate="no" dir="ltr">number</code> </div> <div class="field-description"> Output only. </div> </div> </section> <section id="FIELDS.logprobs_result"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">logprobsResult</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#LogprobsResult">LogprobsResult</a></code>)</code> </div> <div class="field-description"> Output only. Log-likelihood scores for the response tokens and top tokens </div> </div> </section> <section id="FIELDS.index"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">index</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Output only. Index of the candidate in the list of response candidates. </div> </div> </section> </section> </div> <div class="second-column"> <section id="SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "content": { object (<code translate="no" dir="ltr"><a href="/api/caching#Content">Content</a></code>) }, "finishReason": enum (<code translate="no" dir="ltr"><a href="/api/generate-content#FinishReason">FinishReason</a></code>), "safetyRatings": [ { object (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.SafetyRating">SafetyRating</a></code>) } ], "citationMetadata": { object (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.CitationMetadata">CitationMetadata</a></code>) }, "tokenCount": integer, "groundingAttributions": [ { object (<code translate="no" dir="ltr"><a href="/api/generate-content#GroundingAttribution">GroundingAttribution</a></code>) } ], "groundingMetadata": { object (<code translate="no" dir="ltr"><a href="/api/generate-content#GroundingMetadata">GroundingMetadata</a></code>) }, "avgLogprobs": number, "logprobsResult": { object (<code translate="no" dir="ltr"><a href="/api/generate-content#LogprobsResult">LogprobsResult</a></code>) }, "index": integer }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="FinishReason" data-text="FinishReason" tabindex="-1">FinishReason</h2> <section id="FinishReason.description"> Defines the reason why the model stopped generating tokens. </section> <section id="FinishReason.ENUM_VALUES"> <table class="constants responsive fixed" id="FinishReason.ENUM_VALUES-table"> <colgroup> <col width="25%"/> <col/> </colgroup> <thead> <tr> <th colspan="2">Enums</th> </tr> </thead> <tbody> <tr id="FinishReason.ENUM_VALUES.FINISH_REASON_UNSPECIFIED"> <td><code class="apitype" translate="no" dir="ltr">FINISH_REASON_UNSPECIFIED</code></td> <td>Default value. This value is unused.</td> </tr> <tr id="FinishReason.ENUM_VALUES.STOP"> <td><code class="apitype" translate="no" dir="ltr">STOP</code></td> <td>Natural stop point of the model or provided stop sequence.</td> </tr> <tr id="FinishReason.ENUM_VALUES.MAX_TOKENS"> <td><code class="apitype" translate="no" dir="ltr">MAX_TOKENS</code></td> <td>The maximum number of tokens as specified in the request was reached.</td> </tr> <tr id="FinishReason.ENUM_VALUES.SAFETY"> <td><code class="apitype" translate="no" dir="ltr">SAFETY</code></td> <td>The response candidate content was flagged for safety reasons.</td> </tr> <tr id="FinishReason.ENUM_VALUES.RECITATION"> <td><code class="apitype" translate="no" dir="ltr">RECITATION</code></td> <td>The response candidate content was flagged for recitation reasons.</td> </tr> <tr id="FinishReason.ENUM_VALUES.LANGUAGE"> <td><code class="apitype" translate="no" dir="ltr">LANGUAGE</code></td> <td>The response candidate content was flagged for using an unsupported language.</td> </tr> <tr id="FinishReason.ENUM_VALUES.OTHER"> <td><code class="apitype" translate="no" dir="ltr">OTHER</code></td> <td>Unknown reason.</td> </tr> <tr id="FinishReason.ENUM_VALUES.BLOCKLIST"> <td><code class="apitype" translate="no" dir="ltr">BLOCKLIST</code></td> <td>Token generation stopped because the content contains forbidden terms.</td> </tr> <tr id="FinishReason.ENUM_VALUES.PROHIBITED_CONTENT"> <td><code class="apitype" translate="no" dir="ltr">PROHIBITED_CONTENT</code></td> <td>Token generation stopped for potentially containing prohibited content.</td> </tr> <tr id="FinishReason.ENUM_VALUES.SPII"> <td><code class="apitype" translate="no" dir="ltr">SPII</code></td> <td>Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).</td> </tr> <tr id="FinishReason.ENUM_VALUES.MALFORMED_FUNCTION_CALL"> <td><code class="apitype" translate="no" dir="ltr">MALFORMED_FUNCTION_CALL</code></td> <td>The function call generated by the model is invalid.</td> </tr> </tbody> </table> </section> <h2 id="GroundingAttribution" data-text="GroundingAttribution" tabindex="-1">GroundingAttribution</h2> <div class="column-container"> <div class="reference"> <section id="GroundingAttribution.description"> Attribution for a source that contributed to an answer. </section> <section id="GroundingAttribution.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="GroundingAttribution.FIELDS.source_id"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">sourceId</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#AttributionSourceId">AttributionSourceId</a></code>)</code> </div> <div class="field-description"> Output only. Identifier for the source contributing to this attribution. </div> </div> </section> <section id="GroundingAttribution.FIELDS.content"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">content</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/caching#Content">Content</a></code>)</code> </div> <div class="field-description"> Grounding source content that makes up this attribution. </div> </div> </section> </section> </div> <div class="second-column"> <section id="GroundingAttribution.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "sourceId": { object (<code translate="no" dir="ltr"><a href="/api/generate-content#AttributionSourceId">AttributionSourceId</a></code>) }, "content": { object (<code translate="no" dir="ltr"><a href="/api/caching#Content">Content</a></code>) } }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="AttributionSourceId" data-text="AttributionSourceId" tabindex="-1">AttributionSourceId</h2> <div class="column-container"> <div class="reference"> <section id="AttributionSourceId.description"> Identifier for the source contributing to this attribution. </section> <section id="AttributionSourceId.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <div class="field-entry union-type"> <tr class="alt" id="AttributionSourceId.FIELDS.oneof_source"> <div class="union-type-preamble"> <td colspan="2">Union field <code translate="no" dir="ltr">source</code>.<code translate="no" dir="ltr">source</code> can be only one of the following:</td> </div> </tr> <section id="AttributionSourceId.FIELDS.grounding_passage"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">groundingPassage</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#GroundingPassageId">GroundingPassageId</a></code>)</code> </div> <div class="field-description"> Identifier for an inline passage. </div> </div> </section> <section id="AttributionSourceId.FIELDS.semantic_retriever_chunk"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">semanticRetrieverChunk</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#SemanticRetrieverChunk">SemanticRetrieverChunk</a></code>)</code> </div> <div class="field-description"> Identifier for a <code translate="no" dir="ltr">Chunk</code> fetched via Semantic Retriever. </div> </div> </section> </div> </section> </div> <div class="second-column"> <section id="AttributionSourceId.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ // Union field <code translate="no" dir="ltr">source</code> can be only one of the following: "groundingPassage": { object (<code translate="no" dir="ltr"><a href="/api/generate-content#GroundingPassageId">GroundingPassageId</a></code>) }, "semanticRetrieverChunk": { object (<code translate="no" dir="ltr"><a href="/api/generate-content#SemanticRetrieverChunk">SemanticRetrieverChunk</a></code>) } // End of list of possible types for union field <code translate="no" dir="ltr">source</code>. }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="GroundingPassageId" data-text="GroundingPassageId" tabindex="-1">GroundingPassageId</h2> <div class="column-container"> <div class="reference"> <section id="GroundingPassageId.description"> Identifier for a part within a <code translate="no" dir="ltr">GroundingPassage</code>. </section> <section id="GroundingPassageId.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="GroundingPassageId.FIELDS.passage_id"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">passageId</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Output only. ID of the passage matching the <code translate="no" dir="ltr">GenerateAnswerRequest</code>'s <code translate="no" dir="ltr">GroundingPassage.id</code>. </div> </div> </section> <section id="GroundingPassageId.FIELDS.part_index"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">partIndex</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Output only. Index of the part within the <code translate="no" dir="ltr">GenerateAnswerRequest</code>'s <code translate="no" dir="ltr">GroundingPassage.content</code>. </div> </div> </section> </section> </div> <div class="second-column"> <section id="GroundingPassageId.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "passageId": string, "partIndex": integer }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="SemanticRetrieverChunk" data-text="SemanticRetrieverChunk" tabindex="-1">SemanticRetrieverChunk</h2> <div class="column-container"> <div class="reference"> <section id="SemanticRetrieverChunk.description"> Identifier for a <code translate="no" dir="ltr">Chunk</code> retrieved via Semantic Retriever specified in the <code translate="no" dir="ltr">GenerateAnswerRequest</code> using <code translate="no" dir="ltr">SemanticRetrieverConfig</code>. </section> <section id="SemanticRetrieverChunk.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="SemanticRetrieverChunk.FIELDS.source"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">source</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Output only. Name of the source matching the request's <code translate="no" dir="ltr">SemanticRetrieverConfig.source</code>. Example: <code translate="no" dir="ltr">corpora/123</code> or <code translate="no" dir="ltr">corpora/123/documents/abc</code> </div> </div> </section> <section id="SemanticRetrieverChunk.FIELDS.chunk"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">chunk</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Output only. Name of the <code translate="no" dir="ltr">Chunk</code> containing the attributed text. Example: <code translate="no" dir="ltr">corpora/123/documents/abc/chunks/xyz</code> </div> </div> </section> </section> </div> <div class="second-column"> <section id="SemanticRetrieverChunk.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "source": string, "chunk": string }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="GroundingMetadata" data-text="GroundingMetadata" tabindex="-1">GroundingMetadata</h2> <div class="column-container"> <div class="reference"> <section id="GroundingMetadata.description"> Metadata returned to client when grounding is enabled. </section> <section id="GroundingMetadata.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="GroundingMetadata.FIELDS.grounding_chunks"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">groundingChunks[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#GroundingChunk">GroundingChunk</a></code>)</code> </div> <div class="field-description"> List of supporting references retrieved from specified grounding source. </div> </div> </section> <section id="GroundingMetadata.FIELDS.grounding_supports"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">groundingSupports[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#GroundingSupport">GroundingSupport</a></code>)</code> </div> <div class="field-description"> List of grounding support. </div> </div> </section> <section id="GroundingMetadata.FIELDS.web_search_queries"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">webSearchQueries[]</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Web search queries for the following-up web search. </div> </div> </section> <section id="GroundingMetadata.FIELDS.search_entry_point"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">searchEntryPoint</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#SearchEntryPoint">SearchEntryPoint</a></code>)</code> </div> <div class="field-description"> Optional. Google search entry for the following-up web searches. </div> </div> </section> <section id="GroundingMetadata.FIELDS.retrieval_metadata"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">retrievalMetadata</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#RetrievalMetadata">RetrievalMetadata</a></code>)</code> </div> <div class="field-description"> Metadata related to retrieval in the grounding flow. </div> </div> </section> </section> </div> <div class="second-column"> <section id="GroundingMetadata.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "groundingChunks": [ { object (<code translate="no" dir="ltr"><a href="/api/generate-content#GroundingChunk">GroundingChunk</a></code>) } ], "groundingSupports": [ { object (<code translate="no" dir="ltr"><a href="/api/generate-content#GroundingSupport">GroundingSupport</a></code>) } ], "webSearchQueries": [ string ], "searchEntryPoint": { object (<code translate="no" dir="ltr"><a href="/api/generate-content#SearchEntryPoint">SearchEntryPoint</a></code>) }, "retrievalMetadata": { object (<code translate="no" dir="ltr"><a href="/api/generate-content#RetrievalMetadata">RetrievalMetadata</a></code>) } }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="SearchEntryPoint" data-text="SearchEntryPoint" tabindex="-1">SearchEntryPoint</h2> <div class="column-container"> <div class="reference"> <section id="SearchEntryPoint.description"> Google search entry point. </section> <section id="SearchEntryPoint.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="SearchEntryPoint.FIELDS.rendered_content"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">renderedContent</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Optional. Web content snippet that can be embedded in a web page or an app webview. </div> </div> </section> <section id="SearchEntryPoint.FIELDS.sdk_blob"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">sdkBlob</code></td> <code translate="no" dir="ltr">string (<a href="https://developers.google.com/discovery/v1/type-format">bytes</a> format)</code> </div> <div class="field-description"> Optional. Base64 encoded JSON representing array of <search term, search url> tuple.A base64-encoded string. </div> </div> </section> </section> </div> <div class="second-column"> <section id="SearchEntryPoint.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "renderedContent": string, "sdkBlob": string }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="GroundingChunk" data-text="GroundingChunk" tabindex="-1">GroundingChunk</h2> <div class="column-container"> <div class="reference"> <section id="GroundingChunk.description"> Grounding chunk. </section> <section id="GroundingChunk.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <div class="field-entry union-type"> <tr class="alt" id="GroundingChunk.FIELDS.oneof_chunk_type"> <div class="union-type-preamble"> <td colspan="2">Union field <code translate="no" dir="ltr">chunk_type</code>. Chunk type. <code translate="no" dir="ltr">chunk_type</code> can be only one of the following:</td> </div> </tr> <section id="GroundingChunk.FIELDS.web"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">web</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#Web">Web</a></code>)</code> </div> <div class="field-description"> Grounding chunk from the web. </div> </div> </section> </div> </section> </div> <div class="second-column"> <section id="GroundingChunk.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ // Union field <code translate="no" dir="ltr">chunk_type</code> can be only one of the following: "web": { object (<code translate="no" dir="ltr"><a href="/api/generate-content#Web">Web</a></code>) } // End of list of possible types for union field <code translate="no" dir="ltr">chunk_type</code>. }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="Web" data-text="Web" tabindex="-1">Web</h2> <div class="column-container"> <div class="reference"> <section id="Web.description"> Chunk from the web. </section> <section id="Web.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="Web.FIELDS.uri"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">uri</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> URI reference of the chunk. </div> </div> </section> <section id="Web.FIELDS.title"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">title</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Title of the chunk. </div> </div> </section> </section> </div> <div class="second-column"> <section id="Web.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "uri": string, "title": string }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="GroundingSupport" data-text="GroundingSupport" tabindex="-1">GroundingSupport</h2> <div class="column-container"> <div class="reference"> <section id="GroundingSupport.description"> Grounding support. </section> <section id="GroundingSupport.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="GroundingSupport.FIELDS.grounding_chunk_indices"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">groundingChunkIndices[]</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. </div> </div> </section> <section id="GroundingSupport.FIELDS.confidence_scores"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">confidenceScores[]</code></td> <code translate="no" dir="ltr">number</code> </div> <div class="field-description"> Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the groundingChunkIndices. </div> </div> </section> <section id="GroundingSupport.FIELDS.segment"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">segment</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#Segment">Segment</a></code>)</code> </div> <div class="field-description"> Segment of the content this support belongs to. </div> </div> </section> </section> </div> <div class="second-column"> <section id="GroundingSupport.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "groundingChunkIndices": [ integer ], "confidenceScores": [ number ], "segment": { object (<code translate="no" dir="ltr"><a href="/api/generate-content#Segment">Segment</a></code>) } }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="Segment" data-text="Segment" tabindex="-1">Segment</h2> <div class="column-container"> <div class="reference"> <section id="Segment.description"> Segment of the content. </section> <section id="Segment.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="Segment.FIELDS.part_index"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">partIndex</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Output only. The index of a Part object within its parent Content object. </div> </div> </section> <section id="Segment.FIELDS.start_index"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">startIndex</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. </div> </div> </section> <section id="Segment.FIELDS.end_index"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">endIndex</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. </div> </div> </section> <section id="Segment.FIELDS.text"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">text</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Output only. The text corresponding to the segment from the response. </div> </div> </section> </section> </div> <div class="second-column"> <section id="Segment.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="RetrievalMetadata" data-text="RetrievalMetadata" tabindex="-1">RetrievalMetadata</h2> <div class="column-container"> <div class="reference"> <section id="RetrievalMetadata.description"> Metadata related to retrieval in the grounding flow. </section> <section id="RetrievalMetadata.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="RetrievalMetadata.FIELDS.google_search_dynamic_retrieval_score"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">googleSearchDynamicRetrievalScore</code></td> <code translate="no" dir="ltr">number</code> </div> <div class="field-description"> Optional. Score indicating how likely information from google search could help answer the prompt. The score is in the range [0, 1], where 0 is the least likely and 1 is the most likely. This score is only populated when google search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger google search. </div> </div> </section> </section> </div> <div class="second-column"> <section id="RetrievalMetadata.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "googleSearchDynamicRetrievalScore": number }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="LogprobsResult" data-text="LogprobsResult" tabindex="-1">LogprobsResult</h2> <div class="column-container"> <div class="reference"> <section id="LogprobsResult.description"> Logprobs Result </section> <section id="LogprobsResult.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="LogprobsResult.FIELDS.top_candidates"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">topCandidates[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#TopCandidates">TopCandidates</a></code>)</code> </div> <div class="field-description"> Length = total number of decoding steps. </div> </div> </section> <section id="LogprobsResult.FIELDS.chosen_candidates"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">chosenCandidates[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#Candidate">Candidate</a></code>)</code> </div> <div class="field-description"> Length = total number of decoding steps. The chosen candidates may or may not be in topCandidates. </div> </div> </section> </section> </div> <div class="second-column"> <section id="LogprobsResult.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "topCandidates": [ { object (<code translate="no" dir="ltr"><a href="/api/generate-content#TopCandidates">TopCandidates</a></code>) } ], "chosenCandidates": [ { object (<code translate="no" dir="ltr"><a href="/api/generate-content#Candidate">Candidate</a></code>) } ] }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="TopCandidates" data-text="TopCandidates" tabindex="-1">TopCandidates</h2> <div class="column-container"> <div class="reference"> <section id="TopCandidates.description"> Candidates with top log probabilities at each decoding step. </section> <section id="TopCandidates.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="TopCandidates.FIELDS.candidates"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">candidates[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#Candidate">Candidate</a></code>)</code> </div> <div class="field-description"> Sorted by log probability in descending order. </div> </div> </section> </section> </div> <div class="second-column"> <section id="TopCandidates.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "candidates": [ { object (<code translate="no" dir="ltr"><a href="/api/generate-content#Candidate">Candidate</a></code>) } ] }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="Candidate" data-text="Candidate" tabindex="-1">Candidate</h2> <div class="column-container"> <div class="reference"> <section id="Candidate.description"> Candidate for the logprobs token and score. </section> <section id="Candidate.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="Candidate.FIELDS.token"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">token</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> The candidate’s token string value. </div> </div> </section> <section id="Candidate.FIELDS.token_id"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">tokenId</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> The candidate’s token id value. </div> </div> </section> <section id="Candidate.FIELDS.log_probability"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">logProbability</code></td> <code translate="no" dir="ltr">number</code> </div> <div class="field-description"> The candidate's log probability. </div> </div> </section> </section> </div> <div class="second-column"> <section id="Candidate.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "token": string, "tokenId": integer, "logProbability": number }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> </section> </div><div itemscope="" itemtype="http://developers.google.com/ReferenceObject"><h2 id="citationmetadata" data-text="CitationMetadata" tabindex="-1">CitationMetadata</h2><a name="v1beta.CitationMetadata"></a> <meta content="CitationMetadata" itemprop="name"/> <meta content="/api/rest/v1beta/CitationMetadata" itemprop="path"/> <section class="prototype" id="/api/rest/v1beta/CitationMetadata"> <ul class="toc"> <li><a href="#SCHEMA_REPRESENTATION">JSON representation</a></li><li><a href="#CitationSource">CitationSource</a> <ul> <li><a href="#CitationSource.SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> </li> </ul> <div class="column-container"> <div class="reference"> <section id="description"> A collection of source attributions for a piece of content. </section> <section id="FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="FIELDS.citation_sources"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">citationSources[]</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/generate-content#CitationSource">CitationSource</a></code>)</code> </div> <div class="field-description"> Citations to sources for a specific response. </div> </div> </section> </section> </div> <div class="second-column"> <section id="SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "citationSources": [ { object (<code translate="no" dir="ltr"><a href="/api/generate-content#CitationSource">CitationSource</a></code>) } ] }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="CitationSource" data-text="CitationSource" tabindex="-1">CitationSource</h2> <div class="column-container"> <div class="reference"> <section id="CitationSource.description"> A citation to a source for a portion of a specific response. </section> <section id="CitationSource.FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="CitationSource.FIELDS.start_index"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">startIndex</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Optional. Start of segment of the response that is attributed to this source.Index indicates the start of the segment, measured in bytes. </div> </div> </section> <section id="CitationSource.FIELDS.end_index"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">endIndex</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Optional. End of the attributed segment, exclusive. </div> </div> </section> <section id="CitationSource.FIELDS.uri"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">uri</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Optional. URI that is attributed as a source for a portion of the text. </div> </div> </section> <section id="CitationSource.FIELDS.license"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">license</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Optional. License for the GitHub project that is attributed as a source for segment.License info is required for code citations. </div> </div> </section> </section> </div> <div class="second-column"> <section id="CitationSource.SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> </section> </div><div itemscope="" itemtype="http://developers.google.com/ReferenceObject"><h2 id="generationconfig" data-text="GenerationConfig" tabindex="-1">GenerationConfig</h2><a name="v1beta.GenerationConfig"></a> <meta content="GenerationConfig" itemprop="name"/> <meta content="/api/rest/v1beta/GenerationConfig" itemprop="path"/> <section class="prototype" id="/api/rest/v1beta/GenerationConfig"> <ul class="toc"> <li><a href="#SCHEMA_REPRESENTATION">JSON representation</a></li> </ul> <div class="column-container"> <div class="reference"> <section id="description"> Configuration options for model generation and outputs. Not all parameters are configurable for every model. </section> <section id="FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="FIELDS.stop_sequences"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">stopSequences[]</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Optional. The set of character sequences (up to 5) that will stop output generation. If specified, the API will stop at the first appearance of a <code translate="no" dir="ltr">stop_sequence</code>. The stop sequence will not be included as part of the response. </div> </div> </section> <section id="FIELDS.response_mime_type"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">responseMimeType</code></td> <code translate="no" dir="ltr">string</code> </div> <div class="field-description"> Optional. MIME type of the generated candidate text. Supported MIME types are: <code translate="no" dir="ltr">text/plain</code>: (default) Text output. <code translate="no" dir="ltr">application/json</code>: JSON response in the response candidates. <code translate="no" dir="ltr">text/x.enum</code>: ENUM as a string response in the response candidates. Refer to the <a href="https://ai.google.dev/gemini-api/docs/prompting_with_media#plain_text_formats">docs</a> for a list of all supported text MIME types. </div> </div> </section> <section id="FIELDS.response_schema"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">responseSchema</code></td> <code translate="no" dir="ltr">object (<code translate="no" dir="ltr"><a href="/api/caching#Schema">Schema</a></code>)</code> </div> <div class="field-description"> Optional. Output schema of the generated candidate text. Schemas must be a subset of the <a href="https://spec.openapis.org/oas/v3.0.3#schema">OpenAPI schema</a> and can be objects, primitives or arrays.If set, a compatible <code translate="no" dir="ltr">responseMimeType</code> must also be set. Compatible MIME types: <code translate="no" dir="ltr">application/json</code>: Schema for JSON response. Refer to the <a href="https://ai.google.dev/gemini-api/docs/json-mode">JSON text generation guide</a> for more details. </div> </div> </section> <section id="FIELDS.candidate_count"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">candidateCount</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Optional. Number of generated responses to return.Currently, this value can only be set to 1. If unset, this will default to 1. </div> </div> </section> <section id="FIELDS.max_output_tokens"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">maxOutputTokens</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Optional. The maximum number of tokens to include in a response candidate.Note: The default value varies by model, see the <code translate="no" dir="ltr">Model.output_token_limit</code> attribute of the <code translate="no" dir="ltr">Model</code> returned from the <code translate="no" dir="ltr">getModel</code> function. </div> </div> </section> <section id="FIELDS.temperature"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">temperature</code></td> <code translate="no" dir="ltr">number</code> </div> <div class="field-description"> Optional. Controls the randomness of the output.Note: The default value varies by model, see the <code translate="no" dir="ltr">Model.temperature</code> attribute of the <code translate="no" dir="ltr">Model</code> returned from the <code translate="no" dir="ltr">getModel</code> function.Values can range from [0.0, 2.0]. </div> </div> </section> <section id="FIELDS.top_p"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">topP</code></td> <code translate="no" dir="ltr">number</code> </div> <div class="field-description"> Optional. The maximum cumulative probability of tokens to consider when sampling.The model uses combined Top-k and Top-p (nucleus) sampling.Tokens are sorted based on their assigned probabilities so that only the most likely tokens are considered. Top-k sampling directly limits the maximum number of tokens to consider, while Nucleus sampling limits the number of tokens based on the cumulative probability.Note: The default value varies by <code translate="no" dir="ltr">Model</code> and is specified by the<code translate="no" dir="ltr">Model.top_p</code> attribute returned from the <code translate="no" dir="ltr">getModel</code> function. An empty <code translate="no" dir="ltr">topK</code> attribute indicates that the model doesn't apply top-k sampling and doesn't allow setting <code translate="no" dir="ltr">topK</code> on requests. </div> </div> </section> <section id="FIELDS.top_k"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">topK</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Optional. The maximum number of tokens to consider when sampling.Gemini models use Top-p (nucleus) sampling or a combination of Top-k and nucleus sampling. Top-k sampling considers the set of <code translate="no" dir="ltr">topK</code> most probable tokens. Models running with nucleus sampling don't allow topK setting.Note: The default value varies by <code translate="no" dir="ltr">Model</code> and is specified by the<code translate="no" dir="ltr">Model.top_p</code> attribute returned from the <code translate="no" dir="ltr">getModel</code> function. An empty <code translate="no" dir="ltr">topK</code> attribute indicates that the model doesn't apply top-k sampling and doesn't allow setting <code translate="no" dir="ltr">topK</code> on requests. </div> </div> </section> <section id="FIELDS.presence_penalty"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">presencePenalty</code></td> <code translate="no" dir="ltr">number</code> </div> <div class="field-description"> Optional. Presence penalty applied to the next token's logprobs if the token has already been seen in the response.This penalty is binary on/off and not dependant on the number of times the token is used (after the first). Use <code translate="no" dir="ltr"><a href="/api/generate-content#FIELDS.frequency_penalty">frequencyPenalty</a></code> for a penalty that increases with each use.A positive penalty will discourage the use of tokens that have already been used in the response, increasing the vocabulary.A negative penalty will encourage the use of tokens that have already been used in the response, decreasing the vocabulary. </div> </div> </section> <section id="FIELDS.frequency_penalty"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">frequencyPenalty</code></td> <code translate="no" dir="ltr">number</code> </div> <div class="field-description"> Optional. Frequency penalty applied to the next token's logprobs, multiplied by the number of times each token has been seen in the respponse so far.A positive penalty will discourage the use of tokens that have already been used, proportional to the number of times the token has been used: The more a token is used, the more dificult it is for the model to use that token again increasing the vocabulary of responses.Caution: A negative penalty will encourage the model to reuse tokens proportional to the number of times the token has been used. Small negative values will reduce the vocabulary of a response. Larger negative values will cause the model to start repeating a common token until it hits the <code translate="no" dir="ltr"><a href="/api/generate-content#FIELDS.max_output_tokens">maxOutputTokens</a></code> limit: "...the the the the the...". </div> </div> </section> <section id="FIELDS.response_logprobs"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">responseLogprobs</code></td> <code translate="no" dir="ltr">boolean</code> </div> <div class="field-description"> Optional. If true, export the logprobs results in response. </div> </div> </section> <section id="FIELDS.logprobs"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">logprobs</code></td> <code translate="no" dir="ltr">integer</code> </div> <div class="field-description"> Optional. Only valid if <code translate="no" dir="ltr"><a href="/api/generate-content#FIELDS.response_logprobs">responseLogprobs=True</a></code>. This sets the number of top logprobs to return at each decoding step in the <code translate="no" dir="ltr"><a href="/api/generate-content#FIELDS.logprobs_result">Candidate.logprobs_result</a></code>. </div> </div> </section> </section> </div> <div class="second-column"> <section id="SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object (<code translate="no" dir="ltr"><a href="/api/caching#Schema">Schema</a></code>) }, "candidateCount": integer, "maxOutputTokens": integer, "temperature": number, "topP": number, "topK": integer, "presencePenalty": number, "frequencyPenalty": number, "responseLogprobs": boolean, "logprobs": integer }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> </section> </div><div itemscope="" itemtype="http://developers.google.com/ReferenceObject"><h2 id="harmcategory" data-text="HarmCategory" tabindex="-1">HarmCategory</h2><a name="v1beta.HarmCategory"></a> <meta content="HarmCategory" itemprop="name"/> <meta content="/api/rest/v1beta/HarmCategory" itemprop="path"/> <section id="/api/rest/v1beta/HarmCategory"> <section id="description"> The category of a rating.These categories cover various kinds of harms that developers may wish to adjust. </section> <section id="ENUM_VALUES"> <table class="constants responsive fixed" id="ENUM_VALUES-table"> <colgroup> <col width="25%"/> <col/> </colgroup> <thead> <tr> <th colspan="2">Enums</th> </tr> </thead> <tbody> <tr id="ENUM_VALUES.HARM_CATEGORY_UNSPECIFIED"> <td><code class="apitype" translate="no" dir="ltr">HARM_CATEGORY_UNSPECIFIED</code></td> <td>Category is unspecified.</td> </tr> <tr id="ENUM_VALUES.HARM_CATEGORY_DEROGATORY"> <td><code class="apitype" translate="no" dir="ltr">HARM_CATEGORY_DEROGATORY</code></td> <td>PaLM - Negative or harmful comments targeting identity and/or protected attribute.</td> </tr> <tr id="ENUM_VALUES.HARM_CATEGORY_TOXICITY"> <td><code class="apitype" translate="no" dir="ltr">HARM_CATEGORY_TOXICITY</code></td> <td>PaLM - Content that is rude, disrespectful, or profane.</td> </tr> <tr id="ENUM_VALUES.HARM_CATEGORY_VIOLENCE"> <td><code class="apitype" translate="no" dir="ltr">HARM_CATEGORY_VIOLENCE</code></td> <td>PaLM - Describes scenarios depicting violence against an individual or group, or general descriptions of gore.</td> </tr> <tr id="ENUM_VALUES.HARM_CATEGORY_SEXUAL"> <td><code class="apitype" translate="no" dir="ltr">HARM_CATEGORY_SEXUAL</code></td> <td>PaLM - Contains references to sexual acts or other lewd content.</td> </tr> <tr id="ENUM_VALUES.HARM_CATEGORY_MEDICAL"> <td><code class="apitype" translate="no" dir="ltr">HARM_CATEGORY_MEDICAL</code></td> <td>PaLM - Promotes unchecked medical advice.</td> </tr> <tr id="ENUM_VALUES.HARM_CATEGORY_DANGEROUS"> <td><code class="apitype" translate="no" dir="ltr">HARM_CATEGORY_DANGEROUS</code></td> <td>PaLM - Dangerous content that promotes, facilitates, or encourages harmful acts.</td> </tr> <tr id="ENUM_VALUES.HARM_CATEGORY_HARASSMENT"> <td><code class="apitype" translate="no" dir="ltr">HARM_CATEGORY_HARASSMENT</code></td> <td>Gemini - Harassment content.</td> </tr> <tr id="ENUM_VALUES.HARM_CATEGORY_HATE_SPEECH"> <td><code class="apitype" translate="no" dir="ltr">HARM_CATEGORY_HATE_SPEECH</code></td> <td>Gemini - Hate speech and content.</td> </tr> <tr id="ENUM_VALUES.HARM_CATEGORY_SEXUALLY_EXPLICIT"> <td><code class="apitype" translate="no" dir="ltr">HARM_CATEGORY_SEXUALLY_EXPLICIT</code></td> <td>Gemini - Sexually explicit content.</td> </tr> <tr id="ENUM_VALUES.HARM_CATEGORY_DANGEROUS_CONTENT"> <td><code class="apitype" translate="no" dir="ltr">HARM_CATEGORY_DANGEROUS_CONTENT</code></td> <td>Gemini - Dangerous content.</td> </tr> <tr id="ENUM_VALUES.HARM_CATEGORY_CIVIC_INTEGRITY"> <td><code class="apitype" translate="no" dir="ltr">HARM_CATEGORY_CIVIC_INTEGRITY</code></td> <td>Gemini - Content that may be used to harm civic integrity.</td> </tr> </tbody> </table> </section> </section> </div><div itemscope="" itemtype="http://developers.google.com/ReferenceObject"><h2 id="safetyrating" data-text="SafetyRating" tabindex="-1">SafetyRating</h2><a name="v1beta.SafetyRating"></a> <meta content="SafetyRating" itemprop="name"/> <meta content="/api/rest/v1beta/SafetyRating" itemprop="path"/> <section class="prototype" id="/api/rest/v1beta/SafetyRating"> <ul class="toc"> <li><a href="#SCHEMA_REPRESENTATION">JSON representation</a></li><li><a href="#HarmProbability">HarmProbability</a></li> </ul> <div class="column-container"> <div class="reference"> <section id="description"> Safety rating for a piece of content.The safety rating contains the category of harm and the harm probability level in that category for a piece of content. Content is classified for safety across a number of harm categories and the probability of the harm classification is included here. </section> <section id="FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="FIELDS.category"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">category</code></td> <code translate="no" dir="ltr">enum (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.HarmCategory">HarmCategory</a></code>)</code> </div> <div class="field-description"> Required. The category for this rating. </div> </div> </section> <section id="FIELDS.probability"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">probability</code></td> <code translate="no" dir="ltr">enum (<code translate="no" dir="ltr"><a href="/api/generate-content#HarmProbability">HarmProbability</a></code>)</code> </div> <div class="field-description"> Required. The probability of harm for this content. </div> </div> </section> <section id="FIELDS.blocked"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">blocked</code></td> <code translate="no" dir="ltr">boolean</code> </div> <div class="field-description"> Was this content blocked because of this rating? </div> </div> </section> </section> </div> <div class="second-column"> <section id="SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "category": enum (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.HarmCategory">HarmCategory</a></code>), "probability": enum (<code translate="no" dir="ltr"><a href="/api/generate-content#HarmProbability">HarmProbability</a></code>), "blocked": boolean }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="HarmProbability" data-text="HarmProbability" tabindex="-1">HarmProbability</h2> <section id="HarmProbability.description"> The probability that a piece of content is harmful.The classification system gives the probability of the content being unsafe. This does not indicate the severity of harm for a piece of content. </section> <section id="HarmProbability.ENUM_VALUES"> <table class="constants responsive fixed" id="HarmProbability.ENUM_VALUES-table"> <colgroup> <col width="25%"/> <col/> </colgroup> <thead> <tr> <th colspan="2">Enums</th> </tr> </thead> <tbody> <tr id="HarmProbability.ENUM_VALUES.HARM_PROBABILITY_UNSPECIFIED"> <td><code class="apitype" translate="no" dir="ltr">HARM_PROBABILITY_UNSPECIFIED</code></td> <td>Probability is unspecified.</td> </tr> <tr id="HarmProbability.ENUM_VALUES.NEGLIGIBLE"> <td><code class="apitype" translate="no" dir="ltr">NEGLIGIBLE</code></td> <td>Content has a negligible chance of being unsafe.</td> </tr> <tr id="HarmProbability.ENUM_VALUES.LOW"> <td><code class="apitype" translate="no" dir="ltr">LOW</code></td> <td>Content has a low chance of being unsafe.</td> </tr> <tr id="HarmProbability.ENUM_VALUES.MEDIUM"> <td><code class="apitype" translate="no" dir="ltr">MEDIUM</code></td> <td>Content has a medium chance of being unsafe.</td> </tr> <tr id="HarmProbability.ENUM_VALUES.HIGH"> <td><code class="apitype" translate="no" dir="ltr">HIGH</code></td> <td>Content has a high chance of being unsafe.</td> </tr> </tbody> </table> </section> </section> </div><div itemscope="" itemtype="http://developers.google.com/ReferenceObject"><h2 id="safetysetting" data-text="SafetySetting" tabindex="-1">SafetySetting</h2><a name="v1beta.SafetySetting"></a> <meta content="SafetySetting" itemprop="name"/> <meta content="/api/rest/v1beta/SafetySetting" itemprop="path"/> <section class="prototype" id="/api/rest/v1beta/SafetySetting"> <ul class="toc"> <li><a href="#SCHEMA_REPRESENTATION">JSON representation</a></li><li><a href="#HarmBlockThreshold">HarmBlockThreshold</a></li> </ul> <div class="column-container"> <div class="reference"> <section id="description"> Safety setting, affecting the safety-blocking behavior.Passing a safety setting for a category changes the allowed probability that content is blocked. </section> <section id="FIELDS"> <thead> <tr> <th colspan="2">Fields</th> </tr> </thead> <section id="FIELDS.category"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">category</code></td> <code translate="no" dir="ltr">enum (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.HarmCategory">HarmCategory</a></code>)</code> </div> <div class="field-description"> Required. The category for this setting. </div> </div> </section> <section id="FIELDS.threshold"> <div class="field-entry"> <div class="signature"> <td><code translate="no" dir="ltr">threshold</code></td> <code translate="no" dir="ltr">enum (<code translate="no" dir="ltr"><a href="/api/generate-content#HarmBlockThreshold">HarmBlockThreshold</a></code>)</code> </div> <div class="field-description"> Required. Controls the probability threshold at which harm is blocked. </div> </div> </section> </section> </div> <div class="second-column"> <section id="SCHEMA_REPRESENTATION"> <table class="properties responsive fixed"> <thead> <tr> <th>JSON representation</th> </tr> </thead> <tbody> <tr> <td style="margin:0;padding:0;"><div></div><devsite-code><pre style="border: 0;margin: 0;" translate="no" dir="ltr" is-upgraded>{ "category": enum (<code translate="no" dir="ltr"><a href="/api/generate-content#v1beta.HarmCategory">HarmCategory</a></code>), "threshold": enum (<code translate="no" dir="ltr"><a href="/api/generate-content#HarmBlockThreshold">HarmBlockThreshold</a></code>) }</pre></devsite-code></td> </tr> </tbody> </table> </section> </div> </div> <h2 id="HarmBlockThreshold" data-text="HarmBlockThreshold" tabindex="-1">HarmBlockThreshold</h2> <section id="HarmBlockThreshold.description"> Block at and beyond a specified harm probability. </section> <section id="HarmBlockThreshold.ENUM_VALUES"> <table class="constants responsive fixed" id="HarmBlockThreshold.ENUM_VALUES-table"> <colgroup> <col width="25%"/> <col/> </colgroup> <thead> <tr> <th colspan="2">Enums</th> </tr> </thead> <tbody> <tr id="HarmBlockThreshold.ENUM_VALUES.HARM_BLOCK_THRESHOLD_UNSPECIFIED"> <td><code class="apitype" translate="no" dir="ltr">HARM_BLOCK_THRESHOLD_UNSPECIFIED</code></td> <td>Threshold is unspecified.</td> </tr> <tr id="HarmBlockThreshold.ENUM_VALUES.BLOCK_LOW_AND_ABOVE"> <td><code class="apitype" translate="no" dir="ltr">BLOCK_LOW_AND_ABOVE</code></td> <td>Content with NEGLIGIBLE will be allowed.</td> </tr> <tr id="HarmBlockThreshold.ENUM_VALUES.BLOCK_MEDIUM_AND_ABOVE"> <td><code class="apitype" translate="no" dir="ltr">BLOCK_MEDIUM_AND_ABOVE</code></td> <td>Content with NEGLIGIBLE and LOW will be allowed.</td> </tr> <tr id="HarmBlockThreshold.ENUM_VALUES.BLOCK_ONLY_HIGH"> <td><code class="apitype" translate="no" dir="ltr">BLOCK_ONLY_HIGH</code></td> <td>Content with NEGLIGIBLE, LOW, and MEDIUM will be allowed.</td> </tr> <tr id="HarmBlockThreshold.ENUM_VALUES.BLOCK_NONE"> <td><code class="apitype" translate="no" dir="ltr">BLOCK_NONE</code></td> <td>All content will be allowed.</td> </tr> <tr id="HarmBlockThreshold.ENUM_VALUES.OFF"> <td><code class="apitype" translate="no" dir="ltr">OFF</code></td> <td>Turn off the safety filter.</td> </tr> </tbody> </table> </section> </section> </div> </div> <devsite-thumb-rating position="footer"> </devsite-thumb-rating> <devsite-feedback position="footer" project-name="Gemini API" product-id="5292923" bucket="documentation" context="" version="t-devsite-webserver-20241114-r00-rc02.464921008191574316" data-label="Send Feedback Button" track-type="feedback" track-name="sendFeedbackLink" track-metadata-position="footer" class="nocontent" project-icon="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/googledevai/images/touchicon-180-new.png" > <button> Send feedback </button> </devsite-feedback> <div class="devsite-floating-action-buttons"> </div> </article> <devsite-content-footer class="nocontent"> Except as otherwise noted, the content of this page is licensed under the <a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 License</a>, and code samples are licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 License</a>. For details, see the <a href="https://developers.google.com/site-policies">Google Developers Site Policies</a>. Java is a registered trademark of Oracle and/or its affiliates. Last updated 2024-10-31 UTC. </devsite-content-footer> <devsite-notification > </devsite-notification> <div class="devsite-content-data"> <template class="devsite-thumb-rating-feedback"> <devsite-feedback position="thumb-rating" project-name="Gemini API" product-id="5292923" bucket="documentation" context="" version="t-devsite-webserver-20241114-r00-rc02.464921008191574316" data-label="Send Feedback Button" track-type="feedback" track-name="sendFeedbackLink" track-metadata-position="thumb-rating" class="nocontent" project-icon="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/googledevai/images/touchicon-180-new.png" > <button> Need to tell us more? </button> </devsite-feedback> </template> <template class="devsite-content-data-template"> [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[],[]] </template> </div> </devsite-content> </main> <devsite-footer-promos class="devsite-footer"> </devsite-footer-promos> <devsite-footer-linkboxes class="devsite-footer"> <nav class="devsite-footer-linkboxes nocontent" aria-label="Footer links"> </nav> </devsite-footer-linkboxes> <devsite-footer-utility class="devsite-footer"> <div class="devsite-footer-utility nocontent"> <nav class="devsite-footer-utility-links" aria-label="Utility links"> <ul class="devsite-footer-utility-list"> <li class="devsite-footer-utility-item "> <a class="devsite-footer-utility-link gc-analytics-event" href="//policies.google.com/terms" data-category="Site-Wide Custom Events" data-label="Footer Terms link" > Terms </a> </li> <li class="devsite-footer-utility-item "> <a class="devsite-footer-utility-link gc-analytics-event" href="//policies.google.com/privacy" data-category="Site-Wide Custom Events" data-label="Footer Privacy link" > Privacy </a> </li> <li class="devsite-footer-utility-item glue-cookie-notification-bar-control"> <a class="devsite-footer-utility-link gc-analytics-event" href="#" data-category="Site-Wide Custom Events" data-label="Footer Manage cookies link" aria-hidden="true" > Manage cookies </a> </li> </ul> <devsite-language-selector> <ul role="presentation"> <li role="presentation"> <a role="menuitem" lang="en" >English</a> </li> <li role="presentation"> <a role="menuitem" lang="de" >Deutsch</a> </li> <li role="presentation"> <a role="menuitem" lang="es_419" >Español – América Latina</a> </li> <li role="presentation"> <a role="menuitem" lang="fr" >Français</a> </li> <li role="presentation"> <a role="menuitem" lang="id" >Indonesia</a> </li> <li role="presentation"> <a role="menuitem" lang="it" >Italiano</a> </li> <li role="presentation"> <a role="menuitem" lang="pl" >Polski</a> </li> <li role="presentation"> <a role="menuitem" lang="pt_br" >Português – Brasil</a> </li> <li role="presentation"> <a role="menuitem" lang="vi" >Tiếng Việt</a> </li> <li role="presentation"> <a role="menuitem" lang="tr" >Türkçe</a> </li> <li role="presentation"> <a role="menuitem" lang="ru" >Русский</a> </li> <li role="presentation"> <a role="menuitem" lang="he" >עברית</a> </li> <li role="presentation"> <a role="menuitem" lang="ar" >العربيّة</a> </li> <li role="presentation"> <a role="menuitem" lang="fa" >فارسی</a> </li> <li role="presentation"> <a role="menuitem" lang="hi" >हिंदी</a> </li> <li role="presentation"> <a role="menuitem" lang="bn" >বাংলা</a> </li> <li role="presentation"> <a role="menuitem" lang="th" >ภาษาไทย</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_cn" >中文 – 简体</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_tw" >中文 – 繁體</a> </li> <li role="presentation"> <a role="menuitem" lang="ja" >日本語</a> </li> <li role="presentation"> <a role="menuitem" lang="ko" >한국어</a> </li> </ul> </devsite-language-selector> </nav> </div> </devsite-footer-utility> <devsite-panel></devsite-panel> </section></section> <devsite-sitemask></devsite-sitemask> <devsite-snackbar></devsite-snackbar> <devsite-tooltip ></devsite-tooltip> <devsite-heading-link></devsite-heading-link> <devsite-analytics> <script type="application/json" analytics>[]</script> <script type="application/json" tag-management>{"at": "True", "ga4": [], "ga4p": [], "gtm": [{"id": "GTM-TC2MQKS8", "purpose": 0}], "parameters": {"internalUser": "False", "language": {"machineTranslated": "False", "requested": "en", "served": "en"}, "pageType": "reference", "projectName": "Gemini API", "signedIn": "False", "tenant": "googledevai", "recommendations": {"sourcePage": "", "sourceType": 0, "sourceRank": 0, "sourceIdenticalDescriptions": 0, "sourceTitleWords": 0, "sourceDescriptionWords": 0, "experiment": ""}, "experiment": {"ids": ""}}}</script> </devsite-analytics> <devsite-badger></devsite-badger> <script nonce="qOk7PqmnqBaRQbpxjdIJa3gTRufB/c"> (function(d,e,v,s,i,t,E){d['GoogleDevelopersObject']=i; t=e.createElement(v);t.async=1;t.src=s;E=e.getElementsByTagName(v)[0]; E.parentNode.insertBefore(t,E);})(window, document, 'script', 'https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/googledevai/js/app_loader.js', '[59,"en",null,"/js/devsite_app_module.js","https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625","https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/googledevai","https://googledevai-dot-devsite-v2-prod-3p.appspot.com",null,null,["/_pwa/googledevai/manifest.json","https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/images/video-placeholder.svg","https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/googledevai/images/favicon-new.png","/_static/googledevai/images/lockup-new.svg","https://fonts.googleapis.com/css?family=Google+Sans:400,500|Roboto:400,400italic,500,500italic,700,700italic|Roboto+Mono:400,500,700&display=swap"],1,null,[1,6,8,12,14,17,21,25,50,52,63,70,75,76,80,87,91,92,93,97,98,100,101,102,103,104,105,107,108,109,110,112,113,117,118,120,122,124,125,126,127,129,130,131,132,133,134,135,136,138,140,141,147,148,149,151,152,156,157,158,159,161,163,164,168,169,170,179,180,182,183,186,191,193,196],"AIzaSyCNm9YxQumEXwGJgTDjxoxXK6m1F-9720Q","AIzaSyCc76DZePGtoyUjqKrLdsMGk_ry7sljLbY","ai.google.dev","AIzaSyB9bqgQ2t11WJsOX8qNsCQ6U-w91mmqF-I","AIzaSyAdYnStPdzjcJJtQ0mvIaeaMKj7_t6J_Fg",null,null,null,["Cloud__enable_cloudx_experiment_ids","MiscFeatureFlags__enable_firebase_utm","Search__enable_ai_eligibility_checks","Profiles__enable_developer_profiles_callout","Profiles__enable_release_notes_notifications","EngEduTelemetry__enable_engedu_telemetry","Cloud__enable_llm_concierge_chat","Profiles__enable_recognition_badges","Search__enable_page_map","CloudShell__cloud_shell_button","Profiles__enable_public_developer_profiles","Profiles__enable_complete_playlist_endpoint","Cloud__enable_legacy_calculator_redirect","Profiles__enable_profile_collections","Cloud__enable_cloud_facet_chat","DevPro__enable_developer_subscriptions","Profiles__enable_page_saving","OnSwitch__enable","CloudShell__cloud_code_overflow_menu","MiscFeatureFlags__developers_footer_image","MiscFeatureFlags__enable_variable_operator","MiscFeatureFlags__developers_footer_dark_image","Experiments__reqs_query_experiments","Profiles__enable_completecodelab_endpoint","MiscFeatureFlags__enable_explain_this_code","Analytics__enable_clearcut_logging","Search__enable_suggestions_from_borg","Profiles__enable_dashboard_curated_recommendations","Profiles__require_profile_eligibility_for_signin","Cloud__enable_cloud_shell_fte_user_flow","Cloud__enable_cloud_dlp_service","TpcFeatures__enable_required_headers","MiscFeatureFlags__enable_view_transitions","MiscFeatureFlags__emergency_css","Cloud__enable_cloud_shell","DevPro__enable_cloud_innovators_plus","Cloud__enable_free_trial_server_call","MiscFeatureFlags__enable_project_variables","Cloud__enable_cloudx_ping","Profiles__enable_awarding_url","BookNav__enable_tenant_cache_key","Concierge__enable_pushui","TpcFeatures__enable_mirror_tenant_redirects","Search__enable_dynamic_content_confidential_banner"],null,null,"AIzaSyA58TaKli1DculwmAmbpzLVGuWc8eCQgQc","https://developerscontentserving-pa.googleapis.com","AIzaSyDWBU60w0P9hEkr29kkksYs8Z7gvZ8u_wc","https://developerscontentsearch-pa.googleapis.com",2,4,null,"https://developerprofiles-pa.googleapis.com",[59,"googledevai","Google AI for Developers","ai.google.dev",null,"googledevai-dot-devsite-v2-prod-3p.appspot.com",null,null,[null,1,null,null,null,null,null,null,null,null,null,[1],null,null,null,null,null,null,[1],null,null,null,null,[1],[1,1,null,1,1]],null,[73,null,null,null,null,null,"/images/lockup-new.svg","/images/touchicon-180-new.png",null,null,null,null,1,1,null,null,null,null,null,null,null,1,null,null,null,"/images/lockup-dark-theme-new.svg",[]],[],null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,[[],[1,1]],[[null,null,null,null,null,["GTM-TC2MQKS8"],null,null,null,null,null,[["GTM-TC2MQKS8",1]],1]],null,4]]') </script> <devsite-a11y-announce></devsite-a11y-announce> </body> </html>