PaLM (decommissioned)

Phương thức: models.generateText

Tạo câu trả lời từ mô hình dựa trên một thông báo đầu vào.

Điểm cuối

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateText

Tham số đường dẫn

model string

Bắt buộc. Tên của Model hoặc TunedModel dùng để tạo phần hoàn thành. Ví dụ: models/text-bison-001 tunedModels/sentence-translator-u3b7m. Tham số 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:

Trường
prompt object (TextPrompt)

Bắt buộc. Văn bản đầu vào dạng tự do được cung cấp cho mô hình dưới dạng câu lệnh.

Khi nhận được một câu lệnh, mô hình sẽ tạo ra một phản hồi TextCompletion mà mô hình dự đoán là phần hoàn thành của văn bản đầu vào.

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.

sẽ được thực thi trên GenerateTextRequest.prompt và GenerateTextResponse.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 câu lệnh và câu trả lời không đáp ứng các ngưỡng do các 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 đó. Các danh mục nội dung gây hại HARM_CATEGORY_DEROGATORY, HARM_CATEGORY_TOXICITY, HARM_CATEGORY_VIOLENCE, HARM_CATEGORY_SEXUAL, HARM_CATEGORY_MEDICAL, HARM_CATEGORY_DANGEROUS được hỗ trợ trong dịch vụ văn bản.

stopSequences[] string

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 một chuỗi dừng. Chuỗi dừng sẽ không được đưa vào câu trả lời.

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 từng mô hình, hãy xem thuộc tính Model.temperature của Model được trả về trong hàm getModel.

Giá trị có thể nằm trong khoảng [0.0,1.0], bao gồm cả hai giá trị này. Giá trị càng gần 1.0 thì câu trả lời càng đa dạng và sáng tạo, trong khi giá trị càng gần 0.0 thì mô hình thường sẽ đưa ra câu trả lời đơn giản hơn.

candidateCount integer

Không bắt buộc. Số lượng câu trả lời được tạo cần trả về.

Giá trị này phải nằm trong khoảng từ 1 đến 8, tính cả hai giá trị này. Nếu bạn không đặt, giá trị này sẽ mặc định là 1.

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.

Nếu bạn không đặt, giá trị này sẽ mặc định là outputTokenLimit được chỉ định trong quy cách Model.

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 kết hợp lấy mẫu Top-k và lấy mẫu 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 theo 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 tuỳ theo từng mô hình, hãy xem thuộc tính Model.top_p của Model được trả về trong hàm getModel.

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.

Mô hình này sử dụng phương pháp kết hợp lấy mẫu Top-k và lấy mẫu 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. Giá trị mặc định là 40.

Lưu ý: Giá trị mặc định tuỳ theo từng mô hình, hãy xem thuộc tính Model.top_k của Model được trả về trong hàm getModel.

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

Phương thức: models.countTextTokens

Chạy trình mã hoá từ của một mô hình trên một văn bản và trả về số lượng mã thông báo.

Điểm cuối

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countTextTokens

Tham số đường dẫn

model string

Bắt buộc. Tên tài nguyên của mô hình. Đây là mã nhận dạng mà Mô hình sẽ sử dụng.

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

Định dạng: models/{model}. Định dạng 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:

Trường
prompt object (TextPrompt)

Bắt buộc. Văn bản đầu vào dạng tự do được cung cấp cho mô hình dưới dạng câu lệnh.

Nội dung phản hồi

Câu trả lời của models.countTextTokens.

Thao tác này trả về tokenCount của mô hình cho prompt.

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:

Trường
tokenCount integer

Số lượng mã thông báo mà model mã hoá prompt thành.

Luôn không âm.

Biểu diễn dưới dạng JSON 
{
  "tokenCount": integer
}

Phương thức: models.generateMessage

Tạo câu trả lời từ mô hình dựa trên một đầu vào MessagePrompt.

Điểm cuối

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateMessage

Tham số đường dẫn

model string

Bắt buộc. Tên của mô hình cần sử dụng.

Định dạng: name=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:

Trường
prompt object (MessagePrompt)

Bắt buộc. Đầu vào văn bản có cấu trúc được cung cấp cho mô hình dưới dạng câu lệnh.

Khi nhận được một câu lệnh, mô hình sẽ trả về thông tin mà mô hình dự đoán là tin nhắn tiếp theo trong cuộc thảo luận.

temperature number

Không bắt buộc. Kiểm soát tính ngẫu nhiên của kết quả.

