REST Resource: projects.locations.processors

{
  "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
}

string

name of resource.

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".

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".

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" }.

string

Required. A user friendly display name for the processor.

string

Illustrative sentences for describing the functionality of the processor.

enum (ProcessorType)

Output only. Processor Type.

enum (ModelType)

Model Type.

object (CustomProcessorSourceInfo)

Source info for customer created processor.

enum (ProcessorState)

Output only. State of the Processor.

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.

string

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

enum (StreamAnnotationType)

boolean

Indicates if the processor supports post processing.

{
  "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.
}

enum (SourceType)

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

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" }.

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.

string

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

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

object (GcsSource)

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

object (GcsSource)

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

object (GcsSource)

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

{
  "uris": [
    string
  ]
}

string

Required. References to a Google Cloud Storage paths.

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

object (GraphInputChannelSpec)

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

object (GraphOutputChannelSpec)

The output artifact specifications for the current processor.

object (InstanceResourceInputBindingSpec)

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

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.

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

string

The name of the current input channel.

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.

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.

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.

string (int64 format)

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

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

string

The name of the current output channel.

enum (DataType)

The data type of the current output channel.

string

{
  "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.
}

string

Name of the input binding, unique within the processor.

string

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

string

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

{
  "name": string,
  "resourceTypeUri": string,
  "explicit": boolean
}

string

Name of the output binding, unique within the processor.

string

The resource type uri of the acceptable output resource.

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.