Gemini API は、画像、音声、コード、ツールなどを使用したコンテンツ生成をサポートしています。これらの各機能の詳細については、この後の説明をお読みになり、タスクに焦点を当てたサンプルコードや包括的なガイドをご覧ください。
メソッド: models.generateContent
入力 GenerateContentRequest
に基づいてモデル レスポンスを生成します。詳細な使用方法については、テキスト生成ガイドをご覧ください。入力機能は、チューニングされたモデルを含め、モデルによって異なります。詳細については、モデルガイドとチューニング ガイドをご覧ください。
エンドポイント
投稿https: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
パスパラメータ
model
string
必須。補完の生成に使用する Model
の名前。
形式: models/{model}
。形式は models/{model}
です。
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
toolConfig
object (ToolConfig
)
省略可。リクエストで指定された Tool
のツール構成。使用例については、関数呼び出しガイドをご覧ください。
safetySettings[]
object (SafetySetting
)
省略可。安全でないコンテンツをブロックするための、一意の SafetySetting
インスタンスのリスト。
この条件は GenerateContentRequest.contents
と GenerateContentResponse.candidates
に適用されます。SafetyCategory
タイプごとに設定は 1 つだけにする必要があります。API は、これらの設定で設定されたしきい値を満たさないコンテンツとレスポンスをブロックします。このリストは、safetySettings で指定された各 SafetyCategory
のデフォルト設定をオーバーライドします。リストに指定された特定の SafetyCategory
に SafetySetting
がない場合、API はそのカテゴリのデフォルトの安全性設定を使用します。有害カテゴリ HARM_CATEGORY_HATE_SPEECH、HARM_CATEGORY_SEXUALLY_EXPLICIT、HARM_CATEGORY_DANGEROUS_CONTENT、HARM_CATEGORY_HARASSMENT、HARM_CATEGORY_CIVIC_INTEGRITY がサポートされています。利用可能な安全設定の詳細については、ガイドをご覧ください。AI アプリケーションに安全性の考慮事項を組み込む方法については、安全に関するガイダンスもご覧ください。
generationConfig
object (GenerationConfig
)
省略可。モデルの生成と出力の構成オプション。
cachedContent
string
省略可。予測を提供するためにコンテキストとして使用される、キャッシュに保存されたコンテンツの名前。形式: cachedContents/{cachedContent}
リクエスト例
テキスト
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
画像
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
音声
Python
Node.js
Go
Shell
動画
Python
Node.js
Go
Shell
Python
Go
Shell
チャット
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
キャッシュ
Python
Node.js
Go
チューニング済みモデル
Python
JSON モード
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
コードの実行
Python
Go
Kotlin
Java
関数呼び出し
Python
Go
Node.js
Shell
Kotlin
Swift
Dart
Java
生成構成
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
安全性設定
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
システム指示
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
レスポンスの本文
成功した場合、レスポンスの本文には GenerateContentResponse
のインスタンスが含まれます。
メソッド: models.streamGenerateContent
入力 GenerateContentRequest
が指定されたモデルからストリーミング レスポンスを生成します。
エンドポイント
投稿https: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
パスパラメータ
model
string
必須。補完の生成に使用する Model
の名前。
形式: models/{model}
。形式は models/{model}
です。
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
toolConfig
object (ToolConfig
)
省略可。リクエストで指定された Tool
のツール構成。使用例については、関数呼び出しガイドをご覧ください。
safetySettings[]
object (SafetySetting
)
省略可。安全でないコンテンツをブロックするための、一意の SafetySetting
インスタンスのリスト。
この条件は GenerateContentRequest.contents
と GenerateContentResponse.candidates
に適用されます。SafetyCategory
タイプごとに設定は 1 つだけにする必要があります。API は、これらの設定で設定されたしきい値を満たさないコンテンツとレスポンスをブロックします。このリストは、safetySettings で指定された各 SafetyCategory
のデフォルト設定をオーバーライドします。リストに指定された特定の SafetyCategory
に SafetySetting
がない場合、API はそのカテゴリのデフォルトの安全性設定を使用します。有害カテゴリ HARM_CATEGORY_HATE_SPEECH、HARM_CATEGORY_SEXUALLY_EXPLICIT、HARM_CATEGORY_DANGEROUS_CONTENT、HARM_CATEGORY_HARASSMENT、HARM_CATEGORY_CIVIC_INTEGRITY がサポートされています。利用可能な安全設定の詳細については、ガイドをご覧ください。AI アプリケーションに安全性の考慮事項を組み込む方法については、安全に関するガイダンスもご覧ください。
generationConfig
object (GenerationConfig
)
省略可。モデルの生成と出力の構成オプション。
cachedContent
string
省略可。予測を提供するためにコンテキストとして使用される、キャッシュに保存されたコンテンツの名前。形式: cachedContents/{cachedContent}
リクエスト例
テキスト
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
画像
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
音声
Python
Go
Shell
動画
Python
Node.js
Go
Shell
Python
Go
Shell
チャット
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
レスポンスの本文
成功した場合、レスポンスの本文には GenerateContentResponse
インスタンスのストリームが含まれます。
GenerateContentResponse
複数の候補レスポンスをサポートするモデルからのレスポンス。
安全スコアとコンテンツ フィルタリングは、GenerateContentResponse.prompt_feedback
のプロンプトと、finishReason
と safetyRatings
の各候補の両方について報告されます。API は次の処理を行います。- リクエストされた候補をすべて返すか、1 つも返さない - プロンプトに問題があった場合にのみ、候補を 1 つも返さない(promptFeedback
を確認)- 各候補に関するフィードバックを finishReason
と safetyRatings
で報告する。
candidates[]
object (Candidate
)
モデルからの候補レスポンス。
promptFeedback
object (PromptFeedback
)
コンテンツ フィルタに関連するプロンプトのフィードバックを返します。
usageMetadata
object (UsageMetadata
)
出力専用。生成リクエストのトークン使用量に関するメタデータ。
modelVersion
string
出力専用。レスポンスの生成に使用されたモデル バージョン。
responseId
string
出力専用。responseId は各レスポンスの識別に使用されます。
JSON 表現 |
---|
{ "candidates": [ { object ( |
PromptFeedback
GenerateContentRequest.content
で指定されたプロンプトのフィードバック メタデータのセット。
blockReason
enum (BlockReason
)
省略可。設定されている場合、プロンプトはブロックされ、候補は返されません。プロンプトを言い換えます。
safetyRatings[]
object (SafetyRating
)
プロンプトの安全性の評価。カテゴリごとに 1 つのレーティングのみが許可されます。
JSON 表現 |
---|
{ "blockReason": enum ( |
BlockReason
プロンプトがブロックされた理由を指定します。
列挙型 | |
---|---|
BLOCK_REASON_UNSPECIFIED |
デフォルト値。この値は使用されません。 |
SAFETY |
安全上の理由によりプロンプトがブロックされました。safetyRatings を調べて、どの安全性カテゴリでブロックされたかを確認します。 |
OTHER |
不明な理由によりプロンプトがブロックされました。 |
BLOCKLIST |
用語のブロックリストに含まれているキーワードが原因で、プロンプトがブロックされました。 |
PROHIBITED_CONTENT |
禁止されているコンテンツのため、プロンプトがブロックされました。 |
IMAGE_SAFETY |
安全でない画像生成コンテンツのため、候補がブロックされました。 |
UsageMetadata
生成リクエストのトークン使用量に関するメタデータ。
promptTokenCount
integer
プロンプト内のトークン数。cachedContent
が設定されている場合でも、これは有効なプロンプトの合計サイズであり、キャッシュに保存されたコンテンツのトークン数も含まれます。
cachedContentTokenCount
integer
プロンプトのキャッシュに保存された部分(キャッシュに保存されたコンテンツ)のトークン数
candidatesTokenCount
integer
生成されたすべてのレスポンス候補のトークンの合計数。
toolUsePromptTokenCount
integer
出力専用。ツール使用プロンプト内のトークン数。
thoughtsTokenCount
integer
出力専用。思考モデルの思考トークンの数。
totalTokenCount
integer
生成リクエストのトークンの合計数(プロンプト + レスポンス候補)。
promptTokensDetails[]
object (ModalityTokenCount
)
出力専用。リクエスト入力で処理されたモダリティのリスト。
cacheTokensDetails[]
object (ModalityTokenCount
)
出力専用。リクエスト入力内のキャッシュに保存されたコンテンツのモダリティのリスト。
candidatesTokensDetails[]
object (ModalityTokenCount
)
出力専用。レスポンスで返されたモダリティのリスト。
toolUsePromptTokensDetails[]
object (ModalityTokenCount
)
出力専用。ツール使用リクエストの入力に対して処理されたモダリティのリスト。
JSON 表現 |
---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
受験者
- JSON 表現
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- ウェブ
- GroundingSupport
- セグメント
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- 候補
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
モデルから生成されたレスポンス候補。
content
object (Content
)
出力専用。モデルから返された生成コンテンツ。
finishReason
enum (FinishReason
)
省略可。出力専用。モデルがトークンの生成を停止した理由。
空の場合、モデルはトークンの生成を停止していません。
safetyRatings[]
object (SafetyRating
)
レスポンス候補の安全性に関する評価のリスト。
カテゴリごとに 1 つのレーティングのみが許可されます。
citationMetadata
object (CitationMetadata
)
出力専用。モデルが生成した候補の引用情報。
このフィールドには、content
に含まれるテキストの朗読情報が入力されることがあります。これらは、基盤となる LLM のトレーニング データに含まれる著作権で保護された素材から「引用」された文章です。
tokenCount
integer
出力専用。この候補のトークン数。
groundingAttributions[]
object (GroundingAttribution
)
出力専用。根拠のある回答に貢献したソースの帰属情報。
このフィールドは、GenerateAnswer
呼び出しで入力されます。
groundingMetadata
object (GroundingMetadata
)
出力専用。候補のグラウンディング メタデータ。
このフィールドは、GenerateContent
呼び出しで入力されます。
avgLogprobs
number
出力専用。候補の平均ログ確率スコア。
logprobsResult
object (LogprobsResult
)
出力専用。レスポンス トークンと上位トークンの対数尤度スコア
urlContextMetadata
object (UrlContextMetadata
)
出力専用。URL コンテキスト取得ツールに関連するメタデータ。
index
integer
出力専用。レスポンス候補のリスト内の候補のインデックス。
JSON 表現 |
---|
{ "content": { object ( |
FinishReason
モデルがトークンの生成を停止した理由を定義します。
列挙型 | |
---|---|
FINISH_REASON_UNSPECIFIED |
デフォルト値。この値は使用されません。 |
STOP |
モデルの自然な停止点、または指定された停止シーケンス。 |
MAX_TOKENS |
リクエストで指定されたトークンの上限に達しました。 |
SAFETY |
安全上の理由からレスポンス候補のコンテンツにフラグが付けられました。 |
RECITATION |
レスポンス候補のコンテンツに、朗読の理由でフラグが付けられました。 |
LANGUAGE |
回答候補のコンテンツが、サポートされていない言語を使用しているとしてフラグ設定されました。 |
OTHER |
不明な理由。 |
BLOCKLIST |
禁止されている語句がコンテンツに含まれているため、トークンの生成が停止されました。 |
PROHIBITED_CONTENT |
禁止コンテンツが含まれている可能性があるため、トークンの生成が停止されました。 |
SPII |
コンテンツに個人を特定できる機密情報(SPII)が含まれている可能性があるため、トークンの生成が停止されました。 |
MALFORMED_FUNCTION_CALL |
モデルによって生成された関数呼び出しが無効です。 |
IMAGE_SAFETY |
生成された画像に安全上の違反が含まれているため、トークンの生成が停止されました。 |
UNEXPECTED_TOOL_CALL |
モデルがツール呼び出しを生成しましたが、リクエストでツールが有効になっていませんでした。 |
GroundingAttribution
回答に貢献した情報源の帰属。
sourceId
object (AttributionSourceId
)
出力専用。このアトリビューションに貢献したソースの識別子。
content
object (Content
)
この帰属を構成するグラウンディング ソース コンテンツ。
JSON 表現 |
---|
{ "sourceId": { object ( |
AttributionSourceId
このアトリビューションに貢献したソースの識別子。
source
Union type
source
は次のいずれかになります。groundingPassage
object (GroundingPassageId
)
インライン パッセージの識別子。
semanticRetrieverChunk
object (SemanticRetrieverChunk
)
セマンティック リトリーバーで取得された Chunk
の識別子。
JSON 表現 |
---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
GroundingPassage
内のパートの識別子。
passageId
string
出力専用。GenerateAnswerRequest
の GroundingPassage.id
と一致するパッセージの ID。
partIndex
integer
出力専用。GenerateAnswerRequest
の GroundingPassage.content
内のパーツのインデックス。
JSON 表現 |
---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
SemanticRetrieverConfig
を使用して GenerateAnswerRequest
で指定されたセマンティック リトリーバーを介して取得された Chunk
の識別子。
source
string
出力専用。リクエストの SemanticRetrieverConfig.source
に一致するソースの名前。例: corpora/123
または corpora/123/documents/abc
chunk
string
出力専用。帰属テキストを含む Chunk
の名前。例: corpora/123/documents/abc/chunks/xyz
JSON 表現 |
---|
{ "source": string, "chunk": string } |
GroundingMetadata
グラウンディングが有効になっている場合にクライアントに返されるメタデータ。
groundingChunks[]
object (GroundingChunk
)
指定されたグラウンディング ソースから取得されたサポート参照のリスト。
groundingSupports[]
object (GroundingSupport
)
グラウンディングのサポートのリスト。
webSearchQueries[]
string
ウェブ検索のフォローアップのためのウェブ検索クエリ。
searchEntryPoint
object (SearchEntryPoint
)
省略可。ウェブ検索のフォローアップ用の Google 検索エントリ。
retrievalMetadata
object (RetrievalMetadata
)
グラウンディング フローでの取得に関連するメタデータ。
JSON 表現 |
---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
Google 検索のエントリ ポイント。
renderedContent
string
省略可。ウェブページまたはアプリの WebView に埋め込むことができるウェブ コンテンツ スニペット。
sdkBlob
string (bytes format)
省略可。<検索語句、検索 URL> タプルの配列を表す Base64 エンコードされた JSON。
Base64 でエンコードされた文字列。
JSON 表現 |
---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
グラウンディング チャンク。
JSON 表現 |
---|
{
// chunk_type
"web": {
object ( |
ウェブ
ウェブからのチャンク。
uri
string
チャンクの URI 参照。
title
string
チャンクのタイトル。
JSON 表現 |
---|
{ "uri": string, "title": string } |
GroundingSupport
グラウンディング サポート。
groundingChunkIndices[]
integer
申し立てに関連付けられている引用を指定するインデックス(grounding_chunk 内)のリスト。たとえば、[1,3,4] は、grounding_chunk[1]、grounding_chunk[3]、grounding_chunk[4] が、主張に関連付けられた取得済みコンテンツであることを意味します。
confidenceScores[]
number
サポート参照の信頼スコア。範囲は 0 ~ 1 です。1 が最も自信があることを示します。このリストは groundingChunkIndices と同じサイズにする必要があります。
segment
object (Segment
)
このサポートが属するコンテンツのセグメント。
JSON 表現 |
---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"segment": {
object ( |
セグメント
コンテンツのセグメント。
partIndex
integer
出力専用。親 Content オブジェクト内の Part オブジェクトのインデックス。
startIndex
integer
出力専用。指定された Part の開始インデックス(バイト単位)。Part の先頭からのオフセット(0 から始まる)。
endIndex
integer
出力専用。指定された Part の終了インデックス(バイト単位)。Part の先頭からのオフセット(排他的、ゼロから開始)。
text
string
出力専用。レスポンスのセグメントに対応するテキスト。
JSON 表現 |
---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
グラウンディング フローでの取得に関連するメタデータ。
googleSearchDynamicRetrievalScore
number
省略可。Google 検索の情報がプロンプトの回答に役立つ可能性を示すスコア。スコアの範囲は [0, 1] で、0 は可能性が最も低く、1 は可能性が最も高いことを示します。このスコアは、Google 検索のグラウンディングと動的取得が有効になっている場合にのみ入力されます。しきい値と比較して、Google 検索をトリガーするかどうかを判断します。
JSON 表現 |
---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
Logprobs の結果
topCandidates[]
object (TopCandidates
)
長さ = デコード ステップの合計数。
chosenCandidates[]
object (Candidate
)
長さ = デコード ステップの合計数。選択した候補は topCandidates に含まれる場合もあれば、含まれない場合もあります。
JSON 表現 |
---|
{ "topCandidates": [ { object ( |
TopCandidates
各デコード ステップでログ確率が最も高い候補。
candidates[]
object (Candidate
)
対数確率の降順で並べ替えられています。
JSON 表現 |
---|
{
"candidates": [
{
object ( |
受験者
logprobs トークンとスコアの候補。
token
string
候補のトークン文字列値。
tokenId
integer
候補のトークン ID 値。
logProbability
number
候補のログ確率。
JSON 表現 |
---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlContextMetadata
URL コンテキスト取得ツールに関連するメタデータ。
urlMetadata[]
object (UrlMetadata
)
URL コンテキストのリスト。
JSON 表現 |
---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
単一の URL の取得のコンテキスト。
retrievedUrl
string
ツールによって取得された URL。
urlRetrievalStatus
enum (UrlRetrievalStatus
)
URL 取得のステータス。
JSON 表現 |
---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
URL 取得のステータス。
列挙型 | |
---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED |
デフォルト値。この値は使用されません。 |
URL_RETRIEVAL_STATUS_SUCCESS |
URL の取得に成功しました。 |
URL_RETRIEVAL_STATUS_ERROR |
エラーのため、URL の取得に失敗しました。 |
CitationMetadata
コンテンツのソース帰属情報のコレクション。
citationSources[]
object (CitationSource
)
特定の回答のソースへの引用。
JSON 表現 |
---|
{
"citationSources": [
{
object ( |
CitationSource
特定のレスポンスの一部に対するソースの引用。
startIndex
integer
省略可。このソースに起因するレスポンスのセグメントの開始。
インデックスはセグメントの開始を示します(バイト単位)。
endIndex
integer
省略可。アトリビューション セグメントの終了(この値は含まれません)。
uri
string
省略可。テキストの一部にソースとして帰属する URI。
license
string
省略可。セグメントのソースとして帰属する GitHub プロジェクトのライセンス。
コードの引用にはライセンス情報が必要です。
JSON 表現 |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
GenerationConfig
- JSON 表現
- モダリティ
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- MediaResolution
モデルの生成と出力の構成オプション。すべてのモデルですべてのパラメータを構成できるわけではありません。
stopSequences[]
string
省略可。出力生成を停止する文字シーケンスのセット(最大 5 個)。指定した場合、API は stop_sequence
が最初に出現したところで停止します。停止シーケンスはレスポンスには含まれません。
responseMimeType
string
省略可。生成された候補テキストの MIME タイプ。サポートされている MIME タイプは、text/plain
(デフォルト): テキスト出力です。application/json
: レスポンス候補の JSON レスポンス。text/x.enum
: レスポンス候補の文字列レスポンスとしての ENUM。サポートされているテキスト MIME タイプの一覧については、ドキュメントをご覧ください。
responseSchema
object (Schema
)
省略可。生成された候補テキストの出力スキーマ。スキーマは OpenAPI スキーマのサブセットである必要があり、オブジェクト、プリミティブ、配列にすることができます。
設定する場合は、互換性のある responseMimeType
も設定する必要があります。互換性のある MIME タイプ: application/json
: JSON レスポンスのスキーマ。詳しくは、JSON テキスト生成ガイドをご覧ください。
responseJsonSchema
value (Value
format)
省略可。生成されたレスポンスの出力スキーマ。これは、JSON スキーマを受け入れる responseSchema
の代替手段です。
設定する場合は、responseSchema
を省略する必要がありますが、responseMimeType
は必須です。
完全な JSON スキーマを送信できますが、すべての機能がサポートされているわけではありません。具体的には、次のプロパティのみがサポートされています。
$id
$defs
$ref
$anchor
type
format
title
description
enum
(文字列と数値の場合)items
prefixItems
minItems
maxItems
minimum
maximum
anyOf
oneOf
(anyOf
と同じように解釈されます)properties
additionalProperties
required
標準以外の propertyOrdering
プロパティを設定することもできます。
循環参照は一定の範囲で展開されるため、必須ではないプロパティ内でのみ使用できます。(Nullable プロパティでは不十分です)。サブスキーマに $ref
が設定されている場合、$
で始まるプロパティ以外のプロパティは設定できません。
responseModalities[]
enum (Modality
)
省略可。リクエストされたレスポンスのモダリティ。モデルが返すことができる、レスポンスで想定される一連のモダリティを表します。これは、レスポンスのモダリティと完全に一致しています。
モデルは、サポートされているモダリティの複数の組み合わせを持つ場合があります。リクエストされたモダリティがサポートされている組み合わせのいずれにも一致しない場合は、エラーが返されます。
空のリストは、テキストのみをリクエストすることと同じです。
candidateCount
integer
省略可。返す生成されたレスポンスの数。設定しない場合、デフォルトで 1 になります。この機能は、以前の世代のモデル(Gemini 1.0 ファミリー)では使用できません。
maxOutputTokens
integer
省略可。レスポンス候補に含めるトークンの最大数。
注: デフォルト値はモデルによって異なります。getModel
関数から返される Model
の Model.output_token_limit
属性をご覧ください。
temperature
number
省略可。出力のランダム性を制御します。
注: デフォルト値はモデルによって異なります。getModel
関数から返される Model
の Model.temperature
属性をご覧ください。
値の範囲は [0.0, 2.0] です。
topP
number
省略可。サンプリング時に考慮するトークンの累積確率の最大値。
このモデルでは、Top-k と Top-p(Nucleus)サンプリングを組み合わせて使用します。
トークンは割り当てられた確率に基づいて並べ替えられ、最も可能性の高いトークンのみが考慮されます。Top-k サンプリングは、考慮するトークンの最大数を直接制限しますが、Nucleus サンプリングは、累積確率に基づいてトークンの数を制限します。
注: デフォルト値は Model
によって異なり、getModel
関数から返される Model.top_p
属性によって指定されます。topK
属性が空の場合、モデルは top-k サンプリングを適用せず、リクエストで topK
を設定できません。
topK
integer
省略可。サンプリング時に考慮するトークンの最大数。
Gemini モデルは、Top-p(Nucleus)サンプリング、または Top-k と Nucleus サンプリングの組み合わせを使用します。Top-k サンプリングでは、最も確率の高い topK
個のトークンのセットが考慮されます。Nucleus サンプリングで実行されているモデルでは、topK 設定は使用できません。
注: デフォルト値は Model
によって異なり、getModel
関数から返される Model.top_p
属性によって指定されます。topK
属性が空の場合、モデルは top-k サンプリングを適用せず、リクエストで topK
を設定できません。
seed
integer
省略可。デコードで使用されるシード。設定されていない場合、リクエストはランダムに生成されたシードを使用します。
presencePenalty
number
省略可。トークンがレスポンスですでに確認されている場合、次のトークンの logprobs に適用されるプレゼンス ペナルティ。
このペナルティはバイナリのオン/オフであり、トークンが使用された回数(初回以降)には依存しません。使用するたびにペナルティが増加する場合は、frequencyPenalty
を使用します。
正のペナルティは、レスポンスですでに使用されているトークンの使用を抑制し、語彙を増やします。
負のペナルティは、レスポンスですでに使用されているトークンの使用を促し、語彙を減らします。
frequencyPenalty
number
省略可。次のトークンの logprobs に適用される頻度ペナルティ。各トークンがこれまでのレスポンスで出現した回数を掛けます。
正のペナルティは、すでに使用されたトークンの使用を抑制します。抑制の程度は、トークンが使用された回数に比例します。トークンが使用される回数が多いほど、モデルがそのトークンを再び使用することが難しくなり、レスポンスの語彙が増えます。
注意: 負のペナルティは、トークンが使用された回数に比例してモデルがトークンを再利用するように促します。負の値を小さくすると、レスポンスの語彙が減ります。負の値が大きいほど、モデルは maxOutputTokens
の上限に達するまで共通トークンの繰り返しを開始します。
responseLogprobs
boolean
省略可。true の場合、レスポンスで logprobs の結果をエクスポートします。
logprobs
integer
省略可。responseLogprobs=True
の場合にのみ有効です。これにより、Candidate.logprobs_result
の各デコード ステップで返す上位の logprobs の数が設定されます。
enableEnhancedCivicAnswers
boolean
省略可。強化された市民向け回答を有効にします。一部のモデルではご利用いただけない場合があります。
speechConfig
object (SpeechConfig
)
省略可。音声生成の構成。
thinkingConfig
object (ThinkingConfig
)
省略可。思考機能の設定。思考をサポートしていないモデルに対してこのフィールドが設定されている場合、エラーが返されます。
mediaResolution
enum (MediaResolution
)
省略可。指定した場合、指定されたメディアの解像度が使用されます。
JSON 表現 |
---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
モダリティ
レスポンスでサポートされているモダリティ。
列挙型 | |
---|---|
MODALITY_UNSPECIFIED |
デフォルト値。 |
TEXT |
モデルがテキストを返すことを示します。 |
IMAGE |
モデルが画像を返す必要があることを示します。 |
AUDIO |
モデルが音声を返す必要があることを示します。 |
SpeechConfig
音声生成の構成。
voiceConfig
object (VoiceConfig
)
単一音声出力の場合の構成。
multiSpeakerVoiceConfig
object (MultiSpeakerVoiceConfig
)
省略可。マルチスピーカー設定の構成。voiceConfig フィールドとは相互に排他的です。
languageCode
string
省略可。音声合成用の言語コード(BCP 47 形式。例: en-US)。
有効な値は、de-DE、en-AU、en-GB、en-IN、en-US、es-US、fr-FR、hi-IN、pt-BR、ar-XA、es-ES、fr-CA、id-ID、it-IT、ja-JP、tr-TR、vi-VN、bn-IN、gu-IN、kn-IN、ml-IN、mr-IN、ta-IN、te-IN、nl-NL、ko-KR、cmn-CN、pl-PL、ru-RU、th-TH です。
JSON 表現 |
---|
{ "voiceConfig": { object ( |
VoiceConfig
使用する音声の構成。
voice_config
Union type
voice_config
は次のいずれかになります。prebuiltVoiceConfig
object (PrebuiltVoiceConfig
)
使用する事前構築済み音声の構成。
JSON 表現 |
---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
使用するビルド済みスピーカーの構成。
voiceName
string
使用するプリセット音声の名前。
JSON 表現 |
---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
マルチスピーカー設定の構成。
speakerVoiceConfigs[]
object (SpeakerVoiceConfig
)
必須。有効になっているすべてのスピーカー音声。
JSON 表現 |
---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
マルチスピーカー設定の単一スピーカーの構成。
speaker
string
必須。使用するスピーカーの名前。プロンプトと同じにする必要があります。
voiceConfig
object (VoiceConfig
)
必須。使用する音声の構成。
JSON 表現 |
---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
思考機能の構成。
includeThoughts
boolean
レスポンスに思考を含めるかどうかを示します。true の場合、思考は利用可能な場合にのみ返されます。
thinkingBudget
integer
モデルが生成する思考トークンの数。
JSON 表現 |
---|
{ "includeThoughts": boolean, "thinkingBudget": integer } |
MediaResolution
入力メディアのメディア解像度。
列挙型 | |
---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
メディアの解像度が設定されていません。 |
MEDIA_RESOLUTION_LOW |
メディアの解像度が低(64 トークン)に設定されている。 |
MEDIA_RESOLUTION_MEDIUM |
メディアの解像度が中(256 トークン)に設定されています。 |
MEDIA_RESOLUTION_HIGH |
メディアの解像度を高に設定(256 トークンでズームして再フレーミング)。 |
HarmCategory
評価のカテゴリ。
これらのカテゴリは、デベロッパーが調整を希望する可能性のあるさまざまな種類の有害性を対象としています。
列挙型 | |
---|---|
HARM_CATEGORY_UNSPECIFIED |
カテゴリが指定されていません。 |
HARM_CATEGORY_DEROGATORY |
PaLM - ID や保護されている属性をターゲットとする否定的なコメントや有害なコメント。 |
HARM_CATEGORY_TOXICITY |
PaLM - 粗暴、無礼、または冒とく的なコンテンツ。 |
HARM_CATEGORY_VIOLENCE |
PaLM - 個人やグループに対する暴力を描写したシナリオ、または残虐行為の一般的な説明についての記述。 |
HARM_CATEGORY_SEXUAL |
PaLM - 性行為やわいせつな内容に関する情報が含まれるコンテンツ。 |
HARM_CATEGORY_MEDICAL |
PaLM - 未確認の医学的アドバイスを推奨します。 |
HARM_CATEGORY_DANGEROUS |
PaLM - 有害な行為を奨励、促進、または助長する危険なコンテンツ。 |
HARM_CATEGORY_HARASSMENT |
Gemini - ハラスメント コンテンツ。 |
HARM_CATEGORY_HATE_SPEECH |
Gemini - ヘイトスピーチとコンテンツ。 |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
Gemini - 性的描写が露骨なコンテンツ。 |
HARM_CATEGORY_DANGEROUS_CONTENT |
Gemini - 危険なコンテンツ。 |
HARM_CATEGORY_CIVIC_INTEGRITY |
Gemini - 市民の誠実性を損なう可能性があるコンテンツ。 |
ModalityTokenCount
単一のモダリティのトークン カウント情報を表します。
modality
enum (Modality
)
このトークン数に関連付けられたモダリティ。
tokenCount
integer
トークンの数。
JSON 表現 |
---|
{
"modality": enum ( |
モダリティ
コンテンツ パーツのモダリティ
列挙型 | |
---|---|
MODALITY_UNSPECIFIED |
モダリティが指定されていません。 |
TEXT |
書式なしテキスト。 |
IMAGE |
Image. |
VIDEO |
動画 |
AUDIO |
音声。 |
DOCUMENT |
ドキュメント(PDF など)。 |
SafetyRating
コンテンツの安全性評価。
安全性評価には、コンテンツの有害カテゴリと、そのカテゴリにおける有害確率レベルが含まれます。コンテンツは、複数の有害カテゴリにわたって安全性が分類され、有害として分類される確率がここに含まれます。
category
enum (HarmCategory
)
必須。この評価のカテゴリ。
probability
enum (HarmProbability
)
必須。このコンテンツが有害である確率。
blocked
boolean
このコンテンツは、このレーティングが原因でブロックされましたか?
JSON 表現 |
---|
{ "category": enum ( |
HarmProbability
コンテンツが有害である確率。
分類システムは、コンテンツが安全でない確率を示します。これは、コンテンツの有害性の重大度を示すものではありません。
列挙型 | |
---|---|
HARM_PROBABILITY_UNSPECIFIED |
確率は指定されていません。 |
NEGLIGIBLE |
コンテンツが安全でない確率はごくわずかである。 |
LOW |
コンテンツが安全でない確率は低い。 |
MEDIUM |
コンテンツが安全でない確率は中程度である。 |
HIGH |
コンテンツが安全でない可能性が高い。 |
SafetySetting
安全性設定。安全性ブロックの動作に影響します。
カテゴリの安全性設定を渡すと、コンテンツがブロックされる可能性の許容値が変更されます。
category
enum (HarmCategory
)
必須。この設定のカテゴリ。
threshold
enum (HarmBlockThreshold
)
必須。有害性がブロックされる確率のしきい値を制御します。
JSON 表現 |
---|
{ "category": enum ( |
HarmBlockThreshold
指定された有害性の確率以上でブロックします。
列挙型 | |
---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
しきい値が指定されていません。 |
BLOCK_LOW_AND_ABOVE |
「NEGLIGIBLE」のコンテンツは許可されます。 |
BLOCK_MEDIUM_AND_ABOVE |
「NEGLIGIBLE」と「LOW」のコンテンツは許可されます。 |
BLOCK_ONLY_HIGH |
NEGLIGIBLE、LOW、MEDIUM のコンテンツは許可されます。 |
BLOCK_NONE |
すべてのコンテンツが許可されます。 |
OFF |
安全フィルタをオフにします。 |