genai

type DocumentFromTextRequest struct {

	// Model is the URI of the model to use.
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Text to send as input.
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// UUID to set for the document.
	Uuid string `protobuf:"bytes,3,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// URI to set for the document.
	Uri string `protobuf:"bytes,4,opt,name=uri,proto3" json:"uri,omitempty"`
	// AdditionalLinks that should be added to the generated document.
	AdditionalLinks []*newsdoc.Block `protobuf:"bytes,5,rep,name=additionalLinks,proto3" json:"additionalLinks,omitempty"`
	// AdditionalMeta blocks that should be added to the generated document.
	AdditionalMeta []*newsdoc.Block `protobuf:"bytes,6,rep,name=additionalMeta,proto3" json:"additionalMeta,omitempty"`
	// AsyncTimeoutSeconds is the time after which a JobID will be returned
	// instead of a direct result. Optional, defaults to no timeout.
	AsyncTimeoutSeconds int64 `protobuf:"varint,7,opt,name=async_timeout_seconds,json=asyncTimeoutSeconds,proto3" json:"async_timeout_seconds,omitempty"`
	// contains filtered or unexported fields
}

type DocumentFromTextResponse struct {

	// JobID that identifies the job.
	JobId int64 `protobuf:"varint,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// Document that was generated.
	Document *newsdoc.Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// contains filtered or unexported fields
}

type Generate interface {
	// DocumentFromText creates a document from an input text.
	DocumentFromText(context.Context, *DocumentFromTextRequest) (*DocumentFromTextResponse, error)

	// LanguageFeedback gives feedback on a text.
	LanguageFeedback(context.Context, *LanguageFeedbackRequest) (*LanguageFeedbackResponse, error)

	// Text generates text from a input.
	Text(context.Context, *TextRequest) (*TextResponse, error)

	// ListJobs that have been submitted.
	ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error)

	// WaitForJobs is used to wait for status updates for a set of jobs.
	WaitForJobs(context.Context, *WaitForJobsRequest) (*WaitForJobsResponse, error)

	// GetResult returns the result for a job.
	GetResult(context.Context, *GetResultRequest) (*GetResultResponse, error)
}

