REST Resource: corpora.documents

資源:Document

DocumentChunk 的集合。Corpus 最多可以有 10,000 個 Document

JSON 表示法
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
欄位
name

string

無法變更。ID。Document 資源名稱。ID (名稱不含「corpora/*/documents/」前置字元) 最多可以包含 40 個字元,且只能使用小寫英數字元或破折號 (-),且 ID 的開頭或結尾不得為破折號。如果建立時名稱空白,系統就會從 displayName 衍生不重複名稱,以及 12 個半形字元的隨機後置字串。範例:corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName

string

選用設定。Document 的使用者可理解的顯示名稱。顯示名稱長度不得超過 512 個半形字元 (包含空格)。例如:「語意擷取器說明文件」

customMetadata[]

object (CustomMetadata)

選用設定。使用者提供的自訂中繼資料,以鍵/值組合的形式儲存用於查詢。Document 最多只能有 20 個CustomMetadata

updateTime

string (Timestamp format)

僅供輸出。Document 上次更新時間的時間戳記。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

createTime

string (Timestamp format)

僅供輸出。Document 建立時的時間戳記。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

方法

create

建立空白的 Document

delete

刪除 Document

get

取得特定 Document 的相關資訊。

list

列出 Corpus 中的所有 Document

patch

更新 Document

query

Document 執行語意搜尋。