v1

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• Variables
• func RegisterMLInferenceServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterMLInferenceServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MLInferenceServiceClient) error
• func RegisterMLInferenceServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterMLInferenceServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MLInferenceServiceServer) error
• func RegisterMLInferenceServiceServer(s grpc.ServiceRegistrar, srv MLInferenceServiceServer)
• type GetInferenceRequest
  • func (*GetInferenceRequest) Descriptor() ([]byte, []int)
  • func (x *GetInferenceRequest) GetBinaryId() *v1.BinaryID
  • func (x *GetInferenceRequest) GetOrganizationId() string
  • func (x *GetInferenceRequest) GetRegistryItemId() string
  • func (x *GetInferenceRequest) GetRegistryItemVersion() string
  • func (*GetInferenceRequest) ProtoMessage()
  • func (x *GetInferenceRequest) ProtoReflect() protoreflect.Message
  • func (x *GetInferenceRequest) Reset()
  • func (x *GetInferenceRequest) String() string
• type GetInferenceResponse
  • func (*GetInferenceResponse) Descriptor() ([]byte, []int)
  • func (*GetInferenceResponse) ProtoMessage()
  • func (x *GetInferenceResponse) ProtoReflect() protoreflect.Message
  • func (x *GetInferenceResponse) Reset()
  • func (x *GetInferenceResponse) String() string
• type MLInferenceServiceClient
  • func NewMLInferenceServiceClient(cc grpc.ClientConnInterface) MLInferenceServiceClient
• type MLInferenceServiceServer
• type UnimplementedMLInferenceServiceServer
  • func (UnimplementedMLInferenceServiceServer) GetInference(context.Context, *GetInferenceRequest) (*GetInferenceResponse, error)
• type UnsafeMLInferenceServiceServer

Variables

var File_app_mlinference_v1_ml_inference_proto protoreflect.FileDescriptor

var MLInferenceService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "viam.app.mlinference.v1.MLInferenceService",
	HandlerType: (*MLInferenceServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetInference",
			Handler:    _MLInferenceService_GetInference_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "app/mlinference/v1/ml_inference.proto",
}

MLInferenceService_ServiceDesc is the grpc.ServiceDesc for MLInferenceService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterMLInferenceServiceHandler

func RegisterMLInferenceServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterMLInferenceServiceHandler registers the http handlers for service MLInferenceService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterMLInferenceServiceHandlerClient

func RegisterMLInferenceServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MLInferenceServiceClient) error

RegisterMLInferenceServiceHandlerClient registers the http handlers for service MLInferenceService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "MLInferenceServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "MLInferenceServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "MLInferenceServiceClient" to call the correct interceptors.

func RegisterMLInferenceServiceHandlerFromEndpoint

func RegisterMLInferenceServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterMLInferenceServiceHandlerFromEndpoint is same as RegisterMLInferenceServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterMLInferenceServiceHandlerServer

func RegisterMLInferenceServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MLInferenceServiceServer) error

RegisterMLInferenceServiceHandlerServer registers the http handlers for service MLInferenceService to "mux". UnaryRPC :call MLInferenceServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterMLInferenceServiceHandlerFromEndpoint instead.

func RegisterMLInferenceServiceServer

func RegisterMLInferenceServiceServer(s grpc.ServiceRegistrar, srv MLInferenceServiceServer)

Types

type GetInferenceRequest

type GetInferenceRequest struct {

	// The model framework and model type are inferred from the ML model registry item;
	// For valid model types (classification, detections) we will return the formatted
	// labels or annotations from the associated inference outputs.
	RegistryItemId      string       `protobuf:"bytes,1,opt,name=registry_item_id,json=registryItemId,proto3" json:"registry_item_id,omitempty"`
	RegistryItemVersion string       `protobuf:"bytes,2,opt,name=registry_item_version,json=registryItemVersion,proto3" json:"registry_item_version,omitempty"`
	BinaryId            *v1.BinaryID `protobuf:"bytes,3,opt,name=binary_id,json=binaryId,proto3" json:"binary_id,omitempty"`
	OrganizationId      string       `protobuf:"bytes,4,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetInferenceRequest) Descriptor

func (*GetInferenceRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetInferenceRequest.ProtoReflect.Descriptor instead.

func (*GetInferenceRequest) GetBinaryId

func (x *GetInferenceRequest) GetBinaryId() *v1.BinaryID

func (*GetInferenceRequest) GetOrganizationId

func (x *GetInferenceRequest) GetOrganizationId() string

func (*GetInferenceRequest) GetRegistryItemId

func (x *GetInferenceRequest) GetRegistryItemId() string

func (*GetInferenceRequest) GetRegistryItemVersion

func (x *GetInferenceRequest) GetRegistryItemVersion() string

func (*GetInferenceRequest) ProtoMessage

func (*GetInferenceRequest) ProtoMessage()

func (*GetInferenceRequest) ProtoReflect

func (x *GetInferenceRequest) ProtoReflect() protoreflect.Message

func (*GetInferenceRequest) Reset

func (x *GetInferenceRequest) Reset()

func (*GetInferenceRequest) String

func (x *GetInferenceRequest) String() string

type GetInferenceResponse

type GetInferenceResponse struct {
	// contains filtered or unexported fields
}

func (*GetInferenceResponse) Descriptor

func (*GetInferenceResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetInferenceResponse.ProtoReflect.Descriptor instead.

func (*GetInferenceResponse) ProtoMessage

func (*GetInferenceResponse) ProtoMessage()

func (*GetInferenceResponse) ProtoReflect

func (x *GetInferenceResponse) ProtoReflect() protoreflect.Message

func (*GetInferenceResponse) Reset

func (x *GetInferenceResponse) Reset()

func (*GetInferenceResponse) String

func (x *GetInferenceResponse) String() string

type MLInferenceServiceClient

type MLInferenceServiceClient interface {
	GetInference(ctx context.Context, in *GetInferenceRequest, opts ...grpc.CallOption) (*GetInferenceResponse, error)
}

MLInferenceServiceClient is the client API for MLInferenceService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewMLInferenceServiceClient

func NewMLInferenceServiceClient(cc grpc.ClientConnInterface) MLInferenceServiceClient

type MLInferenceServiceServer

type MLInferenceServiceServer interface {
	GetInference(context.Context, *GetInferenceRequest) (*GetInferenceResponse, error)
	// contains filtered or unexported methods
}

MLInferenceServiceServer is the server API for MLInferenceService service. All implementations must embed UnimplementedMLInferenceServiceServer for forward compatibility

type UnimplementedMLInferenceServiceServer

type UnimplementedMLInferenceServiceServer struct {
}

UnimplementedMLInferenceServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedMLInferenceServiceServer) GetInference

func (UnimplementedMLInferenceServiceServer) GetInference(context.Context, *GetInferenceRequest) (*GetInferenceResponse, error)

type UnsafeMLInferenceServiceServer

type UnsafeMLInferenceServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeMLInferenceServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to MLInferenceServiceServer will result in compilation errors.