REST Resource: projects.locations.processors

Resource: Processor

Message describing Processor object. Next ID: 19

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "displayName": string,
  "description": string,
  "processorType": enum (ProcessorType),
  "modelType": enum (ModelType),
  "customProcessorSourceInfo": {
    object (CustomProcessorSourceInfo)
  },
  "state": enum (ProcessorState),
  "processorIoSpec": {
    object (ProcessorIOSpec)
  },
  "configurationTypeurl": string,
  "supportedAnnotationTypes": [
    enum (StreamAnnotationType)
  ],
  "supportsPostProcessing": boolean
}
Fields
name

string

name of resource.
createTime

string (Timestamp format)

Output only. [Output only] Create timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. [Output only] Update timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Labels as key value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
displayName

string

Required. A user friendly display name for the processor.
description

string

Illustrative sentences for describing the functionality of the processor.
processorType

enum (ProcessorType)

Output only. Processor Type.
modelType

enum (ModelType)

Model Type.
customProcessorSourceInfo

object (CustomProcessorSourceInfo)

Source info for customer created processor.
state

enum (ProcessorState)

Output only. State of the Processor.
processorIoSpec

object (ProcessorIOSpec)

Output only. [Output only] The input / output specifications of a processor, each type of processor has fixed input / output specs which cannot be altered by customer.
configurationTypeurl

string

Output only. The corresponding configuration can be used in the Application to customize the behavior of the processor.
supportedAnnotationTypes[]

enum (StreamAnnotationType)
supportsPostProcessing

boolean

Indicates if the processor supports post processing.

ProcessorType

Type

Enums
PROCESSOR_TYPE_UNSPECIFIED Processor Type UNSPECIFIED.
PRETRAINED Processor Type PRETRAINED. Pretrained processor is developed by Vision AI App Platform with state-of-the-art vision data processing functionality, like occupancy counting or person blur. Pretrained processor is usually publicly available.
CUSTOM Processor Type CUSTOM. Custom processors are specialized processors which are either uploaded by customers or imported from other Google Cloud platforms (for example Vertex AI). Custom processor is only visible to the creator.
CONNECTOR Processor Type CONNECTOR. Connector processors are special processors which perform I/O for the application, they do not processing the data but either deliver the data to other processors or receive data from other processors.

ModelType

All the supported model types in Vision AI App Platform.

Enums
MODEL_TYPE_UNSPECIFIED Processor Type UNSPECIFIED.
IMAGE_CLASSIFICATION Model Type Image Classification.
OBJECT_DETECTION Model Type Object Detection.
VIDEO_CLASSIFICATION Model Type Video Classification.
VIDEO_OBJECT_TRACKING Model Type Object Tracking.
VIDEO_ACTION_RECOGNITION Model Type Action Recognition.
OCCUPANCY_COUNTING Model Type Occupancy Counting.
PERSON_BLUR Model Type Person Blur.
VERTEX_CUSTOM Model Type Vertex Custom.

CustomProcessorSourceInfo

Describes the source info for a custom processor.

JSON representation 
{
  "sourceType": enum (SourceType),
  "additionalInfo": {
    string: string,
    ...
  },
  "modelSchema": {
    object (ModelSchema)
  },

  // Union field artifact_path can be only one of the following:
  "vertexModel": string
  // End of list of possible types for union field artifact_path.
}
Fields
sourceType

enum (SourceType)

The original product which holds the custom processor's functionality.
additionalInfo

map (key: string, value: string)

Output only. Additional info related to the imported custom processor. Data is filled in by app platform during the processor creation.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
modelSchema

object (ModelSchema)

Model schema files which specifies the signature of the model. For VERTEX_CUSTOM models, instances schema is required. If instances schema is not specified during the processor creation, VisionAI Platform will try to get it from Vertex, if it doesn't exist, the creation will fail.
Union field artifact_path. The path where App Platform loads the artifacts for the custom processor. artifact_path can be only one of the following:
vertexModel

string

The resource name original model hosted in the vertex AI platform.

SourceType

Source type of the imported custom processor.

Enums
SOURCE_TYPE_UNSPECIFIED Source type unspecified.
VERTEX_AUTOML Custom processors coming from Vertex AutoML product.
VERTEX_CUSTOM Custom processors coming from general custom models from Vertex.
PRODUCT_RECOGNIZER Source for Product Recognizer.

ModelSchema

The schema is defined as an OpenAPI 3.0.2 Schema Object.

JSON representation 
{
  "instancesSchema": {
    object (GcsSource)
  },
  "parametersSchema": {
    object (GcsSource)
  },
  "predictionsSchema": {
    object (GcsSource)
  }
}
Fields
instancesSchema

object (GcsSource)

Cloud Storage location to a YAML file that defines the format of a single instance used in prediction and explanation requests.
parametersSchema

object (GcsSource)

Cloud Storage location to a YAML file that defines the prediction and explanation parameters.
predictionsSchema

