對 Corpus
執行語意搜尋。
HTTP 要求
POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
name |
必要欄位。要查詢的 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{
"query": string,
"metadataFilters": [
{
object ( |
欄位 | |
---|---|
query |
必要欄位。要執行語意搜尋的查詢字串。 |
metadataFilters[] |
選用設定。篩選 文件層級的查詢範例:(年份 >= 2020 OR 年份 < 2010) AND (類型 = 戲劇 OR 類型 = 動作)
查詢中區塊層級的數值範圍範例:(年份 > 2015 AND 年 <= 2020)
注意:只有數字值可以使用「AND」這個鍵。字串值僅支援相同鍵的「OR」。 |
resultsCount |
選用設定。要傳回的 如未指定,最多會傳回 10 個 |
回應主體
corpora.query
的回應,其中包含相關區塊的清單。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"relevantChunks": [
{
object ( |
欄位 | |
---|---|
relevantChunks[] |
相關的片段。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/generative-language.retriever
https://www.googleapis.com/auth/generative-language.retriever.readonly
詳情請參閱驗證總覽。