- HTTP 要求
- 路徑參數
- 要求主體
- 回應主體
- ProductInfo
- OutputSpec
- TitleExample
- ProductTextGenerationSuggestion
- ProductTextGenerationMetadata
根據產品資訊生成一組候選文字完成/回覆。
HTTP 要求
POST https://productstudio.googleapis.com/v1/{parent=projects/*}:generateProductText
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
parent |
必要欄位。撥打電話的專案。必須參照呼叫端的專案。格式: |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "titleExamples": [ { object ( |
欄位 | |
---|---|
titleExamples[] |
(選用步驟) 提供一些手動製作的標題改善範例,這些範例專為您的用途而設計。TiDe 是處理多個產品類別的通用工具,但您的品牌形象可能需要自訂功能。歡迎在此指定。 |
productInfo |
必要欄位。產品的可用資訊。用來提供生成式 AI 模型資訊。 |
outputSpec |
(選用步驟) 直接影響生成內容,以及最終回覆中內容呈現方式的設定參數。 |
回應主體
為提供的產品生成的文字。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{ "attributes": { string: string, ... }, "title": { object ( |
欄位 | |
---|---|
attributes |
任何其他產生的屬性 這個物件中包含 |
title |
生成的標題。 |
description |
生成的說明。 |
metadata |
用戶端可能想稽核生成內容的額外資訊。 |
ProductInfo
產品的可用資訊。用來提供生成式 AI 模型資訊。
JSON 表示法 |
---|
{
"productAttributes": {
string: string,
...
},
"productImage": {
object ( |
欄位 | |
---|---|
productAttributes |
必要欄位。所有可用產品屬性的對應。例如名稱、說明、品牌、性別、顏色、尺寸等。 這個物件中包含 |
productImage |
(選用步驟) 與產品相關的圖片。 |
OutputSpec
直接影響生成內容,以及最終回覆中內容呈現方式的設定參數。
JSON 表示法 |
---|
{ "workflowId": string, "tone": string, "editorialChanges": string } |
欄位 | |
---|---|
workflowId |
(選用步驟) 要為提供的產品資料執行的工作流程。工作流程可能會填入回覆的標題、說明或兩者。 |
tone |
(選用步驟) 生成文字的所需語氣,例如嚴肅、輕鬆。 |
editorialChanges |
(選用步驟) 對產生的產品資料進行任何編輯變更。例如,將「小」替換為「S」,如果顏色已存在,請勿修改。 |
TitleExample
這是手動製作的產品名稱改善範例。這些範例會提供給 AI,以提升品質。
JSON 表示法 |
---|
{ "productInfo": { string: string, ... }, "finalProductInfo": { string: string, ... }, "titleFormat": string, "category": string } |
欄位 | |
---|---|
productInfo |
必要欄位。包含所有現有產品資訊的地圖,例如 {"title": "dress", "description": "A red dress", "brand": "Dresses4All"} 你可能會用來填入產品動態饋給的任何資訊。 這個物件中包含 |
finalProductInfo |
必要欄位。地圖格式與 productInfo 相同,但包含所有改良項目。例如:{"brand": "Dresses4All", "product": "dress", "color": "red", ...} 目前請按照你希望這些屬性在最終名稱中顯示的順序排序。例如,上述屬性會變成:Dresses4All dress | red 這個物件中包含 |
titleFormat |
必要欄位。構成名稱的屬性或近似屬性。例如,名稱「Google GShoe M」的 titleFormat 可以是「brand | product | size」。 |
category |
必要欄位。產品類別。這有助於 AI 瞭解哪些範例比其他範例更相關。 |
ProductTextGenerationSuggestion
為產品生成的文字,可選擇是否包含品質分數。
JSON 表示法 |
---|
{ "text": string, "score": number, "changeSummary": string } |
欄位 | |
---|---|
text |
生成的文字 |
score |
與生成內容相關聯的品質分數。根據 feedgen 團隊的實作樣式實作的啟發式演算法。 |
changeSummary |
所有變更的簡要摘要。 |
ProductTextGenerationMetadata
與文字生成相關聯的任何中繼資料的包裝函式資料型別。
JSON 表示法 |
---|
{ "metadata": { object } } |
欄位 | |
---|---|
metadata |
中繼資料是相當寬鬆的概念。這裡的資料會以對應項的形式呈現,表示輸出內容不會有簡單的 K:V 關聯,因此無法保證結構。第一個用途是追蹤生成內容中新增/移除/變更的字詞。 |