proto

package
v0.8.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 14, 2026 License: Apache-2.0, MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	DocReader_Read_FullMethodName        = "/docreader.DocReader/Read"
	DocReader_ReadStream_FullMethodName  = "/docreader.DocReader/ReadStream"
	DocReader_ListEngines_FullMethodName = "/docreader.DocReader/ListEngines"
)

Variables

View Source
var DocReader_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "docreader.DocReader",
	HandlerType: (*DocReaderServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Read",
			Handler:    _DocReader_Read_Handler,
		},
		{
			MethodName: "ListEngines",
			Handler:    _DocReader_ListEngines_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ReadStream",
			Handler:       _DocReader_ReadStream_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "docreader.proto",
}

DocReader_ServiceDesc is the grpc.ServiceDesc for DocReader service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_docreader_proto protoreflect.FileDescriptor

Functions

func RegisterDocReaderServer

func RegisterDocReaderServer(s grpc.ServiceRegistrar, srv DocReaderServer)

Types

type DocReaderClient

type DocReaderClient interface {
	Read(ctx context.Context, in *ReadRequest, opts ...grpc.CallOption) (*ReadResponse, error)
	// ReadStream is the streaming counterpart of Read. It first emits one
	// ReadStreamResponse carrying the parse metadata (markdown / metadata /
	// error), then emits one message per image. This keeps every gRPC message
	// small so large scanned PDFs (hundreds of page images, far exceeding the
	// unary message-size cap) can be returned without RESOURCE_EXHAUSTED and
	// with bounded memory on both ends.
	ReadStream(ctx context.Context, in *ReadRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[ReadStreamResponse], error)
	ListEngines(ctx context.Context, in *ListEnginesRequest, opts ...grpc.CallOption) (*ListEnginesResponse, error)
}

DocReaderClient is the client API for DocReader service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewDocReaderClient

func NewDocReaderClient(cc grpc.ClientConnInterface) DocReaderClient

type DocReaderServer

type DocReaderServer interface {
	Read(context.Context, *ReadRequest) (*ReadResponse, error)
	// ReadStream is the streaming counterpart of Read. It first emits one
	// ReadStreamResponse carrying the parse metadata (markdown / metadata /
	// error), then emits one message per image. This keeps every gRPC message
	// small so large scanned PDFs (hundreds of page images, far exceeding the
	// unary message-size cap) can be returned without RESOURCE_EXHAUSTED and
	// with bounded memory on both ends.
	ReadStream(*ReadRequest, grpc.ServerStreamingServer[ReadStreamResponse]) error
	ListEngines(context.Context, *ListEnginesRequest) (*ListEnginesResponse, error)
	// contains filtered or unexported methods
}

DocReaderServer is the server API for DocReader service. All implementations must embed UnimplementedDocReaderServer for forward compatibility.

type DocReader_ReadStreamClient

