docarray

type DenseNdArrayProto struct {

	// the actual array data, in bytes
	Buffer []byte `protobuf:"bytes,1,opt,name=buffer,proto3" json:"buffer,omitempty"`
	// the shape (dimensions) of the array
	Shape []uint32 `protobuf:"varint,2,rep,packed,name=shape,proto3" json:"shape,omitempty"`
	// the data type of the array
	Dtype string `protobuf:"bytes,3,opt,name=dtype,proto3" json:"dtype,omitempty"`
	// contains filtered or unexported fields
}

type DocumentArrayProto struct {
	Docs []*DocumentProto `protobuf:"bytes,1,rep,name=docs,proto3" json:"docs,omitempty"` // a list of Documents
	// contains filtered or unexported fields
}

type DocumentProto struct {

	// A hexdigest that represents a unique document ID
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Types that are assignable to Content:
	//	*DocumentProto_Blob
	//	*DocumentProto_Tensor
	//	*DocumentProto_Text
	Content isDocumentProto_Content `protobuf_oneof:"content"`
	// the depth of the recursive chunk structure
	Granularity uint32 `protobuf:"varint,5,opt,name=granularity,proto3" json:"granularity,omitempty"`
	// the width of the recursive match structure
	Adjacency uint32 `protobuf:"varint,6,opt,name=adjacency,proto3" json:"adjacency,omitempty"`
	// the parent id from the previous granularity
	ParentId string `protobuf:"bytes,7,opt,name=parent_id,json=parentId,proto3" json:"parent_id,omitempty"`
	// The weight of this document
	Weight float32 `protobuf:"fixed32,8,opt,name=weight,proto3" json:"weight,omitempty"`
	// a uri of the document could be: a local file path, a remote url starts with http or https or data URI scheme
	Uri string `protobuf:"bytes,9,opt,name=uri,proto3" json:"uri,omitempty"`
	// modality, an identifier to the modality this document belongs to. In the scope of multi/cross modal search
	Modality string `protobuf:"bytes,10,opt,name=modality,proto3" json:"modality,omitempty"`
	// mime type of this document, for buffer content, this is required; for other contents, this can be guessed
	MimeType string `protobuf:"bytes,11,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// the offset of the doc
	Offset float32 `protobuf:"fixed32,12,opt,name=offset,proto3" json:"offset,omitempty"`
	// the position of the doc, could be start and end index of a string; could be x,y (top, left) coordinate of an image crop; could be timestamp of an audio clip
	Location []float32 `protobuf:"fixed32,13,rep,packed,name=location,proto3" json:"location,omitempty"`
	// list of the sub-documents of this document (recursive structure)
	Chunks []*DocumentProto `protobuf:"bytes,14,rep,name=chunks,proto3" json:"chunks,omitempty"`
	// the matched documents on the same level (recursive structure)
	Matches []*DocumentProto `protobuf:"bytes,15,rep,name=matches,proto3" json:"matches,omitempty"`
	// the embedding of this document
	Embedding *NdArrayProto `protobuf:"bytes,16,opt,name=embedding,proto3" json:"embedding,omitempty"`
	// a structured data value, consisting of field which map to dynamically typed values.
	Tags *structpb.Struct `protobuf:"bytes,17,opt,name=tags,proto3" json:"tags,omitempty"`
	// Scores performed on the document, each element corresponds to a metric
	Scores map[string]*NamedScoreProto `` /* 154-byte string literal not displayed */
	// Evaluations performed on the document, each element corresponds to a metric
	Evaluations map[string]*NamedScoreProto `` /* 164-byte string literal not displayed */
	// system-defined meta attributes represented in a structured data value.
	XMetadata *structpb.Struct `protobuf:"bytes,20,opt,name=_metadata,json=Metadata,proto3" json:"_metadata,omitempty"`
	// contains filtered or unexported fields
}

type DocumentProto_Blob struct {
	// the raw binary content of this document, which often represents the original document when comes into jina
	Blob []byte `protobuf:"bytes,2,opt,name=blob,proto3,oneof"`
}

type DocumentProto_Tensor struct {
	// the ndarray of the image/audio/video document
	Tensor *NdArrayProto `protobuf:"bytes,3,opt,name=tensor,proto3,oneof"`
}

type DocumentProto_Text struct {
	// a text document
	Text string `protobuf:"bytes,4,opt,name=text,proto3,oneof"`
}

type NamedScoreProto struct {
	Value       float32 `protobuf:"fixed32,1,opt,name=value,proto3" json:"value,omitempty"`               // value
	OpName      string  `protobuf:"bytes,2,opt,name=op_name,json=opName,proto3" json:"op_name,omitempty"` // the name of the operator/score function
	Description string  `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`     // text description of the score
	RefId       string  `protobuf:"bytes,4,opt,name=ref_id,json=refId,proto3" json:"ref_id,omitempty"`    // the score is computed between doc `id` and `ref_id`
	// contains filtered or unexported fields
}

type NdArrayProto struct {

	// Types that are assignable to Content:
	//	*NdArrayProto_Dense
	//	*NdArrayProto_Sparse
	Content isNdArrayProto_Content `protobuf_oneof:"content"`
	// the name of the ndarray class
	ClsName    string           `protobuf:"bytes,3,opt,name=cls_name,json=clsName,proto3" json:"cls_name,omitempty"`
	Parameters *structpb.Struct `protobuf:"bytes,4,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

type NdArrayProto_Dense struct {
	Dense *DenseNdArrayProto `protobuf:"bytes,1,opt,name=dense,proto3,oneof"` // dense representation of the ndarray
}

type NdArrayProto_Sparse struct {
	Sparse *SparseNdArrayProto `protobuf:"bytes,2,opt,name=sparse,proto3,oneof"` // sparse representation of the ndarray
}

type SparseNdArrayProto struct {

	// A 2-D int64 tensor of shape [N, ndims], which specifies the indices of the elements in the sparse tensor that contain nonzero values (elements are zero-indexed)
	Indices *DenseNdArrayProto `protobuf:"bytes,1,opt,name=indices,proto3" json:"indices,omitempty"`
	// A 1-D tensor of any type and shape [N], which supplies the values for each element in indices.
	Values *DenseNdArrayProto `protobuf:"bytes,2,opt,name=values,proto3" json:"values,omitempty"`
	// A 1-D int64 tensor of shape [ndims], which specifies the shape of the sparse tensor.
	Shape []uint32 `protobuf:"varint,3,rep,packed,name=shape,proto3" json:"shape,omitempty"`
	// contains filtered or unexported fields
}