Gemini API hỗ trợ tạo nội dung bằng hình ảnh, âm thanh, mã, công cụ và nhiều nội dung khác. Để biết thông tin chi tiết về từng tính năng này, hãy đọc tiếp và xem mã mẫu tập trung vào tác vụ hoặc đọc các hướng dẫn toàn diện.
- Tạo văn bản
- Thị lực
- Âm thanh
- Vectơ nhúng
- Ngữ cảnh dài
- Thực thi mã
- Chế độ JSON
- Gọi hàm
- Hướng dẫn về hệ thống
Phương thức: models.generateContent
Tạo câu trả lời của mô hình dựa trên một GenerateContentRequest
đầu vào. Hãy tham khảo hướng dẫn tạo văn bản để biết thông tin chi tiết về cách sử dụng. Khả năng nhập dữ liệu khác nhau giữa các mô hình, bao gồm cả mô hình được điều chỉnh. Hãy tham khảo hướng dẫn về mô hình và hướng dẫn điều chỉnh để biết thông tin chi tiết.
Điểm cuối
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
Tham số đường dẫn
model
string
Bắt buộc. Tên của Model
dùng để tạo phần hoàn thành.
Định dạng: models/{model}
. Địa chỉ này có dạng models/{model}
.
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:
tools[]
object (Tool
)
Không bắt buộc. Danh sách Tools
mà Model
có thể dùng để tạo câu trả lời tiếp theo.
Tool
là một đoạn mã cho phép hệ thống tương tác với các hệ thống bên ngoài để thực hiện một hành động hoặc một nhóm hành động nằm ngoài kiến thức và phạm vi của Model
. Các Tool
được hỗ trợ là Function
và codeExecution
. Hãy tham khảo hướng dẫn về Gọi hàm và Thực thi mã để tìm hiểu thêm.
toolConfig
object (ToolConfig
)
Không bắt buộc. Cấu hình công cụ cho mọi Tool
được chỉ định trong yêu cầu. Hãy tham khảo Hướng dẫn gọi hàm để xem ví dụ về cách sử dụng.
safetySettings[]
object (SafetySetting
)
Không bắt buộc. Danh sách các thực thể SafetySetting
riêng biệt để chặn nội dung không an toàn.
Quy định này sẽ được thực thi trên GenerateContentRequest.contents
và GenerateContentResponse.candidates
. Không được có nhiều hơn một chế độ cài đặt cho mỗi loại SafetyCategory
. API sẽ chặn mọi nội dung và phản hồi không đáp ứng các ngưỡng do những chế độ cài đặt này đặt ra. Danh sách này sẽ ghi đè các chế độ cài đặt mặc định cho từng SafetyCategory
được chỉ định trong safetySettings. Nếu không có SafetySetting
cho một SafetyCategory
nhất định được cung cấp trong danh sách, thì API sẽ sử dụng chế độ cài đặt an toàn mặc định cho danh mục đó. Chúng tôi hỗ trợ các danh mục nội dung gây hại HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY. Hãy tham khảo hướng dẫn để biết thông tin chi tiết về các chế độ cài đặt an toàn hiện có. Bạn cũng có thể tham khảo Hướng dẫn về an toàn để tìm hiểu cách đưa các yếu tố cần cân nhắc về an toàn vào ứng dụng AI của mình.
systemInstruction
object (Content
)
Không bắt buộc. Nhà phát triển đặt (các) chỉ dẫn hệ thống. Hiện tại, chỉ có văn bản.
generationConfig
object (GenerationConfig
)
Không bắt buộc. Các lựa chọn cấu hình để tạo mô hình và đầu ra.
cachedContent
string
Không bắt buộc. Tên của nội dung được lưu vào bộ nhớ đệm để dùng làm bối cảnh phân phát thông tin dự đoán. Định dạng: cachedContents/{cachedContent}
Ví dụ về yêu cầu
Văn bản
Python
Node.js
Go
Vỏ
Kotlin
Swift
Dart
Java
Hình ảnh
Python
Node.js
Go
Vỏ
Kotlin
Swift
Dart
Java
Âm thanh
Python
Node.js
Go
Vỏ
Video
Python
Node.js
Go
Vỏ
Python
Go
Vỏ
Chat (Trò chuyện)
Python
Node.js
Go
Vỏ
Kotlin
Swift
Dart
Java
Bộ nhớ đệm
Python
Node.js
Go
Mô hình được tinh chỉnh
Python
Chế độ JSON
Python
Node.js
Go
Vỏ
Kotlin
Swift
Dart
Java
Thực thi mã
Python
Go
Kotlin
Java
Gọi hàm
Python
Go
Node.js
Vỏ
Kotlin
Swift
Dart
Java
Cấu hình tạo
Python
Node.js
Go
Vỏ
Kotlin
Swift
Dart
Java
Chế độ cài đặt an toàn
Python
Node.js
Go
Vỏ
Kotlin
Swift
Dart
Java
Hướng dẫn về hệ thống
Python
Node.js
Go
Vỏ
Kotlin
Swift
Dart
Java
Nội dung phản hồi
Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của GenerateContentResponse
.
Phương thức: models.streamGenerateContent
Tạo một phản hồi truyền trực tuyến từ mô hình dựa trên một GenerateContentRequest
đầu vào.
Điểm cuối
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
Tham số đường dẫn
model
string
Bắt buộc. Tên của Model
dùng để tạo phần hoàn thành.
Định dạng: models/{model}
. Địa chỉ này có dạng models/{model}
.
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:
tools[]
object (Tool
)
Không bắt buộc. Danh sách Tools
mà Model
có thể dùng để tạo câu trả lời tiếp theo.
Tool
là một đoạn mã cho phép hệ thống tương tác với các hệ thống bên ngoài để thực hiện một hành động hoặc một nhóm hành động nằm ngoài kiến thức và phạm vi của Model
. Các Tool
được hỗ trợ là Function
và codeExecution
. Hãy tham khảo hướng dẫn về Gọi hàm và Thực thi mã để tìm hiểu thêm.
toolConfig
object (ToolConfig
)
Không bắt buộc. Cấu hình công cụ cho mọi Tool
được chỉ định trong yêu cầu. Hãy tham khảo Hướng dẫn gọi hàm để xem ví dụ về cách sử dụng.
safetySettings[]
object (SafetySetting
)
Không bắt buộc. Danh sách các thực thể SafetySetting
riêng biệt để chặn nội dung không an toàn.
Quy định này sẽ được thực thi trên GenerateContentRequest.contents
và GenerateContentResponse.candidates
. Không được có nhiều hơn một chế độ cài đặt cho mỗi loại SafetyCategory
. API sẽ chặn mọi nội dung và phản hồi không đáp ứng các ngưỡng do những chế độ cài đặt này đặt ra. Danh sách này sẽ ghi đè các chế độ cài đặt mặc định cho từng SafetyCategory
được chỉ định trong safetySettings. Nếu không có SafetySetting
cho một SafetyCategory
nhất định được cung cấp trong danh sách, thì API sẽ sử dụng chế độ cài đặt an toàn mặc định cho danh mục đó. Chúng tôi hỗ trợ các danh mục nội dung gây hại HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY. Hãy tham khảo hướng dẫn để biết thông tin chi tiết về các chế độ cài đặt an toàn hiện có. Bạn cũng có thể tham khảo Hướng dẫn về an toàn để tìm hiểu cách đưa các yếu tố cần cân nhắc về an toàn vào ứng dụng AI của mình.
systemInstruction
object (Content
)
Không bắt buộc. Nhà phát triển đặt (các) chỉ dẫn hệ thống. Hiện tại, chỉ có văn bản.
generationConfig
object (GenerationConfig
)
Không bắt buộc. Các lựa chọn cấu hình để tạo mô hình và đầu ra.
cachedContent
string
Không bắt buộc. Tên của nội dung được lưu vào bộ nhớ đệm để dùng làm bối cảnh phân phát thông tin dự đoán. Định dạng: cachedContents/{cachedContent}
Ví dụ về yêu cầu
Văn bản
Python
Node.js
Go
Vỏ
Kotlin
Swift
Dart
Java
Hình ảnh
Python
Node.js
Go
Vỏ
Kotlin
Swift
Dart
Java
Âm thanh
Python
Go
Vỏ
Video
Python
Node.js
Go
Vỏ
Python
Go
Vỏ
Chat (Trò chuyện)
Python
Node.js
Go
Vỏ
Kotlin
Swift
Dart
Java
Nội dung phản hồi
Nếu thành công, nội dung phản hồi sẽ chứa một luồng các phiên bản GenerateContentResponse
.
GenerateContentResponse
Phản hồi từ mô hình hỗ trợ nhiều câu trả lời đề xuất.
Chúng tôi báo cáo mức độ an toàn và bộ lọc nội dung cho cả câu lệnh trong GenerateContentResponse.prompt_feedback
và cho từng đề xuất trong finishReason
và safetyRatings
. API này: – Trả về tất cả các đề xuất được yêu cầu hoặc không trả về đề xuất nào – Chỉ trả về không đề xuất nào nếu có vấn đề với câu lệnh (kiểm tra promptFeedback
) – Báo cáo ý kiến phản hồi về từng đề xuất trong finishReason
và safetyRatings
.
candidates[]
object (Candidate
)
Các câu trả lời đề xuất của mô hình.
promptFeedback
object (PromptFeedback
)
Trả về ý kiến phản hồi về câu lệnh liên quan đến bộ lọc nội dung.
usageMetadata
object (UsageMetadata
)
Chỉ có đầu ra. Siêu dữ liệu về mức sử dụng mã thông báo của các yêu cầu tạo.
modelVersion
string
Chỉ có đầu ra. Phiên bản mô hình được dùng để tạo câu trả lời.
responseId
string
Chỉ đầu ra. responseId dùng để xác định từng phản hồi.
Biểu diễn dưới dạng JSON |
---|
{ "candidates": [ { object ( |
PromptFeedback
Một tập hợp siêu dữ liệu phản hồi mà câu lệnh đã chỉ định trong GenerateContentRequest.content
.
blockReason
enum (BlockReason
)
Không bắt buộc. Nếu được đặt, lời nhắc sẽ bị chặn và không có đề xuất nào được trả về. Diễn đạt lại câu lệnh.
safetyRatings[]
object (SafetyRating
)
Mức phân loại về độ an toàn của câu lệnh. Mỗi danh mục chỉ có tối đa một mức phân loại.
Biểu diễn dưới dạng JSON |
---|
{ "blockReason": enum ( |
BlockReason
Nêu rõ lý do khiến câu lệnh bị chặn.
Enum | |
---|---|
BLOCK_REASON_UNSPECIFIED |
Giá trị mặc định. Giá trị này không được dùng. |
SAFETY |
Câu lệnh bị chặn vì lý do an toàn. Kiểm tra safetyRatings để biết danh mục an toàn nào đã chặn quảng cáo đó. |
OTHER |
Câu lệnh bị chặn vì lý do không xác định. |
BLOCKLIST |
Câu lệnh bị chặn do có chứa các cụm từ trong danh sách chặn thuật ngữ. |
PROHIBITED_CONTENT |
Câu lệnh bị chặn do có nội dung bị cấm. |
IMAGE_SAFETY |
Ứng viên bị chặn do nội dung tạo hình ảnh không an toàn. |
UsageMetadata
Siêu dữ liệu về mức sử dụng mã thông báo của yêu cầu tạo.
promptTokenCount
integer
Số lượng mã thông báo trong câu lệnh. Khi cachedContent
được đặt, đây vẫn là tổng kích thước hiệu quả của câu lệnh, tức là bao gồm cả số lượng mã thông báo trong nội dung được lưu vào bộ nhớ đệm.
cachedContentTokenCount
integer
Số lượng mã thông báo trong phần được lưu vào bộ nhớ đệm của câu lệnh (nội dung được lưu vào bộ nhớ đệm)
candidatesTokenCount
integer
Tổng số mã thông báo trên tất cả các đề xuất phản hồi được tạo.
toolUsePromptTokenCount
integer
Chỉ có đầu ra. Số lượng mã thông báo có trong(các) câu lệnh sử dụng công cụ.
thoughtsTokenCount
integer
Chỉ có đầu ra. Số lượng mã thông báo về suy nghĩ cho các mô hình tư duy.
totalTokenCount
integer
Tổng số mã thông báo cho yêu cầu tạo (lời nhắc + các câu trả lời đề xuất).
promptTokensDetails[]
object (ModalityTokenCount
)
Chỉ có đầu ra. Danh sách các phương thức đã được xử lý trong dữ liệu đầu vào của yêu cầu.
cacheTokensDetails[]
object (ModalityTokenCount
)
Chỉ có đầu ra. Danh sách các phương thức của nội dung được lưu vào bộ nhớ đệm trong dữ liệu đầu vào của yêu cầu.
candidatesTokensDetails[]
object (ModalityTokenCount
)
Chỉ có đầu ra. Danh sách các phương thức được trả về trong phản hồi.
toolUsePromptTokensDetails[]
object (ModalityTokenCount
)
Chỉ có đầu ra. Danh sách các phương thức đã được xử lý cho dữ liệu đầu vào của yêu cầu sử dụng công cụ.
Biểu diễn dưới dạng JSON |
---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
Ứng viên
- Biểu diễn dưới dạng JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- Web
- GroundingSupport
- Phân đoạn
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- Ứng cử viên
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
Một câu trả lời đề xuất do mô hình tạo ra.
content
object (Content
)
Chỉ có đầu ra. Nội dung được tạo do mô hình trả về.
finishReason
enum (FinishReason
)
Không bắt buộc. Chỉ có đầu ra. Lý do khiến mô hình ngừng tạo mã thông báo.
Nếu trống, tức là mô hình chưa dừng tạo mã thông báo.
safetyRatings[]
object (SafetyRating
)
Danh sách các điểm xếp hạng về mức độ an toàn của một đề xuất phản hồi.
Mỗi danh mục chỉ có tối đa một mức phân loại.
citationMetadata
object (CitationMetadata
)
Chỉ có đầu ra. Thông tin trích dẫn cho đề xuất do mô hình tạo.
Trường này có thể được điền thông tin đọc lại cho mọi văn bản có trong content
. Đây là những đoạn văn được "trích dẫn" từ tài liệu có bản quyền trong dữ liệu huấn luyện của LLM cơ bản.
tokenCount
integer
Chỉ có đầu ra. Số lượng mã thông báo cho đề xuất này.
groundingAttributions[]
object (GroundingAttribution
)
Chỉ có đầu ra. Thông tin phân bổ cho những nguồn đóng góp vào câu trả lời có căn cứ.
Trường này được điền sẵn cho các cuộc gọi GenerateAnswer
.
groundingMetadata
object (GroundingMetadata
)
Chỉ có đầu ra. Siêu dữ liệu cơ bản cho đề xuất.
Trường này được điền sẵn cho các cuộc gọi GenerateContent
.
avgLogprobs
number
Chỉ có đầu ra. Điểm xác suất trung bình của ứng viên.
logprobsResult
object (LogprobsResult
)
Chỉ có đầu ra. Điểm log-likelihood cho các mã thông báo phản hồi và mã thông báo hàng đầu
urlContextMetadata
object (UrlContextMetadata
)
Chỉ có đầu ra. Siêu dữ liệu liên quan đến công cụ truy xuất bối cảnh URL.
index
integer
Chỉ có đầu ra. Chỉ mục của đề xuất trong danh sách đề xuất phản hồi.
Biểu diễn dưới dạng JSON |
---|
{ "content": { object ( |
FinishReason
Xác định lý do khiến mô hình ngừng tạo mã thông báo.
Enum | |
---|---|
FINISH_REASON_UNSPECIFIED |
Giá trị mặc định. Giá trị này không được dùng. |
STOP |
Điểm dừng tự nhiên của mô hình hoặc chuỗi dừng được cung cấp. |
MAX_TOKENS |
Đã đạt đến số lượng mã thông báo tối đa như được chỉ định trong yêu cầu. |
SAFETY |
Nội dung đề xuất phản hồi đã bị gắn cờ vì lý do an toàn. |
RECITATION |
Nội dung đề xuất phản hồi đã bị gắn cờ vì lý do trích dẫn. |
LANGUAGE |
Nội dung đề xuất phản hồi đã bị gắn cờ vì sử dụng ngôn ngữ không được hỗ trợ. |
OTHER |
Lý do không xác định. |
BLOCKLIST |
Quá trình tạo mã thông báo đã dừng lại vì nội dung chứa các cụm từ bị cấm. |
PROHIBITED_CONTENT |
Quá trình tạo mã thông báo đã dừng do có thể chứa nội dung bị cấm. |
SPII |
Quá trình tạo mã thông báo đã dừng vì nội dung có thể chứa Thông tin nhạy cảm có thể nhận dạng cá nhân (SPII). |
MALFORMED_FUNCTION_CALL |
Lệnh gọi hàm do mô hình tạo ra không hợp lệ. |
IMAGE_SAFETY |
Quá trình tạo mã thông báo đã dừng lại vì hình ảnh được tạo có chứa nội dung vi phạm an toàn. |
UNEXPECTED_TOOL_CALL |
Mô hình đã tạo một lệnh gọi công cụ nhưng không có công cụ nào được bật trong yêu cầu. |
GroundingAttribution
Thông tin ghi nhận quyền tác giả cho một nguồn đóng góp vào câu trả lời.
sourceId
object (AttributionSourceId
)
Chỉ có đầu ra. Giá trị nhận dạng của nguồn đóng góp vào mô hình phân bổ này.
content
object (Content
)
Nội dung nguồn cơ sở tạo nên thông tin phân bổ này.
Biểu diễn dưới dạng JSON |
---|
{ "sourceId": { object ( |
AttributionSourceId
Giá trị nhận dạng của nguồn đóng góp vào mô hình phân bổ này.
source
Union type
source
chỉ có thể là một trong những trạng thái sau:groundingPassage
object (GroundingPassageId
)
Giá trị nhận dạng cho một đoạn văn bản nội tuyến.
semanticRetrieverChunk
object (SemanticRetrieverChunk
)
Giá trị nhận dạng cho Chunk
được tìm nạp thông qua Semantic Retriever.
Biểu diễn dưới dạng JSON |
---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
Giá trị nhận dạng của một bộ phận trong GroundingPassage
.
passageId
string
Chỉ có đầu ra. Mã nhận dạng của đoạn văn khớp với GroundingPassage.id
của GenerateAnswerRequest
.
partIndex
integer
Chỉ có đầu ra. Chỉ mục của phần trong GroundingPassage.content
của GenerateAnswerRequest
.
Biểu diễn dưới dạng JSON |
---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
Giá trị nhận dạng cho một Chunk
được truy xuất thông qua Semantic Retriever được chỉ định trong GenerateAnswerRequest
bằng cách sử dụng SemanticRetrieverConfig
.
source
string
Chỉ có đầu ra. Tên của nguồn khớp với SemanticRetrieverConfig.source
của yêu cầu. Ví dụ: corpora/123
hoặc corpora/123/documents/abc
chunk
string
Chỉ có đầu ra. Tên của Chunk
chứa văn bản được ghi nhận quyền tác giả. Ví dụ: corpora/123/documents/abc/chunks/xyz
Biểu diễn dưới dạng JSON |
---|
{ "source": string, "chunk": string } |
GroundingMetadata
Siêu dữ liệu được trả về cho ứng dụng khi tính năng tiếp đất được bật.
groundingChunks[]
object (GroundingChunk
)
Danh sách các thông tin tham khảo hỗ trợ được truy xuất từ nguồn cơ sở được chỉ định.
groundingSupports[]
object (GroundingSupport
)
Danh sách các thông tin hỗ trợ cơ bản.
webSearchQueries[]
string
Cụm từ tìm kiếm trên web để tìm kiếm trên web.
searchEntryPoint
object (SearchEntryPoint
)
Không bắt buộc. Mục nhập tìm kiếm trên Google cho các cụm từ tìm kiếm tiếp theo trên web.
retrievalMetadata
object (RetrievalMetadata
)
Siêu dữ liệu liên quan đến việc truy xuất trong quy trình tiếp đất.
Biểu diễn dưới dạng JSON |
---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
Điểm truy cập Google Tìm kiếm.
renderedContent
string
Không bắt buộc. Đoạn nội dung web có thể được nhúng vào một trang web hoặc webview của ứng dụng.
sdkBlob
string (bytes format)
Không bắt buộc. JSON được mã hoá Base64 đại diện cho mảng của bộ <cụm từ tìm kiếm, URL tìm kiếm>.
Một chuỗi được mã hoá base64.
Biểu diễn dưới dạng JSON |
---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
Phần tiếp đất.
chunk_type
Union type
chunk_type
chỉ có thể là một trong những trạng thái sau:web
object (Web
)
Đoạn văn cơ sở trên web.
Biểu diễn dưới dạng JSON |
---|
{
// chunk_type
"web": {
object ( |
Web
Đoạn video trên web.
uri
string
Tham chiếu URI của đoạn.
title
string
Tiêu đề của đoạn.
Biểu diễn dưới dạng JSON |
---|
{ "uri": string, "title": string } |
GroundingSupport
Hỗ trợ cơ sở.
groundingChunkIndices[]
integer
Danh sách các chỉ mục (trong "grounding_chunk") chỉ định các trích dẫn liên quan đến tuyên bố. Ví dụ: [1,3,4] có nghĩa là grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] là nội dung được truy xuất và được cho là thuộc về câu khẳng định.
confidenceScores[]
number
Điểm số mức độ tin cậy của các tài liệu tham khảo hỗ trợ. Dao động từ 0 đến 1. 1 là mức tự tin nhất. Danh sách này phải có cùng kích thước với groundingChunkIndices.
segment
object (Segment
)
Phân đoạn nội dung mà thông tin hỗ trợ này thuộc về.
Biểu diễn dưới dạng JSON |
---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"segment": {
object ( |
Phân đoạn
Phân đoạn nội dung.
partIndex
integer
Chỉ có đầu ra. Chỉ mục của đối tượng Part trong đối tượng Content mẹ.
startIndex
integer
Chỉ có đầu ra. Chỉ mục bắt đầu trong Phần đã cho, được đo bằng byte. Độ lệch so với điểm bắt đầu của Phần, bao gồm cả giá trị đầu và giá trị cuối, bắt đầu từ 0.
endIndex
integer
Chỉ có đầu ra. Chỉ mục kết thúc trong Phần đã cho, được đo bằng byte. Độ lệch so với điểm bắt đầu của Phần, loại trừ, bắt đầu từ 0.
text
string
Chỉ có đầu ra. Văn bản tương ứng với đoạn trong câu trả lời.
Biểu diễn dưới dạng JSON |
---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
Siêu dữ liệu liên quan đến việc truy xuất trong quy trình tiếp đất.
googleSearchDynamicRetrievalScore
number
Không bắt buộc. Điểm số cho biết khả năng thông tin từ Google Tìm kiếm có thể giúp trả lời câu lệnh. Điểm số nằm trong khoảng [0, 1], trong đó 0 là ít có khả năng nhất và 1 là có khả năng nhất. Điểm số này chỉ được điền sẵn khi bạn bật tính năng cơ sở dữ liệu tìm kiếm của Google và truy xuất động. Giá trị này sẽ được so sánh với ngưỡng để xác định xem có kích hoạt tính năng tìm kiếm trên Google hay không.
Biểu diễn dưới dạng JSON |
---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
Kết quả Logprobs
topCandidates[]
object (TopCandidates
)
Độ dài = tổng số bước giải mã.
chosenCandidates[]
object (Candidate
)
Độ dài = tổng số bước giải mã. Các đề xuất đã chọn có thể nằm hoặc không nằm trong topCandidates.
Biểu diễn dưới dạng JSON |
---|
{ "topCandidates": [ { object ( |
TopCandidates
Các ứng viên có xác suất nhật ký cao nhất ở mỗi bước giải mã.
candidates[]
object (Candidate
)
Sắp xếp theo xác suất nhật ký theo thứ tự giảm dần.
Biểu diễn dưới dạng JSON |
---|
{
"candidates": [
{
object ( |
Ứng viên
Ứng cử viên cho mã thông báo và điểm số logprobs.
token
string
Giá trị chuỗi mã thông báo của ứng viên.
tokenId
integer
Giá trị mã nhận dạng mã thông báo của ứng viên.
logProbability
number
Xác suất lôgarit của đề xuất.
Biểu diễn dưới dạng JSON |
---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlContextMetadata
Siêu dữ liệu liên quan đến công cụ truy xuất bối cảnh URL.
urlMetadata[]
object (UrlMetadata
)
Danh sách ngữ cảnh URL.
Biểu diễn dưới dạng JSON |
---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
Bối cảnh của việc truy xuất một URL duy nhất.
retrievedUrl
string
URL do công cụ truy xuất.
urlRetrievalStatus
enum (UrlRetrievalStatus
)
Trạng thái truy xuất URL.
Biểu diễn dưới dạng JSON |
---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
Trạng thái truy xuất URL.
Enum | |
---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED |
Giá trị mặc định. Giá trị này không được dùng. |
URL_RETRIEVAL_STATUS_SUCCESS |
Truy xuất URL thành công. |
URL_RETRIEVAL_STATUS_ERROR |
Không truy xuất được URL do lỗi. |
CitationMetadata
Tập hợp các thông tin ghi nhận nguồn cho một nội dung.
citationSources[]
object (CitationSource
)
Nguồn trích dẫn cho một câu trả lời cụ thể.
Biểu diễn dưới dạng JSON |
---|
{
"citationSources": [
{
object ( |
CitationSource
Thông tin trích dẫn về một nguồn cho một phần của câu trả lời cụ thể.
startIndex
integer
Không bắt buộc. Điểm bắt đầu của phân đoạn phản hồi được phân bổ cho nguồn này.
Chỉ mục cho biết điểm bắt đầu của phân đoạn, được đo bằng byte.
endIndex
integer
Không bắt buộc. Kết thúc phân đoạn được phân bổ, không bao gồm.
uri
string
Không bắt buộc. URI được coi là nguồn của một phần văn bản.
license
string
Không bắt buộc. Giấy phép cho dự án trên GitHub được ghi nhận là nguồn của phân đoạn.
Bạn phải có thông tin về giấy phép đối với các trích dẫn mã.
Biểu diễn dưới dạng JSON |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
GenerationConfig
- Biểu diễn dưới dạng JSON
- Phương thức
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- MediaResolution
Các lựa chọn cấu hình để tạo mô hình và đầu ra. Không phải mô hình nào cũng có thể định cấu hình mọi thông số.
stopSequences[]
string
Không bắt buộc. Tập hợp các chuỗi ký tự (tối đa 5) sẽ dừng quá trình tạo đầu ra. Nếu được chỉ định, API sẽ dừng ở lần xuất hiện đầu tiên của stop_sequence
. Chuỗi dừng sẽ không được đưa vào câu trả lời.
responseMimeType
string
Không bắt buộc. Loại MIME của văn bản đề xuất được tạo. Các loại MIME được hỗ trợ là: text/plain
: (mặc định) Đầu ra văn bản. application/json
: Phản hồi JSON trong các đề xuất phản hồi. text/x.enum
: ENUM dưới dạng phản hồi chuỗi trong các đề xuất phản hồi. Tham khảo tài liệu để biết danh sách tất cả các loại MIME văn bản được hỗ trợ.
responseSchema
object (Schema
)
Không bắt buộc. Giản đồ đầu ra của văn bản đề xuất được tạo. Các giản đồ phải là một tập hợp con của giản đồ OpenAPI và có thể là các đối tượng, nguyên hàm hoặc mảng.
Nếu bạn đặt chế độ này, thì bạn cũng phải đặt một responseMimeType
tương thích. Các loại MIME tương thích: application/json
: Giản đồ cho phản hồi JSON. Tham khảo hướng dẫn tạo văn bản JSON để biết thêm thông tin chi tiết.
responseJsonSchema
value (Value
format)
Không bắt buộc. Lược đồ đầu ra của câu trả lời được tạo. Đây là một lựa chọn thay thế cho responseSchema
, chấp nhận Giản đồ JSON.
Nếu được đặt, bạn phải bỏ qua responseSchema
, nhưng responseMimeType
là bắt buộc.
Mặc dù bạn có thể gửi toàn bộ lược đồ JSON, nhưng không phải tính năng nào cũng được hỗ trợ. Cụ thể, chỉ những thuộc tính sau được hỗ trợ:
$id
$defs
$ref
$anchor
type
format
title
description
enum
(đối với chuỗi và số)items
prefixItems
minItems
maxItems
minimum
maximum
anyOf
oneOf
(được diễn giải giống nhưanyOf
)properties
additionalProperties
required
Bạn cũng có thể đặt thuộc tính propertyOrdering
không theo tiêu chuẩn.
Các tham chiếu theo chu kỳ được mở ra ở một mức độ giới hạn và do đó, chỉ có thể được sử dụng trong các thuộc tính không bắt buộc. (Các thuộc tính có thể rỗng là không đủ.) Nếu bạn đặt $ref
trên một lược đồ con, thì không thể đặt bất kỳ thuộc tính nào khác, ngoại trừ những thuộc tính bắt đầu bằng $
.
responseModalities[]
enum (Modality
)
Không bắt buộc. Các phương thức phản hồi được yêu cầu. Biểu thị tập hợp các phương thức mà mô hình có thể trả về và dự kiến sẽ có trong phản hồi. Đây là một kết quả khớp chính xác với các phương thức phản hồi.
Một mô hình có thể có nhiều tổ hợp phương thức được hỗ trợ. Nếu các phương thức được yêu cầu không khớp với bất kỳ tổ hợp nào được hỗ trợ, thì hệ thống sẽ trả về lỗi.
Danh sách trống tương đương với việc chỉ yêu cầu văn bản.
candidateCount
integer
Không bắt buộc. Số lượng câu trả lời được tạo cần trả về. Nếu bạn không đặt, giá trị này sẽ mặc định là 1. Xin lưu ý rằng tính năng này không hoạt động đối với các mô hình thế hệ trước (dòng Gemini 1.0)
maxOutputTokens
integer
Không bắt buộc. Số lượng mã thông báo tối đa cần đưa vào một đề xuất phản hồi.
Lưu ý: Giá trị mặc định tuỳ theo mô hình, hãy xem thuộc tính Model.output_token_limit
của Model
được trả về từ hàm getModel
.
temperature
number
Không bắt buộc. Kiểm soát tính ngẫu nhiên của kết quả.
Lưu ý: Giá trị mặc định tuỳ theo mô hình, hãy xem thuộc tính Model.temperature
của Model
được trả về từ hàm getModel
.
Giá trị có thể nằm trong khoảng [0.0, 2.0].
topP
number
Không bắt buộc. Xác suất tích luỹ tối đa của các mã thông báo cần xem xét khi lấy mẫu.
Mô hình này sử dụng phương pháp lấy mẫu kết hợp Top-k và Top-p (hạt nhân).
Các mã thông báo được sắp xếp dựa trên xác suất được chỉ định để chỉ những mã thông báo có khả năng cao nhất mới được xem xét. Phương pháp lấy mẫu k hàng đầu trực tiếp giới hạn số lượng mã thông báo tối đa cần xem xét, trong khi phương pháp lấy mẫu hạt nhân giới hạn số lượng mã thông báo dựa trên xác suất tích luỹ.
Lưu ý: Giá trị mặc định thay đổi theo Model
và được chỉ định bằng thuộc tính Model.top_p
do hàm getModel
trả về. Thuộc tính topK
trống cho biết mô hình không áp dụng phương pháp lấy mẫu k hàng đầu và không cho phép đặt topK
trên các yêu cầu.
topK
integer
Không bắt buộc. Số lượng mã thông báo tối đa cần xem xét khi lấy mẫu.
Các mô hình Gemini sử dụng phương pháp lấy mẫu Top-p (hạt nhân) hoặc kết hợp phương pháp lấy mẫu Top-k và hạt nhân. Phương pháp lấy mẫu k hàng đầu xem xét tập hợp topK
mã thông báo có khả năng xảy ra nhất. Các mô hình chạy với tính năng lấy mẫu hạt nhân không cho phép cài đặt topK.
Lưu ý: Giá trị mặc định thay đổi theo Model
và được chỉ định bằng thuộc tính Model.top_p
do hàm getModel
trả về. Thuộc tính topK
trống cho biết mô hình không áp dụng phương pháp lấy mẫu k hàng đầu và không cho phép đặt topK
trên các yêu cầu.
seed
integer
Không bắt buộc. Dữ liệu gốc được dùng trong quá trình giải mã. Nếu bạn không đặt, yêu cầu sẽ sử dụng một giá trị ban đầu được tạo ngẫu nhiên.
presencePenalty
number
Không bắt buộc. Hình phạt về sự hiện diện được áp dụng cho logprobs của mã thông báo tiếp theo nếu mã thông báo đó đã xuất hiện trong phản hồi.
Mức phạt này là mức phạt nhị phân (bật/tắt) và không phụ thuộc vào số lần sử dụng mã thông báo (sau lần đầu tiên). Sử dụng frequencyPenalty
cho một khoản tiền phạt tăng lên theo mỗi lần sử dụng.
Mức phạt dương sẽ ngăn chặn việc sử dụng các mã thông báo đã được dùng trong câu trả lời, từ đó tăng vốn từ vựng.
Mức phạt âm sẽ khuyến khích việc sử dụng các mã thông báo đã được dùng trong câu trả lời, giảm từ vựng.
frequencyPenalty
number
Không bắt buộc. Mức phạt tần suất được áp dụng cho logprobs của mã thông báo tiếp theo, nhân với số lần mỗi mã thông báo đã xuất hiện trong phản hồi cho đến nay.
Mức phạt dương sẽ ngăn chặn việc sử dụng các mã thông báo đã được sử dụng, tỷ lệ thuận với số lần mã thông báo đã được sử dụng: Mã thông báo càng được sử dụng nhiều, thì mô hình càng khó sử dụng lại mã thông báo đó, từ đó làm tăng vốn từ vựng của các câu trả lời.
Thận trọng: Mức phạt tiêu cực sẽ khuyến khích mô hình sử dụng lại các mã thông báo tương ứng với số lần mã thông báo đã được sử dụng. Các giá trị âm nhỏ sẽ làm giảm từ vựng của một câu trả lời. Các giá trị âm lớn hơn sẽ khiến mô hình bắt đầu lặp lại một mã thông báo phổ biến cho đến khi đạt đến giới hạn maxOutputTokens
.
responseLogprobs
boolean
Không bắt buộc. Nếu đúng, hãy xuất kết quả logprobs trong phản hồi.
logprobs
integer
Không bắt buộc. Chỉ hợp lệ nếu responseLogprobs=True
. Thao tác này đặt số lượng logprobs hàng đầu cần trả về ở mỗi bước giải mã trong Candidate.logprobs_result
.
enableEnhancedCivicAnswers
boolean
Không bắt buộc. Bật câu trả lời nâng cao về thông tin công dân. Tính năng này có thể không dùng được trên một số mẫu.
speechConfig
object (SpeechConfig
)
Không bắt buộc. Cấu hình tạo lời nói.
thinkingConfig
object (ThinkingConfig
)
Không bắt buộc. Cấu hình cho các tính năng suy nghĩ. Hệ thống sẽ trả về lỗi nếu bạn đặt trường này cho những mô hình không hỗ trợ tính năng suy nghĩ.
mediaResolution
enum (MediaResolution
)
Không bắt buộc. Nếu được chỉ định, độ phân giải của nội dung nghe nhìn được chỉ định sẽ được dùng.
Biểu diễn dưới dạng JSON |
---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
Phương thức
Các phương thức được hỗ trợ của phản hồi.
Enum | |
---|---|
MODALITY_UNSPECIFIED |
Giá trị mặc định. |
TEXT |
Cho biết mô hình sẽ trả về văn bản. |
IMAGE |
Cho biết mô hình sẽ trả về hình ảnh. |
AUDIO |
Cho biết mô hình sẽ trả về âm thanh. |
SpeechConfig
Cấu hình tạo lời nói.
voiceConfig
object (VoiceConfig
)
Cấu hình trong trường hợp đầu ra một giọng nói.
multiSpeakerVoiceConfig
object (MultiSpeakerVoiceConfig
)
Không bắt buộc. Cấu hình cho chế độ thiết lập nhiều loa. Trường này mang tính loại trừ lẫn nhau với trường voiceConfig.
languageCode
string
Không bắt buộc. Mã ngôn ngữ (theo định dạng BCP 47, ví dụ: "en-US") để chuyển văn bản sang lời nói.
Các giá trị hợp lệ là: 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 và th-TH.
Biểu diễn dưới dạng JSON |
---|
{ "voiceConfig": { object ( |
VoiceConfig
Cấu hình cho giọng nói sẽ sử dụng.
voice_config
Union type
voice_config
chỉ có thể là một trong những trạng thái sau:prebuiltVoiceConfig
object (PrebuiltVoiceConfig
)
Cấu hình cho giọng nói được tạo sẵn để sử dụng.
Biểu diễn dưới dạng JSON |
---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
Cấu hình mà loa dựng sẵn sẽ sử dụng.
voiceName
string
Tên của giọng nói đặt sẵn cần sử dụng.
Biểu diễn dưới dạng JSON |
---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
Cấu hình cho chế độ thiết lập nhiều loa.
speakerVoiceConfigs[]
object (SpeakerVoiceConfig
)
Bắt buộc. Tất cả giọng nói của người nói đã bật.
Biểu diễn dưới dạng JSON |
---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
Cấu hình cho một loa trong chế độ thiết lập nhiều loa.
speaker
string
Bắt buộc. Tên của người nói sẽ sử dụng. Phải giống như trong câu lệnh.
voiceConfig
object (VoiceConfig
)
Bắt buộc. Cấu hình cho giọng nói sẽ sử dụng.
Biểu diễn dưới dạng JSON |
---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
Cấu hình cho các tính năng suy nghĩ.
includeThoughts
boolean
Cho biết có nên đưa suy nghĩ vào câu trả lời hay không. Nếu đúng, suy nghĩ chỉ được trả về khi có sẵn.
thinkingBudget
integer
Số lượng mã thông báo suy nghĩ mà mô hình sẽ tạo.
Biểu diễn dưới dạng JSON |
---|
{ "includeThoughts": boolean, "thinkingBudget": integer } |
MediaResolution
Độ phân giải của nội dung nghe nhìn đầu vào.
Enum | |
---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
Chưa đặt độ phân giải của nội dung nghe nhìn. |
MEDIA_RESOLUTION_LOW |
Độ phân giải của nội dung nghe nhìn được đặt ở mức thấp (64 mã thông báo). |
MEDIA_RESOLUTION_MEDIUM |
Độ phân giải của nội dung nghe nhìn được đặt ở mức trung bình (256 mã thông báo). |
MEDIA_RESOLUTION_HIGH |
Độ phân giải của nội dung nghe nhìn được đặt ở mức cao (tái khung hình thu phóng bằng 256 mã thông báo). |
HarmCategory
Danh mục của điểm phân loại.
Các danh mục này bao gồm nhiều loại hành vi gây hại mà nhà phát triển có thể muốn điều chỉnh.
Enum | |
---|---|
HARM_CATEGORY_UNSPECIFIED |
Danh mục chưa được chỉ định. |
HARM_CATEGORY_DEROGATORY |
PaLM – Bình luận tiêu cực hoặc gây hại nhắm đến danh tính và/hoặc thuộc tính được bảo vệ. |
HARM_CATEGORY_TOXICITY |
PaLM – Nội dung thô lỗ, bất kính hoặc thô tục. |
HARM_CATEGORY_VIOLENCE |
PaLM – Mô tả các tình huống mô tả cảnh bạo lực đối với một cá nhân hoặc nhóm người, hoặc mô tả chung về nội dung ghê rợn. |
HARM_CATEGORY_SEXUAL |
PaLM – Chứa nội dung đề cập đến hành vi tình dục hoặc nội dung khiêu dâm khác. |
HARM_CATEGORY_MEDICAL |
PaLM – Quảng bá thông tin tư vấn y tế chưa được kiểm chứng. |
HARM_CATEGORY_DANGEROUS |
PaLM – Nội dung nguy hiểm cổ xuý, tạo điều kiện hoặc khuyến khích việc thực hiện hành động gây hại. |
HARM_CATEGORY_HARASSMENT |
Gemini – Nội dung quấy rối. |
HARM_CATEGORY_HATE_SPEECH |
Gemini – Lời nói hận thù và nội dung hận thù. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
Gemini – Nội dung khiêu dâm. |
HARM_CATEGORY_DANGEROUS_CONTENT |
Gemini – Nội dung nguy hiểm. |
HARM_CATEGORY_CIVIC_INTEGRITY |
Gemini – Nội dung có thể được dùng để gây hại cho sự liêm chính trong hoạt động công dân. |
ModalityTokenCount
Biểu thị thông tin về số lượng mã thông báo cho một phương thức duy nhất.
modality
enum (Modality
)
Phương thức liên kết với số lượng mã thông báo này.
tokenCount
integer
Số lượng mã thông báo.
Biểu diễn dưới dạng JSON |
---|
{
"modality": enum ( |
Phương thức
Phương thức của phần nội dung
Enum | |
---|---|
MODALITY_UNSPECIFIED |
Phương thức chưa được chỉ định. |
TEXT |
Văn bản thuần tuý. |
IMAGE |
Hình ảnh. |
VIDEO |
Video. |
AUDIO |
Âm thanh. |
DOCUMENT |
Tài liệu, ví dụ: PDF. |
SafetyRating
Mức độ an toàn của một nội dung.
Mức độ an toàn chứa danh mục gây hại và mức độ xác suất gây hại trong danh mục đó đối với một nội dung. Nội dung được phân loại để đảm bảo an toàn theo một số danh mục gây hại và xác suất phân loại mức độ gây hại được đưa vào đây.
category
enum (HarmCategory
)
Bắt buộc. Danh mục cho điểm xếp hạng này.
probability
enum (HarmProbability
)
Bắt buộc. Xác suất gây hại của nội dung này.
blocked
boolean
Nội dung này có bị chặn do mức phân loại này không?
Biểu diễn dưới dạng JSON |
---|
{ "category": enum ( |
HarmProbability
Xác suất một nội dung gây hại.
Hệ thống phân loại đưa ra xác suất nội dung không an toàn. Điều này không cho biết mức độ nghiêm trọng của tác hại đối với một nội dung.
Enum | |
---|---|
HARM_PROBABILITY_UNSPECIFIED |
Không xác định được xác suất. |
NEGLIGIBLE |
Nội dung có khả năng không an toàn rất thấp. |
LOW |
Nội dung có ít khả năng không an toàn. |
MEDIUM |
Nội dung có khả năng không an toàn ở mức trung bình. |
HIGH |
Nội dung có khả năng cao là không an toàn. |
SafetySetting
Chế độ cài đặt an toàn, ảnh hưởng đến hành vi chặn nội dung không an toàn.
Việc truyền một chế độ cài đặt an toàn cho một danh mục sẽ thay đổi xác suất được phép để chặn nội dung.
category
enum (HarmCategory
)
Bắt buộc. Danh mục cho chế độ cài đặt này.
threshold
enum (HarmBlockThreshold
)
Bắt buộc. Kiểm soát ngưỡng xác suất mà tại đó nội dung gây hại sẽ bị chặn.
Biểu diễn dưới dạng JSON |
---|
{ "category": enum ( |
HarmBlockThreshold
Chặn ở mức và vượt quá một xác suất gây hại cụ thể.
Enum | |
---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
Ngưỡng chưa được chỉ định. |
BLOCK_LOW_AND_ABOVE |
Nội dung có mức độ VI PHẠM KHÔNG ĐÁNG KỂ sẽ được cho phép. |
BLOCK_MEDIUM_AND_ABOVE |
Chúng tôi sẽ cho phép nội dung có mức độ VI PHẠM KHÔNG ĐÁNG KỂ và VI PHẠM Ở MỨC THẤP. |
BLOCK_ONLY_HIGH |
Chúng tôi sẽ cho phép nội dung có mức độ NEGLIGIBLE (KHÔNG ĐÁNG KỂ), LOW (THẤP) và MEDIUM (TRUNG BÌNH). |
BLOCK_NONE |
Tất cả nội dung sẽ được cho phép. |
OFF |
Tắt bộ lọc an toàn. |