Batch Mode

Gemini API hỗ trợ chế độ hàng loạt, cho phép bạn xử lý nhiều yêu cầu trong một lệnh gọi. Để biết thêm thông tin chi tiết, hãy xem Hướng dẫn về chế độ hàng loạt.

Ứng viên

Một câu trả lời đề xuất do mô hình tạo ra.

Trường
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 (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "groundingAttributions": [
    {
      object (GroundingAttribution)
    }
  ],
  "groundingMetadata": {
    object (GroundingMetadata)
  },
  "avgLogprobs": number,
  "logprobsResult": {
    object (LogprobsResult)
  },
  "urlContextMetadata": {
    object (UrlContextMetadata)
  },
  "index": integer
}

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.

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.

Trường
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)
  },
  "content": {
    object (Content)
  }
}

AttributionSourceId

Giá trị nhận dạng của nguồn đóng góp vào mô hình phân bổ này.

Trường
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)
  },
  "semanticRetrieverChunk": {
    object (SemanticRetrieverChunk)
  }
  // Union type
}

GroundingPassageId

Giá trị nhận dạng của một bộ phận trong GroundingPassage.

Trường
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.

Trường
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.

Trường
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 (GroundingChunk)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "webSearchQueries": [
    string
  ],
  "searchEntryPoint": {
    object (SearchEntryPoint)
  },
  "retrievalMetadata": {
    object (RetrievalMetadata)
  }
}

SearchEntryPoint

Điểm truy cập Google Tìm kiếm.

Trường
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.

Trường
chunk_type Union type
Loại phân đoạn. 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)
  }
  // Union type
}

Web

Đoạn video trên web.

Trường
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ở.

Trường
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 (Segment)
  }
}

Phân đoạn

Phân đoạn nội dung.

Trường
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.

Trường
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

Trường
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)
    }
  ],
  "chosenCandidates": [
    {
      object (Candidate)
    }
  ]
}

TopCandidates

Các ứng viên có xác suất nhật ký cao nhất ở mỗi bước giải mã.

Trường
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 (Candidate)
    }
  ]
}

Ứng viên

Ứng cử viên cho mã thông báo và điểm số logprobs.

Trường
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.

Trường
urlMetadata[] object (UrlMetadata)

Danh sách ngữ cảnh URL.

Biểu diễn dưới dạng JSON 
{
  "urlMetadata": [
    {
      object (UrlMetadata)
    }
  ]
}

UrlMetadata

Bối cảnh của việc truy xuất một URL duy nhất.

Trường
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)
}

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.

Trường
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)
    }
  ]
}

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ể.

Trường
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
}

Tài nguyên REST: batches

Tài nguyên: Thao tác

Tài nguyên này đại diện cho một thao tác diễn ra trong thời gian dài, là kết quả của một lệnh gọi API mạng.

Trường
name string

Tên do máy chủ chỉ định, chỉ có tính duy nhất trong cùng một dịch vụ ban đầu trả về tên đó. Nếu bạn sử dụng ánh xạ HTTP mặc định, name phải là tên tài nguyên kết thúc bằng operations/{unique_id}.

metadata object

Siêu dữ liệu dành riêng cho dịch vụ liên quan đến thao tác. Thường thì tệp này chứa thông tin về tiến trình và siêu dữ liệu chung, chẳng hạn như thời gian tạo. Một số dịch vụ có thể không cung cấp siêu dữ liệu như vậy. Mọi phương thức trả về một thao tác diễn ra trong thời gian dài đều phải ghi lại loại siêu dữ liệu (nếu có).

Một đối tượng chứa các trường thuộc một loại tuỳ ý. Một trường bổ sung "@type" chứa một URI xác định loại. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Nếu giá trị là false, tức là thao tác vẫn đang diễn ra. Nếu true, thao tác sẽ hoàn tất và có thể dùng error hoặc response.