type GetResultRequest struct {
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

type GetResultResponse struct {
	Id        int64             `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Model     string            `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"`
	Type      JobType           `protobuf:"varint,3,opt,name=type,proto3,enum=ttab.genai.JobType" json:"type,omitempty"`
	Status    JobStatus         `protobuf:"varint,4,opt,name=status,proto3,enum=ttab.genai.JobStatus" json:"status,omitempty"`
	ErrorCode string            `protobuf:"bytes,5,opt,name=error_code,json=errorCode,proto3" json:"error_code,omitempty"`
	Error     string            `protobuf:"bytes,6,opt,name=error,proto3" json:"error,omitempty"`
	Document  *newsdoc.Document `protobuf:"bytes,7,opt,name=document,proto3" json:"document,omitempty"`
	Feedback  *LanguageFeedback `protobuf:"bytes,8,opt,name=feedback,proto3" json:"feedback,omitempty"`
	// contains filtered or unexported fields
}

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

type JobReference struct {
	Id     int64     `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Status JobStatus `protobuf:"varint,2,opt,name=status,proto3,enum=ttab.genai.JobStatus" json:"status,omitempty"`
	// contains filtered or unexported fields
}

type JobStatus int32

type JobType int32

type LanguageFeedback struct {

	// Paragraph index. Set to -1 if the feedback couldn't be connected to a
	// specific paragraph.
	Paragraph int64 `protobuf:"varint,1,opt,name=paragraph,proto3" json:"paragraph,omitempty"`
	// Original text excerpt.
	Original string `protobuf:"bytes,2,opt,name=original,proto3" json:"original,omitempty"`
	// Suggestion for new text.
	Suggestion string `protobuf:"bytes,4,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
	// Motivation for the change.
	Motivation string `protobuf:"bytes,5,opt,name=motivation,proto3" json:"motivation,omitempty"`
	// ParagraphID is present when the feedback is performed on a document and the
	// text block had a ID.
	ParagraphId string `protobuf:"bytes,6,opt,name=paragraph_id,json=paragraphId,proto3" json:"paragraph_id,omitempty"`
	// contains filtered or unexported fields
}

type LanguageFeedbackRequest struct {

	// Model is the URI of the model to use.
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Paragraphs to review. Feedback will reference these paragraphs by
	// index. Optional, but either paragraphs, document_uuid, or document must be
	// set.
	Paragraphs []string `protobuf:"bytes,2,rep,name=paragraphs,proto3" json:"paragraphs,omitempty"`
	// DocumentUUID of the document to give feedback on. The "core/text" content
	// blocks will be extracted and the feedback will reference them by
	// index. Optional, but either paragraphs, document_uuid, or document must be
	// set.
	DocumentUuid string `protobuf:"bytes,3,opt,name=document_uuid,json=documentUuid,proto3" json:"document_uuid,omitempty"`
	// Document is the document to give feedback on. The "core/text" content
	// blocks will be extracted and the feedback will reference them by
	// index. Optional, but either paragraphs, document_uuid, or document must be
	// set.
	Document *newsdoc.Document `protobuf:"bytes,4,opt,name=document,proto3" json:"document,omitempty"`
	// AsyncTimeoutSeconds is the time after which a JobID will be returned
	// instead of a direct result. Optional, defaults to no timeout.
	AsyncTimeoutSeconds int64 `protobuf:"varint,5,opt,name=async_timeout_seconds,json=asyncTimeoutSeconds,proto3" json:"async_timeout_seconds,omitempty"`
	// contains filtered or unexported fields
}

type LanguageFeedbackResponse struct {

	// JobID that identifies the created job.
	JobId int64 `protobuf:"varint,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// Feedback items.
	Feedback []*LanguageFeedback `protobuf:"bytes,2,rep,name=feedback,proto3" json:"feedback,omitempty"`
	// Paragraphs are the paragraphs being referenced in the feedback.
	Paragraphs []string `protobuf:"bytes,3,rep,name=paragraphs,proto3" json:"paragraphs,omitempty"`
	// contains filtered or unexported fields
}

type ListJobsRequest struct {

	// After lists jobs after the given ID. Optional, omit to get latest.
	After int64 `protobuf:"varint,1,opt,name=after,proto3" json:"after,omitempty"`
	// contains filtered or unexported fields
}

type ListJobsResponse struct {
	Jobs []*JobReference `protobuf:"bytes,1,rep,name=jobs,proto3" json:"jobs,omitempty"`
	// contains filtered or unexported fields
}

type TextRequest struct {

	// Model is the URI of the model to use.
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Text to send as input.
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// ParseText tries to parse the generated text into blocks if set to true.
	ParseText bool `protobuf:"varint,3,opt,name=parse_text,json=parseText,proto3" json:"parse_text,omitempty"`
	// CharacterCount sets a target for how long the generated text should be.
	CharacterCount int32 `protobuf:"varint,4,opt,name=character_count,json=characterCount,proto3" json:"character_count,omitempty"`
	// AsyncTimeoutSeconds is the time after which a JobID will be returned
	// instead of a direct result. Optional, defaults to no timeout.
	AsyncTimeoutSeconds int64 `protobuf:"varint,5,opt,name=async_timeout_seconds,json=asyncTimeoutSeconds,proto3" json:"async_timeout_seconds,omitempty"`
	// contains filtered or unexported fields
}

type TextResponse struct {

	// JobID that identifies the created job.
	JobId int64 `protobuf:"varint,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// Text is the generated text.
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// Contet blocks generated from the text.
	Content []*newsdoc.Block `protobuf:"bytes,3,rep,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

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
}

type WaitForJobsRequest struct {

	// Jobs and the currently known version that the client is waiting
	// for. Required.
	Jobs map[int64]int64 `` /* 137-byte string literal not displayed */
	// MaxWaitSec is the maximum time to wait for updates. Optional, defaults to
	// 10.
	MaxWaitSec int64 `protobuf:"varint,2,opt,name=max_wait_sec,json=maxWaitSec,proto3" json:"max_wait_sec,omitempty"`
	// contains filtered or unexported fields
}

type WaitForJobsResponse struct {

	// Updated jobs, can be empty if the wait timed out without any updates.
	Updated []*JobReference `protobuf:"bytes,1,rep,name=updated,proto3" json:"updated,omitempty"`
	// contains filtered or unexported fields
}