列出文件¶
GET https://generativelanguage.googleapis.com/v1beta/fileSearchStores/{fileSearchStore}/documents
列出所有 Document(Corpus 內的全部文件)。
參數¶
fileSearchStore: required string
file search store ID。組成資源名稱 fileSearchStores/{fileSearchStore}。
pageSize: integer
選填。要傳回的 Document 數量上限(每頁)。服務傳回的 Document 數量可能較少。若未指定,最多傳回 10 個 Document。每頁數量上限為 20 個 Document。
pageToken: string
選填。從先前的 ListDocuments 呼叫取得的分頁權杖。將回應中傳回的 next_page_token 作為引數傳給下一個要求,以擷取下一頁。分頁時,提供給 ListDocuments 的所有其他參數都必須與提供分頁權杖的那次呼叫相同。
範例要求
curl -X GET "https://generativelanguage.googleapis.com/v1beta/fileSearchStores/$FILE_SEARCH_STORE_ID/documents" \
-H "x-goog-api-key: $GEMINI_API_KEY"
回應¶
documents: Document array
傳回的 Document。
nextPageToken: string
可作為 page_token 傳送以擷取下一頁的權杖。若省略此欄位,表示沒有更多頁面。
範例回應
{
"documents": [
{
"name": "string",
"displayName": "string",
"customMetadata": [
{
"key": "string",
"stringValue": "string",
"stringListValue": {
"values": [
"..."
]
},
"numericValue": 0.0
}
],
"updateTime": "string",
"createTime": "string",
"state": "STATE_UNSPECIFIED",
"sizeBytes": "string",
"mimeType": "string"
}
],
"nextPageToken": "string"
}
資源¶
Document¶
Document 是 Chunk 的集合。
屬性:
name: string
不可變更。識別碼。Document 資源名稱。ID(名稱去除 "fileSearchStores/*/documents/" 前綴的部分)最多可包含 40 個字元,限小寫英數字元或連字號 (-)。ID 不得以連字號開頭或結尾。若建立時名稱為空,將從 display_name 衍生出唯一名稱,並加上 12 個字元的隨機後綴。範例:fileSearchStores/{file_search_store_id}/documents/my-awesome-doc-123a456b789c
displayName: string
選填。Document 方便閱讀的顯示名稱。顯示名稱長度不得超過 512 個字元(含空格)。範例:"Semantic Retriever Documentation"
**customMetadata**: `CustomMetadata array` 選填。使用者提供的自訂中繼資料,以鍵值對形式儲存,用於查詢。一個 [`Document`](/api-reference/file-search/documents/list-documents/#Resource:Document) 最多可有 20 個 `CustomMetadata`。
**key**: required `string` 要儲存的中繼資料的鍵。**value**: `Union type`
聯集欄位 `value` 只能是下列其中之一: **stringValue**: `string` 要儲存的中繼資料的字串值。**stringListValue**: `StringList` 要儲存的中繼資料的 StringList 值。
**values**: `string array` 要儲存的中繼資料的字串值。updateTime: string
僅供輸出。Document 最後更新的時間戳記。
createTime: string
僅供輸出。Document 建立的時間戳記。
**state**: `string enum` 僅供輸出。[`Document`](/api-reference/file-search/documents/list-documents/#Resource:Document) 目前的狀態。
可能的值: - `STATE_UNSPECIFIED`:預設值。省略狀態時使用此值。 - `STATE_PENDING`:`Chunks` 有部分正在處理中(嵌入與向量儲存),屬於該 [`Document`](/api-reference/file-search/documents/list-documents/#Resource:Document)。 - `STATE_ACTIVE`:`Chunks` 全部已處理完成,該 [`Document`](/api-reference/file-search/documents/list-documents/#Resource:Document) 可供查詢。 - `STATE_FAILED`:`Chunks` 有部分處理失敗,屬於該 [`Document`](/api-reference/file-search/documents/list-documents/#Resource:Document)。sizeBytes: string
僅供輸出。匯入 Document 的原始位元組大小。
mimeType: string
僅供輸出。Document 的 mime 類型。