object (GcsSource)

Cloud Storage location to a YAML file that defines the format of a single prediction or explanation.

GcsSource

The Google Cloud Storage location for the input content.

JSON representation 
{
  "uris": [
    string
  ]
}
Fields
uris[]

string

Required. References to a Google Cloud Storage paths.

ProcessorState

Enums
PROCESSOR_STATE_UNSPECIFIED Unspecified Processor state.
CREATING Processor is being created (not ready for use).
ACTIVE Processor is and ready for use.
DELETING Processor is being deleted (not ready for use).
FAILED Processor deleted or creation failed .

ProcessorIOSpec

Message describing the input / output specifications of a processor.

JSON representation 
{
  "graphInputChannelSpecs": [
    {
      object (GraphInputChannelSpec)
    }
  ],
  "graphOutputChannelSpecs": [
    {
      object (GraphOutputChannelSpec)
    }
  ],
  "instanceResourceInputBindingSpecs": [
    {
      object (InstanceResourceInputBindingSpec)
    }
  ],
  "instanceResourceOutputBindingSpecs": [
    {
      object (InstanceResourceOutputBindingSpec)
    }
  ]
}
Fields
graphInputChannelSpecs[]

object (GraphInputChannelSpec)

For processors with input_channel_specs, the processor must be explicitly connected to another processor.
graphOutputChannelSpecs[]

object (GraphOutputChannelSpec)

The output artifact specifications for the current processor.
instanceResourceInputBindingSpecs[]

object (InstanceResourceInputBindingSpec)

The input resource that needs to be fed from the application instance.
instanceResourceOutputBindingSpecs[]

object (InstanceResourceOutputBindingSpec)

The output resource that the processor will generate per instance. Other than the explicitly listed output bindings here, all the processors' GraphOutputChannels can be binded to stream resource. The bind name then is the same as the GraphOutputChannel's name.

GraphInputChannelSpec

Message for input channel specification.

JSON representation 
{
  "name": string,
  "dataType": enum (DataType),
  "acceptedDataTypeUris": [
    string
  ],
  "required": boolean,
  "maxConnectionAllowed": string
}
Fields
name

string

The name of the current input channel.
dataType

enum (DataType)

The data types of the current input channel. When this field has more than 1 value, it means this input channel can be connected to either of these different data types.
acceptedDataTypeUris[]

string

If specified, only those detailed data types can be connected to the processor. For example, jpeg stream for MEDIA, or PredictionResult proto for PROTO type. If unspecified, then any proto is accepted.
required

boolean

Whether the current input channel is required by the processor. For example, for a processor with required video input and optional audio input, if video input is missing, the application will be rejected while the audio input can be missing as long as the video input exists.
maxConnectionAllowed

string (int64 format)

How many input edges can be connected to this input channel. 0 means unlimited.

DataType

All supported data types.

Enums
DATA_TYPE_UNSPECIFIED The default value of DataType.
VIDEO Video data type like H264.
IMAGE Image data type.
PROTO Protobuf data type, usually used for general data blob.

GraphOutputChannelSpec

Message for output channel specification.

JSON representation 
{
  "name": string,
  "dataType": enum (DataType),
  "dataTypeUri": string
}
Fields
name

string

The name of the current output channel.
dataType

enum (DataType)

The data type of the current output channel.
dataTypeUri

string

InstanceResourceInputBindingSpec

Message for instance resource channel specification. External resources are virtual nodes which are not expressed in the application graph. Each processor expresses its out-graph spec, so customer is able to override the external source or destinations to the

JSON representation 
{
  "name": string,

  // Union field resource_type can be only one of the following:
  "configTypeUri": string,
  "resourceTypeUri": string
  // End of list of possible types for union field resource_type.
}
Fields
name

string

Name of the input binding, unique within the processor.

Union field resource_type.

resource_type can be only one of the following:
configTypeUri

string

The configuration proto that includes the Googleapis resources. I.e. type.googleapis.com/google.cloud.vision.v1.StreamWithAnnotation
resourceTypeUri

string

The direct type url of Googleapis resource. i.e. type.googleapis.com/google.cloud.vision.v1.Asset

InstanceResourceOutputBindingSpec

JSON representation 
{
  "name": string,
  "resourceTypeUri": string,
  "explicit": boolean
}
Fields
name

string

Name of the output binding, unique within the processor.
resourceTypeUri

string

The resource type uri of the acceptable output resource.
explicit

boolean

Whether the output resource needs to be explicitly set in the instance. If it is false, the processor will automatically generate it if required.

Methods

create

 Creates a new Processor in a given project and location.

delete

 Deletes a single Processor.

get

 Gets details of a single Processor.

list

 Lists Processors in a given project and location.

patch

 Updates the parameters of a single Processor.

prebuilt

 ListPrebuiltProcessors is a custom pass-through verb that Lists Prebuilt Processors.