result Union type
Kết quả của thao tác, có thể là error hoặc response hợp lệ. Nếu done == false, thì error và response đều không được đặt. Nếu done == true, bạn chỉ có thể đặt một trong hai tham số error hoặc response. Một số dịch vụ có thể không cung cấp kết quả. result chỉ có thể là một trong những trạng thái sau:
error object (Status)

Kết quả lỗi của thao tác trong trường hợp thất bại hoặc huỷ.

response object

Phản hồi bình thường, thành công của thao tác. Nếu phương thức ban đầu không trả về dữ liệu khi thành công, chẳng hạn như Delete, thì phản hồi là google.protobuf.Empty. Nếu phương thức ban đầu là Get/Create/Update tiêu chuẩn, thì phản hồi phải là tài nguyên. Đối với các phương thức khác, phản hồi phải có kiểu XxxResponse, trong đó Xxx là tên phương thức ban đầu. Ví dụ: nếu tên phương thức ban đầu là TakeSnapshot(), thì loại phản hồi được suy luận là TakeSnapshotResponse.

Một đối tượng chứa các trường thuộc một loại tuỳ ý. Một trường bổ sung "@type" chứa một URI xác định loại. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" }.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

Phương thức: batches.get

Lấy trạng thái mới nhất của một thao tác diễn ra trong thời gian dài. Ứng dụng có thể dùng phương thức này để thăm dò kết quả của thao tác theo khoảng thời gian mà dịch vụ API đề xuất.

Điểm cuối

get https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

Tham số đường dẫn

name string

Tên của tài nguyên thao tác. Địa chỉ này có dạng batches/{batches}.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

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 Operation.

Phương thức: batches.list

Liệt kê các thao tác khớp với bộ lọc đã chỉ định trong yêu cầu. Nếu máy chủ không hỗ trợ phương thức này, thì máy chủ sẽ trả về UNIMPLEMENTED.

Điểm cuối

get https://generativelanguage.googleapis.com/v1beta/{name=batches}

Tham số đường dẫn

name string

Tên của tài nguyên mẹ của thao tác. Địa chỉ này có dạng batches.

Tham số truy vấn

filter string

Bộ lọc danh sách tiêu chuẩn.

pageSize integer

Kích thước trang danh sách tiêu chuẩn.

pageToken string

Mã thông báo trang danh sách chuẩn.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

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 ListOperationsResponse.

Phương thức: batches.cancel

Bắt đầu huỷ không đồng bộ trên một thao tác chạy trong thời gian dài. Máy chủ sẽ cố gắng hết sức để huỷ thao tác, nhưng không đảm bảo thành công. Nếu máy chủ không hỗ trợ phương thức này, thì máy chủ sẽ trả về google.rpc.Code.UNIMPLEMENTED. Các ứng dụng có thể dùng Operations.GetOperation hoặc các phương thức khác để kiểm tra xem việc huỷ có thành công hay không hoặc liệu thao tác có hoàn tất hay không mặc dù đã huỷ. Khi huỷ thành công, thao tác sẽ không bị xoá; thay vào đó, thao tác sẽ trở thành một thao tác có giá trị Operation.error với google.rpc.Status.code là 1, tương ứng với Code.CANCELLED.

Điểm cuối

post https://generativelanguage.googleapis.com/v1beta/{name=batches/*}:cancel

Tham số đường dẫn

name string

Tên của tài nguyên thao tác cần huỷ. Địa chỉ này có dạng batches/{batches}.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ là một đối tượng JSON trống.

Phương thức: batches.delete

Xoá một thao tác kéo dài. Phương thức này cho biết rằng ứng dụng khách không còn quan tâm đến kết quả của thao tác nữa. Thao tác này không huỷ thao tác. Nếu máy chủ không hỗ trợ phương thức này, thì máy chủ sẽ trả về google.rpc.Code.UNIMPLEMENTED.

Điểm cuối

xoá https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

Tham số đường dẫn

name string

Tên của tài nguyên thao tác cần xoá. Địa chỉ này có dạng batches/{batches}.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ là một đối tượng JSON trống.