package collab

Get desktop application:
View/edit binary Protocol Buffers messages

Payload for creating batch of collab over http.

• string workspace_id = 1

  Workspace id.

• repeated CollabParams params_list = 2

  List of collab params.

Originating from an AppFlowy Client.

Used in: CollabOrigin

• int64 uid = 1

  User id.

• string device_id = 2

  Device id.

Wrapper over a collection of embeddings, together with metadata associated on the collection level.

Used in: CollabParams

• uint32 tokens_consumed = 1

  OpenAPI tokens consumed.

• repeated CollabEmbeddingsParams embeddings = 2

  List of embeddings.

Embeddings and the associated collab metadata.

Used in: CollabEmbeddings

• string fragment_id = 1

  Fragment id.

• string object_id = 2

  Collab object id.

• CollabType collab_type = 3

  Collab type.

• EmbeddingContentType content_type = 4

  Embedding content type.

• string content = 5

  Embedding content as string.

• repeated float embedding = 6

  Embedding as float array.

Origin of a collab message.

• oneof origin

  • EmptyOrigin empty = 1

  • ClientOrigin client = 2

  • ServerOrigin server = 3

Payload for sending and receive collab over http.

Used in: BatchCreateCollabParams

• string object_id = 1

• bytes encoded_collab = 2

  Serialized EncodedCollab object, which could either be in bincode or protobuf serialization format.

• CollabType collab_type = 3

  Collab type.

• optional CollabEmbeddings embeddings = 4

  Document embeddings.

Collab Type.

Used in: CollabEmbeddingsParams, CollabParams, CreateCollabParams

• COLLAB_TYPE_UNKNOWN = 0

• COLLAB_TYPE_DOCUMENT = 1

• COLLAB_TYPE_DATABASE = 2

• COLLAB_TYPE_WORKSPACE_DATABASE = 3

• COLLAB_TYPE_FOLDER = 4

• COLLAB_TYPE_DATABASE_ROW = 5

• COLLAB_TYPE_USER_AWARENESS = 6

Payload for creating new collab or update existing collab over http.

• string workspace_id = 1

  Workspace id.

• string object_id = 2

  Object id.

• bytes encoded_collab = 3

  Serialized EncodedCollab object, which could either be in bincode or protobuf serialization format.

• CollabType collab_type = 4

  Collab type.

Types of embeddings content.

Used in: CollabEmbeddingsParams

• EMBEDDING_CONTENT_TYPE_UNKNOWN = 0

  Unknown content type.

• EMBEDDING_CONTENT_TYPE_PLAIN_TEXT = 1

  Plain text

Unknown origin.

Used in: CollabOrigin

(message has no fields)

Encoded collaborative document.

• bytes state_vector = 1

  yrs state vector

• bytes doc_state = 2

  yrs document state

• EncoderVersion encoder_version = 3

  yrs encoder version used for the state vector and doc state

yrs encoder version.

Used in: EncodedCollab

• ENCODER_VERSION_UNKNOWN = 0

• ENCODER_VERSION_V1 = 1

• ENCODER_VERSION_V2 = 2

Originating from the AppFlowy Server.

Used in: CollabOrigin

(message has no fields)