Giá trị có thể nằm trong khoảng [0.0,1.0], bao gồm cả giá trị này. Giá trị càng gần 1.0 thì câu trả lời càng đa dạng, còn giá trị càng gần 0.0 thì câu trả lời của mô hình thường ít gây bất ngờ hơn.

candidateCount integer

Không bắt buộc. Số lượng thông báo phản hồi được tạo cần trả về.

Giá trị này phải nằm trong khoảng [1, 8] (bao gồm). Nếu bạn không đặt, giá trị này sẽ mặc định là 1.

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 kết hợp lấy mẫu Top-k và lấy mẫu hạt nhân.

Lấy mẫu hạt nhân xem xét tập hợp mã thông báo nhỏ nhất có tổng xác suất ít nhất là topP.

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.

Mô hình này sử dụng phương pháp kết hợp lấy mẫu Top-k và lấy mẫu 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.

Nội dung phản hồi

Câu trả lời của mô hình.

Trong đó có tin nhắn đề xuất và nhật ký cuộc trò chuyện dưới dạng các tin nhắn được sắp xếp theo thứ tự thời gian.

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:

Trường
candidates[] object (Message)

Tin nhắn phản hồi đề xuất của mô hình.

messages[] object (Message)

Nhật ký trò chuyện mà mô hình sử dụng.

filters[] object (ContentFilter)

Một tập hợp siêu dữ liệu lọc nội dung cho văn bản câu lệnh và văn bản phản hồi.

Thông tin này cho biết(các) SafetyCategory nào đã chặn một đề xuất khỏi phản hồi này, HarmProbability thấp nhất đã kích hoạt lệnh chặn và chế độ cài đặt HarmThreshold cho danh mục đó.

Biểu diễn dưới dạng JSON 
{
  "candidates": [
    {
      object (Message)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ]
}

Phương thức: models.countMessageTokens

Chạy trình mã hoá từ của mô hình trên một chuỗi và trả về số lượng mã thông báo.

Điểm cuối

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countMessageTokens

Tham số đường dẫn

model string

Bắt buộc. Tên tài nguyên của mô hình. Đây là mã nhận dạng mà Mô hình sẽ sử dụng.

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

Định dạng: models/{model}. Định dạng 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:

Trường
prompt object (MessagePrompt)

Bắt buộc. Câu lệnh có số lượng mã thông báo cần được trả về.

Nội dung phản hồi

Câu trả lời của models.countMessageTokens.

Thao tác này trả về tokenCount của mô hình cho prompt.

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:

Trường
tokenCount integer

Số lượng mã thông báo mà model mã hoá prompt thành.

Luôn không âm.

Biểu diễn dưới dạng JSON 
{
  "tokenCount": integer
}

Phương thức: models.embedText

Tạo một mục nhúng từ mô hình dựa trên một thông báo đầu vào.

Điểm cuối

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedText

Tham số đường dẫn

model string

Bắt buộc. Tên mô hình để sử dụng với mô hì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:

Trường
text string

Không bắt buộc. Văn bản đầu vào dạng tự do mà mô hình sẽ chuyển thành một mục nhúng.

Nội dung phản hồi

Phản hồi cho EmbedTextRequest.

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:

Trường
embedding object (Embedding)

Chỉ có đầu ra. Vectơ nhúng được tạo từ văn bản đầu vào.

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

Phương thức: models.batchEmbedText

Tạo nhiều mục nhúng từ mô hình dựa trên văn bản đầu vào trong một lệnh gọi đồng bộ.

Điểm cuối

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedText

Tham số đường dẫn

model string

Bắt buộc. Tên của Model dùng để tạo mục nhúng. Ví dụ: models/embedding-gecko-001 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:

Trường
texts[] string

Không bắt buộc. Văn bản đầu vào dạng tự do mà mô hình sẽ chuyển thành một vectơ nhúng. Giới hạn hiện tại là 100 văn bản. Nếu vượt quá giới hạn này, hệ thống sẽ báo lỗi.

requests[] object (EmbedTextRequest)

Không bắt buộc. Nhúng các yêu cầu cho lô. Bạn chỉ có thể đặt một trong hai giá trị texts hoặc requests.

Nội dung phản hồi

Phản hồi cho EmbedTextRequest.

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:

Trường
embeddings[] object (Embedding)

Chỉ có đầu ra. Các vectơ nhúng được tạo từ văn bản đầu vào.

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

EmbedTextRequest

Yêu cầu nhận một vectơ nhúng văn bản từ mô hình.

Trường
model string

Bắt buộc. Tên mô hình để sử dụng với mô hình định dạng=models/{model}.

text string

Không bắt buộc. Văn bản đầu vào dạng tự do mà mô hình sẽ chuyển thành một mục nhúng.

Biểu diễn dưới dạng JSON 
{
  "model": string,
  "text": string
}

ContentFilter

Siêu dữ liệu lọc nội dung được liên kết với việc xử lý một yêu cầu duy nhất.

ContentFilter chứa một lý do và một chuỗi hỗ trợ không bắt buộc. Lý do có thể không được chỉ định.

Trường
reason enum (BlockedReason)

Lý do nội dung bị chặn trong quá trình xử lý yêu cầu.

message string

Một chuỗi mô tả chi tiết hơn về hành vi lọc.

Biểu diễn dưới dạng JSON 
{
  "reason": enum (BlockedReason),
  "message": string
}

BlockedReason

Danh sách các lý do khiến nội dung có thể đã bị chặn.

Enum
BLOCKED_REASON_UNSPECIFIED Bạn chưa chỉ định lý do bị chặn.
SAFETY Nội dung đã bị chặn theo chế độ cài đặt an toàn.
OTHER Nội dung bị chặn nhưng lý do không được phân loại.

Nhúng

Một danh sách các số thực đại diện cho việc nhúng.

Trường
value[] number

Các giá trị nhúng.

Biểu diễn dưới dạng JSON 
{
  "value": [
    number
  ]
}

Thông điệp

Đơn vị cơ sở của văn bản có cấu trúc.

Message bao gồm author và content của Message.

author được dùng để gắn thẻ cho các thông báo khi chúng được đưa vào mô hình dưới dạng văn bản.

Trường
author string

Không bắt buộc. Tác giả của Thông báo này.

Đây là khoá để gắn thẻ nội dung của Thông báo này khi được đưa vào mô hình dưới dạng văn bản.

Tác giả có thể là bất kỳ chuỗi dạng chữ và số nào.

content string

Bắt buộc. Nội dung văn bản của Message có cấu trúc.

citationMetadata object (CitationMetadata)

Chỉ có đầu ra. Thông tin trích dẫn cho content do mô hình tạo trong Message này.

Nếu Message này được tạo dưới dạng đầu ra từ mô hình, thì trường này có thể được điền sẵn thông tin phân bổ cho mọi văn bản có trong content. Trường này chỉ được dùng cho đầu ra.

Biểu diễn dưới dạng JSON 
{
  "author": string,
  "content": string,
  "citationMetadata": {
    object (CitationMetadata)
  }
}

MessagePrompt

Tất cả văn bản đầu vào có cấu trúc được truyền đến mô hình dưới dạng một câu lệnh.

MessagePrompt chứa một tập hợp các trường có cấu trúc cung cấp ngữ cảnh cho cuộc trò chuyện, ví dụ về các cặp tin nhắn đầu vào của người dùng/đầu ra của mô hình giúp mô hình phản hồi theo nhiều cách và nhật ký trò chuyện hoặc danh sách tin nhắn thể hiện các lượt trò chuyện xen kẽ giữa người dùng và mô hình.

Trường
context string

Không bắt buộc. Văn bản cần được cung cấp cho mô hình trước tiên để làm cơ sở cho câu trả lời.

Nếu không trống, context này sẽ được cung cấp cho mô hình trước examples và messages. Khi sử dụng context, hãy nhớ cung cấp mã này cho mọi yêu cầu để duy trì tính liên tục.

Trường này có thể là nội dung mô tả câu lệnh của bạn cho mô hình để giúp cung cấp bối cảnh và hướng dẫn các câu trả lời. Ví dụ: "Dịch cụm từ từ tiếng Anh sang tiếng Pháp" hoặc "Cho trước một câu, hãy phân loại cảm xúc là vui, buồn hay trung tính".

Mọi nội dung trong trường này sẽ được ưu tiên hơn nhật ký tin nhắn nếu tổng kích thước đầu vào vượt quá inputTokenLimit của mô hình và yêu cầu đầu vào bị cắt bớt.

examples[] object (Example)

Không bắt buộc. Ví dụ về những nội dung mà mô hình nên tạo.

Dữ liệu này bao gồm cả thông tin đầu vào của người dùng và phản hồi mà mô hình sẽ mô phỏng.

Những examples này được xử lý giống như tin nhắn trong cuộc trò chuyện, ngoại trừ việc chúng được ưu tiên hơn nhật ký trong messages: Nếu tổng kích thước đầu vào vượt quá inputTokenLimit của mô hình, thì đầu vào sẽ bị cắt bớt. Các mục sẽ được thả từ messages trước examples.

messages[] object (Message)

Bắt buộc. Thông tin tổng quan nhanh về nhật ký trò chuyện gần đây được sắp xếp theo trình tự thời gian.

Lượt thay phiên giữa hai tác giả.

Nếu tổng kích thước đầu vào vượt quá inputTokenLimit của mô hình, thì đầu vào sẽ bị cắt bớt: Các mục cũ nhất sẽ bị loại bỏ khỏi messages.

Biểu diễn dưới dạng JSON 
{
  "context": string,
  "examples": [
    {
      object (Example)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ]
}

Ví dụ:

Một ví dụ về đầu vào/đầu ra được dùng để hướng dẫn Mô hình.

Đây là ví dụ minh hoạ cách mô hình nên phản hồi hoặc định dạng phản hồi.

Trường
input object (Message)

Bắt buộc. Ví dụ về một thông tin đầu vào Message của người dùng.

output object (Message)

Bắt buộc. Ví dụ về những gì mô hình sẽ xuất ra khi có dữ liệu đầu vào.

Biểu diễn dưới dạng JSON 
{
  "input": {
    object (Message)
  },
  "output": {
    object (Message)
  }
}

GenerateTextResponse

Phản hồi của mô hình, bao gồm cả các đề xuất hoàn thành.

Trường
candidates[] object (TextCompletion)

Các câu trả lời đề xuất của mô hình.

filters[] object (ContentFilter)

Một tập hợp siêu dữ liệu lọc nội dung cho văn bản câu lệnh và văn bản phản hồi.

Thông tin này cho biết(các) SafetyCategory nào đã chặn một đề xuất khỏi phản hồi này, HarmProbability thấp nhất đã kích hoạt lệnh chặn và chế độ cài đặt HarmThreshold cho danh mục đó. Điều này cho biết thay đổi nhỏ nhất đối với SafetySettings cần thiết để bỏ chặn ít nhất 1 phản hồi.

Việc chặn được SafetySettings định cấu hình trong yêu cầu (hoặc SafetySettings mặc định của API).

safetyFeedback[] object (SafetyFeedback)

Trả về mọi ý kiến phản hồi về sự an toàn liên quan đến việc lọc nội dung.

Biểu diễn dưới dạng JSON 
{
  "candidates": [
    {
      object (TextCompletion)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ],
  "safetyFeedback": [
    {
      object (SafetyFeedback)
    }
  ]
}

TextCompletion

Văn bản đầu ra do một mô hình trả về.

Trường
output string

Chỉ có đầu ra. Văn bản được tạo do mô hình trả về.

safetyRatings[] object (SafetyRating)

Điểm xếp hạng về mức độ an toàn của một câu trả lờ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 output do mô hình tạo trong TextCompletion này.

Trường này có thể được điền thông tin ghi nhận quyền tác giả cho mọi văn bản có trong output.

Biểu diễn dưới dạng JSON 
{
  "output": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  }
}

SafetyFeedback

Ý kiến phản hồi về mức độ an toàn cho toàn bộ yêu cầu.

Trường này sẽ được điền sẵn nếu nội dung trong dữ liệu đầu vào và/hoặc phản hồi bị chặn do chế độ cài đặt an toàn. SafetyFeedback có thể không tồn tại cho mọi HarmCategory. Mỗi SafetyFeedback sẽ trả về chế độ cài đặt an toàn mà yêu cầu sử dụng, cũng như HarmProbability thấp nhất được phép để trả về kết quả.

Trường
rating object (SafetyRating)

Mức độ an toàn được đánh giá dựa trên nội dung.

setting object (SafetySetting)

Chế độ cài đặt an toàn được áp dụng cho yêu cầu.

Biểu diễn dưới dạng JSON 
{
  "rating": {
    object (SafetyRating)
  },
  "setting": {
    object (SafetySetting)
  }
}

TextPrompt

Văn bản được cung cấp cho mô hình dưới dạng câu lệnh.

Mô hình sẽ dùng TextPrompt này để tạo một đoạn văn bản hoàn chỉnh.

Trường
text string

Bắt buộc. Văn bản câu lệnh.

Biểu diễn dưới dạng JSON 
{
  "text": string
}