Method: models.embedContent

Tạo một bản nhúng từ mô hình dựa vào Content đầu vào.

Yêu cầu HTTP

POST https://generativelanguage.googleapis.com/v1/{model=models/*}:embedContent

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
model

string

Bắt buộc. Tên tài nguyên của mô hình. Mã này đóng vai trò là mã nhận dạng cho Mô hình sử dụng.

Tên này phải khớp với tên mô hình được phương thức models.list trả về.

Định 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:

Biểu diễn dưới dạng JSON
{
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
Trường
content

object (Content)

Bắt buộc. Nội dung cần nhúng. Hệ thống sẽ chỉ tính các trường parts.text.

taskType

enum (TaskType)

Không bắt buộc. Loại tác vụ không bắt buộc sẽ sử dụng các tính năng nhúng. Chỉ có thể đặt cho models/embedding-001.

title

string

Không bắt buộc. Tiêu đề không bắt buộc cho văn bản. Chỉ áp dụng khi TaskType là RETRIEVAL_DOCUMENT.

Lưu ý: Việc chỉ định title cho RETRIEVAL_DOCUMENT sẽ cung cấp các hoạt động nhúng có chất lượng tốt hơn để truy xuất.

outputDimensionality

integer

Không bắt buộc. Kích thước giảm (không bắt buộc) để nhúng đầu ra. Nếu bạn đặt chính sách này, thì các giá trị quá mức trong tệp nhúng đầu ra sẽ bị cắt bớt từ cuối. Được các mô hình mới hỗ trợ kể từ năm 2024 và mô hình cũ (models/embedding-001) không thể chỉ định giá trị này.

Nội dung phản hồi

Phản hồi cho một EmbedContentRequest.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON
{
  "embedding": {
    object (ContentEmbedding)
  }
}
Trường
embedding

object (ContentEmbedding)

Chỉ có đầu ra. Việc nhúng được tạo từ nội dung đầu vào.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.