網路搜尋與新聞搜尋會在每個結果的 content 欄位中傳回已擷取的網頁內容。 瀏覽 回傳你指定的網址內容。
可選擇 contentFormat 片段或完整文件格式,並以 maxLength 限制回傳字元數。 明確設定兩個參數,以避免依賴預設值。 接地時,請使用 contentFormat: "passage"。
段落
設定 contentFormat 為 passage 以取得每個結果中最與你查詢相關的部分,最多可達 maxLength 字元。 Web IQ 會在其端處理整份文件,並回傳一個針對查詢的擷取,讓你的模型不必再讀過無關段落就能找到相關句子。
- 代幣節省:你的模型接收到文件的一部分,而非全部。
- 更佳的事實性:語境中離題內容減少,模型較不容易受離題段落牽引。
Passages 適用於所有應用程式。 對於網路搜尋和新聞搜尋,一個好的起點是 maxResults = 10,passagecontentFormat = , maxLength = 3000。 Browse 不接受 maxResults;它會回傳每個請求一個 URL 的內容。 接著,根據你的使用情境調整;請參考 我應該如何調整 maxResults 和 maxLength?
完整文件: text, html, markdown
Web IQ 不會回傳原始網頁。 在索引過程中,它會從每頁有意義的內容建立結構化文件,並從該文件中挑選段落。 擁有完整文件存取權的應用程式可以請求完整文件,而非段落:
contentFormat |
Returns |
|---|---|
passage |
文件中與查詢最相關的部分,最多 maxLength 個字元。 |
text |
完整文件以純文字呈現,最多 maxLength 個字元。 |
html |
完整文件以 HTML 格式呈現,最多可包含 maxLength 個字元。 |
markdown |
完整文件以 Markdown 格式,最多 maxLength 個字元。 |
長度超過 maxLength 的文件會被截斷。 要取得完整文件,將 maxLength 設定得夠高。
如果你的應用程式沒有完整的文件存取權,設定 text、html 或 markdown 的請求會傳回 HTTP 403,錯誤代碼為 AuthContentFormatForbidden。 段落仍是建議作為依據的格式。
取得所有文件格式
若要申請完整文件存取,請提交 Web IQ 支援請求。 已使用 html 或 text 的應用程式,仍會如同目前一樣繼續運作。
預設值和限制
可用的格式和預設值取決於你的應用程式是否擁有完整文件存取權。 在每個請求中設定 contentFormat 和 maxLength ,明確控制回應格式與最大長度。
| Setting | 沒有完整文件存取權 | 具備完整文件存取權 |
|---|---|---|
| 可用格式 | passage |
passage、text、html、markdown |
contentFormat 如果你省略它的話 |
passage |
html (網路搜尋)、 text (新聞搜尋) |
maxLength 如果你省略它的話 |
3000 | 10000 |
| 最大回傳內容長度 | 3,000 字元,即使你設定更大的 maxLength |
最多可達 500,000 字元,由 maxLength 控制 |
瀏覽
Browse 會回傳你選擇的 URL 內容,並支援相同的格式。 將 contentFormat 設為 query 並發送 maxLength,以取得與該查詢最相關的頁面部分,最多可達 passage 個字元。 通行要求需要 query。
沒有完整文件存取權時,passage 是預設格式,也是你唯一能要求的格式,因此每次 Browse 要求都要包含 query。 在完整文件存取時,你也可以請求 text、markdown 或 maxLength 來取得完整文件,文件長度上限為 html 個字元。
如果你省略 contentFormat 了,Browse 預設為 passage「無完整文件存取」或 html「有完整文件存取」。 如果你省略 maxLength,預設為 3000(未完整存取文件時),或 10000(可完整存取文件時)。 擁有完整文件存取權限時,你可以設定 maxLength 最多 500000 字元;沒有完整存取權限,內容上限為 3000 字元。