Package inference

Class GrpcService.ModelInferRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
inference.GrpcService.ModelInferRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GrpcService.ModelInferRequestOrBuilder, Serializable
Enclosing class:
GrpcService
public static final class GrpcService.ModelInferRequest extends com.google.protobuf.GeneratedMessageV3 implements GrpcService.ModelInferRequestOrBuilder
@@
@@.. cpp:var:: message ModelInferRequest
@@
@@   Request message for ModelInfer.
@@
Protobuf type inference.ModelInferRequest
See Also:

  • Field Details

    • MODEL_NAME_FIELD_NUMBER

      public static final int MODEL_NAME_FIELD_NUMBER
      See Also:

    • MODEL_VERSION_FIELD_NUMBER

      public static final int MODEL_VERSION_FIELD_NUMBER
      See Also:

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • PARAMETERS_FIELD_NUMBER

      public static final int PARAMETERS_FIELD_NUMBER
      See Also:

    • INPUTS_FIELD_NUMBER

      public static final int INPUTS_FIELD_NUMBER
      See Also:

    • OUTPUTS_FIELD_NUMBER

      public static final int OUTPUTS_FIELD_NUMBER
      See Also:

    • RAW_INPUT_CONTENTS_FIELD_NUMBER

      public static final int RAW_INPUT_CONTENTS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getModelName

      public String getModelName()
      @@  .. cpp:var:: string model_name
@@
@@     The name of the model to use for inferencing.
@@
      string model_name = 1;
      Specified by:
      getModelName in interface GrpcService.ModelInferRequestOrBuilder
      Returns:
      The modelName.

    • getModelNameBytes

      public com.google.protobuf.ByteString getModelNameBytes()
      @@  .. cpp:var:: string model_name
@@
@@     The name of the model to use for inferencing.
@@
      string model_name = 1;
      Specified by:
      getModelNameBytes in interface GrpcService.ModelInferRequestOrBuilder
      Returns:
      The bytes for modelName.

    • getModelVersion

      public String getModelVersion()
      @@  .. cpp:var:: string model_version
@@
@@     The version of the model to use for inference. If not
@@     given the latest/most-recent version of the model is used.
@@
      string model_version = 2;
      Specified by:
      getModelVersion in interface GrpcService.ModelInferRequestOrBuilder
      Returns:
      The modelVersion.

    • getModelVersionBytes

      public com.google.protobuf.ByteString getModelVersionBytes()
      @@  .. cpp:var:: string model_version
@@
@@     The version of the model to use for inference. If not
@@     given the latest/most-recent version of the model is used.
@@
      string model_version = 2;
      Specified by:
      getModelVersionBytes in interface GrpcService.ModelInferRequestOrBuilder
      Returns:
      The bytes for modelVersion.

    • getId

      public String getId()
      @@  .. cpp:var:: string id
@@
@@     Optional identifier for the request. If specified will be
@@     returned in the response.
@@
      string id = 3;
      Specified by:
      getId in interface GrpcService.ModelInferRequestOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
      @@  .. cpp:var:: string id
@@
@@     Optional identifier for the request. If specified will be
@@     returned in the response.
@@
      string id = 3;
      Specified by:
      getIdBytes in interface GrpcService.ModelInferRequestOrBuilder
      Returns:
      The bytes for id.

    • getParametersCount

      public int getParametersCount()
      Description copied from interface: GrpcService.ModelInferRequestOrBuilder
      @@  .. cpp:var:: map<string,InferParameter> parameters
@@
@@     Optional inference parameters.
@@
      map<string, .inference.InferParameter> parameters = 4;
      Specified by:
      getParametersCount in interface GrpcService.ModelInferRequestOrBuilder

    • containsParameters

      public boolean containsParameters(String key)
      @@  .. cpp:var:: map<string,InferParameter> parameters
@@
@@     Optional inference parameters.
@@
      map<string, .inference.InferParameter> parameters = 4;
      Specified by:
      containsParameters in interface GrpcService.ModelInferRequestOrBuilder

    • getParameters

      @Deprecated public Map<String,GrpcService.InferParameter> getParameters()
      Deprecated.
      Use getParametersMap() instead.
      Specified by:
      getParameters in interface GrpcService.ModelInferRequestOrBuilder

    • getParametersMap

      public Map<String,GrpcService.InferParameter> getParametersMap()
      @@  .. cpp:var:: map<string,InferParameter> parameters
@@
@@     Optional inference parameters.
@@
      map<string, .inference.InferParameter> parameters = 4;
      Specified by:
      getParametersMap in interface GrpcService.ModelInferRequestOrBuilder

    • getParametersOrDefault

      public GrpcService.InferParameter getParametersOrDefault(String key, GrpcService.InferParameter defaultValue)
      @@  .. cpp:var:: map<string,InferParameter> parameters
