Protocol Documentation

Table of Contents

dss/graphrag_importer/proto/graphrag_importer.proto

Top

GraphRAGImporterServiceV1

GraphRAGImporterService handles file imports for GraphRAG creation

HTTP bindings

Method Name Method Route Body Response
ImportFile POST /v1/import ImportFileRequest ImportFileResponse
HealthCheck GET /v1/health HealthCheckRequest HealthCheckResponse

ImportFile

ImportFile processes a file to create a GraphRAG

Input Body: ImportFileRequest
Output: ImportFileResponse

HealthCheck

HealthCheck provides basic service health status

Input Body: HealthCheckRequest
Output: HealthCheckResponse

HealthCheckRequest

Health check messages

HealthCheckResponse

FieldTypeLabelDescription
success bool

message string optional


ImportFileRequest

ImportFileRequest represents the input file for processing

FieldTypeLabelDescription
file_content bytes

Direct file content

file_url string

URL to download the file from

file_name string

Original filename

store_in_s3 bool

Whether to store in S3

batch_size int32

Batch size for importing documents, entities, and relationships

enable_chunk_embeddings bool

Whether to enable chunk embeddings

enable_edge_embeddings bool

Whether to enable edge embeddings

chunk_token_size int32

Maximum tokens per chunk

chunk_overlap_token_size int32

Overlap tokens between chunks

entity_types string repeated

Entity types to extract

relationship_types string repeated

Relationship types to extract

community_report_num_findings string

e.g., "5-10"

community_report_instructions string

Custom community report instructions

partition_id string

Partition id


ImportFileResponse

FieldTypeLabelDescription
success bool

message string optional


Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)