eidos

type AnalyseDocumentRequest struct {

	// DocumentUUID is the uuid of the document to analyse, optional. Required if
	// no document is provided in the request.
	DocumentUuid string `protobuf:"bytes,1,opt,name=document_uuid,json=documentUuid,proto3" json:"document_uuid,omitempty"`
	// Document to analyse, optional.
	Document *newsdoc.Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// contains filtered or unexported fields
}

type AnalyseDocumentResponse struct {

	// Meta document with the detected entities and topics.
	Meta *newsdoc.Document `protobuf:"bytes,1,opt,name=meta,proto3" json:"meta,omitempty"`
	// Text used in recognition query.
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type RegisterUsageRequest struct {

	// ContentType of the media that was tagged.
	ContentType string `protobuf:"bytes,1,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// ContentURI is an URI that identified the tagged media.
	ContextUri string `protobuf:"bytes,2,opt,name=context_uri,json=contextUri,proto3" json:"context_uri,omitempty"`
	// The UUIDs of the entities that were used.
	EntityUuids []string `protobuf:"bytes,3,rep,name=entity_uuids,json=entityUuids,proto3" json:"entity_uuids,omitempty"`
	// contains filtered or unexported fields
}

type RegisterUsageResponse struct {
	// contains filtered or unexported fields
}

type Tagger interface {
	// AnalyseDocument and return the generated meta document and the text
	// representatin of the document that was used for analysis.
	AnalyseDocument(context.Context, *AnalyseDocumentRequest) (*AnalyseDocumentResponse, error)

	// RegisterUsage is used to inform eidos when an external system has tagged a
	// piece of media with entities managed by eidos.
	RegisterUsage(context.Context, *RegisterUsageRequest) (*RegisterUsageResponse, error)
}

type TwirpServer interface {
	http.Handler

	// ServiceDescriptor returns gzipped bytes describing the .proto file that
	// this service was generated from. Once unzipped, the bytes can be
	// unmarshalled as a
	// google.golang.org/protobuf/types/descriptorpb.FileDescriptorProto.
	//
	// The returned integer is the index of this particular service within that
	// FileDescriptorProto's 'Service' slice of ServiceDescriptorProtos. This is a
	// low-level field, expected to be used for reflection.
	ServiceDescriptor() ([]byte, int)

	// ProtocGenTwirpVersion is the semantic version string of the version of
	// twirp used to generate this file.
	ProtocGenTwirpVersion() string

	// PathPrefix returns the HTTP URL path prefix for all methods handled by this
	// service. This can be used with an HTTP mux to route Twirp requests.
	// The path prefix is in the form: "/<prefix>/<package>.<Service>/"
	// that is, everything in a Twirp route except for the <Method> at the end.
	PathPrefix() string
}