@@
@@     Optional inference parameters.
@@
      map<string, .inference.InferParameter> parameters = 4;
      Specified by:
      getParametersOrDefault in interface GrpcService.ModelInferRequestOrBuilder

    • getParametersOrThrow

      public GrpcService.InferParameter getParametersOrThrow(String key)
      @@  .. cpp:var:: map<string,InferParameter> parameters
@@
@@     Optional inference parameters.
@@
      map<string, .inference.InferParameter> parameters = 4;
      Specified by:
      getParametersOrThrow in interface GrpcService.ModelInferRequestOrBuilder

    • getInputsList

      public List<GrpcService.ModelInferRequest.InferInputTensor> getInputsList()
      @@
@@  .. cpp:var:: InferInputTensor inputs (repeated)
@@
@@     The input tensors for the inference.
@@
      repeated .inference.ModelInferRequest.InferInputTensor inputs = 5;
      Specified by:
      getInputsList in interface GrpcService.ModelInferRequestOrBuilder

    • getInputsOrBuilderList

      public List<? extends GrpcService.ModelInferRequest.InferInputTensorOrBuilder> getInputsOrBuilderList()
      @@
@@  .. cpp:var:: InferInputTensor inputs (repeated)
@@
@@     The input tensors for the inference.
@@
      repeated .inference.ModelInferRequest.InferInputTensor inputs = 5;
      Specified by:
      getInputsOrBuilderList in interface GrpcService.ModelInferRequestOrBuilder

    • getInputsCount

      public int getInputsCount()
      @@
@@  .. cpp:var:: InferInputTensor inputs (repeated)
@@
@@     The input tensors for the inference.
@@
      repeated .inference.ModelInferRequest.InferInputTensor inputs = 5;
      Specified by:
      getInputsCount in interface GrpcService.ModelInferRequestOrBuilder

    • getInputs

      public GrpcService.ModelInferRequest.InferInputTensor getInputs(int index)
      @@
@@  .. cpp:var:: InferInputTensor inputs (repeated)
@@
@@     The input tensors for the inference.
@@
      repeated .inference.ModelInferRequest.InferInputTensor inputs = 5;
      Specified by:
      getInputs in interface GrpcService.ModelInferRequestOrBuilder

    • getInputsOrBuilder

      public GrpcService.ModelInferRequest.InferInputTensorOrBuilder getInputsOrBuilder(int index)
      @@
@@  .. cpp:var:: InferInputTensor inputs (repeated)
@@
@@     The input tensors for the inference.
@@
      repeated .inference.ModelInferRequest.InferInputTensor inputs = 5;
      Specified by:
      getInputsOrBuilder in interface GrpcService.ModelInferRequestOrBuilder

    • getOutputsList

      public List<GrpcService.ModelInferRequest.InferRequestedOutputTensor> getOutputsList()
      @@
@@  .. cpp:var:: InferRequestedOutputTensor outputs (repeated)
@@
@@     The requested output tensors for the inference. Optional, if not
@@     specified all outputs specified in the model config will be
@@     returned.
@@
      repeated .inference.ModelInferRequest.InferRequestedOutputTensor outputs = 6;
      Specified by:
      getOutputsList in interface GrpcService.ModelInferRequestOrBuilder

    • getOutputsOrBuilderList

      public List<? extends GrpcService.ModelInferRequest.InferRequestedOutputTensorOrBuilder> getOutputsOrBuilderList()
      @@
@@  .. cpp:var:: InferRequestedOutputTensor outputs (repeated)
@@
@@     The requested output tensors for the inference. Optional, if not
@@     specified all outputs specified in the model config will be
@@     returned.
@@
      repeated .inference.ModelInferRequest.InferRequestedOutputTensor outputs = 6;
      Specified by:
      getOutputsOrBuilderList in interface GrpcService.ModelInferRequestOrBuilder

    • getOutputsCount

      public int getOutputsCount()
      @@
@@  .. cpp:var:: InferRequestedOutputTensor outputs (repeated)
@@
@@     The requested output tensors for the inference. Optional, if not
@@     specified all outputs specified in the model config will be
@@     returned.
@@
      repeated .inference.ModelInferRequest.InferRequestedOutputTensor outputs = 6;
      Specified by:
      getOutputsCount in interface GrpcService.ModelInferRequestOrBuilder

    • getOutputs

      public GrpcService.ModelInferRequest.InferRequestedOutputTensor getOutputs(int index)
      @@
@@  .. cpp:var:: InferRequestedOutputTensor outputs (repeated)
@@
@@     The requested output tensors for the inference. Optional, if not
@@     specified all outputs specified in the model config will be
@@     returned.
@@
      repeated .inference.ModelInferRequest.InferRequestedOutputTensor outputs = 6;
      Specified by:
      getOutputs in interface GrpcService.ModelInferRequestOrBuilder

    • getOutputsOrBuilder

      public GrpcService.ModelInferRequest.InferRequestedOutputTensorOrBuilder getOutputsOrBuilder(int index)
      @@
