Skip to main content

Uniphore Help Center Portal

JSON Generation

The JSON is generated based on the follow proto:

JSON

Copy

syntax = "proto3";

package pb.protos_external.orby.v1alpha1;

import "google/api/field_behavior.proto";

import "google/cloud/documentai/v1/document.proto";

option go_package = "github.com/orby-ai-engineering/web-api-server/pb/protos-external/orby";

message OutputResult { Metadata metadata = 1;

repeated Prediction predictions = 2;

}

message Review { string email = 1;

// Reviewed time in seconds. int32 reviewed_time_seconds = 2;

// Whether task prediction values are modified by the reviewer bool is_modified = 3;

}

message Prediction { oneof prediction {

Classification classification = 1; Extraction extraction = 2;

}

repeated Review reviews = 3;

message Classification {

string classification_label = 1;

}

message Extraction {

repeated google.cloud.documentai.v1.Document.Entity entities = 1;

}

}

message Metadata {

WorkflowMetadata workflow_metadata = 1; TaskMetadata task_metadata = 2;

}

message TaskMetadata {

string task_display_name = 1; string task_uri = 2;

oneof data {

File file = 3;

}

// The execution id of this execution is created from.

// Only set if this execution is a following up execution.

string source_execution_id = 4 [(google.api.field_behavior) = OPTIONAL];

// The execution ids of this execution that are following up this execution.

// Only set if this execution is a source execution.

repeated string following_up_execution_ids = 5 [(google.api.field_behavior) = OPTIONAL];

}

message WorkflowMetadata {

string workflow_display_name = 1;

}

// Data model for files and folders

// Supported applications: Google Doc message File {

// Path to the file

// E.g. Sftp: organization_folder/OrbyAI_Completed/example.pdf

// E.g. GDrive: OrbyAI_Completed/example.pdf string path = 1;

string name = 2;

}