List file chunks

listFileChunks(input: ListFileChunksInput!): ListFileChunksPayload!

Requires project.knowledge.read.

Arguments

ArgumentTypeRequired
inputListFileChunksInput!Yes

Input fields

input

ListFileChunksInput

FieldTypeRequiredDescription
filePathString!YesFile path to list chunks for
environmentSearchEnvironmentNoSearch environment
branchIdIDNoBranch ID for PREVIEW environment
releaseIdIDNoRelease ID for RELEASE environment
releaseVersionStringNoRelease version for RELEASE environment
includeEmbeddingsBooleanNoInclude embeddings in results
embeddingDimensionEmbeddingDimensionNoEmbedding dimension (required if includeEmbeddings=true)
limitIntNoPage size 1-100; defaults to 10.
cursorStringNoOpaque continuation from pageInfo.endCursor for the same file and snapshot. Chunks are ordered by index, then ID.

Response

Returns ListFileChunksPayload!. Open the type for its fields and nested types.

FieldType
chunks[FileChunk!]!
pageInfoPageInfo!

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query ListFileChunks($input: ListFileChunksInput!) {
  listFileChunks(input: $input) {
    chunks {
      id
      content
      index
    }
    pageInfo {
      hasNextPage
      endCursor
      hasPreviousPage
      startCursor
    }
  }
}
json
{
  "input": {
    "filePath": "example"
  }
}