@@  .. cpp:var:: InferRequestedOutputTensor outputs (repeated)
@@
@@     The requested output tensors for the inference. Optional, if not
@@     specified all outputs specified in the model config will be
@@     returned.
@@
      repeated .inference.ModelInferRequest.InferRequestedOutputTensor outputs = 6;
      Specified by:
      getOutputsOrBuilder in interface GrpcService.ModelInferRequestOrBuilder

    • getRawInputContentsList

      public List<com.google.protobuf.ByteString> getRawInputContentsList()
      @@
@@  .. cpp:var:: bytes raw_input_contents
@@
@@     The data contained in an input tensor can be represented in
@@     "raw" bytes form or in the repeated type that matches the
@@     tensor's data type. Using the "raw" bytes form will
@@     typically allow higher performance due to the way protobuf
@@     allocation and reuse interacts with GRPC. For example, see
@@     https://github.com/grpc/grpc/issues/23231.
@@
@@     To use the raw representation 'raw_input_contents' must be
@@     initialized with data for each tensor in the same order as
@@     'inputs'. For each tensor, the size of this content must
@@     match what is expected by the tensor's shape and data
@@     type. The raw data must be the flattened, one-dimensional,
@@     row-major order of the tensor elements without any stride
@@     or padding between the elements. Note that the FP16 and BF16 data
@@     types must be represented as raw content as there is no
@@     specific data type for a 16-bit float type.
@@
@@     If this field is specified then InferInputTensor::contents
@@     must not be specified for any input tensor.
@@
      repeated bytes raw_input_contents = 7;
      Specified by:
      getRawInputContentsList in interface GrpcService.ModelInferRequestOrBuilder
      Returns:
      A list containing the rawInputContents.

    • getRawInputContentsCount

      public int getRawInputContentsCount()
      @@
@@  .. cpp:var:: bytes raw_input_contents
@@
@@     The data contained in an input tensor can be represented in
@@     "raw" bytes form or in the repeated type that matches the
@@     tensor's data type. Using the "raw" bytes form will
@@     typically allow higher performance due to the way protobuf
@@     allocation and reuse interacts with GRPC. For example, see
@@     https://github.com/grpc/grpc/issues/23231.
@@
@@     To use the raw representation 'raw_input_contents' must be
@@     initialized with data for each tensor in the same order as
@@     'inputs'. For each tensor, the size of this content must
@@     match what is expected by the tensor's shape and data
@@     type. The raw data must be the flattened, one-dimensional,
@@     row-major order of the tensor elements without any stride
@@     or padding between the elements. Note that the FP16 and BF16 data
@@     types must be represented as raw content as there is no
@@     specific data type for a 16-bit float type.
@@
@@     If this field is specified then InferInputTensor::contents
@@     must not be specified for any input tensor.
@@
      repeated bytes raw_input_contents = 7;
      Specified by:
      getRawInputContentsCount in interface GrpcService.ModelInferRequestOrBuilder
      Returns:
      The count of rawInputContents.

    • getRawInputContents

      public com.google.protobuf.ByteString getRawInputContents(int index)
      @@
@@  .. cpp:var:: bytes raw_input_contents
@@
@@     The data contained in an input tensor can be represented in
@@     "raw" bytes form or in the repeated type that matches the
@@     tensor's data type. Using the "raw" bytes form will
@@     typically allow higher performance due to the way protobuf
@@     allocation and reuse interacts with GRPC. For example, see
@@     https://github.com/grpc/grpc/issues/23231.
@@
@@     To use the raw representation 'raw_input_contents' must be
@@     initialized with data for each tensor in the same order as
@@     'inputs'. For each tensor, the size of this content must
@@     match what is expected by the tensor's shape and data
@@     type. The raw data must be the flattened, one-dimensional,
@@     row-major order of the tensor elements without any stride
@@     or padding between the elements. Note that the FP16 and BF16 data
@@     types must be represented as raw content as there is no
@@     specific data type for a 16-bit float type.
@@
@@     If this field is specified then InferInputTensor::contents
@@     must not be specified for any input tensor.
@@
      repeated bytes raw_input_contents = 7;
      Specified by:
      getRawInputContents in interface GrpcService.ModelInferRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The rawInputContents at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static GrpcService.ModelInferRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrpcService.ModelInferRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrpcService.ModelInferRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrpcService.ModelInferRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrpcService.ModelInferRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrpcService.ModelInferRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrpcService.ModelInferRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GrpcService.ModelInferRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GrpcService.ModelInferRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GrpcService.ModelInferRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GrpcService.ModelInferRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GrpcService.ModelInferRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public GrpcService.ModelInferRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static GrpcService.ModelInferRequest.Builder newBuilder()

    • newBuilder

      public static GrpcService.ModelInferRequest.Builder newBuilder(GrpcService.ModelInferRequest prototype)

    • toBuilder

      public GrpcService.ModelInferRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected GrpcService.ModelInferRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static GrpcService.ModelInferRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<GrpcService.ModelInferRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<GrpcService.ModelInferRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public GrpcService.ModelInferRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder