Question answering

Semantic Retrieval API 提供代管的問答服務,可讓您使用 Google 基礎架構建構檢索增強生成 (RAG) 系統。如需詳細操作說明,請參閱語意擷取指南

方法:models.generateAnswer

在輸入 GenerateAnswerRequest 的情況下,從模型產生有依據的答案。

端點

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

路徑參數

model string

必要欄位。用於產生有依據回覆的 Model 名稱。

格式:model=models/{model}。其格式為 models/{model}

要求主體

要求主體的資料會採用以下結構:

欄位
contents[] object (Content)

必要欄位。與 Model 目前對話的內容。對於單輪查詢,這是要回答的單一問題。對於多回合查詢,這個欄位會重複出現,其中包含對話記錄,以及包含問題的清單中最後一個 Content

注意:models.generateAnswer 僅支援英文查詢。

answerStyle enum (AnswerStyle)

必要欄位。應傳回答案的樣式。

safetySettings[] object (SafetySetting)

選用設定。用來封鎖不安全內容的 SafetySetting 唯一例項清單。

這項規定將適用於 GenerateAnswerRequest.contentsGenerateAnswerResponse.candidate。每個 SafetyCategory 類型應只設定一個設定。API 會封鎖任何不符合這些設定所設門檻的內容和回應。這份清單會覆寫 safetySettings 中指定的每個 SafetyCategory 的預設設定。如果清單中提供的特定 SafetyCategory 沒有 SafetySetting,API 就會使用該類別的預設安全設定。系統支援的危害類別包括 HARM_CATEGORY_HATE_SPEECH、HARM_CATEGORY_SEXUALLY_EXPLICIT、HARM_CATEGORY_DANGEROUS_CONTENT 和 HARM_CATEGORY_HARASSMENT。如要進一步瞭解可用的安全設定,請參閱指南。您也可以參閱安全性指南,瞭解如何在 AI 應用程式中納入安全性考量。

grounding_source Union type
提供答案的來源。grounding_source 只能是下列其中一項:
inlinePassages object (GroundingPassages)

與要求一併提供的段落。

semanticRetriever object (SemanticRetrieverConfig)

透過 Semantic Retriever API 建立的資源擷取的內容。

temperature number

選用設定。控制輸出的隨機性。

值的範圍為 [0.0,1.0],含兩端。值越接近 1.0,產生的回覆就會越多元且更有創意;值越接近 0.0,模型通常會提供較直接的回覆。一般來說,如果是歸因問答用途,建議使用低溫度值 (~0.2)。

回應主體

模型提供有依據答案的回覆。

如果成功,回應主體會含有以下結構的資料:

欄位
answer object (Candidate)

模型的候選答案。

注意:即使答案不太可能來自指定段落,模型仍會一律嘗試提供有根據的答案。在這種情況下,系統可能會提供品質不佳或不切實際的答案,並且 answerableProbability 偏低。

answerableProbability number

僅供輸出。模型對答案正確且根據輸入段落推估的機率。

answerableProbability 值偏低表示答案可能並未根據來源資料提供。

answerableProbability 偏低時,建議您採取下列做法:

  • 向使用者顯示類似「我們無法回答這個問題」的訊息。
  • 改為使用通用大型語言模型,根據世界知識回答問題。這類備用方案的門檻和性質會因個別用途而異。0.5 是良好的起始門檻。
inputFeedback object (InputFeedback)

僅供輸出。與用於回答問題的輸入資料相關的意見回饋,而非模型針對問題產生的回覆。

輸入資料可以是下列一或多項:

  • GenerateAnswerRequest.content 中最後一個項目指定的問題
  • GenerateAnswerRequest.content 中其他項目指定的對話記錄
  • 基準來源 (GenerateAnswerRequest.semantic_retrieverGenerateAnswerRequest.inline_passages)
JSON 表示法
{
  "answer": {
    object (Candidate)
  },
  "answerableProbability": number,
  "inputFeedback": {
    object (InputFeedback)
  }
}

GroundingPassages

重複的經文清單。

欄位
passages[] object (GroundingPassage)

段落清單。

JSON 表示法
{
  "passages": [
    {
      object (GroundingPassage)
    }
  ]
}

GroundingPassage

與接地設定一併納入的段落。

欄位
id string

在具依據的答案中,用於歸屬該段落的 ID。

content object (Content)

段落內容。

JSON 表示法
{
  "id": string,
  "content": {
    object (Content)
  }
}

SemanticRetrieverConfig

從使用 Semantic Retriever API 建立的 CorpusDocument 擷取基礎內容的設定。

欄位
source string

必要欄位。要擷取的資源名稱。例如 corpora/123corpora/123/documents/abc

query object (Content)

必要欄位。用於根據相似度比對指定資源中的 Chunk 時使用的查詢。

metadataFilters[] object (MetadataFilter)

選用設定。用於從資源中選取 Document 和/或 Chunk 的篩選器。

maxChunksCount integer

選用設定。要擷取的相關 Chunk 數量上限。

minimumRelevanceScore number

選用設定。擷取的相關 Chunk 的最低關聯度分數。

JSON 表示法
{
  "source": string,
  "query": {
    object (Content)
  },
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ],
  "maxChunksCount": integer,
  "minimumRelevanceScore": number
}

AnswerStyle

有依據的答案樣式。

列舉
ANSWER_STYLE_UNSPECIFIED 未指定答案樣式。
ABSTRACTIVE 簡潔但抽象的風格。
EXTRACTIVE 非常簡短,且採用擷取式風格。
VERBOSE 冗長風格,包含額外詳細資料。回覆內容的格式可以是句子、段落、多個段落或項目符號等。

InputFeedback

與用於回答問題的輸入資料相關的意見回饋,而非模型針對問題產生的回覆。

欄位
safetyRatings[] object (SafetyRating)

輸入內容的安全性評分。每個類別最多只能有一個評分。

blockReason enum (BlockReason)

選用設定。如果已設為已封鎖,則系統不會傳回候選字串。重新表達輸入內容。

JSON 表示法
{
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "blockReason": enum (BlockReason)
}

BlockReason

指定輸入內容遭到封鎖的原因。

列舉
BLOCK_REASON_UNSPECIFIED 預設值。此值未使用。
SAFETY 輸入內容基於安全性考量而遭到封鎖。檢查 safetyRatings,瞭解哪個安全類別封鎖了該內容。
OTHER 輸入內容因其他原因遭到封鎖。