type DocReader_ReadStreamClient = grpc.ServerStreamingClient[ReadStreamResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type DocReader_ReadStreamServer

type DocReader_ReadStreamServer = grpc.ServerStreamingServer[ReadStreamResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type ImageRef

type ImageRef struct {
	Filename    string `protobuf:"bytes,1,opt,name=filename,proto3" json:"filename,omitempty"`
	OriginalRef string `protobuf:"bytes,2,opt,name=original_ref,json=originalRef,proto3" json:"original_ref,omitempty"`
	MimeType    string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	StorageKey  string `protobuf:"bytes,4,opt,name=storage_key,json=storageKey,proto3" json:"storage_key,omitempty"` // download URL from shared storage
	ImageData   []byte `protobuf:"bytes,5,opt,name=image_data,json=imageData,proto3" json:"image_data,omitempty"`    // inline bytes fallback
	// contains filtered or unexported fields
}

func (*ImageRef) Descriptor deprecated

func (*ImageRef) Descriptor() ([]byte, []int)

Deprecated: Use ImageRef.ProtoReflect.Descriptor instead.

func (*ImageRef) GetFilename

func (x *ImageRef) GetFilename() string

func (*ImageRef) GetImageData

func (x *ImageRef) GetImageData() []byte

func (*ImageRef) GetMimeType

func (x *ImageRef) GetMimeType() string

func (*ImageRef) GetOriginalRef

func (x *ImageRef) GetOriginalRef() string

func (*ImageRef) GetStorageKey

func (x *ImageRef) GetStorageKey() string

func (*ImageRef) ProtoMessage

func (*ImageRef) ProtoMessage()

func (*ImageRef) ProtoReflect

func (x *ImageRef) ProtoReflect() protoreflect.Message

func (*ImageRef) Reset

func (x *ImageRef) Reset()

func (*ImageRef) String

func (x *ImageRef) String() string

type ListEnginesRequest

type ListEnginesRequest struct {
	ConfigOverrides map[string]string `` /* 180-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ListEnginesRequest) Descriptor deprecated

func (*ListEnginesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListEnginesRequest.ProtoReflect.Descriptor instead.

func (*ListEnginesRequest) GetConfigOverrides

func (x *ListEnginesRequest) GetConfigOverrides() map[string]string

func (*ListEnginesRequest) ProtoMessage

func (*ListEnginesRequest) ProtoMessage()

func (*ListEnginesRequest) ProtoReflect

func (x *ListEnginesRequest) ProtoReflect() protoreflect.Message

func (*ListEnginesRequest) Reset

func (x *ListEnginesRequest) Reset()

func (*ListEnginesRequest) String

func (x *ListEnginesRequest) String() string

type ListEnginesResponse

type ListEnginesResponse struct {
	Engines []*ParserEngineInfo `protobuf:"bytes,1,rep,name=engines,proto3" json:"engines,omitempty"`
	// contains filtered or unexported fields
}

func (*ListEnginesResponse) Descriptor deprecated

func (*ListEnginesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListEnginesResponse.ProtoReflect.Descriptor instead.

func (*ListEnginesResponse) GetEngines

func (x *ListEnginesResponse) GetEngines() []*ParserEngineInfo

func (*ListEnginesResponse) ProtoMessage

func (*ListEnginesResponse) ProtoMessage()

func (*ListEnginesResponse) ProtoReflect

func (x *ListEnginesResponse) ProtoReflect() protoreflect.Message

func (*ListEnginesResponse) Reset

func (x *ListEnginesResponse) Reset()

func (*ListEnginesResponse) String

func (x *ListEnginesResponse) String() string

type ParserEngineInfo

type ParserEngineInfo struct {
	Name              string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Description       string   `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	FileTypes         []string `protobuf:"bytes,3,rep,name=file_types,json=fileTypes,proto3" json:"file_types,omitempty"`
	Available         bool     `protobuf:"varint,4,opt,name=available,proto3" json:"available,omitempty"`
	UnavailableReason string   `protobuf:"bytes,5,opt,name=unavailable_reason,json=unavailableReason,proto3" json:"unavailable_reason,omitempty"`
	// contains filtered or unexported fields
}

func (*ParserEngineInfo) Descriptor deprecated

func (*ParserEngineInfo) Descriptor() ([]byte, []int)

Deprecated: Use ParserEngineInfo.ProtoReflect.Descriptor instead.

func (*ParserEngineInfo) GetAvailable

func (x *ParserEngineInfo) GetAvailable() bool

func (*ParserEngineInfo) GetDescription

func (x *ParserEngineInfo) GetDescription() string

func (*ParserEngineInfo) GetFileTypes

func (x *ParserEngineInfo) GetFileTypes() []string

func (*ParserEngineInfo) GetName

func (x *ParserEngineInfo) GetName() string

func (*ParserEngineInfo) GetUnavailableReason

func (x *ParserEngineInfo) GetUnavailableReason() string

func (*ParserEngineInfo) ProtoMessage

func (*ParserEngineInfo) ProtoMessage()

func (*ParserEngineInfo) ProtoReflect

func (x *ParserEngineInfo) ProtoReflect() protoreflect.Message

func (*ParserEngineInfo) Reset

func (x *ParserEngineInfo) Reset()

func (*ParserEngineInfo) String

func (x *ParserEngineInfo) String() string

type ReadConfig

type ReadConfig struct {
	ParserEngine          string            `protobuf:"bytes,1,opt,name=parser_engine,json=parserEngine,proto3" json:"parser_engine,omitempty"`
	ParserEngineOverrides map[string]string `` /* 200-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ReadConfig) Descriptor deprecated

func (*ReadConfig) Descriptor() ([]byte, []int)

Deprecated: Use ReadConfig.ProtoReflect.Descriptor instead.

func (*ReadConfig) GetParserEngine

func (x *ReadConfig) GetParserEngine() string

func (*ReadConfig) GetParserEngineOverrides

func (x *ReadConfig) GetParserEngineOverrides() map[string]string

func (*ReadConfig) ProtoMessage

func (*ReadConfig) ProtoMessage()

func (*ReadConfig) ProtoReflect

func (x *ReadConfig) ProtoReflect() protoreflect.Message

func (*ReadConfig) Reset

func (x *ReadConfig) Reset()

func (*ReadConfig) String

func (x *ReadConfig) String() string

type ReadRequest

type ReadRequest struct {
	FileContent []byte      `protobuf:"bytes,1,opt,name=file_content,json=fileContent,proto3" json:"file_content,omitempty"`
	FileName    string      `protobuf:"bytes,2,opt,name=file_name,json=fileName,proto3" json:"file_name,omitempty"`
	FileType    string      `protobuf:"bytes,3,opt,name=file_type,json=fileType,proto3" json:"file_type,omitempty"`
	Url         string      `protobuf:"bytes,4,opt,name=url,proto3" json:"url,omitempty"`
	Title       string      `protobuf:"bytes,5,opt,name=title,proto3" json:"title,omitempty"`
	Config      *ReadConfig `protobuf:"bytes,6,opt,name=config,proto3" json:"config,omitempty"`
	RequestId   string      `protobuf:"bytes,7,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

Unified read request: set file_content for file mode, url for URL mode.

func (*ReadRequest) Descriptor deprecated

func (*ReadRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadRequest.ProtoReflect.Descriptor instead.

func (*ReadRequest) GetConfig

func (x *ReadRequest) GetConfig() *ReadConfig

func (*ReadRequest) GetFileContent

func (x *ReadRequest) GetFileContent() []byte

func (*ReadRequest) GetFileName

func (x *ReadRequest) GetFileName() string

func (*ReadRequest) GetFileType

func (x *ReadRequest) GetFileType() string

func (*ReadRequest) GetRequestId

func (x *ReadRequest) GetRequestId() string

func (*ReadRequest) GetTitle

func (x *ReadRequest) GetTitle() string

func (*ReadRequest) GetUrl

func (x *ReadRequest) GetUrl() string

func (*ReadRequest) ProtoMessage

func (*ReadRequest) ProtoMessage()

func (*ReadRequest) ProtoReflect

func (x *ReadRequest) ProtoReflect() protoreflect.Message

func (*ReadRequest) Reset

func (x *ReadRequest) Reset()

func (*ReadRequest) String

func (x *ReadRequest) String() string

type ReadResponse

type ReadResponse struct {
	MarkdownContent string            `protobuf:"bytes,1,opt,name=markdown_content,json=markdownContent,proto3" json:"markdown_content,omitempty"`
	ImageRefs       []*ImageRef       `protobuf:"bytes,2,rep,name=image_refs,json=imageRefs,proto3" json:"image_refs,omitempty"`
	ImageDirPath    string            `protobuf:"bytes,3,opt,name=image_dir_path,json=imageDirPath,proto3" json:"image_dir_path,omitempty"`
	Metadata        map[string]string `` /* 143-byte string literal not displayed */
	Error           string            `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"`
	SourceBlocks    []*SourceBlock    `protobuf:"bytes,6,rep,name=source_blocks,json=sourceBlocks,proto3" json:"source_blocks,omitempty"`
	// contains filtered or unexported fields
}

func (*ReadResponse) Descriptor deprecated

func (*ReadResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadResponse.ProtoReflect.Descriptor instead.

func (*ReadResponse) GetError

func (x *ReadResponse) GetError() string

func (*ReadResponse) GetImageDirPath

func (x *ReadResponse) GetImageDirPath() string

func (*ReadResponse) GetImageRefs

func (x *ReadResponse) GetImageRefs() []*ImageRef

func (*ReadResponse) GetMarkdownContent

func (x *ReadResponse) GetMarkdownContent() string

func (*ReadResponse) GetMetadata

func (x *ReadResponse) GetMetadata() map[string]string

func (*ReadResponse) GetSourceBlocks

func (x *ReadResponse) GetSourceBlocks() []*SourceBlock

func (*ReadResponse) ProtoMessage

func (*ReadResponse) ProtoMessage()

func (*ReadResponse) ProtoReflect

func (x *ReadResponse) ProtoReflect() protoreflect.Message

func (*ReadResponse) Reset

func (x *ReadResponse) Reset()

func (*ReadResponse) String

func (x *ReadResponse) String() string

type ReadStreamMeta

type ReadStreamMeta struct {
	MarkdownContent string            `protobuf:"bytes,1,opt,name=markdown_content,json=markdownContent,proto3" json:"markdown_content,omitempty"`
	ImageDirPath    string            `protobuf:"bytes,2,opt,name=image_dir_path,json=imageDirPath,proto3" json:"image_dir_path,omitempty"`
	Metadata        map[string]string `` /* 143-byte string literal not displayed */
	Error           string            `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`
	ImageCount      uint32            `protobuf:"varint,5,opt,name=image_count,json=imageCount,proto3" json:"image_count,omitempty"` // best-effort total image count (0 if unknown)
	SourceBlocks    []*SourceBlock    `protobuf:"bytes,6,rep,name=source_blocks,json=sourceBlocks,proto3" json:"source_blocks,omitempty"`
	// contains filtered or unexported fields
}

Metadata header for a streamed read. Sent exactly once, before any image.

func (*ReadStreamMeta) Descriptor deprecated

func (*ReadStreamMeta) Descriptor() ([]byte, []int)

Deprecated: Use ReadStreamMeta.ProtoReflect.Descriptor instead.

func (*ReadStreamMeta) GetError

func (x *ReadStreamMeta) GetError() string

func (*ReadStreamMeta) GetImageCount

func (x *ReadStreamMeta) GetImageCount() uint32

func (*ReadStreamMeta) GetImageDirPath

func (x *ReadStreamMeta) GetImageDirPath() string

func (*ReadStreamMeta) GetMarkdownContent

func (x *ReadStreamMeta) GetMarkdownContent() string

func (*ReadStreamMeta) GetMetadata

func (x *ReadStreamMeta) GetMetadata() map[string]string

func (*ReadStreamMeta) GetSourceBlocks

func (x *ReadStreamMeta) GetSourceBlocks() []*SourceBlock

func (*ReadStreamMeta) ProtoMessage

func (*ReadStreamMeta) ProtoMessage()

func (*ReadStreamMeta) ProtoReflect

func (x *ReadStreamMeta) ProtoReflect() protoreflect.Message

func (*ReadStreamMeta) Reset

func (x *ReadStreamMeta) Reset()

func (*ReadStreamMeta) String

func (x *ReadStreamMeta) String() string

type ReadStreamResponse

type ReadStreamResponse struct {

	// Types that are valid to be assigned to Payload:
	//
	//	*ReadStreamResponse_Meta
	//	*ReadStreamResponse_Image
	Payload isReadStreamResponse_Payload `protobuf_oneof:"payload"`
	// contains filtered or unexported fields
}

One frame of a ReadStream. The first frame carries `meta`; every subsequent frame carries a single `image`.

func (*ReadStreamResponse) Descriptor deprecated

func (*ReadStreamResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadStreamResponse.ProtoReflect.Descriptor instead.

func (*ReadStreamResponse) GetImage

func (x *ReadStreamResponse) GetImage() *ImageRef

func (*ReadStreamResponse) GetMeta

func (x *ReadStreamResponse) GetMeta() *ReadStreamMeta

func (*ReadStreamResponse) GetPayload

func (x *ReadStreamResponse) GetPayload() isReadStreamResponse_Payload

func (*ReadStreamResponse) ProtoMessage

func (*ReadStreamResponse) ProtoMessage()

func (*ReadStreamResponse) ProtoReflect

func (x *ReadStreamResponse) ProtoReflect() protoreflect.Message

func (*ReadStreamResponse) Reset

func (x *ReadStreamResponse) Reset()

func (*ReadStreamResponse) String

func (x *ReadStreamResponse) String() string

type ReadStreamResponse_Image

type ReadStreamResponse_Image struct {
	Image *ImageRef `protobuf:"bytes,2,opt,name=image,proto3,oneof"`
}

type ReadStreamResponse_Meta

type ReadStreamResponse_Meta struct {
	Meta *ReadStreamMeta `protobuf:"bytes,1,opt,name=meta,proto3,oneof"`
}

type SourceBlock

type SourceBlock struct {

	// Unicode code point offsets into markdown_content, end exclusive.
	Start uint32 `protobuf:"varint,1,opt,name=start,proto3" json:"start,omitempty"`
	End   uint32 `protobuf:"varint,2,opt,name=end,proto3" json:"end,omitempty"`
	// JSON-encoded locator: {"type":"pdf","page":3,"bbox":[x0,y0,x1,y1]}
	// with ordinals 1-based and bbox as fractions of the page, origin top-left.
	LocatorJson string `protobuf:"bytes,3,opt,name=locator_json,json=locatorJson,proto3" json:"locator_json,omitempty"`
	// contains filtered or unexported fields
}

SourceBlock ties a range of markdown_content to the place in the original file it was parsed from, so a citation can open the file there.

func (*SourceBlock) Descriptor deprecated

func (*SourceBlock) Descriptor() ([]byte, []int)

Deprecated: Use SourceBlock.ProtoReflect.Descriptor instead.

func (*SourceBlock) GetEnd

func (x *SourceBlock) GetEnd() uint32

func (*SourceBlock) GetLocatorJson

func (x *SourceBlock) GetLocatorJson() string

func (*SourceBlock) GetStart

func (x *SourceBlock) GetStart() uint32

func (*SourceBlock) ProtoMessage

func (*SourceBlock) ProtoMessage()

func (*SourceBlock) ProtoReflect

func (x *SourceBlock) ProtoReflect() protoreflect.Message

func (*SourceBlock) Reset

func (x *SourceBlock) Reset()

func (*SourceBlock) String

func (x *SourceBlock) String() string

type UnimplementedDocReaderServer

type UnimplementedDocReaderServer struct{}

UnimplementedDocReaderServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedDocReaderServer) ListEngines

func (UnimplementedDocReaderServer) Read

func (UnimplementedDocReaderServer) ReadStream

type UnsafeDocReaderServer

type UnsafeDocReaderServer interface {
	// contains filtered or unexported methods
}

UnsafeDocReaderServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DocReaderServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL