List Chunks.

List Chunks.

Path Parameters

corpusId string required

The corpus to list chunks in.

Query Parameters

limit int32

The maximum number of results to return. The service may return fewer than this value. If unspecified, the service will choose a sensible default. The maximum allowed value is 1000.

offset int32

The number of entries in the result set to skip.

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

chunks object[]
The list of chunks.
Array [
corpusId string
The corpus this chunk belongs to.
chunkId string
The unique ID of this chunk.
originalSourceId string
The source ID and document ID of the document from which this chunk was originally derived, if it still exists.
originalDocumentId string
created date-time
When this chunk was initially created.
content string
The text content of this chunk.
vectorsCount int32
The number of embedded vectors that correspond to this chunk.
]
pageInfo object

Information about the page of results returned.

requestedPageSize int32

The number of results requested.

requestedOffset int32

The offset specified in the request.

totalResultCount int32

The total number of results available.

{
  "chunks": [
    {
      "corpusId": "string",
      "chunkId": "string",
      "originalSourceId": "string",
      "originalDocumentId": "string",
      "created": "2024-03-07T22:56:08.190Z",
      "content": "string",
      "vectorsCount": 0
    }
  ],
  "pageInfo": {
    "requestedPageSize": 0,
    "requestedOffset": 0,
    "totalResultCount": 0
  }
}

Default error response

application/json

Schema

Example (from schema)

---

Schema

code int32

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details object[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Array [
@type string
The type of the serialized message.
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...