aiplatformpb

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 7, 2023 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	HarmCategory_name = map[int32]string{
		0: "HARM_CATEGORY_UNSPECIFIED",
		1: "HARM_CATEGORY_HATE_SPEECH",
		2: "HARM_CATEGORY_DANGEROUS_CONTENT",
		3: "HARM_CATEGORY_HARASSMENT",
		4: "HARM_CATEGORY_SEXUALLY_EXPLICIT",
	}
	HarmCategory_value = map[string]int32{
		"HARM_CATEGORY_UNSPECIFIED":       0,
		"HARM_CATEGORY_HATE_SPEECH":       1,
		"HARM_CATEGORY_DANGEROUS_CONTENT": 2,
		"HARM_CATEGORY_HARASSMENT":        3,
		"HARM_CATEGORY_SEXUALLY_EXPLICIT": 4,
	}
)

Enum value maps for HarmCategory.

View Source
var (
	SafetySetting_HarmBlockThreshold_name = map[int32]string{
		0: "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
		1: "BLOCK_LOW_AND_ABOVE",
		2: "BLOCK_MEDIUM_AND_ABOVE",
		3: "BLOCK_ONLY_HIGH",
		4: "BLOCK_NONE",
	}
	SafetySetting_HarmBlockThreshold_value = map[string]int32{
		"HARM_BLOCK_THRESHOLD_UNSPECIFIED": 0,
		"BLOCK_LOW_AND_ABOVE":              1,
		"BLOCK_MEDIUM_AND_ABOVE":           2,
		"BLOCK_ONLY_HIGH":                  3,
		"BLOCK_NONE":                       4,
	}
)

Enum value maps for SafetySetting_HarmBlockThreshold.

View Source
var (
	SafetyRating_HarmProbability_name = map[int32]string{
		0: "HARM_PROBABILITY_UNSPECIFIED",
		1: "NEGLIGIBLE",
		2: "LOW",
		3: "MEDIUM",
		4: "HIGH",
	}
	SafetyRating_HarmProbability_value = map[string]int32{
		"HARM_PROBABILITY_UNSPECIFIED": 0,
		"NEGLIGIBLE":                   1,
		"LOW":                          2,
		"MEDIUM":                       3,
		"HIGH":                         4,
	}
)

Enum value maps for SafetyRating_HarmProbability.

View Source
var (
	Candidate_FinishReason_name = map[int32]string{
		0: "FINISH_REASON_UNSPECIFIED",
		1: "STOP",
		2: "MAX_TOKENS",
		3: "SAFETY",
		4: "RECITATION",
		5: "OTHER",
	}
	Candidate_FinishReason_value = map[string]int32{
		"FINISH_REASON_UNSPECIFIED": 0,
		"STOP":                      1,
		"MAX_TOKENS":                2,
		"SAFETY":                    3,
		"RECITATION":                4,
		"OTHER":                     5,
	}
)

Enum value maps for Candidate_FinishReason.

View Source
var (
	EvaluatedAnnotation_EvaluatedAnnotationType_name = map[int32]string{
		0: "EVALUATED_ANNOTATION_TYPE_UNSPECIFIED",
		1: "TRUE_POSITIVE",
		2: "FALSE_POSITIVE",
		3: "FALSE_NEGATIVE",
	}
	EvaluatedAnnotation_EvaluatedAnnotationType_value = map[string]int32{
		"EVALUATED_ANNOTATION_TYPE_UNSPECIFIED": 0,
		"TRUE_POSITIVE":                         1,
		"FALSE_POSITIVE":                        2,
		"FALSE_NEGATIVE":                        3,
	}
)

Enum value maps for EvaluatedAnnotation_EvaluatedAnnotationType.

View Source
var (
	ErrorAnalysisAnnotation_QueryType_name = map[int32]string{
		0: "QUERY_TYPE_UNSPECIFIED",
		1: "ALL_SIMILAR",
		2: "SAME_CLASS_SIMILAR",
		3: "SAME_CLASS_DISSIMILAR",
	}
	ErrorAnalysisAnnotation_QueryType_value = map[string]int32{
		"QUERY_TYPE_UNSPECIFIED": 0,
		"ALL_SIMILAR":            1,
		"SAME_CLASS_SIMILAR":     2,
		"SAME_CLASS_DISSIMILAR":  3,
	}
)

Enum value maps for ErrorAnalysisAnnotation_QueryType.

View Source
var (
	Event_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "INPUT",
		2: "OUTPUT",
	}
	Event_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"INPUT":            1,
		"OUTPUT":           2,
	}
)

Enum value maps for Event_Type.

View Source
var (
	Execution_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "NEW",
		2: "RUNNING",
		3: "COMPLETE",
		4: "FAILED",
		5: "CACHED",
		6: "CANCELLED",
	}
	Execution_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"NEW":               1,
		"RUNNING":           2,
		"COMPLETE":          3,
		"FAILED":            4,
		"CACHED":            5,
		"CANCELLED":         6,
	}
)

Enum value maps for Execution_State.

View Source
var (
	Examples_ExampleGcsSource_DataFormat_name = map[int32]string{
		0: "DATA_FORMAT_UNSPECIFIED",
		1: "JSONL",
	}
	Examples_ExampleGcsSource_DataFormat_value = map[string]int32{
		"DATA_FORMAT_UNSPECIFIED": 0,
		"JSONL":                   1,
	}
)

Enum value maps for Examples_ExampleGcsSource_DataFormat.

View Source
var (
	Presets_Query_name = map[int32]string{
		0: "PRECISE",
		1: "FAST",
	}
	Presets_Query_value = map[string]int32{
		"PRECISE": 0,
		"FAST":    1,
	}
)

Enum value maps for Presets_Query.

View Source
var (
	Presets_Modality_name = map[int32]string{
		0: "MODALITY_UNSPECIFIED",
		1: "IMAGE",
		2: "TEXT",
		3: "TABULAR",
	}
	Presets_Modality_value = map[string]int32{
		"MODALITY_UNSPECIFIED": 0,
		"IMAGE":                1,
		"TEXT":                 2,
		"TABULAR":              3,
	}
)

Enum value maps for Presets_Modality.

View Source
var (
	ExamplesOverride_DataFormat_name = map[int32]string{
		0: "DATA_FORMAT_UNSPECIFIED",
		1: "INSTANCES",
		2: "EMBEDDINGS",
	}
	ExamplesOverride_DataFormat_value = map[string]int32{
		"DATA_FORMAT_UNSPECIFIED": 0,
		"INSTANCES":               1,
		"EMBEDDINGS":              2,
	}
)

Enum value maps for ExamplesOverride_DataFormat.

View Source
var (
	ExplanationMetadata_InputMetadata_Encoding_name = map[int32]string{
		0: "ENCODING_UNSPECIFIED",
		1: "IDENTITY",
		2: "BAG_OF_FEATURES",
		3: "BAG_OF_FEATURES_SPARSE",
		4: "INDICATOR",
		5: "COMBINED_EMBEDDING",
		6: "CONCAT_EMBEDDING",
	}
	ExplanationMetadata_InputMetadata_Encoding_value = map[string]int32{
		"ENCODING_UNSPECIFIED":   0,
		"IDENTITY":               1,
		"BAG_OF_FEATURES":        2,
		"BAG_OF_FEATURES_SPARSE": 3,
		"INDICATOR":              4,
		"COMBINED_EMBEDDING":     5,
		"CONCAT_EMBEDDING":       6,
	}
)

Enum value maps for ExplanationMetadata_InputMetadata_Encoding.

View Source
var (
	ExplanationMetadata_InputMetadata_Visualization_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "PIXELS",
		2: "OUTLINES",
	}
	ExplanationMetadata_InputMetadata_Visualization_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"PIXELS":           1,
		"OUTLINES":         2,
	}
)

Enum value maps for ExplanationMetadata_InputMetadata_Visualization_Type.

View Source
var (
	ExplanationMetadata_InputMetadata_Visualization_Polarity_name = map[int32]string{
		0: "POLARITY_UNSPECIFIED",
		1: "POSITIVE",
		2: "NEGATIVE",
		3: "BOTH",
	}
	ExplanationMetadata_InputMetadata_Visualization_Polarity_value = map[string]int32{
		"POLARITY_UNSPECIFIED": 0,
		"POSITIVE":             1,
		"NEGATIVE":             2,
		"BOTH":                 3,
	}
)

Enum value maps for ExplanationMetadata_InputMetadata_Visualization_Polarity.

View Source
var (
	ExplanationMetadata_InputMetadata_Visualization_ColorMap_name = map[int32]string{
		0: "COLOR_MAP_UNSPECIFIED",
		1: "PINK_GREEN",
		2: "VIRIDIS",
		3: "RED",
		4: "GREEN",
		6: "RED_GREEN",
		5: "PINK_WHITE_GREEN",
	}
	ExplanationMetadata_InputMetadata_Visualization_ColorMap_value = map[string]int32{
		"COLOR_MAP_UNSPECIFIED": 0,
		"PINK_GREEN":            1,
		"VIRIDIS":               2,
		"RED":                   3,
		"GREEN":                 4,
		"RED_GREEN":             6,
		"PINK_WHITE_GREEN":      5,
	}
)

Enum value maps for ExplanationMetadata_InputMetadata_Visualization_ColorMap.

View Source
var (
	ExplanationMetadata_InputMetadata_Visualization_OverlayType_name = map[int32]string{
		0: "OVERLAY_TYPE_UNSPECIFIED",
		1: "NONE",
		2: "ORIGINAL",
		3: "GRAYSCALE",
		4: "MASK_BLACK",
	}
	ExplanationMetadata_InputMetadata_Visualization_OverlayType_value = map[string]int32{
		"OVERLAY_TYPE_UNSPECIFIED": 0,
		"NONE":                     1,
		"ORIGINAL":                 2,
		"GRAYSCALE":                3,
		"MASK_BLACK":               4,
	}
)

Enum value maps for ExplanationMetadata_InputMetadata_Visualization_OverlayType.

View Source
var (
	MetadataSchema_MetadataSchemaType_name = map[int32]string{
		0: "METADATA_SCHEMA_TYPE_UNSPECIFIED",
		1: "ARTIFACT_TYPE",
		2: "EXECUTION_TYPE",
		3: "CONTEXT_TYPE",
	}
	MetadataSchema_MetadataSchemaType_value = map[string]int32{
		"METADATA_SCHEMA_TYPE_UNSPECIFIED": 0,
		"ARTIFACT_TYPE":                    1,
		"EXECUTION_TYPE":                   2,
		"CONTEXT_TYPE":                     3,
	}
)

Enum value maps for MetadataSchema_MetadataSchemaType.

View Source
var (
	Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "STRING",
		2: "NUMBER",
		3: "INTEGER",
		4: "BOOLEAN",
		5: "ARRAY",
		6: "OBJECT",
	}
	Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"STRING":           1,
		"NUMBER":           2,
		"INTEGER":          3,
		"BOOLEAN":          4,
		"ARRAY":            5,
		"OBJECT":           6,
	}
)

Enum value maps for Type.

View Source
var (
	GenerateContentResponse_PromptFeedback_BlockedReason_name = map[int32]string{
		0: "BLOCKED_REASON_UNSPECIFIED",
		1: "SAFETY",
		2: "OTHER",
	}
	GenerateContentResponse_PromptFeedback_BlockedReason_value = map[string]int32{
		"BLOCKED_REASON_UNSPECIFIED": 0,
		"SAFETY":                     1,
		"OTHER":                      2,
	}
)

Enum value maps for GenerateContentResponse_PromptFeedback_BlockedReason.

View Source
var (
	Tensor_DataType_name = map[int32]string{
		0:  "DATA_TYPE_UNSPECIFIED",
		1:  "BOOL",
		2:  "STRING",
		3:  "FLOAT",
		4:  "DOUBLE",
		5:  "INT8",
		6:  "INT16",
		7:  "INT32",
		8:  "INT64",
		9:  "UINT8",
		10: "UINT16",
		11: "UINT32",
		12: "UINT64",
	}
	Tensor_DataType_value = map[string]int32{
		"DATA_TYPE_UNSPECIFIED": 0,
		"BOOL":                  1,
		"STRING":                2,
		"FLOAT":                 3,
		"DOUBLE":                4,
		"INT8":                  5,
		"INT16":                 6,
		"INT32":                 7,
		"INT64":                 8,
		"UINT8":                 9,
		"UINT16":                10,
		"UINT32":                11,
		"UINT64":                12,
	}
)

Enum value maps for Tensor_DataType.

View Source
var File_google_cloud_aiplatform_v1beta1_content_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_context_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_data_item_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_env_var_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_evaluated_annotation_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_event_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_execution_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_explanation_metadata_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_explanation_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_io_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_metadata_schema_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_openapi_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_operation_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_prediction_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_tool_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_types_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_aiplatform_v1beta1_value_proto protoreflect.FileDescriptor

Functions

func RegisterPredictionServiceServer

func RegisterPredictionServiceServer(s *grpc.Server, srv PredictionServiceServer)

Types

type Attribution

type Attribution struct {

	// Output only. Model predicted output if the input instance is constructed
	// from the baselines of all the features defined in
	// [ExplanationMetadata.inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs].
	// The field name of the output is determined by the key in
	// [ExplanationMetadata.outputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.outputs].
	//
	// If the Model's predicted output has multiple dimensions (rank > 1), this is
	// the value in the output located by
	// [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index].
	//
	// If there are multiple baselines, their output values are averaged.
	BaselineOutputValue float64 `protobuf:"fixed64,1,opt,name=baseline_output_value,json=baselineOutputValue,proto3" json:"baseline_output_value,omitempty"`
	// Output only. Model predicted output on the corresponding [explanation
	// instance][ExplainRequest.instances]. The field name of the output is
	// determined by the key in
	// [ExplanationMetadata.outputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.outputs].
	//
	// If the Model predicted output has multiple dimensions, this is the value in
	// the output located by
	// [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index].
	InstanceOutputValue float64 `protobuf:"fixed64,2,opt,name=instance_output_value,json=instanceOutputValue,proto3" json:"instance_output_value,omitempty"`
	// Output only. Attributions of each explained feature. Features are extracted
	// from the [prediction
	// instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances]
	// according to [explanation metadata for
	// inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs].
	//
	// The value is a struct, whose keys are the name of the feature. The values
	// are how much the feature in the
	// [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances]
	// contributed to the predicted result.
	//
	// The format of the value is determined by the feature's input format:
	//
	//   * If the feature is a scalar value, the attribution value is a
	//     [floating number][google.protobuf.Value.number_value].
	//
	//   * If the feature is an array of scalar values, the attribution value is
	//     an [array][google.protobuf.Value.list_value].
	//
	//   * If the feature is a struct, the attribution value is a
	//     [struct][google.protobuf.Value.struct_value]. The keys in the
	//     attribution value struct are the same as the keys in the feature
	//     struct. The formats of the values in the attribution struct are
	//     determined by the formats of the values in the feature struct.
	//
	// The
	// [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1beta1.ExplanationMetadata.feature_attributions_schema_uri]
	// field, pointed to by the
	// [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] field of
	// the
	// [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models]
	// object, points to the schema file that describes the features and their
	// attribution values (if it is populated).
	FeatureAttributions *structpb.Value `protobuf:"bytes,3,opt,name=feature_attributions,json=featureAttributions,proto3" json:"feature_attributions,omitempty"`
	// Output only. The index that locates the explained prediction output.
	//
	// If the prediction output is a scalar value, output_index is not populated.
	// If the prediction output has multiple dimensions, the length of the
	// output_index list is the same as the number of dimensions of the output.
	// The i-th element in output_index is the element index of the i-th dimension
	// of the output vector. Indices start from 0.
	OutputIndex []int32 `protobuf:"varint,4,rep,packed,name=output_index,json=outputIndex,proto3" json:"output_index,omitempty"`
	// Output only. The display name of the output identified by
	// [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index].
	// For example, the predicted class name by a multi-classification Model.
	//
	// This field is only populated iff the Model predicts display names as a
	// separate field along with the explained output. The predicted display name
	// must has the same shape of the explained output, and can be located using
	// output_index.
	OutputDisplayName string `protobuf:"bytes,5,opt,name=output_display_name,json=outputDisplayName,proto3" json:"output_display_name,omitempty"`
	// Output only. Error of
	// [feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions]
	// caused by approximation used in the explanation method. Lower value means
	// more precise attributions.
	//
	// * For Sampled Shapley
	// [attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.sampled_shapley_attribution],
	// increasing
	// [path_count][google.cloud.aiplatform.v1beta1.SampledShapleyAttribution.path_count]
	// might reduce the error.
	// * For Integrated Gradients
	// [attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution],
	// increasing
	// [step_count][google.cloud.aiplatform.v1beta1.IntegratedGradientsAttribution.step_count]
	// might reduce the error.
	// * For [XRAI
	// attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution],
	// increasing
	// [step_count][google.cloud.aiplatform.v1beta1.XraiAttribution.step_count]
	// might reduce the error.
	//
	// See [this introduction](/vertex-ai/docs/explainable-ai/overview)
	// for more information.
	ApproximationError float64 `protobuf:"fixed64,6,opt,name=approximation_error,json=approximationError,proto3" json:"approximation_error,omitempty"`
	// Output only. Name of the explain output. Specified as the key in
	// [ExplanationMetadata.outputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.outputs].
	OutputName string `protobuf:"bytes,7,opt,name=output_name,json=outputName,proto3" json:"output_name,omitempty"`
	// contains filtered or unexported fields
}

Attribution that explains a particular prediction output.

func (*Attribution) Descriptor deprecated

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

Deprecated: Use Attribution.ProtoReflect.Descriptor instead.

func (*Attribution) GetApproximationError

func (x *Attribution) GetApproximationError() float64

func (*Attribution) GetBaselineOutputValue

func (x *Attribution) GetBaselineOutputValue() float64

func (*Attribution) GetFeatureAttributions

func (x *Attribution) GetFeatureAttributions() *structpb.Value

func (*Attribution) GetInstanceOutputValue

func (x *Attribution) GetInstanceOutputValue() float64

func (*Attribution) GetOutputDisplayName

func (x *Attribution) GetOutputDisplayName() string

func (*Attribution) GetOutputIndex

func (x *Attribution) GetOutputIndex() []int32

func (*Attribution) GetOutputName

func (x *Attribution) GetOutputName() string

func (*Attribution) ProtoMessage

func (*Attribution) ProtoMessage()

func (*Attribution) ProtoReflect

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

func (*Attribution) Reset

func (x *Attribution) Reset()

func (*Attribution) String

func (x *Attribution) String() string

type AvroSource

type AvroSource struct {

	// Required. Google Cloud Storage location.
	GcsSource *GcsSource `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3" json:"gcs_source,omitempty"`
	// contains filtered or unexported fields
}

The storage details for Avro input content.

func (*AvroSource) Descriptor deprecated

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

Deprecated: Use AvroSource.ProtoReflect.Descriptor instead.

func (*AvroSource) GetGcsSource

func (x *AvroSource) GetGcsSource() *GcsSource

func (*AvroSource) ProtoMessage

func (*AvroSource) ProtoMessage()

func (*AvroSource) ProtoReflect

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

func (*AvroSource) Reset

func (x *AvroSource) Reset()

func (*AvroSource) String

func (x *AvroSource) String() string

type BigQueryDestination

type BigQueryDestination struct {

	// Required. BigQuery URI to a project or table, up to 2000 characters long.
	//
	// When only the project is specified, the Dataset and Table is created.
	// When the full table reference is specified, the Dataset must exist and
	// table must not exist.
	//
	// Accepted forms:
	//
	// *  BigQuery path. For example:
	// `bq://projectId` or `bq://projectId.bqDatasetId` or
	// `bq://projectId.bqDatasetId.bqTableId`.
	OutputUri string `protobuf:"bytes,1,opt,name=output_uri,json=outputUri,proto3" json:"output_uri,omitempty"`
	// contains filtered or unexported fields
}

The BigQuery location for the output content.

func (*BigQueryDestination) Descriptor deprecated

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

Deprecated: Use BigQueryDestination.ProtoReflect.Descriptor instead.

func (*BigQueryDestination) GetOutputUri

func (x *BigQueryDestination) GetOutputUri() string

func (*BigQueryDestination) ProtoMessage

func (*BigQueryDestination) ProtoMessage()

func (*BigQueryDestination) ProtoReflect

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

func (*BigQueryDestination) Reset

func (x *BigQueryDestination) Reset()

func (*BigQueryDestination) String

func (x *BigQueryDestination) String() string

type BigQuerySource

type BigQuerySource struct {

	// Required. BigQuery URI to a table, up to 2000 characters long.
	// Accepted forms:
	//
	// *  BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
	InputUri string `protobuf:"bytes,1,opt,name=input_uri,json=inputUri,proto3" json:"input_uri,omitempty"`
	// contains filtered or unexported fields
}

The BigQuery location for the input content.

func (*BigQuerySource) Descriptor deprecated

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

Deprecated: Use BigQuerySource.ProtoReflect.Descriptor instead.

func (*BigQuerySource) GetInputUri

func (x *BigQuerySource) GetInputUri() string

func (*BigQuerySource) ProtoMessage

func (*BigQuerySource) ProtoMessage()

func (*BigQuerySource) ProtoReflect

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

func (*BigQuerySource) Reset

func (x *BigQuerySource) Reset()

func (*BigQuerySource) String

func (x *BigQuerySource) String() string

type Blob

type Blob struct {

	// Required. The IANA standard MIME type of the source data.
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Required. Raw bytes for media formats.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Raw media bytes.

Text should not be sent as raw bytes, use the 'text' field.

func (*Blob) Descriptor deprecated

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

Deprecated: Use Blob.ProtoReflect.Descriptor instead.

func (*Blob) GetData

func (x *Blob) GetData() []byte

func (*Blob) GetMimeType

func (x *Blob) GetMimeType() string

func (*Blob) ProtoMessage

func (*Blob) ProtoMessage()

func (*Blob) ProtoReflect

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

func (*Blob) Reset

func (x *Blob) Reset()

func (*Blob) String

func (x *Blob) String() string

type BlurBaselineConfig

type BlurBaselineConfig struct {

	// The standard deviation of the blur kernel for the blurred baseline. The
	// same blurring parameter is used for both the height and the width
	// dimension. If not set, the method defaults to the zero (i.e. black for
	// images) baseline.
	MaxBlurSigma float32 `protobuf:"fixed32,1,opt,name=max_blur_sigma,json=maxBlurSigma,proto3" json:"max_blur_sigma,omitempty"`
	// contains filtered or unexported fields
}

Config for blur baseline.

When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383

func (*BlurBaselineConfig) Descriptor deprecated

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

Deprecated: Use BlurBaselineConfig.ProtoReflect.Descriptor instead.

func (*BlurBaselineConfig) GetMaxBlurSigma

func (x *BlurBaselineConfig) GetMaxBlurSigma() float32

func (*BlurBaselineConfig) ProtoMessage

func (*BlurBaselineConfig) ProtoMessage()

func (*BlurBaselineConfig) ProtoReflect

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

func (*BlurBaselineConfig) Reset

func (x *BlurBaselineConfig) Reset()

func (*BlurBaselineConfig) String

func (x *BlurBaselineConfig) String() string

type BoolArray

type BoolArray struct {

	// A list of bool values.
	Values []bool `protobuf:"varint,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

A list of boolean values.

func (*BoolArray) Descriptor deprecated

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

Deprecated: Use BoolArray.ProtoReflect.Descriptor instead.

func (*BoolArray) GetValues

func (x *BoolArray) GetValues() []bool

func (*BoolArray) ProtoMessage

func (*BoolArray) ProtoMessage()

func (*BoolArray) ProtoReflect

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

func (*BoolArray) Reset

func (x *BoolArray) Reset()

func (*BoolArray) String

func (x *BoolArray) String() string

type Candidate

type Candidate struct {

	// Output only. Index of the candidate.
	Index int32 `protobuf:"varint,1,opt,name=index,proto3" json:"index,omitempty"`
	// Output only. Content parts of the candidate.
	Content *Content `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// Output only. The reason why the model stopped generating tokens.
	// If empty, the model has not stopped generating the tokens.
	FinishReason Candidate_FinishReason `` /* 158-byte string literal not displayed */
	// Output only. List of ratings for the safety of a response candidate.
	//
	// There is at most one rating per category.
	SafetyRatings []*SafetyRating `protobuf:"bytes,4,rep,name=safety_ratings,json=safetyRatings,proto3" json:"safety_ratings,omitempty"`
	// Output only. Describes the reason the mode stopped generating tokens in
	// more detail. This is only filled when `finish_reason` is set.
	FinishMessage *string `protobuf:"bytes,5,opt,name=finish_message,json=finishMessage,proto3,oneof" json:"finish_message,omitempty"`
	// Output only. Source attribution of the generated content.
	CitationMetadata *CitationMetadata `protobuf:"bytes,6,opt,name=citation_metadata,json=citationMetadata,proto3" json:"citation_metadata,omitempty"`
	// contains filtered or unexported fields
}

A response candidate generated from the model.

func (*Candidate) Descriptor deprecated

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

Deprecated: Use Candidate.ProtoReflect.Descriptor instead.

func (*Candidate) GetCitationMetadata

func (x *Candidate) GetCitationMetadata() *CitationMetadata

func (*Candidate) GetContent

func (x *Candidate) GetContent() *Content

func (*Candidate) GetFinishMessage

func (x *Candidate) GetFinishMessage() string

func (*Candidate) GetFinishReason

func (x *Candidate) GetFinishReason() Candidate_FinishReason

func (*Candidate) GetIndex

func (x *Candidate) GetIndex() int32

func (*Candidate) GetSafetyRatings

func (x *Candidate) GetSafetyRatings() []*SafetyRating

func (*Candidate) ProtoMessage

func (*Candidate) ProtoMessage()

func (*Candidate) ProtoReflect

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

func (*Candidate) Reset

func (x *Candidate) Reset()

func (*Candidate) String

func (x *Candidate) String() string

type Candidate_FinishReason

type Candidate_FinishReason int32

The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.

const (
	// The finish reason is unspecified.
	Candidate_FINISH_REASON_UNSPECIFIED Candidate_FinishReason = 0
	// Natural stop point of the model or provided stop sequence.
	Candidate_STOP Candidate_FinishReason = 1
	// The maximum number of tokens as specified in the request was reached.
	Candidate_MAX_TOKENS Candidate_FinishReason = 2
	// The token generation was stopped as the response was flagged for safety
	// reasons. NOTE: When streaming the Candidate.content will be empty if
	// content filters blocked the output.
	Candidate_SAFETY Candidate_FinishReason = 3
	// The token generation was stopped as the response was flagged for
	// unauthorized citations.
	Candidate_RECITATION Candidate_FinishReason = 4
	// All other reasons that stopped the token generation
	Candidate_OTHER Candidate_FinishReason = 5
)

func (Candidate_FinishReason) Descriptor

func (Candidate_FinishReason) Enum

func (Candidate_FinishReason) EnumDescriptor deprecated

func (Candidate_FinishReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use Candidate_FinishReason.Descriptor instead.

func (Candidate_FinishReason) Number

func (Candidate_FinishReason) String

func (x Candidate_FinishReason) String() string

func (Candidate_FinishReason) Type

type Citation

type Citation struct {

	// Output only. Start index into the content.
	StartIndex int32 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
	// Output only. End index into the content.
	EndIndex int32 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
	// Output only. Url reference of the attribution.
	Uri string `protobuf:"bytes,3,opt,name=uri,proto3" json:"uri,omitempty"`
	// Output only. Title of the attribution.
	Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`
	// Output only. License of the attribution.
	License string `protobuf:"bytes,5,opt,name=license,proto3" json:"license,omitempty"`
	// Output only. Publication date of the attribution.
	PublicationDate *date.Date `protobuf:"bytes,6,opt,name=publication_date,json=publicationDate,proto3" json:"publication_date,omitempty"`
	// contains filtered or unexported fields
}

Source attributions for content.

func (*Citation) Descriptor deprecated

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

Deprecated: Use Citation.ProtoReflect.Descriptor instead.

func (*Citation) GetEndIndex

func (x *Citation) GetEndIndex() int32

func (*Citation) GetLicense

func (x *Citation) GetLicense() string

func (*Citation) GetPublicationDate

func (x *Citation) GetPublicationDate() *date.Date

func (*Citation) GetStartIndex

func (x *Citation) GetStartIndex() int32

func (*Citation) GetTitle

func (x *Citation) GetTitle() string

func (*Citation) GetUri

func (x *Citation) GetUri() string

func (*Citation) ProtoMessage

func (*Citation) ProtoMessage()

func (*Citation) ProtoReflect

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

func (*Citation) Reset

func (x *Citation) Reset()

func (*Citation) String

func (x *Citation) String() string

type CitationMetadata

type CitationMetadata struct {

	// Output only. List of citations.
	Citations []*Citation `protobuf:"bytes,1,rep,name=citations,proto3" json:"citations,omitempty"`
	// contains filtered or unexported fields
}

A collection of source attributions for a piece of content.

func (*CitationMetadata) Descriptor deprecated

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

Deprecated: Use CitationMetadata.ProtoReflect.Descriptor instead.

func (*CitationMetadata) GetCitations

func (x *CitationMetadata) GetCitations() []*Citation

func (*CitationMetadata) ProtoMessage

func (*CitationMetadata) ProtoMessage()

func (*CitationMetadata) ProtoReflect

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

func (*CitationMetadata) Reset

func (x *CitationMetadata) Reset()

func (*CitationMetadata) String

func (x *CitationMetadata) String() string

type ContainerRegistryDestination

type ContainerRegistryDestination struct {

	// Required. Container Registry URI of a container image.
	// Only Google Container Registry and Artifact Registry are supported now.
	// Accepted forms:
	//
	// *  Google Container Registry path. For example:
	//    `gcr.io/projectId/imageName:tag`.
	//
	// *  Artifact Registry path. For example:
	//    `us-central1-docker.pkg.dev/projectId/repoName/imageName:tag`.
	//
	// If a tag is not specified, "latest" will be used as the default tag.
	OutputUri string `protobuf:"bytes,1,opt,name=output_uri,json=outputUri,proto3" json:"output_uri,omitempty"`
	// contains filtered or unexported fields
}

The Container Registry location for the container image.

func (*ContainerRegistryDestination) Descriptor deprecated

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

Deprecated: Use ContainerRegistryDestination.ProtoReflect.Descriptor instead.

func (*ContainerRegistryDestination) GetOutputUri

func (x *ContainerRegistryDestination) GetOutputUri() string

func (*ContainerRegistryDestination) ProtoMessage

func (*ContainerRegistryDestination) ProtoMessage()

func (*ContainerRegistryDestination) ProtoReflect

func (*ContainerRegistryDestination) Reset

func (x *ContainerRegistryDestination) Reset()

func (*ContainerRegistryDestination) String

type Content

type Content struct {

	// Optional. The producer of the content. Must be either 'user' or 'model'.
	//
	// Useful to set for multi-turn conversations, otherwise can be left blank
	// or unset.
	Role string `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`
	// Required. Ordered `Parts` that constitute a single message. Parts may have
	// different IANA MIME types.
	Parts []*Part `protobuf:"bytes,2,rep,name=parts,proto3" json:"parts,omitempty"`
	// contains filtered or unexported fields
}

The base structured datatype containing multi-part content of a message.

A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.

func (*Content) Descriptor deprecated

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

Deprecated: Use Content.ProtoReflect.Descriptor instead.

func (*Content) GetParts

func (x *Content) GetParts() []*Part

func (*Content) GetRole

func (x *Content) GetRole() string

func (*Content) ProtoMessage

func (*Content) ProtoMessage()

func (*Content) ProtoReflect

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

func (*Content) Reset

func (x *Content) Reset()

func (*Content) String

func (x *Content) String() string

type Context

type Context struct {

	// Immutable. The resource name of the Context.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// User provided display name of the Context.
	// May be up to 128 Unicode characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// An eTag used to perform consistent read-modify-write updates. If not set, a
	// blind "overwrite" update happens.
	Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
	// The labels with user-defined metadata to organize your Contexts.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one Context (System
	// labels are excluded).
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Output only. Timestamp when this Context was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this Context was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. A list of resource names of Contexts that are parents of this
	// Context. A Context may have at most 10 parent_contexts.
	ParentContexts []string `protobuf:"bytes,12,rep,name=parent_contexts,json=parentContexts,proto3" json:"parent_contexts,omitempty"`
	// The title of the schema describing the metadata.
	//
	// Schema title and version is expected to be registered in earlier Create
	// Schema calls. And both are used together as unique identifiers to identify
	// schemas within the local metadata store.
	SchemaTitle string `protobuf:"bytes,13,opt,name=schema_title,json=schemaTitle,proto3" json:"schema_title,omitempty"`
	// The version of the schema in schema_name to use.
	//
	// Schema title and version is expected to be registered in earlier Create
	// Schema calls. And both are used together as unique identifiers to identify
	// schemas within the local metadata store.
	SchemaVersion string `protobuf:"bytes,14,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`
	// Properties of the Context.
	// Top level metadata keys' heading and trailing spaces will be trimmed.
	// The size of this field should not exceed 200KB.
	Metadata *structpb.Struct `protobuf:"bytes,15,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Description of the Context
	Description string `protobuf:"bytes,16,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Instance of a general context.

func (*Context) Descriptor deprecated

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

Deprecated: Use Context.ProtoReflect.Descriptor instead.

func (*Context) GetCreateTime

func (x *Context) GetCreateTime() *timestamppb.Timestamp

func (*Context) GetDescription

func (x *Context) GetDescription() string

func (*Context) GetDisplayName

func (x *Context) GetDisplayName() string

func (*Context) GetEtag

func (x *Context) GetEtag() string

func (*Context) GetLabels

func (x *Context) GetLabels() map[string]string

func (*Context) GetMetadata

func (x *Context) GetMetadata() *structpb.Struct

func (*Context) GetName

func (x *Context) GetName() string

func (*Context) GetParentContexts

func (x *Context) GetParentContexts() []string

func (*Context) GetSchemaTitle

func (x *Context) GetSchemaTitle() string

func (*Context) GetSchemaVersion

func (x *Context) GetSchemaVersion() string

func (*Context) GetUpdateTime

func (x *Context) GetUpdateTime() *timestamppb.Timestamp

func (*Context) ProtoMessage

func (*Context) ProtoMessage()

func (*Context) ProtoReflect

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

func (*Context) Reset

func (x *Context) Reset()

func (*Context) String

func (x *Context) String() string

type CountTokensRequest

type CountTokensRequest struct {

	// Required. The name of the Endpoint requested to perform token counting.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Required. The name of the publisher model requested to serve the
	// prediction. Format:
	// `projects/{project}/locations/{location}/publishers/*/models/*`
	Model string `protobuf:"bytes,3,opt,name=model,proto3" json:"model,omitempty"`
	// Required. The instances that are the input to token counting call.
	// Schema is identical to the prediction schema of the underlying model.
	Instances []*structpb.Value `protobuf:"bytes,2,rep,name=instances,proto3" json:"instances,omitempty"`
	// Required. Input content.
	Contents []*Content `protobuf:"bytes,4,rep,name=contents,proto3" json:"contents,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.CountTokens][google.cloud.aiplatform.v1beta1.PredictionService.CountTokens].

func (*CountTokensRequest) Descriptor deprecated

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

Deprecated: Use CountTokensRequest.ProtoReflect.Descriptor instead.

func (*CountTokensRequest) GetContents

func (x *CountTokensRequest) GetContents() []*Content

func (*CountTokensRequest) GetEndpoint

func (x *CountTokensRequest) GetEndpoint() string

func (*CountTokensRequest) GetInstances

func (x *CountTokensRequest) GetInstances() []*structpb.Value

func (*CountTokensRequest) GetModel

func (x *CountTokensRequest) GetModel() string

func (*CountTokensRequest) ProtoMessage

func (*CountTokensRequest) ProtoMessage()

func (*CountTokensRequest) ProtoReflect

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

func (*CountTokensRequest) Reset

func (x *CountTokensRequest) Reset()

func (*CountTokensRequest) String

func (x *CountTokensRequest) String() string

type CountTokensResponse

type CountTokensResponse struct {

	// The total number of tokens counted across all instances from the request.
	TotalTokens int32 `protobuf:"varint,1,opt,name=total_tokens,json=totalTokens,proto3" json:"total_tokens,omitempty"`
	// The total number of billable characters counted across all instances from
	// the request.
	TotalBillableCharacters int32 `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message for [PredictionService.CountTokens][google.cloud.aiplatform.v1beta1.PredictionService.CountTokens].

func (*CountTokensResponse) Descriptor deprecated

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

Deprecated: Use CountTokensResponse.ProtoReflect.Descriptor instead.

func (*CountTokensResponse) GetTotalBillableCharacters

func (x *CountTokensResponse) GetTotalBillableCharacters() int32

func (*CountTokensResponse) GetTotalTokens

func (x *CountTokensResponse) GetTotalTokens() int32

func (*CountTokensResponse) ProtoMessage

func (*CountTokensResponse) ProtoMessage()

func (*CountTokensResponse) ProtoReflect

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

func (*CountTokensResponse) Reset

func (x *CountTokensResponse) Reset()

func (*CountTokensResponse) String

func (x *CountTokensResponse) String() string

type CsvDestination

type CsvDestination struct {

	// Required. Google Cloud Storage location.
	GcsDestination *GcsDestination `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3" json:"gcs_destination,omitempty"`
	// contains filtered or unexported fields
}

The storage details for CSV output content.

func (*CsvDestination) Descriptor deprecated

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

Deprecated: Use CsvDestination.ProtoReflect.Descriptor instead.

func (*CsvDestination) GetGcsDestination

func (x *CsvDestination) GetGcsDestination() *GcsDestination

func (*CsvDestination) ProtoMessage

func (*CsvDestination) ProtoMessage()

func (*CsvDestination) ProtoReflect

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

func (*CsvDestination) Reset

func (x *CsvDestination) Reset()

func (*CsvDestination) String

func (x *CsvDestination) String() string

type CsvSource

type CsvSource struct {

	// Required. Google Cloud Storage location.
	GcsSource *GcsSource `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3" json:"gcs_source,omitempty"`
	// contains filtered or unexported fields
}

The storage details for CSV input content.

func (*CsvSource) Descriptor deprecated

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

Deprecated: Use CsvSource.ProtoReflect.Descriptor instead.

func (*CsvSource) GetGcsSource

func (x *CsvSource) GetGcsSource() *GcsSource

func (*CsvSource) ProtoMessage

func (*CsvSource) ProtoMessage()

func (*CsvSource) ProtoReflect

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

func (*CsvSource) Reset

func (x *CsvSource) Reset()

func (*CsvSource) String

func (x *CsvSource) String() string

type DataItem

type DataItem struct {

	// Output only. The resource name of the DataItem.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Timestamp when this DataItem was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this DataItem was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. The labels with user-defined metadata to organize your DataItems.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one DataItem(System
	// labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Required. The data that the DataItem represents (for example, an image or a
	// text snippet). The schema of the payload is stored in the parent Dataset's
	// [metadata
	// schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri]
	// dataItemSchemaUri field.
	Payload *structpb.Value `protobuf:"bytes,4,opt,name=payload,proto3" json:"payload,omitempty"`
	// Optional. Used to perform consistent read-modify-write updates. If not set,
	// a blind "overwrite" update happens.
	Etag string `protobuf:"bytes,7,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

A piece of data in a Dataset. Could be an image, a video, a document or plain text.

func (*DataItem) Descriptor deprecated

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

Deprecated: Use DataItem.ProtoReflect.Descriptor instead.

func (*DataItem) GetCreateTime

func (x *DataItem) GetCreateTime() *timestamppb.Timestamp

func (*DataItem) GetEtag

func (x *DataItem) GetEtag() string

func (*DataItem) GetLabels

func (x *DataItem) GetLabels() map[string]string

func (*DataItem) GetName

func (x *DataItem) GetName() string

func (*DataItem) GetPayload

func (x *DataItem) GetPayload() *structpb.Value

func (*DataItem) GetUpdateTime

func (x *DataItem) GetUpdateTime() *timestamppb.Timestamp

func (*DataItem) ProtoMessage

func (*DataItem) ProtoMessage()

func (*DataItem) ProtoReflect

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

func (*DataItem) Reset

func (x *DataItem) Reset()

func (*DataItem) String

func (x *DataItem) String() string

type DeleteOperationMetadata

type DeleteOperationMetadata struct {

	// The common part of the operation metadata.
	GenericMetadata *GenericOperationMetadata `protobuf:"bytes,1,opt,name=generic_metadata,json=genericMetadata,proto3" json:"generic_metadata,omitempty"`
	// contains filtered or unexported fields
}

Details of operations that perform deletes of any entities.

func (*DeleteOperationMetadata) Descriptor deprecated

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

Deprecated: Use DeleteOperationMetadata.ProtoReflect.Descriptor instead.

func (*DeleteOperationMetadata) GetGenericMetadata

func (x *DeleteOperationMetadata) GetGenericMetadata() *GenericOperationMetadata

func (*DeleteOperationMetadata) ProtoMessage

func (*DeleteOperationMetadata) ProtoMessage()

func (*DeleteOperationMetadata) ProtoReflect

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

func (*DeleteOperationMetadata) Reset

func (x *DeleteOperationMetadata) Reset()

func (*DeleteOperationMetadata) String

func (x *DeleteOperationMetadata) String() string

type DirectPredictRequest

type DirectPredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// The prediction input.
	Inputs []*Tensor `protobuf:"bytes,2,rep,name=inputs,proto3" json:"inputs,omitempty"`
	// The parameters that govern the prediction.
	Parameters *Tensor `protobuf:"bytes,3,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.DirectPredict][google.cloud.aiplatform.v1beta1.PredictionService.DirectPredict].

func (*DirectPredictRequest) Descriptor deprecated

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

Deprecated: Use DirectPredictRequest.ProtoReflect.Descriptor instead.

func (*DirectPredictRequest) GetEndpoint

func (x *DirectPredictRequest) GetEndpoint() string

func (*DirectPredictRequest) GetInputs

func (x *DirectPredictRequest) GetInputs() []*Tensor

func (*DirectPredictRequest) GetParameters

func (x *DirectPredictRequest) GetParameters() *Tensor

func (*DirectPredictRequest) ProtoMessage

func (*DirectPredictRequest) ProtoMessage()

func (*DirectPredictRequest) ProtoReflect

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

func (*DirectPredictRequest) Reset

func (x *DirectPredictRequest) Reset()

func (*DirectPredictRequest) String

func (x *DirectPredictRequest) String() string

type DirectPredictResponse

type DirectPredictResponse struct {

	// The prediction output.
	Outputs []*Tensor `protobuf:"bytes,1,rep,name=outputs,proto3" json:"outputs,omitempty"`
	// The parameters that govern the prediction.
	Parameters *Tensor `protobuf:"bytes,2,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.DirectPredict][google.cloud.aiplatform.v1beta1.PredictionService.DirectPredict].

func (*DirectPredictResponse) Descriptor deprecated

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

Deprecated: Use DirectPredictResponse.ProtoReflect.Descriptor instead.

func (*DirectPredictResponse) GetOutputs

func (x *DirectPredictResponse) GetOutputs() []*Tensor

func (*DirectPredictResponse) GetParameters

func (x *DirectPredictResponse) GetParameters() *Tensor

func (*DirectPredictResponse) ProtoMessage

func (*DirectPredictResponse) ProtoMessage()

func (*DirectPredictResponse) ProtoReflect

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

func (*DirectPredictResponse) Reset

func (x *DirectPredictResponse) Reset()

func (*DirectPredictResponse) String

func (x *DirectPredictResponse) String() string

type DirectRawPredictRequest

type DirectRawPredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Fully qualified name of the API method being invoked to perform
	// predictions.
	//
	// Format:
	// `/namespace.Service/Method/`
	// Example:
	// `/tensorflow.serving.PredictionService/Predict`
	MethodName string `protobuf:"bytes,2,opt,name=method_name,json=methodName,proto3" json:"method_name,omitempty"`
	// The prediction input.
	Input []byte `protobuf:"bytes,3,opt,name=input,proto3" json:"input,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.DirectRawPredict][google.cloud.aiplatform.v1beta1.PredictionService.DirectRawPredict].

func (*DirectRawPredictRequest) Descriptor deprecated

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

Deprecated: Use DirectRawPredictRequest.ProtoReflect.Descriptor instead.

func (*DirectRawPredictRequest) GetEndpoint

func (x *DirectRawPredictRequest) GetEndpoint() string

func (*DirectRawPredictRequest) GetInput

func (x *DirectRawPredictRequest) GetInput() []byte

func (*DirectRawPredictRequest) GetMethodName

func (x *DirectRawPredictRequest) GetMethodName() string

func (*DirectRawPredictRequest) ProtoMessage

func (*DirectRawPredictRequest) ProtoMessage()

func (*DirectRawPredictRequest) ProtoReflect

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

func (*DirectRawPredictRequest) Reset

func (x *DirectRawPredictRequest) Reset()

func (*DirectRawPredictRequest) String

func (x *DirectRawPredictRequest) String() string

type DirectRawPredictResponse

type DirectRawPredictResponse struct {

	// The prediction output.
	Output []byte `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.DirectRawPredict][google.cloud.aiplatform.v1beta1.PredictionService.DirectRawPredict].

func (*DirectRawPredictResponse) Descriptor deprecated

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

Deprecated: Use DirectRawPredictResponse.ProtoReflect.Descriptor instead.

func (*DirectRawPredictResponse) GetOutput

func (x *DirectRawPredictResponse) GetOutput() []byte

func (*DirectRawPredictResponse) ProtoMessage

func (*DirectRawPredictResponse) ProtoMessage()

func (*DirectRawPredictResponse) ProtoReflect

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

func (*DirectRawPredictResponse) Reset

func (x *DirectRawPredictResponse) Reset()

func (*DirectRawPredictResponse) String

func (x *DirectRawPredictResponse) String() string

type DoubleArray

type DoubleArray struct {

	// A list of double values.
	Values []float64 `protobuf:"fixed64,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

A list of double values.

func (*DoubleArray) Descriptor deprecated

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

Deprecated: Use DoubleArray.ProtoReflect.Descriptor instead.

func (*DoubleArray) GetValues

func (x *DoubleArray) GetValues() []float64

func (*DoubleArray) ProtoMessage

func (*DoubleArray) ProtoMessage()

func (*DoubleArray) ProtoReflect

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

func (*DoubleArray) Reset

func (x *DoubleArray) Reset()

func (*DoubleArray) String

func (x *DoubleArray) String() string

type EnvVar

type EnvVar struct {

	// Required. Name of the environment variable. Must be a valid C identifier.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Variables that reference a $(VAR_NAME) are expanded
	// using the previous defined environment variables in the container and
	// any service environment variables. If a variable cannot be resolved,
	// the reference in the input string will be unchanged. The $(VAR_NAME)
	// syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped
	// references will never be expanded, regardless of whether the variable
	// exists or not.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Represents an environment variable present in a Container or Python Module.

func (*EnvVar) Descriptor deprecated

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

Deprecated: Use EnvVar.ProtoReflect.Descriptor instead.

func (*EnvVar) GetName

func (x *EnvVar) GetName() string

func (*EnvVar) GetValue

func (x *EnvVar) GetValue() string

func (*EnvVar) ProtoMessage

func (*EnvVar) ProtoMessage()

func (*EnvVar) ProtoReflect

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

func (*EnvVar) Reset

func (x *EnvVar) Reset()

func (*EnvVar) String

func (x *EnvVar) String() string

type ErrorAnalysisAnnotation

type ErrorAnalysisAnnotation struct {

	// Attributed items for a given annotation, typically representing neighbors
	// from the training sets constrained by the query type.
	AttributedItems []*ErrorAnalysisAnnotation_AttributedItem `protobuf:"bytes,1,rep,name=attributed_items,json=attributedItems,proto3" json:"attributed_items,omitempty"`
	// The query type used for finding the attributed items.
	QueryType ErrorAnalysisAnnotation_QueryType `` /* 160-byte string literal not displayed */
	// The outlier score of this annotated item. Usually defined as the min of all
	// distances from attributed items.
	OutlierScore float64 `protobuf:"fixed64,3,opt,name=outlier_score,json=outlierScore,proto3" json:"outlier_score,omitempty"`
	// The threshold used to determine if this annotation is an outlier or not.
	OutlierThreshold float64 `protobuf:"fixed64,4,opt,name=outlier_threshold,json=outlierThreshold,proto3" json:"outlier_threshold,omitempty"`
	// contains filtered or unexported fields
}

Model error analysis for each annotation.

func (*ErrorAnalysisAnnotation) Descriptor deprecated

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

Deprecated: Use ErrorAnalysisAnnotation.ProtoReflect.Descriptor instead.

func (*ErrorAnalysisAnnotation) GetAttributedItems

func (*ErrorAnalysisAnnotation) GetOutlierScore

func (x *ErrorAnalysisAnnotation) GetOutlierScore() float64

func (*ErrorAnalysisAnnotation) GetOutlierThreshold

func (x *ErrorAnalysisAnnotation) GetOutlierThreshold() float64

func (*ErrorAnalysisAnnotation) GetQueryType

func (*ErrorAnalysisAnnotation) ProtoMessage

func (*ErrorAnalysisAnnotation) ProtoMessage()

func (*ErrorAnalysisAnnotation) ProtoReflect

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

func (*ErrorAnalysisAnnotation) Reset

func (x *ErrorAnalysisAnnotation) Reset()

func (*ErrorAnalysisAnnotation) String

func (x *ErrorAnalysisAnnotation) String() string

type ErrorAnalysisAnnotation_AttributedItem

type ErrorAnalysisAnnotation_AttributedItem struct {

	// The unique ID for each annotation. Used by FE to allocate the annotation
	// in DB.
	AnnotationResourceName string `` /* 129-byte string literal not displayed */
	// The distance of this item to the annotation.
	Distance float64 `protobuf:"fixed64,2,opt,name=distance,proto3" json:"distance,omitempty"`
	// contains filtered or unexported fields
}

Attributed items for a given annotation, typically representing neighbors from the training sets constrained by the query type.

func (*ErrorAnalysisAnnotation_AttributedItem) Descriptor deprecated

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

Deprecated: Use ErrorAnalysisAnnotation_AttributedItem.ProtoReflect.Descriptor instead.

func (*ErrorAnalysisAnnotation_AttributedItem) GetAnnotationResourceName

func (x *ErrorAnalysisAnnotation_AttributedItem) GetAnnotationResourceName() string

func (*ErrorAnalysisAnnotation_AttributedItem) GetDistance

func (*ErrorAnalysisAnnotation_AttributedItem) ProtoMessage

func (*ErrorAnalysisAnnotation_AttributedItem) ProtoReflect

func (*ErrorAnalysisAnnotation_AttributedItem) Reset

func (*ErrorAnalysisAnnotation_AttributedItem) String

type ErrorAnalysisAnnotation_QueryType

type ErrorAnalysisAnnotation_QueryType int32

The query type used for finding the attributed items.

const (
	// Unspecified query type for model error analysis.
	ErrorAnalysisAnnotation_QUERY_TYPE_UNSPECIFIED ErrorAnalysisAnnotation_QueryType = 0
	// Query similar samples across all classes in the dataset.
	ErrorAnalysisAnnotation_ALL_SIMILAR ErrorAnalysisAnnotation_QueryType = 1
	// Query similar samples from the same class of the input sample.
	ErrorAnalysisAnnotation_SAME_CLASS_SIMILAR ErrorAnalysisAnnotation_QueryType = 2
	// Query dissimilar samples from the same class of the input sample.
	ErrorAnalysisAnnotation_SAME_CLASS_DISSIMILAR ErrorAnalysisAnnotation_QueryType = 3
)

func (ErrorAnalysisAnnotation_QueryType) Descriptor

func (ErrorAnalysisAnnotation_QueryType) Enum

func (ErrorAnalysisAnnotation_QueryType) EnumDescriptor deprecated

func (ErrorAnalysisAnnotation_QueryType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ErrorAnalysisAnnotation_QueryType.Descriptor instead.

func (ErrorAnalysisAnnotation_QueryType) Number

func (ErrorAnalysisAnnotation_QueryType) String

func (ErrorAnalysisAnnotation_QueryType) Type

type EvaluatedAnnotation

type EvaluatedAnnotation struct {

	// Output only. Type of the EvaluatedAnnotation.
	Type EvaluatedAnnotation_EvaluatedAnnotationType `` /* 143-byte string literal not displayed */
	// Output only. The model predicted annotations.
	//
	// For true positive, there is one and only one prediction, which matches the
	// only one ground truth annotation in
	// [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths].
	//
	// For false positive, there is one and only one prediction, which doesn't
	// match any ground truth annotation of the corresponding
	// [data_item_view_id][EvaluatedAnnotation.data_item_view_id].
	//
	// For false negative, there are zero or more predictions which are similar to
	// the only ground truth annotation in
	// [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths]
	// but not enough for a match.
	//
	// The schema of the prediction is stored in
	// [ModelEvaluation.annotation_schema_uri][]
	Predictions []*structpb.Value `protobuf:"bytes,2,rep,name=predictions,proto3" json:"predictions,omitempty"`
	// Output only. The ground truth Annotations, i.e. the Annotations that exist
	// in the test data the Model is evaluated on.
	//
	// For true positive, there is one and only one ground truth annotation, which
	// matches the only prediction in
	// [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
	//
	// For false positive, there are zero or more ground truth annotations that
	// are similar to the only prediction in
	// [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions],
	// but not enough for a match.
	//
	// For false negative, there is one and only one ground truth annotation,
	// which doesn't match any predictions created by the model.
	//
	// The schema of the ground truth is stored in
	// [ModelEvaluation.annotation_schema_uri][]
	GroundTruths []*structpb.Value `protobuf:"bytes,3,rep,name=ground_truths,json=groundTruths,proto3" json:"ground_truths,omitempty"`
	// Output only. The data item payload that the Model predicted this
	// EvaluatedAnnotation on.
	DataItemPayload *structpb.Value `protobuf:"bytes,5,opt,name=data_item_payload,json=dataItemPayload,proto3" json:"data_item_payload,omitempty"`
	// Output only. ID of the EvaluatedDataItemView under the same ancestor
	// ModelEvaluation. The EvaluatedDataItemView consists of all ground truths
	// and predictions on
	// [data_item_payload][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.data_item_payload].
	EvaluatedDataItemViewId string `` /* 136-byte string literal not displayed */
	// Explanations of
	// [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
	// Each element of the explanations indicates the explanation for one
	// explanation Method.
	//
	// The attributions list in the
	// [EvaluatedAnnotationExplanation.explanation][google.cloud.aiplatform.v1beta1.EvaluatedAnnotationExplanation.explanation]
	// object corresponds to the
	// [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions]
	// list. For example, the second element in the attributions list explains the
	// second element in the predictions list.
	Explanations []*EvaluatedAnnotationExplanation `protobuf:"bytes,8,rep,name=explanations,proto3" json:"explanations,omitempty"`
	// Annotations of model error analysis results.
	ErrorAnalysisAnnotations []*ErrorAnalysisAnnotation `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

True positive, false positive, or false negative.

EvaluatedAnnotation is only available under ModelEvaluationSlice with slice of `annotationSpec` dimension.

func (*EvaluatedAnnotation) Descriptor deprecated

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

Deprecated: Use EvaluatedAnnotation.ProtoReflect.Descriptor instead.

func (*EvaluatedAnnotation) GetDataItemPayload

func (x *EvaluatedAnnotation) GetDataItemPayload() *structpb.Value

func (*EvaluatedAnnotation) GetErrorAnalysisAnnotations

func (x *EvaluatedAnnotation) GetErrorAnalysisAnnotations() []*ErrorAnalysisAnnotation

func (*EvaluatedAnnotation) GetEvaluatedDataItemViewId

func (x *EvaluatedAnnotation) GetEvaluatedDataItemViewId() string

func (*EvaluatedAnnotation) GetExplanations

func (x *EvaluatedAnnotation) GetExplanations() []*EvaluatedAnnotationExplanation

func (*EvaluatedAnnotation) GetGroundTruths

func (x *EvaluatedAnnotation) GetGroundTruths() []*structpb.Value

func (*EvaluatedAnnotation) GetPredictions

func (x *EvaluatedAnnotation) GetPredictions() []*structpb.Value

func (*EvaluatedAnnotation) GetType

func (*EvaluatedAnnotation) ProtoMessage

func (*EvaluatedAnnotation) ProtoMessage()

func (*EvaluatedAnnotation) ProtoReflect

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

func (*EvaluatedAnnotation) Reset

func (x *EvaluatedAnnotation) Reset()

func (*EvaluatedAnnotation) String

func (x *EvaluatedAnnotation) String() string

type EvaluatedAnnotationExplanation

type EvaluatedAnnotationExplanation struct {

	// Explanation type.
	//
	// For AutoML Image Classification models, possible values are:
	//
	//   * `image-integrated-gradients`
	//   * `image-xrai`
	ExplanationType string `protobuf:"bytes,1,opt,name=explanation_type,json=explanationType,proto3" json:"explanation_type,omitempty"`
	// Explanation attribution response details.
	Explanation *Explanation `protobuf:"bytes,2,opt,name=explanation,proto3" json:"explanation,omitempty"`
	// contains filtered or unexported fields
}

Explanation result of the prediction produced by the Model.

func (*EvaluatedAnnotationExplanation) Descriptor deprecated

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

Deprecated: Use EvaluatedAnnotationExplanation.ProtoReflect.Descriptor instead.

func (*EvaluatedAnnotationExplanation) GetExplanation

func (x *EvaluatedAnnotationExplanation) GetExplanation() *Explanation

func (*EvaluatedAnnotationExplanation) GetExplanationType

func (x *EvaluatedAnnotationExplanation) GetExplanationType() string

func (*EvaluatedAnnotationExplanation) ProtoMessage

func (*EvaluatedAnnotationExplanation) ProtoMessage()

func (*EvaluatedAnnotationExplanation) ProtoReflect

func (*EvaluatedAnnotationExplanation) Reset

func (x *EvaluatedAnnotationExplanation) Reset()

func (*EvaluatedAnnotationExplanation) String

type EvaluatedAnnotation_EvaluatedAnnotationType

type EvaluatedAnnotation_EvaluatedAnnotationType int32

Describes the type of the EvaluatedAnnotation. The type is determined

const (
	// Invalid value.
	EvaluatedAnnotation_EVALUATED_ANNOTATION_TYPE_UNSPECIFIED EvaluatedAnnotation_EvaluatedAnnotationType = 0
	// The EvaluatedAnnotation is a true positive. It has a prediction created
	// by the Model and a ground truth Annotation which the prediction matches.
	EvaluatedAnnotation_TRUE_POSITIVE EvaluatedAnnotation_EvaluatedAnnotationType = 1
	// The EvaluatedAnnotation is false positive. It has a prediction created by
	// the Model which does not match any ground truth annotation.
	EvaluatedAnnotation_FALSE_POSITIVE EvaluatedAnnotation_EvaluatedAnnotationType = 2
	// The EvaluatedAnnotation is false negative. It has a ground truth
	// annotation which is not matched by any of the model created predictions.
	EvaluatedAnnotation_FALSE_NEGATIVE EvaluatedAnnotation_EvaluatedAnnotationType = 3
)

func (EvaluatedAnnotation_EvaluatedAnnotationType) Descriptor

func (EvaluatedAnnotation_EvaluatedAnnotationType) Enum

func (EvaluatedAnnotation_EvaluatedAnnotationType) EnumDescriptor deprecated

func (EvaluatedAnnotation_EvaluatedAnnotationType) EnumDescriptor() ([]byte, []int)

Deprecated: Use EvaluatedAnnotation_EvaluatedAnnotationType.Descriptor instead.

func (EvaluatedAnnotation_EvaluatedAnnotationType) Number

func (EvaluatedAnnotation_EvaluatedAnnotationType) String

func (EvaluatedAnnotation_EvaluatedAnnotationType) Type

type Event

type Event struct {

	// Required. The relative resource name of the Artifact in the Event.
	Artifact string `protobuf:"bytes,1,opt,name=artifact,proto3" json:"artifact,omitempty"`
	// Output only. The relative resource name of the Execution in the Event.
	Execution string `protobuf:"bytes,2,opt,name=execution,proto3" json:"execution,omitempty"`
	// Output only. Time the Event occurred.
	EventTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
	// Required. The type of the Event.
	Type Event_Type `protobuf:"varint,4,opt,name=type,proto3,enum=google.cloud.aiplatform.v1beta1.Event_Type" json:"type,omitempty"`
	// The labels with user-defined metadata to annotate Events.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one Event (System
	// labels are excluded).
	//
	// See https://goo.gl/xmQnxf for more information and examples of labels.
	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
	// and are immutable.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

An edge describing the relationship between an Artifact and an Execution in a lineage graph.

func (*Event) Descriptor deprecated

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

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetArtifact

func (x *Event) GetArtifact() string

func (*Event) GetEventTime

func (x *Event) GetEventTime() *timestamppb.Timestamp

func (*Event) GetExecution

func (x *Event) GetExecution() string

func (*Event) GetLabels

func (x *Event) GetLabels() map[string]string

func (*Event) GetType

func (x *Event) GetType() Event_Type

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) ProtoReflect

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

func (*Event) Reset

func (x *Event) Reset()

func (*Event) String

func (x *Event) String() string

type Event_Type

type Event_Type int32

Describes whether an Event's Artifact is the Execution's input or output.

const (
	// Unspecified whether input or output of the Execution.
	Event_TYPE_UNSPECIFIED Event_Type = 0
	// An input of the Execution.
	Event_INPUT Event_Type = 1
	// An output of the Execution.
	Event_OUTPUT Event_Type = 2
)

func (Event_Type) Descriptor

func (Event_Type) Descriptor() protoreflect.EnumDescriptor

func (Event_Type) Enum

func (x Event_Type) Enum() *Event_Type

func (Event_Type) EnumDescriptor deprecated

func (Event_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Event_Type.Descriptor instead.

func (Event_Type) Number

func (x Event_Type) Number() protoreflect.EnumNumber

func (Event_Type) String

func (x Event_Type) String() string

func (Event_Type) Type

type Examples

type Examples struct {

	// Types that are assignable to Source:
	//	*Examples_ExampleGcsSource_
	Source isExamples_Source `protobuf_oneof:"source"`
	// Types that are assignable to Config:
	//	*Examples_NearestNeighborSearchConfig
	//	*Examples_Presets
	Config isExamples_Config `protobuf_oneof:"config"`
	// The Cloud Storage locations that contain the instances to be
	// indexed for approximate nearest neighbor search.
	GcsSource *GcsSource `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3" json:"gcs_source,omitempty"`
	// The number of neighbors to return when querying for examples.
	NeighborCount int32 `protobuf:"varint,3,opt,name=neighbor_count,json=neighborCount,proto3" json:"neighbor_count,omitempty"`
	// contains filtered or unexported fields
}

Example-based explainability that returns the nearest neighbors from the provided dataset.

func (*Examples) Descriptor deprecated

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

Deprecated: Use Examples.ProtoReflect.Descriptor instead.

func (*Examples) GetConfig

func (m *Examples) GetConfig() isExamples_Config

func (*Examples) GetExampleGcsSource

func (x *Examples) GetExampleGcsSource() *Examples_ExampleGcsSource

func (*Examples) GetGcsSource

func (x *Examples) GetGcsSource() *GcsSource

func (*Examples) GetNearestNeighborSearchConfig

func (x *Examples) GetNearestNeighborSearchConfig() *structpb.Value

func (*Examples) GetNeighborCount

func (x *Examples) GetNeighborCount() int32

func (*Examples) GetPresets

func (x *Examples) GetPresets() *Presets

func (*Examples) GetSource

func (m *Examples) GetSource() isExamples_Source

func (*Examples) ProtoMessage

func (*Examples) ProtoMessage()

func (*Examples) ProtoReflect

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

func (*Examples) Reset

func (x *Examples) Reset()

func (*Examples) String

func (x *Examples) String() string

type ExamplesOverride

type ExamplesOverride struct {

	// The number of neighbors to return.
	NeighborCount int32 `protobuf:"varint,1,opt,name=neighbor_count,json=neighborCount,proto3" json:"neighbor_count,omitempty"`
	// The number of neighbors to return that have the same crowding tag.
	CrowdingCount int32 `protobuf:"varint,2,opt,name=crowding_count,json=crowdingCount,proto3" json:"crowding_count,omitempty"`
	// Restrict the resulting nearest neighbors to respect these constraints.
	Restrictions []*ExamplesRestrictionsNamespace `protobuf:"bytes,3,rep,name=restrictions,proto3" json:"restrictions,omitempty"`
	// If true, return the embeddings instead of neighbors.
	ReturnEmbeddings bool `protobuf:"varint,4,opt,name=return_embeddings,json=returnEmbeddings,proto3" json:"return_embeddings,omitempty"`
	// The format of the data being provided with each call.
	DataFormat ExamplesOverride_DataFormat `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

Overrides for example-based explanations.

func (*ExamplesOverride) Descriptor deprecated

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

Deprecated: Use ExamplesOverride.ProtoReflect.Descriptor instead.

func (*ExamplesOverride) GetCrowdingCount

func (x *ExamplesOverride) GetCrowdingCount() int32

func (*ExamplesOverride) GetDataFormat

func (x *ExamplesOverride) GetDataFormat() ExamplesOverride_DataFormat

func (*ExamplesOverride) GetNeighborCount

func (x *ExamplesOverride) GetNeighborCount() int32

func (*ExamplesOverride) GetRestrictions

func (x *ExamplesOverride) GetRestrictions() []*ExamplesRestrictionsNamespace

func (*ExamplesOverride) GetReturnEmbeddings

func (x *ExamplesOverride) GetReturnEmbeddings() bool

func (*ExamplesOverride) ProtoMessage

func (*ExamplesOverride) ProtoMessage()

func (*ExamplesOverride) ProtoReflect

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

func (*ExamplesOverride) Reset

func (x *ExamplesOverride) Reset()

func (*ExamplesOverride) String

func (x *ExamplesOverride) String() string

type ExamplesOverride_DataFormat

type ExamplesOverride_DataFormat int32

Data format enum.

const (
	// Unspecified format. Must not be used.
	ExamplesOverride_DATA_FORMAT_UNSPECIFIED ExamplesOverride_DataFormat = 0
	// Provided data is a set of model inputs.
	ExamplesOverride_INSTANCES ExamplesOverride_DataFormat = 1
	// Provided data is a set of embeddings.
	ExamplesOverride_EMBEDDINGS ExamplesOverride_DataFormat = 2
)

func (ExamplesOverride_DataFormat) Descriptor

func (ExamplesOverride_DataFormat) Enum

func (ExamplesOverride_DataFormat) EnumDescriptor deprecated

func (ExamplesOverride_DataFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use ExamplesOverride_DataFormat.Descriptor instead.

func (ExamplesOverride_DataFormat) Number

func (ExamplesOverride_DataFormat) String

func (ExamplesOverride_DataFormat) Type

type ExamplesRestrictionsNamespace

type ExamplesRestrictionsNamespace struct {

	// The namespace name.
	NamespaceName string `protobuf:"bytes,1,opt,name=namespace_name,json=namespaceName,proto3" json:"namespace_name,omitempty"`
	// The list of allowed tags.
	Allow []string `protobuf:"bytes,2,rep,name=allow,proto3" json:"allow,omitempty"`
	// The list of deny tags.
	Deny []string `protobuf:"bytes,3,rep,name=deny,proto3" json:"deny,omitempty"`
	// contains filtered or unexported fields
}

Restrictions namespace for example-based explanations overrides.

func (*ExamplesRestrictionsNamespace) Descriptor deprecated

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

Deprecated: Use ExamplesRestrictionsNamespace.ProtoReflect.Descriptor instead.

func (*ExamplesRestrictionsNamespace) GetAllow

func (x *ExamplesRestrictionsNamespace) GetAllow() []string

func (*ExamplesRestrictionsNamespace) GetDeny

func (x *ExamplesRestrictionsNamespace) GetDeny() []string

func (*ExamplesRestrictionsNamespace) GetNamespaceName

func (x *ExamplesRestrictionsNamespace) GetNamespaceName() string

func (*ExamplesRestrictionsNamespace) ProtoMessage

func (*ExamplesRestrictionsNamespace) ProtoMessage()

func (*ExamplesRestrictionsNamespace) ProtoReflect

func (*ExamplesRestrictionsNamespace) Reset

func (x *ExamplesRestrictionsNamespace) Reset()

func (*ExamplesRestrictionsNamespace) String

type Examples_ExampleGcsSource

type Examples_ExampleGcsSource struct {

	// The format in which instances are given, if not specified, assume it's
	// JSONL format. Currently only JSONL format is supported.
	DataFormat Examples_ExampleGcsSource_DataFormat `` /* 166-byte string literal not displayed */
	// The Cloud Storage location for the input instances.
	GcsSource *GcsSource `protobuf:"bytes,2,opt,name=gcs_source,json=gcsSource,proto3" json:"gcs_source,omitempty"`
	// contains filtered or unexported fields
}

The Cloud Storage input instances.

func (*Examples_ExampleGcsSource) Descriptor deprecated

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

Deprecated: Use Examples_ExampleGcsSource.ProtoReflect.Descriptor instead.

func (*Examples_ExampleGcsSource) GetDataFormat

func (*Examples_ExampleGcsSource) GetGcsSource

func (x *Examples_ExampleGcsSource) GetGcsSource() *GcsSource

func (*Examples_ExampleGcsSource) ProtoMessage

func (*Examples_ExampleGcsSource) ProtoMessage()

func (*Examples_ExampleGcsSource) ProtoReflect

func (*Examples_ExampleGcsSource) Reset

func (x *Examples_ExampleGcsSource) Reset()

func (*Examples_ExampleGcsSource) String

func (x *Examples_ExampleGcsSource) String() string

type Examples_ExampleGcsSource_

type Examples_ExampleGcsSource_ struct {
	// The Cloud Storage input instances.
	ExampleGcsSource *Examples_ExampleGcsSource `protobuf:"bytes,5,opt,name=example_gcs_source,json=exampleGcsSource,proto3,oneof"`
}

type Examples_ExampleGcsSource_DataFormat

type Examples_ExampleGcsSource_DataFormat int32

The format of the input example instances.

const (
	// Format unspecified, used when unset.
	Examples_ExampleGcsSource_DATA_FORMAT_UNSPECIFIED Examples_ExampleGcsSource_DataFormat = 0
	// Examples are stored in JSONL files.
	Examples_ExampleGcsSource_JSONL Examples_ExampleGcsSource_DataFormat = 1
)

func (Examples_ExampleGcsSource_DataFormat) Descriptor

func (Examples_ExampleGcsSource_DataFormat) Enum

func (Examples_ExampleGcsSource_DataFormat) EnumDescriptor deprecated

func (Examples_ExampleGcsSource_DataFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use Examples_ExampleGcsSource_DataFormat.Descriptor instead.

func (Examples_ExampleGcsSource_DataFormat) Number

func (Examples_ExampleGcsSource_DataFormat) String

func (Examples_ExampleGcsSource_DataFormat) Type

type Examples_NearestNeighborSearchConfig

type Examples_NearestNeighborSearchConfig struct {
	// The full configuration for the generated index, the semantics are the
	// same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and
	// should match
	// [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
	NearestNeighborSearchConfig *structpb.Value `protobuf:"bytes,2,opt,name=nearest_neighbor_search_config,json=nearestNeighborSearchConfig,proto3,oneof"`
}

type Examples_Presets

type Examples_Presets struct {
	// Simplified preset configuration, which automatically sets configuration
	// values based on the desired query speed-precision trade-off and modality.
	Presets *Presets `protobuf:"bytes,4,opt,name=presets,proto3,oneof"`
}

type Execution

type Execution struct {

	// Output only. The resource name of the Execution.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// User provided display name of the Execution.
	// May be up to 128 Unicode characters.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The state of this Execution. This is a property of the Execution, and does
	// not imply or capture any ongoing process. This property is managed by
	// clients (such as Vertex AI Pipelines) and the system does not prescribe
	// or check the validity of state transitions.
	State Execution_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.cloud.aiplatform.v1beta1.Execution_State" json:"state,omitempty"`
	// An eTag used to perform consistent read-modify-write updates. If not set, a
	// blind "overwrite" update happens.
	Etag string `protobuf:"bytes,9,opt,name=etag,proto3" json:"etag,omitempty"`
	// The labels with user-defined metadata to organize your Executions.
	//
	// Label keys and values can be no longer than 64 characters
	// (Unicode codepoints), can only contain lowercase letters, numeric
	// characters, underscores and dashes. International characters are allowed.
	// No more than 64 user labels can be associated with one Execution (System
	// labels are excluded).
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Output only. Timestamp when this Execution was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp when this Execution was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The title of the schema describing the metadata.
	//
	// Schema title and version is expected to be registered in earlier Create
	// Schema calls. And both are used together as unique identifiers to identify
	// schemas within the local metadata store.
	SchemaTitle string `protobuf:"bytes,13,opt,name=schema_title,json=schemaTitle,proto3" json:"schema_title,omitempty"`
	// The version of the schema in `schema_title` to use.
	//
	// Schema title and version is expected to be registered in earlier Create
	// Schema calls. And both are used together as unique identifiers to identify
	// schemas within the local metadata store.
	SchemaVersion string `protobuf:"bytes,14,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`
	// Properties of the Execution.
	// Top level metadata keys' heading and trailing spaces will be trimmed.
	// The size of this field should not exceed 200KB.
	Metadata *structpb.Struct `protobuf:"bytes,15,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Description of the Execution
	Description string `protobuf:"bytes,16,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Instance of a general execution.

func (*Execution) Descriptor deprecated

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

Deprecated: Use Execution.ProtoReflect.Descriptor instead.

func (*Execution) GetCreateTime

func (x *Execution) GetCreateTime() *timestamppb.Timestamp

func (*Execution) GetDescription

func (x *Execution) GetDescription() string

func (*Execution) GetDisplayName

func (x *Execution) GetDisplayName() string

func (*Execution) GetEtag

func (x *Execution) GetEtag() string

func (*Execution) GetLabels

func (x *Execution) GetLabels() map[string]string

func (*Execution) GetMetadata

func (x *Execution) GetMetadata() *structpb.Struct

func (*Execution) GetName

func (x *Execution) GetName() string

func (*Execution) GetSchemaTitle

func (x *Execution) GetSchemaTitle() string

func (*Execution) GetSchemaVersion

func (x *Execution) GetSchemaVersion() string

func (*Execution) GetState

func (x *Execution) GetState() Execution_State

func (*Execution) GetUpdateTime

func (x *Execution) GetUpdateTime() *timestamppb.Timestamp

func (*Execution) ProtoMessage

func (*Execution) ProtoMessage()

func (*Execution) ProtoReflect

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

func (*Execution) Reset

func (x *Execution) Reset()

func (*Execution) String

func (x *Execution) String() string

type Execution_State

type Execution_State int32

Describes the state of the Execution.

const (
	// Unspecified Execution state
	Execution_STATE_UNSPECIFIED Execution_State = 0
	// The Execution is new
	Execution_NEW Execution_State = 1
	// The Execution is running
	Execution_RUNNING Execution_State = 2
	// The Execution has finished running
	Execution_COMPLETE Execution_State = 3
	// The Execution has failed
	Execution_FAILED Execution_State = 4
	// The Execution completed through Cache hit.
	Execution_CACHED Execution_State = 5
	// The Execution was cancelled.
	Execution_CANCELLED Execution_State = 6
)

func (Execution_State) Descriptor

func (Execution_State) Enum

func (x Execution_State) Enum() *Execution_State

func (Execution_State) EnumDescriptor deprecated

func (Execution_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Execution_State.Descriptor instead.

func (Execution_State) Number

func (Execution_State) String

func (x Execution_State) String() string

func (Execution_State) Type

type ExplainRequest

type ExplainRequest struct {

	// Required. The name of the Endpoint requested to serve the explanation.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Required. The instances that are the input to the explanation call.
	// A DeployedModel may have an upper limit on the number of instances it
	// supports per request, and when it is exceeded the explanation call errors
	// in case of AutoML Models, or, in case of customer created Models, the
	// behaviour is as documented by that Model.
	// The schema of any single instance may be specified via Endpoint's
	// DeployedModels'
	// [Model's][google.cloud.aiplatform.v1beta1.DeployedModel.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
	// [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
	Instances []*structpb.Value `protobuf:"bytes,2,rep,name=instances,proto3" json:"instances,omitempty"`
	// The parameters that govern the prediction. The schema of the parameters may
	// be specified via Endpoint's DeployedModels' [Model's
	// ][google.cloud.aiplatform.v1beta1.DeployedModel.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
	// [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
	Parameters *structpb.Value `protobuf:"bytes,4,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// If specified, overrides the
	// [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec]
	// of the DeployedModel. Can be used for explaining prediction results with
	// different configurations, such as:
	//  - Explaining top-5 predictions results as opposed to top-1;
	//  - Increasing path count or step count of the attribution methods to reduce
	//    approximate errors;
	//  - Using different baselines for explaining the prediction results.
	ExplanationSpecOverride *ExplanationSpecOverride `` /* 132-byte string literal not displayed */
	// Optional. This field is the same as the one above, but supports multiple
	// explanations to occur in parallel. The key can be any string. Each override
	// will be run against the model, then its explanations will be grouped
	// together.
	//
	// Note - these explanations are run **In Addition** to the default
	// Explanation in the deployed model.
	ConcurrentExplanationSpecOverride map[string]*ExplanationSpecOverride `` /* 252-byte string literal not displayed */
	// If specified, this ExplainRequest will be served by the chosen
	// DeployedModel, overriding
	// [Endpoint.traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split].
	DeployedModelId string `protobuf:"bytes,3,opt,name=deployed_model_id,json=deployedModelId,proto3" json:"deployed_model_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].

func (*ExplainRequest) Descriptor deprecated

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

Deprecated: Use ExplainRequest.ProtoReflect.Descriptor instead.

func (*ExplainRequest) GetConcurrentExplanationSpecOverride

func (x *ExplainRequest) GetConcurrentExplanationSpecOverride() map[string]*ExplanationSpecOverride

func (*ExplainRequest) GetDeployedModelId

func (x *ExplainRequest) GetDeployedModelId() string

func (*ExplainRequest) GetEndpoint

func (x *ExplainRequest) GetEndpoint() string

func (*ExplainRequest) GetExplanationSpecOverride

func (x *ExplainRequest) GetExplanationSpecOverride() *ExplanationSpecOverride

func (*ExplainRequest) GetInstances

func (x *ExplainRequest) GetInstances() []*structpb.Value

func (*ExplainRequest) GetParameters

func (x *ExplainRequest) GetParameters() *structpb.Value

func (*ExplainRequest) ProtoMessage

func (*ExplainRequest) ProtoMessage()

func (*ExplainRequest) ProtoReflect

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

func (*ExplainRequest) Reset

func (x *ExplainRequest) Reset()

func (*ExplainRequest) String

func (x *ExplainRequest) String() string

type ExplainResponse

type ExplainResponse struct {

	// The explanations of the Model's
	// [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].
	//
	// It has the same number of elements as
	// [instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] to be
	// explained.
	Explanations []*Explanation `protobuf:"bytes,1,rep,name=explanations,proto3" json:"explanations,omitempty"`
	// This field stores the results of the explanations run in parallel with
	// The default explanation strategy/method.
	ConcurrentExplanations map[string]*ExplainResponse_ConcurrentExplanation `` /* 215-byte string literal not displayed */
	// ID of the Endpoint's DeployedModel that served this explanation.
	DeployedModelId string `protobuf:"bytes,2,opt,name=deployed_model_id,json=deployedModelId,proto3" json:"deployed_model_id,omitempty"`
	// The predictions that are the output of the predictions call.
	// Same as
	// [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].
	Predictions []*structpb.Value `protobuf:"bytes,3,rep,name=predictions,proto3" json:"predictions,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].

func (*ExplainResponse) Descriptor deprecated

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

Deprecated: Use ExplainResponse.ProtoReflect.Descriptor instead.

func (*ExplainResponse) GetConcurrentExplanations

func (x *ExplainResponse) GetConcurrentExplanations() map[string]*ExplainResponse_ConcurrentExplanation

func (*ExplainResponse) GetDeployedModelId

func (x *ExplainResponse) GetDeployedModelId() string

func (*ExplainResponse) GetExplanations

func (x *ExplainResponse) GetExplanations() []*Explanation

func (*ExplainResponse) GetPredictions

func (x *ExplainResponse) GetPredictions() []*structpb.Value

func (*ExplainResponse) ProtoMessage

func (*ExplainResponse) ProtoMessage()

func (*ExplainResponse) ProtoReflect

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

func (*ExplainResponse) Reset

func (x *ExplainResponse) Reset()

func (*ExplainResponse) String

func (x *ExplainResponse) String() string

type ExplainResponse_ConcurrentExplanation

type ExplainResponse_ConcurrentExplanation struct {

	// The explanations of the Model's
	// [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].
	//
	// It has the same number of elements as
	// [instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] to
	// be explained.
	Explanations []*Explanation `protobuf:"bytes,1,rep,name=explanations,proto3" json:"explanations,omitempty"`
	// contains filtered or unexported fields
}

This message is a wrapper grouping Concurrent Explanations.

func (*ExplainResponse_ConcurrentExplanation) Descriptor deprecated

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

Deprecated: Use ExplainResponse_ConcurrentExplanation.ProtoReflect.Descriptor instead.

func (*ExplainResponse_ConcurrentExplanation) GetExplanations

func (x *ExplainResponse_ConcurrentExplanation) GetExplanations() []*Explanation

func (*ExplainResponse_ConcurrentExplanation) ProtoMessage

func (*ExplainResponse_ConcurrentExplanation) ProtoMessage()

func (*ExplainResponse_ConcurrentExplanation) ProtoReflect

func (*ExplainResponse_ConcurrentExplanation) Reset

func (*ExplainResponse_ConcurrentExplanation) String

type Explanation

type Explanation struct {

	// Output only. Feature attributions grouped by predicted outputs.
	//
	// For Models that predict only one output, such as regression Models that
	// predict only one score, there is only one attibution that explains the
	// predicted output. For Models that predict multiple outputs, such as
	// multiclass Models that predict multiple classes, each element explains one
	// specific item.
	// [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]
	// can be used to identify which output this attribution is explaining.
	//
	// If users set
	// [ExplanationParameters.top_k][google.cloud.aiplatform.v1beta1.ExplanationParameters.top_k],
	// the attributions are sorted by
	// [instance_output_value][Attributions.instance_output_value] in descending
	// order. If
	// [ExplanationParameters.output_indices][google.cloud.aiplatform.v1beta1.ExplanationParameters.output_indices]
	// is specified, the attributions are stored by
	// [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]
	// in the same order as they appear in the output_indices.
	Attributions []*Attribution `protobuf:"bytes,1,rep,name=attributions,proto3" json:"attributions,omitempty"`
	// Output only. List of the nearest neighbors for example-based explanations.
	//
	// For models deployed with the examples explanations feature enabled, the
	// attributions field is empty and instead the neighbors field is populated.
	Neighbors []*Neighbor `protobuf:"bytes,2,rep,name=neighbors,proto3" json:"neighbors,omitempty"`
	// contains filtered or unexported fields
}

Explanation of a prediction (provided in [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions]) produced by the Model on a given [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances].

func (*Explanation) Descriptor deprecated

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

Deprecated: Use Explanation.ProtoReflect.Descriptor instead.

func (*Explanation) GetAttributions

func (x *Explanation) GetAttributions() []*Attribution

func (*Explanation) GetNeighbors

func (x *Explanation) GetNeighbors() []*Neighbor

func (*Explanation) ProtoMessage

func (*Explanation) ProtoMessage()

func (*Explanation) ProtoReflect

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

func (*Explanation) Reset

func (x *Explanation) Reset()

func (*Explanation) String

func (x *Explanation) String() string

type ExplanationMetadata

type ExplanationMetadata struct {

	// Required. Map from feature names to feature input metadata. Keys are the
	// name of the features. Values are the specification of the feature.
	//
	// An empty InputMetadata is valid. It describes a text feature which has the
	// name specified as the key in
	// [ExplanationMetadata.inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs].
	// The baseline of the empty feature is chosen by Vertex AI.
	//
	// For Vertex AI-provided Tensorflow images, the key can be any friendly
	// name of the feature. Once specified,
	// [featureAttributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions]
	// are keyed by this key (if not grouped with another feature).
	//
	// For custom images, the key must match with the key in
	// [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances].
	Inputs map[string]*ExplanationMetadata_InputMetadata `` /* 153-byte string literal not displayed */
	// Required. Map from output names to output metadata.
	//
	// For Vertex AI-provided Tensorflow images, keys can be any user defined
	// string that consists of any UTF-8 characters.
	//
	// For custom images, keys are the name of the output field in the prediction
	// to be explained.
	//
	// Currently only one key is allowed.
	Outputs map[string]*ExplanationMetadata_OutputMetadata `` /* 155-byte string literal not displayed */
	// Points to a YAML file stored on Google Cloud Storage describing the format
	// of the [feature
	// attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions].
	// The schema is defined as an OpenAPI 3.0.2 [Schema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
	// AutoML tabular Models always have this field populated by Vertex AI.
	// Note: The URI given on output may be different, including the URI scheme,
	// than the one given on input. The output URI will point to a location where
	// the user only has a read access.
	FeatureAttributionsSchemaUri string `` /* 149-byte string literal not displayed */
	// Name of the source to generate embeddings for example based explanations.
	LatentSpaceSource string `protobuf:"bytes,5,opt,name=latent_space_source,json=latentSpaceSource,proto3" json:"latent_space_source,omitempty"`
	// contains filtered or unexported fields
}

Metadata describing the Model's input and output for explanation.

func (*ExplanationMetadata) Descriptor deprecated

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

Deprecated: Use ExplanationMetadata.ProtoReflect.Descriptor instead.

func (*ExplanationMetadata) GetFeatureAttributionsSchemaUri

func (x *ExplanationMetadata) GetFeatureAttributionsSchemaUri() string

func (*ExplanationMetadata) GetInputs

func (*ExplanationMetadata) GetLatentSpaceSource

func (x *ExplanationMetadata) GetLatentSpaceSource() string

func (*ExplanationMetadata) GetOutputs

func (*ExplanationMetadata) ProtoMessage

func (*ExplanationMetadata) ProtoMessage()

func (*ExplanationMetadata) ProtoReflect

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

func (*ExplanationMetadata) Reset

func (x *ExplanationMetadata) Reset()

func (*ExplanationMetadata) String

func (x *ExplanationMetadata) String() string

type ExplanationMetadataOverride

type ExplanationMetadataOverride struct {

	// Required. Overrides the [input
	// metadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs] of
	// the features. The key is the name of the feature to be overridden. The keys
	// specified here must exist in the input metadata to be overridden. If a
	// feature is not specified here, the corresponding feature's input metadata
	// is not overridden.
	Inputs map[string]*ExplanationMetadataOverride_InputMetadataOverride `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

The ExplanationMetadata[google.cloud.aiplatform.v1beta1.ExplanationMetadata] entries that can be overridden at [online explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time.

func (*ExplanationMetadataOverride) Descriptor deprecated

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

Deprecated: Use ExplanationMetadataOverride.ProtoReflect.Descriptor instead.

func (*ExplanationMetadataOverride) GetInputs

func (*ExplanationMetadataOverride) ProtoMessage

func (*ExplanationMetadataOverride) ProtoMessage()

func (*ExplanationMetadataOverride) ProtoReflect

func (*ExplanationMetadataOverride) Reset

func (x *ExplanationMetadataOverride) Reset()

func (*ExplanationMetadataOverride) String

func (x *ExplanationMetadataOverride) String() string

type ExplanationMetadataOverride_InputMetadataOverride

type ExplanationMetadataOverride_InputMetadataOverride struct {

	// Baseline inputs for this feature.
	//
	// This overrides the `input_baseline` field of the
	// [ExplanationMetadata.InputMetadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata]
	// object of the corresponding feature's input metadata. If it's not
	// specified, the original baselines are not overridden.
	InputBaselines []*structpb.Value `protobuf:"bytes,1,rep,name=input_baselines,json=inputBaselines,proto3" json:"input_baselines,omitempty"`
	// contains filtered or unexported fields
}

The [input metadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata] entries to be overridden.

func (*ExplanationMetadataOverride_InputMetadataOverride) Descriptor deprecated

Deprecated: Use ExplanationMetadataOverride_InputMetadataOverride.ProtoReflect.Descriptor instead.

func (*ExplanationMetadataOverride_InputMetadataOverride) GetInputBaselines

func (*ExplanationMetadataOverride_InputMetadataOverride) ProtoMessage

func (*ExplanationMetadataOverride_InputMetadataOverride) ProtoReflect

func (*ExplanationMetadataOverride_InputMetadataOverride) Reset

func (*ExplanationMetadataOverride_InputMetadataOverride) String

type ExplanationMetadata_InputMetadata

type ExplanationMetadata_InputMetadata struct {

	// Baseline inputs for this feature.
	//
	// If no baseline is specified, Vertex AI chooses the baseline for this
	// feature. If multiple baselines are specified, Vertex AI returns the
	// average attributions across them in
	// [Attribution.feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions].
	//
	// For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape
	// of each baseline must match the shape of the input tensor. If a scalar is
	// provided, we broadcast to the same shape as the input tensor.
	//
	// For custom images, the element of the baselines must be in the same
	// format as the feature's input in the
	// [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances][].
	// The schema of any single instance may be specified via Endpoint's
	// DeployedModels'
	// [Model's][google.cloud.aiplatform.v1beta1.DeployedModel.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
	// [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
	InputBaselines []*structpb.Value `protobuf:"bytes,1,rep,name=input_baselines,json=inputBaselines,proto3" json:"input_baselines,omitempty"`
	// Name of the input tensor for this feature. Required and is only
	// applicable to Vertex AI-provided images for Tensorflow.
	InputTensorName string `protobuf:"bytes,2,opt,name=input_tensor_name,json=inputTensorName,proto3" json:"input_tensor_name,omitempty"`
	// Defines how the feature is encoded into the input tensor. Defaults to
	// IDENTITY.
	Encoding ExplanationMetadata_InputMetadata_Encoding `` /* 150-byte string literal not displayed */
	// Modality of the feature. Valid values are: numeric, image. Defaults to
	// numeric.
	Modality string `protobuf:"bytes,4,opt,name=modality,proto3" json:"modality,omitempty"`
	// The domain details of the input feature value. Like min/max, original
	// mean or standard deviation if normalized.
	FeatureValueDomain *ExplanationMetadata_InputMetadata_FeatureValueDomain `protobuf:"bytes,5,opt,name=feature_value_domain,json=featureValueDomain,proto3" json:"feature_value_domain,omitempty"`
	// Specifies the index of the values of the input tensor.
	// Required when the input tensor is a sparse representation. Refer to
	// Tensorflow documentation for more details:
	// https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
	IndicesTensorName string `protobuf:"bytes,6,opt,name=indices_tensor_name,json=indicesTensorName,proto3" json:"indices_tensor_name,omitempty"`
	// Specifies the shape of the values of the input if the input is a sparse
	// representation. Refer to Tensorflow documentation for more details:
	// https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
	DenseShapeTensorName string `protobuf:"bytes,7,opt,name=dense_shape_tensor_name,json=denseShapeTensorName,proto3" json:"dense_shape_tensor_name,omitempty"`
	// A list of feature names for each index in the input tensor.
	// Required when the input
	// [InputMetadata.encoding][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoding]
	// is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
	IndexFeatureMapping []string `protobuf:"bytes,8,rep,name=index_feature_mapping,json=indexFeatureMapping,proto3" json:"index_feature_mapping,omitempty"`
	// Encoded tensor is a transformation of the input tensor. Must be provided
	// if choosing
	// [Integrated Gradients
	// attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution]
	// or [XRAI
	// attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution]
	// and the input tensor is not differentiable.
	//
	// An encoded tensor is generated if the input tensor is encoded by a lookup
	// table.
	EncodedTensorName string `protobuf:"bytes,9,opt,name=encoded_tensor_name,json=encodedTensorName,proto3" json:"encoded_tensor_name,omitempty"`
	// A list of baselines for the encoded tensor.
	//
	// The shape of each baseline should match the shape of the encoded tensor.
	// If a scalar is provided, Vertex AI broadcasts to the same shape as the
	// encoded tensor.
	EncodedBaselines []*structpb.Value `protobuf:"bytes,10,rep,name=encoded_baselines,json=encodedBaselines,proto3" json:"encoded_baselines,omitempty"`
	// Visualization configurations for image explanation.
	Visualization *ExplanationMetadata_InputMetadata_Visualization `protobuf:"bytes,11,opt,name=visualization,proto3" json:"visualization,omitempty"`
	// Name of the group that the input belongs to. Features with the same group
	// name will be treated as one feature when computing attributions. Features
	// grouped together can have different shapes in value. If provided, there
	// will be one single attribution generated in
	// [Attribution.feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions],
	// keyed by the group name.
	GroupName string `protobuf:"bytes,12,opt,name=group_name,json=groupName,proto3" json:"group_name,omitempty"`
	// contains filtered or unexported fields
}

Metadata of the input of a feature.

Fields other than [InputMetadata.input_baselines][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.input_baselines] are applicable only for Models that are using Vertex AI-provided images for Tensorflow.

func (*ExplanationMetadata_InputMetadata) Descriptor deprecated

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

Deprecated: Use ExplanationMetadata_InputMetadata.ProtoReflect.Descriptor instead.

func (*ExplanationMetadata_InputMetadata) GetDenseShapeTensorName

func (x *ExplanationMetadata_InputMetadata) GetDenseShapeTensorName() string

func (*ExplanationMetadata_InputMetadata) GetEncodedBaselines

func (x *ExplanationMetadata_InputMetadata) GetEncodedBaselines() []*structpb.Value

func (*ExplanationMetadata_InputMetadata) GetEncodedTensorName

func (x *ExplanationMetadata_InputMetadata) GetEncodedTensorName() string

func (*ExplanationMetadata_InputMetadata) GetEncoding

func (*ExplanationMetadata_InputMetadata) GetFeatureValueDomain

func (*ExplanationMetadata_InputMetadata) GetGroupName

func (x *ExplanationMetadata_InputMetadata) GetGroupName() string

func (*ExplanationMetadata_InputMetadata) GetIndexFeatureMapping

func (x *ExplanationMetadata_InputMetadata) GetIndexFeatureMapping() []string

func (*ExplanationMetadata_InputMetadata) GetIndicesTensorName

func (x *ExplanationMetadata_InputMetadata) GetIndicesTensorName() string

func (*ExplanationMetadata_InputMetadata) GetInputBaselines

func (x *ExplanationMetadata_InputMetadata) GetInputBaselines() []*structpb.Value

func (*ExplanationMetadata_InputMetadata) GetInputTensorName

func (x *ExplanationMetadata_InputMetadata) GetInputTensorName() string

func (*ExplanationMetadata_InputMetadata) GetModality

func (x *ExplanationMetadata_InputMetadata) GetModality() string

func (*ExplanationMetadata_InputMetadata) GetVisualization

func (*ExplanationMetadata_InputMetadata) ProtoMessage

func (*ExplanationMetadata_InputMetadata) ProtoMessage()

func (*ExplanationMetadata_InputMetadata) ProtoReflect

func (*ExplanationMetadata_InputMetadata) Reset

func (*ExplanationMetadata_InputMetadata) String

type ExplanationMetadata_InputMetadata_Encoding

type ExplanationMetadata_InputMetadata_Encoding int32

Defines how a feature is encoded. Defaults to IDENTITY.

const (
	// Default value. This is the same as IDENTITY.
	ExplanationMetadata_InputMetadata_ENCODING_UNSPECIFIED ExplanationMetadata_InputMetadata_Encoding = 0
	// The tensor represents one feature.
	ExplanationMetadata_InputMetadata_IDENTITY ExplanationMetadata_InputMetadata_Encoding = 1
	// The tensor represents a bag of features where each index maps to
	// a feature.
	// [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping]
	// must be provided for this encoding. For example:
	// “`
	// input = [27, 6.0, 150]
	// index_feature_mapping = ["age", "height", "weight"]
	// “`
	ExplanationMetadata_InputMetadata_BAG_OF_FEATURES ExplanationMetadata_InputMetadata_Encoding = 2
	// The tensor represents a bag of features where each index maps to a
	// feature. Zero values in the tensor indicates feature being
	// non-existent.
	// [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping]
	// must be provided for this encoding. For example:
	// “`
	// input = [2, 0, 5, 0, 1]
	// index_feature_mapping = ["a", "b", "c", "d", "e"]
	// “`
	ExplanationMetadata_InputMetadata_BAG_OF_FEATURES_SPARSE ExplanationMetadata_InputMetadata_Encoding = 3
	// The tensor is a list of binaries representing whether a feature exists
	// or not (1 indicates existence).
	// [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping]
	// must be provided for this encoding. For example:
	// “`
	// input = [1, 0, 1, 0, 1]
	// index_feature_mapping = ["a", "b", "c", "d", "e"]
	// “`
	ExplanationMetadata_InputMetadata_INDICATOR ExplanationMetadata_InputMetadata_Encoding = 4
	// The tensor is encoded into a 1-dimensional array represented by an
	// encoded tensor.
	// [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoded_tensor_name]
	// must be provided for this encoding. For example:
	// “`
	// input = ["This", "is", "a", "test", "."]
	// encoded = [0.1, 0.2, 0.3, 0.4, 0.5]
	// “`
	ExplanationMetadata_InputMetadata_COMBINED_EMBEDDING ExplanationMetadata_InputMetadata_Encoding = 5
	// Select this encoding when the input tensor is encoded into a
	// 2-dimensional array represented by an encoded tensor.
	// [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoded_tensor_name]
	// must be provided for this encoding. The first dimension of the encoded
	// tensor's shape is the same as the input tensor's shape. For example:
	// “`
	// input = ["This", "is", "a", "test", "."]
	// encoded = [[0.1, 0.2, 0.3, 0.4, 0.5],
	//            [0.2, 0.1, 0.4, 0.3, 0.5],
	//            [0.5, 0.1, 0.3, 0.5, 0.4],
	//            [0.5, 0.3, 0.1, 0.2, 0.4],
	//            [0.4, 0.3, 0.2, 0.5, 0.1]]
	// “`
	ExplanationMetadata_InputMetadata_CONCAT_EMBEDDING ExplanationMetadata_InputMetadata_Encoding = 6
)

func (ExplanationMetadata_InputMetadata_Encoding) Descriptor

func (ExplanationMetadata_InputMetadata_Encoding) Enum

func (ExplanationMetadata_InputMetadata_Encoding) EnumDescriptor deprecated

func (ExplanationMetadata_InputMetadata_Encoding) EnumDescriptor() ([]byte, []int)

Deprecated: Use ExplanationMetadata_InputMetadata_Encoding.Descriptor instead.

func (ExplanationMetadata_InputMetadata_Encoding) Number

func (ExplanationMetadata_InputMetadata_Encoding) String

func (ExplanationMetadata_InputMetadata_Encoding) Type

type ExplanationMetadata_InputMetadata_FeatureValueDomain

type ExplanationMetadata_InputMetadata_FeatureValueDomain struct {

	// The minimum permissible value for this feature.
	MinValue float32 `protobuf:"fixed32,1,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
	// The maximum permissible value for this feature.
	MaxValue float32 `protobuf:"fixed32,2,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
	// If this input feature has been normalized to a mean value of 0,
	// the original_mean specifies the mean value of the domain prior to
	// normalization.
	OriginalMean float32 `protobuf:"fixed32,3,opt,name=original_mean,json=originalMean,proto3" json:"original_mean,omitempty"`
	// If this input feature has been normalized to a standard deviation of
	// 1.0, the original_stddev specifies the standard deviation of the domain
	// prior to normalization.
	OriginalStddev float32 `protobuf:"fixed32,4,opt,name=original_stddev,json=originalStddev,proto3" json:"original_stddev,omitempty"`
	// contains filtered or unexported fields
}

Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained.

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) Descriptor deprecated

Deprecated: Use ExplanationMetadata_InputMetadata_FeatureValueDomain.ProtoReflect.Descriptor instead.

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) GetMaxValue

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) GetMinValue

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) GetOriginalMean

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) GetOriginalStddev

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) ProtoMessage

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) ProtoReflect

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) Reset

func (*ExplanationMetadata_InputMetadata_FeatureValueDomain) String

type ExplanationMetadata_InputMetadata_Visualization

type ExplanationMetadata_InputMetadata_Visualization struct {

	// Type of the image visualization. Only applicable to
	// [Integrated Gradients
	// attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution].
	// OUTLINES shows regions of attribution, while PIXELS shows per-pixel
	// attribution. Defaults to OUTLINES.
	Type ExplanationMetadata_InputMetadata_Visualization_Type `` /* 152-byte string literal not displayed */
	// Whether to only highlight pixels with positive contributions, negative
	// or both. Defaults to POSITIVE.
	Polarity ExplanationMetadata_InputMetadata_Visualization_Polarity `` /* 164-byte string literal not displayed */
	// The color scheme used for the highlighted areas.
	//
	// Defaults to PINK_GREEN for
	// [Integrated Gradients
	// attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution],
	// which shows positive attributions in green and negative in pink.
	//
	// Defaults to VIRIDIS for
	// [XRAI
	// attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution],
	// which highlights the most influential regions in yellow and the least
	// influential in blue.
	ColorMap ExplanationMetadata_InputMetadata_Visualization_ColorMap `` /* 180-byte string literal not displayed */
	// Excludes attributions above the specified percentile from the
	// highlighted areas. Using the clip_percent_upperbound and
	// clip_percent_lowerbound together can be useful for filtering out noise
	// and making it easier to see areas of strong attribution. Defaults to
	// 99.9.
	ClipPercentUpperbound float32 `` /* 128-byte string literal not displayed */
	// Excludes attributions below the specified percentile, from the
	// highlighted areas. Defaults to 62.
	ClipPercentLowerbound float32 `` /* 128-byte string literal not displayed */
	// How the original image is displayed in the visualization.
	// Adjusting the overlay can help increase visual clarity if the original
	// image makes it difficult to view the visualization. Defaults to NONE.
	OverlayType ExplanationMetadata_InputMetadata_Visualization_OverlayType `` /* 192-byte string literal not displayed */
	// contains filtered or unexported fields
}

Visualization configurations for image explanation.

func (*ExplanationMetadata_InputMetadata_Visualization) Descriptor deprecated

Deprecated: Use ExplanationMetadata_InputMetadata_Visualization.ProtoReflect.Descriptor instead.

func (*ExplanationMetadata_InputMetadata_Visualization) GetClipPercentLowerbound

func (x *ExplanationMetadata_InputMetadata_Visualization) GetClipPercentLowerbound() float32

func (*ExplanationMetadata_InputMetadata_Visualization) GetClipPercentUpperbound

func (x *ExplanationMetadata_InputMetadata_Visualization) GetClipPercentUpperbound() float32

func (*ExplanationMetadata_InputMetadata_Visualization) GetColorMap

func (*ExplanationMetadata_InputMetadata_Visualization) GetOverlayType

func (*ExplanationMetadata_InputMetadata_Visualization) GetPolarity

func (*ExplanationMetadata_InputMetadata_Visualization) GetType

func (*ExplanationMetadata_InputMetadata_Visualization) ProtoMessage

func (*ExplanationMetadata_InputMetadata_Visualization) ProtoReflect

func (*ExplanationMetadata_InputMetadata_Visualization) Reset

func (*ExplanationMetadata_InputMetadata_Visualization) String

type ExplanationMetadata_InputMetadata_Visualization_ColorMap

type ExplanationMetadata_InputMetadata_Visualization_ColorMap int32

The color scheme used for highlighting areas.

const (
	// Should not be used.
	ExplanationMetadata_InputMetadata_Visualization_COLOR_MAP_UNSPECIFIED ExplanationMetadata_InputMetadata_Visualization_ColorMap = 0
	// Positive: green. Negative: pink.
	ExplanationMetadata_InputMetadata_Visualization_PINK_GREEN ExplanationMetadata_InputMetadata_Visualization_ColorMap = 1
	// Viridis color map: A perceptually uniform color mapping which is
	// easier to see by those with colorblindness and progresses from yellow
	// to green to blue. Positive: yellow. Negative: blue.
	ExplanationMetadata_InputMetadata_Visualization_VIRIDIS ExplanationMetadata_InputMetadata_Visualization_ColorMap = 2
	// Positive: red. Negative: red.
	ExplanationMetadata_InputMetadata_Visualization_RED ExplanationMetadata_InputMetadata_Visualization_ColorMap = 3
	// Positive: green. Negative: green.
	ExplanationMetadata_InputMetadata_Visualization_GREEN ExplanationMetadata_InputMetadata_Visualization_ColorMap = 4
	// Positive: green. Negative: red.
	ExplanationMetadata_InputMetadata_Visualization_RED_GREEN ExplanationMetadata_InputMetadata_Visualization_ColorMap = 6
	// PiYG palette.
	ExplanationMetadata_InputMetadata_Visualization_PINK_WHITE_GREEN ExplanationMetadata_InputMetadata_Visualization_ColorMap = 5
)

func (ExplanationMetadata_InputMetadata_Visualization_ColorMap) Descriptor

func (ExplanationMetadata_InputMetadata_Visualization_ColorMap) Enum

func (ExplanationMetadata_InputMetadata_Visualization_ColorMap) EnumDescriptor deprecated

Deprecated: Use ExplanationMetadata_InputMetadata_Visualization_ColorMap.Descriptor instead.

func (ExplanationMetadata_InputMetadata_Visualization_ColorMap) Number

func (ExplanationMetadata_InputMetadata_Visualization_ColorMap) String

func (ExplanationMetadata_InputMetadata_Visualization_ColorMap) Type

type ExplanationMetadata_InputMetadata_Visualization_OverlayType

type ExplanationMetadata_InputMetadata_Visualization_OverlayType int32

How the original image is displayed in the visualization.

const (
	// Default value. This is the same as NONE.
	ExplanationMetadata_InputMetadata_Visualization_OVERLAY_TYPE_UNSPECIFIED ExplanationMetadata_InputMetadata_Visualization_OverlayType = 0
	// No overlay.
	ExplanationMetadata_InputMetadata_Visualization_NONE ExplanationMetadata_InputMetadata_Visualization_OverlayType = 1
	// The attributions are shown on top of the original image.
	ExplanationMetadata_InputMetadata_Visualization_ORIGINAL ExplanationMetadata_InputMetadata_Visualization_OverlayType = 2
	// The attributions are shown on top of grayscaled version of the
	// original image.
	ExplanationMetadata_InputMetadata_Visualization_GRAYSCALE ExplanationMetadata_InputMetadata_Visualization_OverlayType = 3
	// The attributions are used as a mask to reveal predictive parts of
	// the image and hide the un-predictive parts.
	ExplanationMetadata_InputMetadata_Visualization_MASK_BLACK ExplanationMetadata_InputMetadata_Visualization_OverlayType = 4
)

func (ExplanationMetadata_InputMetadata_Visualization_OverlayType) Descriptor

func (ExplanationMetadata_InputMetadata_Visualization_OverlayType) Enum

func (ExplanationMetadata_InputMetadata_Visualization_OverlayType) EnumDescriptor deprecated

Deprecated: Use ExplanationMetadata_InputMetadata_Visualization_OverlayType.Descriptor instead.

func (ExplanationMetadata_InputMetadata_Visualization_OverlayType) Number

func (ExplanationMetadata_InputMetadata_Visualization_OverlayType) String

func (ExplanationMetadata_InputMetadata_Visualization_OverlayType) Type

type ExplanationMetadata_InputMetadata_Visualization_Polarity

type ExplanationMetadata_InputMetadata_Visualization_Polarity int32

Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.

const (
	// Default value. This is the same as POSITIVE.
	ExplanationMetadata_InputMetadata_Visualization_POLARITY_UNSPECIFIED ExplanationMetadata_InputMetadata_Visualization_Polarity = 0
	// Highlights the pixels/outlines that were most influential to the
	// model's prediction.
	ExplanationMetadata_InputMetadata_Visualization_POSITIVE ExplanationMetadata_InputMetadata_Visualization_Polarity = 1
	// Setting polarity to negative highlights areas that does not lead to
	// the models's current prediction.
	ExplanationMetadata_InputMetadata_Visualization_NEGATIVE ExplanationMetadata_InputMetadata_Visualization_Polarity = 2
	// Shows both positive and negative attributions.
	ExplanationMetadata_InputMetadata_Visualization_BOTH ExplanationMetadata_InputMetadata_Visualization_Polarity = 3
)

func (ExplanationMetadata_InputMetadata_Visualization_Polarity) Descriptor

func (ExplanationMetadata_InputMetadata_Visualization_Polarity) Enum

func (ExplanationMetadata_InputMetadata_Visualization_Polarity) EnumDescriptor deprecated

Deprecated: Use ExplanationMetadata_InputMetadata_Visualization_Polarity.Descriptor instead.

func (ExplanationMetadata_InputMetadata_Visualization_Polarity) Number

func (ExplanationMetadata_InputMetadata_Visualization_Polarity) String

func (ExplanationMetadata_InputMetadata_Visualization_Polarity) Type

type ExplanationMetadata_InputMetadata_Visualization_Type

type ExplanationMetadata_InputMetadata_Visualization_Type int32

Type of the image visualization. Only applicable to [Integrated Gradients attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution].

const (
	// Should not be used.
	ExplanationMetadata_InputMetadata_Visualization_TYPE_UNSPECIFIED ExplanationMetadata_InputMetadata_Visualization_Type = 0
	// Shows which pixel contributed to the image prediction.
	ExplanationMetadata_InputMetadata_Visualization_PIXELS ExplanationMetadata_InputMetadata_Visualization_Type = 1
	// Shows which region contributed to the image prediction by outlining
	// the region.
	ExplanationMetadata_InputMetadata_Visualization_OUTLINES ExplanationMetadata_InputMetadata_Visualization_Type = 2
)

func (ExplanationMetadata_InputMetadata_Visualization_Type) Descriptor

func (ExplanationMetadata_InputMetadata_Visualization_Type) Enum

func (ExplanationMetadata_InputMetadata_Visualization_Type) EnumDescriptor deprecated

Deprecated: Use ExplanationMetadata_InputMetadata_Visualization_Type.Descriptor instead.

func (ExplanationMetadata_InputMetadata_Visualization_Type) Number

func (ExplanationMetadata_InputMetadata_Visualization_Type) String

func (ExplanationMetadata_InputMetadata_Visualization_Type) Type

type ExplanationMetadata_OutputMetadata

type ExplanationMetadata_OutputMetadata struct {

	// Defines how to map
	// [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]
	// to
	// [Attribution.output_display_name][google.cloud.aiplatform.v1beta1.Attribution.output_display_name].
	//
	// If neither of the fields are specified,
	// [Attribution.output_display_name][google.cloud.aiplatform.v1beta1.Attribution.output_display_name]
	// will not be populated.
	//
	// Types that are assignable to DisplayNameMapping:
	//	*ExplanationMetadata_OutputMetadata_IndexDisplayNameMapping
	//	*ExplanationMetadata_OutputMetadata_DisplayNameMappingKey
	DisplayNameMapping isExplanationMetadata_OutputMetadata_DisplayNameMapping `protobuf_oneof:"display_name_mapping"`
	// Name of the output tensor. Required and is only applicable to Vertex
	// AI provided images for Tensorflow.
	OutputTensorName string `protobuf:"bytes,3,opt,name=output_tensor_name,json=outputTensorName,proto3" json:"output_tensor_name,omitempty"`
	// contains filtered or unexported fields
}

Metadata of the prediction output to be explained.

func (*ExplanationMetadata_OutputMetadata) Descriptor deprecated

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

Deprecated: Use ExplanationMetadata_OutputMetadata.ProtoReflect.Descriptor instead.

func (*ExplanationMetadata_OutputMetadata) GetDisplayNameMapping

func (m *ExplanationMetadata_OutputMetadata) GetDisplayNameMapping() isExplanationMetadata_OutputMetadata_DisplayNameMapping

func (*ExplanationMetadata_OutputMetadata) GetDisplayNameMappingKey

func (x *ExplanationMetadata_OutputMetadata) GetDisplayNameMappingKey() string

func (*ExplanationMetadata_OutputMetadata) GetIndexDisplayNameMapping

func (x *ExplanationMetadata_OutputMetadata) GetIndexDisplayNameMapping() *structpb.Value

func (*ExplanationMetadata_OutputMetadata) GetOutputTensorName

func (x *ExplanationMetadata_OutputMetadata) GetOutputTensorName() string

func (*ExplanationMetadata_OutputMetadata) ProtoMessage

func (*ExplanationMetadata_OutputMetadata) ProtoMessage()

func (*ExplanationMetadata_OutputMetadata) ProtoReflect

func (*ExplanationMetadata_OutputMetadata) Reset

func (*ExplanationMetadata_OutputMetadata) String

type ExplanationMetadata_OutputMetadata_DisplayNameMappingKey

type ExplanationMetadata_OutputMetadata_DisplayNameMappingKey struct {
	// Specify a field name in the prediction to look for the display name.
	//
	// Use this if the prediction contains the display names for the outputs.
	//
	// The display names in the prediction must have the same shape of the
	// outputs, so that it can be located by
	// [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]
	// for a specific output.
	DisplayNameMappingKey string `protobuf:"bytes,2,opt,name=display_name_mapping_key,json=displayNameMappingKey,proto3,oneof"`
}

type ExplanationMetadata_OutputMetadata_IndexDisplayNameMapping

type ExplanationMetadata_OutputMetadata_IndexDisplayNameMapping struct {
	// Static mapping between the index and display name.
	//
	// Use this if the outputs are a deterministic n-dimensional array, e.g. a
	// list of scores of all the classes in a pre-defined order for a
	// multi-classification Model. It's not feasible if the outputs are
	// non-deterministic, e.g. the Model produces top-k classes or sort the
	// outputs by their values.
	//
	// The shape of the value must be an n-dimensional array of strings. The
	// number of dimensions must match that of the outputs to be explained.
	// The
	// [Attribution.output_display_name][google.cloud.aiplatform.v1beta1.Attribution.output_display_name]
	// is populated by locating in the mapping with
	// [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index].
	IndexDisplayNameMapping *structpb.Value `protobuf:"bytes,1,opt,name=index_display_name_mapping,json=indexDisplayNameMapping,proto3,oneof"`
}

type ExplanationParameters

type ExplanationParameters struct {

	// Types that are assignable to Method:
	//	*ExplanationParameters_SampledShapleyAttribution
	//	*ExplanationParameters_IntegratedGradientsAttribution
	//	*ExplanationParameters_XraiAttribution
	//	*ExplanationParameters_Examples
	Method isExplanationParameters_Method `protobuf_oneof:"method"`
	// If populated, returns attributions for top K indices of outputs
	// (defaults to 1). Only applies to Models that predicts more than one outputs
	// (e,g, multi-class Models). When set to -1, returns explanations for all
	// outputs.
	TopK int32 `protobuf:"varint,4,opt,name=top_k,json=topK,proto3" json:"top_k,omitempty"`
	// If populated, only returns attributions that have
	// [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]
	// contained in output_indices. It must be an ndarray of integers, with the
	// same shape of the output it's explaining.
	//
	// If not populated, returns attributions for
	// [top_k][google.cloud.aiplatform.v1beta1.ExplanationParameters.top_k]
	// indices of outputs. If neither top_k nor output_indices is populated,
	// returns the argmax index of the outputs.
	//
	// Only applicable to Models that predict multiple outputs (e,g, multi-class
	// Models that predict multiple classes).
	OutputIndices *structpb.ListValue `protobuf:"bytes,5,opt,name=output_indices,json=outputIndices,proto3" json:"output_indices,omitempty"`
	// contains filtered or unexported fields
}

Parameters to configure explaining for Model's predictions.

func (*ExplanationParameters) Descriptor deprecated

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

Deprecated: Use ExplanationParameters.ProtoReflect.Descriptor instead.

func (*ExplanationParameters) GetExamples

func (x *ExplanationParameters) GetExamples() *Examples

func (*ExplanationParameters) GetIntegratedGradientsAttribution

func (x *ExplanationParameters) GetIntegratedGradientsAttribution() *IntegratedGradientsAttribution

func (*ExplanationParameters) GetMethod

func (m *ExplanationParameters) GetMethod() isExplanationParameters_Method

func (*ExplanationParameters) GetOutputIndices

func (x *ExplanationParameters) GetOutputIndices() *structpb.ListValue

func (*ExplanationParameters) GetSampledShapleyAttribution

func (x *ExplanationParameters) GetSampledShapleyAttribution() *SampledShapleyAttribution

func (*ExplanationParameters) GetTopK

func (x *ExplanationParameters) GetTopK() int32

func (*ExplanationParameters) GetXraiAttribution

func (x *ExplanationParameters) GetXraiAttribution() *XraiAttribution

func (*ExplanationParameters) ProtoMessage

func (*ExplanationParameters) ProtoMessage()

func (*ExplanationParameters) ProtoReflect

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

func (*ExplanationParameters) Reset

func (x *ExplanationParameters) Reset()

func (*ExplanationParameters) String

func (x *ExplanationParameters) String() string

type ExplanationParameters_Examples

type ExplanationParameters_Examples struct {
	// Example-based explanations that returns the nearest neighbors from the
	// provided dataset.
	Examples *Examples `protobuf:"bytes,7,opt,name=examples,proto3,oneof"`
}

type ExplanationParameters_IntegratedGradientsAttribution

type ExplanationParameters_IntegratedGradientsAttribution struct {
	// An attribution method that computes Aumann-Shapley values taking
	// advantage of the model's fully differentiable structure. Refer to this
	// paper for more details: https://arxiv.org/abs/1703.01365
	IntegratedGradientsAttribution *IntegratedGradientsAttribution `protobuf:"bytes,2,opt,name=integrated_gradients_attribution,json=integratedGradientsAttribution,proto3,oneof"`
}

type ExplanationParameters_SampledShapleyAttribution

type ExplanationParameters_SampledShapleyAttribution struct {
	// An attribution method that approximates Shapley values for features that
	// contribute to the label being predicted. A sampling strategy is used to
	// approximate the value rather than considering all subsets of features.
	// Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
	SampledShapleyAttribution *SampledShapleyAttribution `protobuf:"bytes,1,opt,name=sampled_shapley_attribution,json=sampledShapleyAttribution,proto3,oneof"`
}

type ExplanationParameters_XraiAttribution

type ExplanationParameters_XraiAttribution struct {
	// An attribution method that redistributes Integrated Gradients
	// attribution to segmented regions, taking advantage of the model's fully
	// differentiable structure. Refer to this paper for
	// more details: https://arxiv.org/abs/1906.02825
	//
	// XRAI currently performs better on natural images, like a picture of a
	// house or an animal. If the images are taken in artificial environments,
	// like a lab or manufacturing line, or from diagnostic equipment, like
	// x-rays or quality-control cameras, use Integrated Gradients instead.
	XraiAttribution *XraiAttribution `protobuf:"bytes,3,opt,name=xrai_attribution,json=xraiAttribution,proto3,oneof"`
}

type ExplanationSpec

type ExplanationSpec struct {

	// Required. Parameters that configure explaining of the Model's predictions.
	Parameters *ExplanationParameters `protobuf:"bytes,1,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// Optional. Metadata describing the Model's input and output for explanation.
	Metadata *ExplanationMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

Specification of Model explanation.

func (*ExplanationSpec) Descriptor deprecated

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

Deprecated: Use ExplanationSpec.ProtoReflect.Descriptor instead.

func (*ExplanationSpec) GetMetadata

func (x *ExplanationSpec) GetMetadata() *ExplanationMetadata

func (*ExplanationSpec) GetParameters

func (x *ExplanationSpec) GetParameters() *ExplanationParameters

func (*ExplanationSpec) ProtoMessage

func (*ExplanationSpec) ProtoMessage()

func (*ExplanationSpec) ProtoReflect

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

func (*ExplanationSpec) Reset

func (x *ExplanationSpec) Reset()

func (*ExplanationSpec) String

func (x *ExplanationSpec) String() string

type ExplanationSpecOverride

type ExplanationSpecOverride struct {

	// The parameters to be overridden. Note that the
	// attribution method cannot be changed. If not specified,
	// no parameter is overridden.
	Parameters *ExplanationParameters `protobuf:"bytes,1,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// The metadata to be overridden. If not specified, no metadata is overridden.
	Metadata *ExplanationMetadataOverride `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// The example-based explanations parameter overrides.
	ExamplesOverride *ExamplesOverride `protobuf:"bytes,3,opt,name=examples_override,json=examplesOverride,proto3" json:"examples_override,omitempty"`
	// contains filtered or unexported fields
}

The ExplanationSpec[google.cloud.aiplatform.v1beta1.ExplanationSpec] entries that can be overridden at [online explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time.

func (*ExplanationSpecOverride) Descriptor deprecated

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

Deprecated: Use ExplanationSpecOverride.ProtoReflect.Descriptor instead.

func (*ExplanationSpecOverride) GetExamplesOverride

func (x *ExplanationSpecOverride) GetExamplesOverride() *ExamplesOverride

func (*ExplanationSpecOverride) GetMetadata

func (*ExplanationSpecOverride) GetParameters

func (x *ExplanationSpecOverride) GetParameters() *ExplanationParameters

func (*ExplanationSpecOverride) ProtoMessage

func (*ExplanationSpecOverride) ProtoMessage()

func (*ExplanationSpecOverride) ProtoReflect

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

func (*ExplanationSpecOverride) Reset

func (x *ExplanationSpecOverride) Reset()

func (*ExplanationSpecOverride) String

func (x *ExplanationSpecOverride) String() string

type FeatureNoiseSigma

type FeatureNoiseSigma struct {

	// Noise sigma per feature. No noise is added to features that are not set.
	NoiseSigma []*FeatureNoiseSigma_NoiseSigmaForFeature `protobuf:"bytes,1,rep,name=noise_sigma,json=noiseSigma,proto3" json:"noise_sigma,omitempty"`
	// contains filtered or unexported fields
}

Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients.

func (*FeatureNoiseSigma) Descriptor deprecated

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

Deprecated: Use FeatureNoiseSigma.ProtoReflect.Descriptor instead.

func (*FeatureNoiseSigma) GetNoiseSigma

func (*FeatureNoiseSigma) ProtoMessage

func (*FeatureNoiseSigma) ProtoMessage()

func (*FeatureNoiseSigma) ProtoReflect

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

func (*FeatureNoiseSigma) Reset

func (x *FeatureNoiseSigma) Reset()

func (*FeatureNoiseSigma) String

func (x *FeatureNoiseSigma) String() string

type FeatureNoiseSigma_NoiseSigmaForFeature

type FeatureNoiseSigma_NoiseSigmaForFeature struct {

	// The name of the input feature for which noise sigma is provided. The
	// features are defined in
	// [explanation metadata
	// inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs].
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// This represents the standard deviation of the Gaussian kernel that will
	// be used to add noise to the feature prior to computing gradients. Similar
	// to
	// [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma]
	// but represents the noise added to the current feature. Defaults to 0.1.
	Sigma float32 `protobuf:"fixed32,2,opt,name=sigma,proto3" json:"sigma,omitempty"`
	// contains filtered or unexported fields
}

Noise sigma for a single feature.

func (*FeatureNoiseSigma_NoiseSigmaForFeature) Descriptor deprecated

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

Deprecated: Use FeatureNoiseSigma_NoiseSigmaForFeature.ProtoReflect.Descriptor instead.

func (*FeatureNoiseSigma_NoiseSigmaForFeature) GetName

func (*FeatureNoiseSigma_NoiseSigmaForFeature) GetSigma

func (*FeatureNoiseSigma_NoiseSigmaForFeature) ProtoMessage

func (*FeatureNoiseSigma_NoiseSigmaForFeature) ProtoReflect

func (*FeatureNoiseSigma_NoiseSigmaForFeature) Reset

func (*FeatureNoiseSigma_NoiseSigmaForFeature) String

type FileData

type FileData struct {

	// Required. The IANA standard MIME type of the source data.
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Required. URI.
	FileUri string `protobuf:"bytes,2,opt,name=file_uri,json=fileUri,proto3" json:"file_uri,omitempty"`
	// contains filtered or unexported fields
}

URI based data.

func (*FileData) Descriptor deprecated

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

Deprecated: Use FileData.ProtoReflect.Descriptor instead.

func (*FileData) GetFileUri

func (x *FileData) GetFileUri() string

func (*FileData) GetMimeType

func (x *FileData) GetMimeType() string

func (*FileData) ProtoMessage

func (*FileData) ProtoMessage()

func (*FileData) ProtoReflect

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

func (*FileData) Reset

func (x *FileData) Reset()

func (*FileData) String

func (x *FileData) String() string

type FunctionCall

type FunctionCall struct {

	// Required. The name of the function to call.
	// Matches [FunctionDeclaration.name].
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Required. The function parameters and values in JSON object
	// format. See [FunctionDeclaration.parameters] for parameter details.
	Args *structpb.Struct `protobuf:"bytes,2,opt,name=args,proto3" json:"args,omitempty"`
	// contains filtered or unexported fields
}

A predicted FunctionCall returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.

func (*FunctionCall) Descriptor deprecated

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

Deprecated: Use FunctionCall.ProtoReflect.Descriptor instead.

func (*FunctionCall) GetArgs

func (x *FunctionCall) GetArgs() *structpb.Struct

func (*FunctionCall) GetName

func (x *FunctionCall) GetName() string

func (*FunctionCall) ProtoMessage

func (*FunctionCall) ProtoMessage()

func (*FunctionCall) ProtoReflect

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

func (*FunctionCall) Reset

func (x *FunctionCall) Reset()

func (*FunctionCall) String

func (x *FunctionCall) String() string

type FunctionDeclaration

type FunctionDeclaration struct {

	// Required. The name of the function to call.
	// Must start with a letter or an underscore.
	// Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum
	// length of 64.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Description and purpose of the function.
	// Model uses it to decide how and whether to call the function.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. Describes the parameters to this function in JSON Schema Object
	// format. Reflects the Open API 3.03 Parameter Object. string Key: the name
	// of the parameter. Parameter names are case sensitive. Schema Value: the
	// Schema defining the type used for the parameter. For function with no
	// parameters, this can be left unset. Example with 1 required and 1 optional
	// parameter: type: OBJECT properties:
	//  param1:
	//    type: STRING
	//  param2:
	//    type: INTEGER
	// required:
	//  - param1
	Parameters *Schema `protobuf:"bytes,3,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.

func (*FunctionDeclaration) Descriptor deprecated

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

Deprecated: Use FunctionDeclaration.ProtoReflect.Descriptor instead.

func (*FunctionDeclaration) GetDescription

func (x *FunctionDeclaration) GetDescription() string

func (*FunctionDeclaration) GetName

func (x *FunctionDeclaration) GetName() string

func (*FunctionDeclaration) GetParameters

func (x *FunctionDeclaration) GetParameters() *Schema

func (*FunctionDeclaration) ProtoMessage

func (*FunctionDeclaration) ProtoMessage()

func (*FunctionDeclaration) ProtoReflect

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

func (*FunctionDeclaration) Reset

func (x *FunctionDeclaration) Reset()

func (*FunctionDeclaration) String

func (x *FunctionDeclaration) String() string

type FunctionResponse

type FunctionResponse struct {

	// Required. The name of the function to call.
	// Matches [FunctionDeclaration.name] and [FunctionCall.name].
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The function response in JSON object format.
	Response *structpb.Struct `protobuf:"bytes,2,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

The result output from a FunctionCall that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a FunctionCall made based on model prediction.

func (*FunctionResponse) Descriptor deprecated

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

Deprecated: Use FunctionResponse.ProtoReflect.Descriptor instead.

func (*FunctionResponse) GetName

func (x *FunctionResponse) GetName() string

func (*FunctionResponse) GetResponse

func (x *FunctionResponse) GetResponse() *structpb.Struct

func (*FunctionResponse) ProtoMessage

func (*FunctionResponse) ProtoMessage()

func (*FunctionResponse) ProtoReflect

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

func (*FunctionResponse) Reset

func (x *FunctionResponse) Reset()

func (*FunctionResponse) String

func (x *FunctionResponse) String() string

type GcsDestination

type GcsDestination struct {

	// Required. Google Cloud Storage URI to output directory. If the uri doesn't
	// end with
	// '/', a '/' will be automatically appended. The directory is created if it
	// doesn't exist.
	OutputUriPrefix string `protobuf:"bytes,1,opt,name=output_uri_prefix,json=outputUriPrefix,proto3" json:"output_uri_prefix,omitempty"`
	// contains filtered or unexported fields
}

The Google Cloud Storage location where the output is to be written to.

func (*GcsDestination) Descriptor deprecated

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

Deprecated: Use GcsDestination.ProtoReflect.Descriptor instead.

func (*GcsDestination) GetOutputUriPrefix

func (x *GcsDestination) GetOutputUriPrefix() string

func (*GcsDestination) ProtoMessage

func (*GcsDestination) ProtoMessage()

func (*GcsDestination) ProtoReflect

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

func (*GcsDestination) Reset

func (x *GcsDestination) Reset()

func (*GcsDestination) String

func (x *GcsDestination) String() string

type GcsSource

type GcsSource struct {

	// Required. Google Cloud Storage URI(-s) to the input file(s). May contain
	// wildcards. For more information on wildcards, see
	// https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
	Uris []string `protobuf:"bytes,1,rep,name=uris,proto3" json:"uris,omitempty"`
	// contains filtered or unexported fields
}

The Google Cloud Storage location for the input content.

func (*GcsSource) Descriptor deprecated

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

Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.

func (*GcsSource) GetUris

func (x *GcsSource) GetUris() []string

func (*GcsSource) ProtoMessage

func (*GcsSource) ProtoMessage()

func (*GcsSource) ProtoReflect

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

func (*GcsSource) Reset

func (x *GcsSource) Reset()

func (*GcsSource) String

func (x *GcsSource) String() string

type GenerateContentRequest

type GenerateContentRequest struct {

	// Required. The name of the publisher model requested to serve the
	// prediction. Format:
	// `projects/{project}/locations/{location}/publishers/*/models/*`
	Model string `protobuf:"bytes,5,opt,name=model,proto3" json:"model,omitempty"`
	// Required. The content of the current conversation with the model.
	//
	// For single-turn queries, this is a single instance. For multi-turn queries,
	// this is a repeated field that contains conversation history + latest
	// request.
	Contents []*Content `protobuf:"bytes,2,rep,name=contents,proto3" json:"contents,omitempty"`
	// Optional. A list of `Tools` the model may use to generate the next
	// response.
	//
	// A `Tool` is a piece of code that enables the system to interact with
	// external systems to perform an action, or set of actions, outside of
	// knowledge and scope of the model. The only supported tool is currently
	// `Function`
	Tools []*Tool `protobuf:"bytes,6,rep,name=tools,proto3" json:"tools,omitempty"`
	// Optional. Per request settings for blocking unsafe content.
	// Enforced on GenerateContentResponse.candidates.
	SafetySettings []*SafetySetting `protobuf:"bytes,3,rep,name=safety_settings,json=safetySettings,proto3" json:"safety_settings,omitempty"`
	// Optional. Generation config.
	GenerationConfig *GenerationConfig `protobuf:"bytes,4,opt,name=generation_config,json=generationConfig,proto3" json:"generation_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.GenerateContent].

func (*GenerateContentRequest) Descriptor deprecated

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

Deprecated: Use GenerateContentRequest.ProtoReflect.Descriptor instead.

func (*GenerateContentRequest) GetContents

func (x *GenerateContentRequest) GetContents() []*Content

func (*GenerateContentRequest) GetGenerationConfig

func (x *GenerateContentRequest) GetGenerationConfig() *GenerationConfig

func (*GenerateContentRequest) GetModel

func (x *GenerateContentRequest) GetModel() string

func (*GenerateContentRequest) GetSafetySettings

func (x *GenerateContentRequest) GetSafetySettings() []*SafetySetting

func (*GenerateContentRequest) GetTools

func (x *GenerateContentRequest) GetTools() []*Tool

func (*GenerateContentRequest) ProtoMessage

func (*GenerateContentRequest) ProtoMessage()

func (*GenerateContentRequest) ProtoReflect

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

func (*GenerateContentRequest) Reset

func (x *GenerateContentRequest) Reset()

func (*GenerateContentRequest) String

func (x *GenerateContentRequest) String() string

type GenerateContentResponse

type GenerateContentResponse struct {

	// Output only. Generated candidates.
	Candidates []*Candidate `protobuf:"bytes,2,rep,name=candidates,proto3" json:"candidates,omitempty"`
	// Output only. Content filter results for a prompt sent in the request.
	// Note: Sent only in the first stream chunk.
	// Only happens when no candidates were generated due to content violations.
	PromptFeedback *GenerateContentResponse_PromptFeedback `protobuf:"bytes,3,opt,name=prompt_feedback,json=promptFeedback,proto3" json:"prompt_feedback,omitempty"`
	// Usage metadata about the response(s).
	UsageMetadata *GenerateContentResponse_UsageMetadata `protobuf:"bytes,4,opt,name=usage_metadata,json=usageMetadata,proto3" json:"usage_metadata,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.GenerateContent].

func (*GenerateContentResponse) Descriptor deprecated

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

Deprecated: Use GenerateContentResponse.ProtoReflect.Descriptor instead.

func (*GenerateContentResponse) GetCandidates

func (x *GenerateContentResponse) GetCandidates() []*Candidate

func (*GenerateContentResponse) GetPromptFeedback

func (*GenerateContentResponse) GetUsageMetadata

func (*GenerateContentResponse) ProtoMessage

func (*GenerateContentResponse) ProtoMessage()

func (*GenerateContentResponse) ProtoReflect

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

func (*GenerateContentResponse) Reset

func (x *GenerateContentResponse) Reset()

func (*GenerateContentResponse) String

func (x *GenerateContentResponse) String() string

type GenerateContentResponse_PromptFeedback

type GenerateContentResponse_PromptFeedback struct {

	// Output only. Blocked reason.
	BlockReason GenerateContentResponse_PromptFeedback_BlockedReason `` /* 185-byte string literal not displayed */
	// Output only. Safety ratings.
	SafetyRatings []*SafetyRating `protobuf:"bytes,2,rep,name=safety_ratings,json=safetyRatings,proto3" json:"safety_ratings,omitempty"`
	// Output only. A readable block reason message.
	BlockReasonMessage string `protobuf:"bytes,3,opt,name=block_reason_message,json=blockReasonMessage,proto3" json:"block_reason_message,omitempty"`
	// contains filtered or unexported fields
}

Content filter results for a prompt sent in the request.

func (*GenerateContentResponse_PromptFeedback) Descriptor deprecated

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

Deprecated: Use GenerateContentResponse_PromptFeedback.ProtoReflect.Descriptor instead.

func (*GenerateContentResponse_PromptFeedback) GetBlockReason

func (*GenerateContentResponse_PromptFeedback) GetBlockReasonMessage

func (x *GenerateContentResponse_PromptFeedback) GetBlockReasonMessage() string

func (*GenerateContentResponse_PromptFeedback) GetSafetyRatings

func (x *GenerateContentResponse_PromptFeedback) GetSafetyRatings() []*SafetyRating

func (*GenerateContentResponse_PromptFeedback) ProtoMessage

func (*GenerateContentResponse_PromptFeedback) ProtoReflect

func (*GenerateContentResponse_PromptFeedback) Reset

func (*GenerateContentResponse_PromptFeedback) String

type GenerateContentResponse_PromptFeedback_BlockedReason

type GenerateContentResponse_PromptFeedback_BlockedReason int32

Blocked reason enumeration.

const (
	// Unspecified blocked reason.
	GenerateContentResponse_PromptFeedback_BLOCKED_REASON_UNSPECIFIED GenerateContentResponse_PromptFeedback_BlockedReason = 0
	// Candidates blocked due to safety.
	GenerateContentResponse_PromptFeedback_SAFETY GenerateContentResponse_PromptFeedback_BlockedReason = 1
	// Candidates blocked due to other reason.
	GenerateContentResponse_PromptFeedback_OTHER GenerateContentResponse_PromptFeedback_BlockedReason = 2
)

func (GenerateContentResponse_PromptFeedback_BlockedReason) Descriptor

func (GenerateContentResponse_PromptFeedback_BlockedReason) Enum

func (GenerateContentResponse_PromptFeedback_BlockedReason) EnumDescriptor deprecated

Deprecated: Use GenerateContentResponse_PromptFeedback_BlockedReason.Descriptor instead.

func (GenerateContentResponse_PromptFeedback_BlockedReason) Number

func (GenerateContentResponse_PromptFeedback_BlockedReason) String

func (GenerateContentResponse_PromptFeedback_BlockedReason) Type

type GenerateContentResponse_UsageMetadata

type GenerateContentResponse_UsageMetadata struct {

	// Number of tokens in the request.
	PromptTokenCount int32 `protobuf:"varint,1,opt,name=prompt_token_count,json=promptTokenCount,proto3" json:"prompt_token_count,omitempty"`
	// Number of tokens in the response(s).
	CandidatesTokenCount int32 `protobuf:"varint,2,opt,name=candidates_token_count,json=candidatesTokenCount,proto3" json:"candidates_token_count,omitempty"`
	TotalTokenCount      int32 `protobuf:"varint,3,opt,name=total_token_count,json=totalTokenCount,proto3" json:"total_token_count,omitempty"`
	// contains filtered or unexported fields
}

Usage metadata about response(s).

func (*GenerateContentResponse_UsageMetadata) Descriptor deprecated

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

Deprecated: Use GenerateContentResponse_UsageMetadata.ProtoReflect.Descriptor instead.

func (*GenerateContentResponse_UsageMetadata) GetCandidatesTokenCount

func (x *GenerateContentResponse_UsageMetadata) GetCandidatesTokenCount() int32

func (*GenerateContentResponse_UsageMetadata) GetPromptTokenCount

func (x *GenerateContentResponse_UsageMetadata) GetPromptTokenCount() int32

func (*GenerateContentResponse_UsageMetadata) GetTotalTokenCount

func (x *GenerateContentResponse_UsageMetadata) GetTotalTokenCount() int32

func (*GenerateContentResponse_UsageMetadata) ProtoMessage

func (*GenerateContentResponse_UsageMetadata) ProtoMessage()

func (*GenerateContentResponse_UsageMetadata) ProtoReflect

func (*GenerateContentResponse_UsageMetadata) Reset

func (*GenerateContentResponse_UsageMetadata) String

type GenerationConfig

type GenerationConfig struct {

	// Optional. Controls the randomness of predictions.
	Temperature *float32 `protobuf:"fixed32,1,opt,name=temperature,proto3,oneof" json:"temperature,omitempty"`
	// Optional. If specified, nucleus sampling will be used.
	TopP *float32 `protobuf:"fixed32,2,opt,name=top_p,json=topP,proto3,oneof" json:"top_p,omitempty"`
	// Optional. If specified, top-k sampling will be used.
	TopK *float32 `protobuf:"fixed32,3,opt,name=top_k,json=topK,proto3,oneof" json:"top_k,omitempty"`
	// Optional. Number of candidates to generate.
	CandidateCount *int32 `protobuf:"varint,4,opt,name=candidate_count,json=candidateCount,proto3,oneof" json:"candidate_count,omitempty"`
	// Optional. The maximum number of output tokens to generate per message.
	MaxOutputTokens *int32 `protobuf:"varint,5,opt,name=max_output_tokens,json=maxOutputTokens,proto3,oneof" json:"max_output_tokens,omitempty"`
	// Optional. Stop sequences.
	StopSequences []string `protobuf:"bytes,6,rep,name=stop_sequences,json=stopSequences,proto3" json:"stop_sequences,omitempty"`
	// contains filtered or unexported fields
}

Generation config.

func (*GenerationConfig) Descriptor deprecated

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

Deprecated: Use GenerationConfig.ProtoReflect.Descriptor instead.

func (*GenerationConfig) GetCandidateCount

func (x *GenerationConfig) GetCandidateCount() int32

func (*GenerationConfig) GetMaxOutputTokens

func (x *GenerationConfig) GetMaxOutputTokens() int32

func (*GenerationConfig) GetStopSequences

func (x *GenerationConfig) GetStopSequences() []string

func (*GenerationConfig) GetTemperature

func (x *GenerationConfig) GetTemperature() float32

func (*GenerationConfig) GetTopK

func (x *GenerationConfig) GetTopK() float32

func (*GenerationConfig) GetTopP

func (x *GenerationConfig) GetTopP() float32

func (*GenerationConfig) ProtoMessage

func (*GenerationConfig) ProtoMessage()

func (*GenerationConfig) ProtoReflect

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

func (*GenerationConfig) Reset

func (x *GenerationConfig) Reset()

func (*GenerationConfig) String

func (x *GenerationConfig) String() string

type GenericOperationMetadata

type GenericOperationMetadata struct {

	// Output only. Partial failures encountered.
	// E.g. single files that couldn't be read.
	// This field should never exceed 20 entries.
	// Status details field will contain standard Google Cloud error details.
	PartialFailures []*status.Status `protobuf:"bytes,1,rep,name=partial_failures,json=partialFailures,proto3" json:"partial_failures,omitempty"`
	// Output only. Time when the operation was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Time when the operation was updated for the last time.
	// If the operation has finished (successfully or not), this is the finish
	// time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

Generic Metadata shared by all operations.

func (*GenericOperationMetadata) Descriptor deprecated

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

Deprecated: Use GenericOperationMetadata.ProtoReflect.Descriptor instead.

func (*GenericOperationMetadata) GetCreateTime

func (x *GenericOperationMetadata) GetCreateTime() *timestamppb.Timestamp

func (*GenericOperationMetadata) GetPartialFailures

func (x *GenericOperationMetadata) GetPartialFailures() []*status.Status

func (*GenericOperationMetadata) GetUpdateTime

func (x *GenericOperationMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*GenericOperationMetadata) ProtoMessage

func (*GenericOperationMetadata) ProtoMessage()

func (*GenericOperationMetadata) ProtoReflect

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

func (*GenericOperationMetadata) Reset

func (x *GenericOperationMetadata) Reset()

func (*GenericOperationMetadata) String

func (x *GenericOperationMetadata) String() string

type HarmCategory

type HarmCategory int32

Harm categories that will block the content.

const (
	// The harm category is unspecified.
	HarmCategory_HARM_CATEGORY_UNSPECIFIED HarmCategory = 0
	// The harm category is hate speech.
	HarmCategory_HARM_CATEGORY_HATE_SPEECH HarmCategory = 1
	// The harm category is dangerous content.
	HarmCategory_HARM_CATEGORY_DANGEROUS_CONTENT HarmCategory = 2
	// The harm category is harassment.
	HarmCategory_HARM_CATEGORY_HARASSMENT HarmCategory = 3
	// The harm category is sexually explicit content.
	HarmCategory_HARM_CATEGORY_SEXUALLY_EXPLICIT HarmCategory = 4
)

func (HarmCategory) Descriptor

func (HarmCategory) Enum

func (x HarmCategory) Enum() *HarmCategory

func (HarmCategory) EnumDescriptor deprecated

func (HarmCategory) EnumDescriptor() ([]byte, []int)

Deprecated: Use HarmCategory.Descriptor instead.

func (HarmCategory) Number

func (HarmCategory) String

func (x HarmCategory) String() string

func (HarmCategory) Type

type Int64Array

type Int64Array struct {

	// A list of int64 values.
	Values []int64 `protobuf:"varint,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

A list of int64 values.

func (*Int64Array) Descriptor deprecated

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

Deprecated: Use Int64Array.ProtoReflect.Descriptor instead.

func (*Int64Array) GetValues

func (x *Int64Array) GetValues() []int64

func (*Int64Array) ProtoMessage

func (*Int64Array) ProtoMessage()

func (*Int64Array) ProtoReflect

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

func (*Int64Array) Reset

func (x *Int64Array) Reset()

func (*Int64Array) String

func (x *Int64Array) String() string

type IntegratedGradientsAttribution

type IntegratedGradientsAttribution struct {

	// Required. The number of steps for approximating the path integral.
	// A good value to start is 50 and gradually increase until the
	// sum to diff property is within the desired error range.
	//
	// Valid range of its value is [1, 100], inclusively.
	StepCount int32 `protobuf:"varint,1,opt,name=step_count,json=stepCount,proto3" json:"step_count,omitempty"`
	// Config for SmoothGrad approximation of gradients.
	//
	// When enabled, the gradients are approximated by averaging the gradients
	// from noisy samples in the vicinity of the inputs. Adding
	// noise can help improve the computed gradients. Refer to this paper for more
	// details: https://arxiv.org/pdf/1706.03825.pdf
	SmoothGradConfig *SmoothGradConfig `protobuf:"bytes,2,opt,name=smooth_grad_config,json=smoothGradConfig,proto3" json:"smooth_grad_config,omitempty"`
	// Config for IG with blur baseline.
	//
	// When enabled, a linear path from the maximally blurred image to the input
	// image is created. Using a blurred baseline instead of zero (black image) is
	// motivated by the BlurIG approach explained here:
	// https://arxiv.org/abs/2004.03383
	BlurBaselineConfig *BlurBaselineConfig `protobuf:"bytes,3,opt,name=blur_baseline_config,json=blurBaselineConfig,proto3" json:"blur_baseline_config,omitempty"`
	// contains filtered or unexported fields
}

An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365

func (*IntegratedGradientsAttribution) Descriptor deprecated

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

Deprecated: Use IntegratedGradientsAttribution.ProtoReflect.Descriptor instead.

func (*IntegratedGradientsAttribution) GetBlurBaselineConfig

func (x *IntegratedGradientsAttribution) GetBlurBaselineConfig() *BlurBaselineConfig

func (*IntegratedGradientsAttribution) GetSmoothGradConfig

func (x *IntegratedGradientsAttribution) GetSmoothGradConfig() *SmoothGradConfig

func (*IntegratedGradientsAttribution) GetStepCount

func (x *IntegratedGradientsAttribution) GetStepCount() int32

func (*IntegratedGradientsAttribution) ProtoMessage

func (*IntegratedGradientsAttribution) ProtoMessage()

func (*IntegratedGradientsAttribution) ProtoReflect

func (*IntegratedGradientsAttribution) Reset

func (x *IntegratedGradientsAttribution) Reset()

func (*IntegratedGradientsAttribution) String

type MetadataSchema

type MetadataSchema struct {

	// Output only. The resource name of the MetadataSchema.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The version of the MetadataSchema. The version's format must match
	// the following regular expression: `^[0-9]+[.][0-9]+[.][0-9]+$`, which would
	// allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
	SchemaVersion string `protobuf:"bytes,2,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`
	// Required. The raw YAML string representation of the MetadataSchema. The
	// combination of [MetadataSchema.version] and the schema name given by
	// `title` in [MetadataSchema.schema] must be unique within a MetadataStore.
	//
	// The schema is defined as an OpenAPI 3.0.2
	// [MetadataSchema
	// Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject)
	Schema string `protobuf:"bytes,3,opt,name=schema,proto3" json:"schema,omitempty"`
	// The type of the MetadataSchema. This is a property that identifies which
	// metadata types will use the MetadataSchema.
	SchemaType MetadataSchema_MetadataSchemaType `` /* 163-byte string literal not displayed */
	// Output only. Timestamp when this MetadataSchema was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Description of the Metadata Schema
	Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Instance of a general MetadataSchema.

func (*MetadataSchema) Descriptor deprecated

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

Deprecated: Use MetadataSchema.ProtoReflect.Descriptor instead.

func (*MetadataSchema) GetCreateTime

func (x *MetadataSchema) GetCreateTime() *timestamppb.Timestamp

func (*MetadataSchema) GetDescription

func (x *MetadataSchema) GetDescription() string

func (*MetadataSchema) GetName

func (x *MetadataSchema) GetName() string

func (*MetadataSchema) GetSchema

func (x *MetadataSchema) GetSchema() string

func (*MetadataSchema) GetSchemaType

func (*MetadataSchema) GetSchemaVersion

func (x *MetadataSchema) GetSchemaVersion() string

func (*MetadataSchema) ProtoMessage

func (*MetadataSchema) ProtoMessage()

func (*MetadataSchema) ProtoReflect

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

func (*MetadataSchema) Reset

func (x *MetadataSchema) Reset()

func (*MetadataSchema) String

func (x *MetadataSchema) String() string

type MetadataSchema_MetadataSchemaType

type MetadataSchema_MetadataSchemaType int32

Describes the type of the MetadataSchema.

const (
	// Unspecified type for the MetadataSchema.
	MetadataSchema_METADATA_SCHEMA_TYPE_UNSPECIFIED MetadataSchema_MetadataSchemaType = 0
	// A type indicating that the MetadataSchema will be used by Artifacts.
	MetadataSchema_ARTIFACT_TYPE MetadataSchema_MetadataSchemaType = 1
	// A typee indicating that the MetadataSchema will be used by Executions.
	MetadataSchema_EXECUTION_TYPE MetadataSchema_MetadataSchemaType = 2
	// A state indicating that the MetadataSchema will be used by Contexts.
	MetadataSchema_CONTEXT_TYPE MetadataSchema_MetadataSchemaType = 3
)

func (MetadataSchema_MetadataSchemaType) Descriptor

func (MetadataSchema_MetadataSchemaType) Enum

func (MetadataSchema_MetadataSchemaType) EnumDescriptor deprecated

func (MetadataSchema_MetadataSchemaType) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetadataSchema_MetadataSchemaType.Descriptor instead.

func (MetadataSchema_MetadataSchemaType) Number

func (MetadataSchema_MetadataSchemaType) String

func (MetadataSchema_MetadataSchemaType) Type

type ModelExplanation

type ModelExplanation struct {

	// Output only. Aggregated attributions explaining the Model's prediction
	// outputs over the set of instances. The attributions are grouped by outputs.
	//
	// For Models that predict only one output, such as regression Models that
	// predict only one score, there is only one attibution that explains the
	// predicted output. For Models that predict multiple outputs, such as
	// multiclass Models that predict multiple classes, each element explains one
	// specific item.
	// [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]
	// can be used to identify which output this attribution is explaining.
	//
	// The
	// [baselineOutputValue][google.cloud.aiplatform.v1beta1.Attribution.baseline_output_value],
	// [instanceOutputValue][google.cloud.aiplatform.v1beta1.Attribution.instance_output_value]
	// and
	// [featureAttributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions]
	// fields are averaged over the test data.
	//
	// NOTE: Currently AutoML tabular classification Models produce only one
	// attribution, which averages attributions over all the classes it predicts.
	// [Attribution.approximation_error][google.cloud.aiplatform.v1beta1.Attribution.approximation_error]
	// is not populated.
	MeanAttributions []*Attribution `protobuf:"bytes,1,rep,name=mean_attributions,json=meanAttributions,proto3" json:"mean_attributions,omitempty"`
	// contains filtered or unexported fields
}

Aggregated explanation metrics for a Model over a set of instances.

func (*ModelExplanation) Descriptor deprecated

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

Deprecated: Use ModelExplanation.ProtoReflect.Descriptor instead.

func (*ModelExplanation) GetMeanAttributions

func (x *ModelExplanation) GetMeanAttributions() []*Attribution

func (*ModelExplanation) ProtoMessage

func (*ModelExplanation) ProtoMessage()

func (*ModelExplanation) ProtoReflect

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

func (*ModelExplanation) Reset

func (x *ModelExplanation) Reset()

func (*ModelExplanation) String

func (x *ModelExplanation) String() string

type Neighbor

type Neighbor struct {

	// Output only. The neighbor id.
	NeighborId string `protobuf:"bytes,1,opt,name=neighbor_id,json=neighborId,proto3" json:"neighbor_id,omitempty"`
	// Output only. The neighbor distance.
	NeighborDistance float64 `protobuf:"fixed64,2,opt,name=neighbor_distance,json=neighborDistance,proto3" json:"neighbor_distance,omitempty"`
	// contains filtered or unexported fields
}

Neighbors for example-based explanations.

func (*Neighbor) Descriptor deprecated

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

Deprecated: Use Neighbor.ProtoReflect.Descriptor instead.

func (*Neighbor) GetNeighborDistance

func (x *Neighbor) GetNeighborDistance() float64

func (*Neighbor) GetNeighborId

func (x *Neighbor) GetNeighborId() string

func (*Neighbor) ProtoMessage

func (*Neighbor) ProtoMessage()

func (*Neighbor) ProtoReflect

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

func (*Neighbor) Reset

func (x *Neighbor) Reset()

func (*Neighbor) String

func (x *Neighbor) String() string

type Part

type Part struct {

	// Types that are assignable to Data:
	//	*Part_Text
	//	*Part_InlineData
	//	*Part_FileData
	//	*Part_FunctionCall
	//	*Part_FunctionResponse
	Data isPart_Data `protobuf_oneof:"data"`
	// Types that are assignable to Metadata:
	//	*Part_VideoMetadata
	Metadata isPart_Metadata `protobuf_oneof:"metadata"`
	// contains filtered or unexported fields
}

A datatype containing media that is part of a multi-part `Content` message.

A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`.

A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.

func (*Part) Descriptor deprecated

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

Deprecated: Use Part.ProtoReflect.Descriptor instead.

func (*Part) GetData

func (m *Part) GetData() isPart_Data

func (*Part) GetFileData

func (x *Part) GetFileData() *FileData

func (*Part) GetFunctionCall

func (x *Part) GetFunctionCall() *FunctionCall

func (*Part) GetFunctionResponse

func (x *Part) GetFunctionResponse() *FunctionResponse

func (*Part) GetInlineData

func (x *Part) GetInlineData() *Blob

func (*Part) GetMetadata

func (m *Part) GetMetadata() isPart_Metadata

func (*Part) GetText

func (x *Part) GetText() string

func (*Part) GetVideoMetadata

func (x *Part) GetVideoMetadata() *VideoMetadata

func (*Part) ProtoMessage

func (*Part) ProtoMessage()

func (*Part) ProtoReflect

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

func (*Part) Reset

func (x *Part) Reset()

func (*Part) String

func (x *Part) String() string

type Part_FileData

type Part_FileData struct {
	// Optional. URI based data.
	FileData *FileData `protobuf:"bytes,3,opt,name=file_data,json=fileData,proto3,oneof"`
}

type Part_FunctionCall

type Part_FunctionCall struct {
	// Optional. A predicted [FunctionCall] returned from the model that
	// contains a string representing the [FunctionDeclaration.name] with the
	// parameters and their values.
	FunctionCall *FunctionCall `protobuf:"bytes,5,opt,name=function_call,json=functionCall,proto3,oneof"`
}

type Part_FunctionResponse

type Part_FunctionResponse struct {
	// Optional. The result output of a [FunctionCall] that contains a string
	// representing the [FunctionDeclaration.name] and a structured JSON object
	// containing any output from the function call. It is used as context to
	// the model.
	FunctionResponse *FunctionResponse `protobuf:"bytes,6,opt,name=function_response,json=functionResponse,proto3,oneof"`
}

type Part_InlineData

type Part_InlineData struct {
	// Optional. Inlined bytes data.
	InlineData *Blob `protobuf:"bytes,2,opt,name=inline_data,json=inlineData,proto3,oneof"`
}

type Part_Text

type Part_Text struct {
	// Optional. Text part (can be code).
	Text string `protobuf:"bytes,1,opt,name=text,proto3,oneof"`
}

type Part_VideoMetadata

type Part_VideoMetadata struct {
	// Optional. Video metadata. The metadata should only be specified while the
	// video data is presented in inline_data or file_data.
	VideoMetadata *VideoMetadata `protobuf:"bytes,4,opt,name=video_metadata,json=videoMetadata,proto3,oneof"`
}

type PredictRequest

type PredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Required. The instances that are the input to the prediction call.
	// A DeployedModel may have an upper limit on the number of instances it
	// supports per request, and when it is exceeded the prediction call errors
	// in case of AutoML Models, or, in case of customer created Models, the
	// behaviour is as documented by that Model.
	// The schema of any single instance may be specified via Endpoint's
	// DeployedModels'
	// [Model's][google.cloud.aiplatform.v1beta1.DeployedModel.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
	// [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
	Instances []*structpb.Value `protobuf:"bytes,2,rep,name=instances,proto3" json:"instances,omitempty"`
	// The parameters that govern the prediction. The schema of the parameters may
	// be specified via Endpoint's DeployedModels' [Model's
	// ][google.cloud.aiplatform.v1beta1.DeployedModel.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
	// [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
	Parameters *structpb.Value `protobuf:"bytes,3,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict].

func (*PredictRequest) Descriptor deprecated

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

Deprecated: Use PredictRequest.ProtoReflect.Descriptor instead.

func (*PredictRequest) GetEndpoint

func (x *PredictRequest) GetEndpoint() string

func (*PredictRequest) GetInstances

func (x *PredictRequest) GetInstances() []*structpb.Value

func (*PredictRequest) GetParameters

func (x *PredictRequest) GetParameters() *structpb.Value

func (*PredictRequest) ProtoMessage

func (*PredictRequest) ProtoMessage()

func (*PredictRequest) ProtoReflect

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

func (*PredictRequest) Reset

func (x *PredictRequest) Reset()

func (*PredictRequest) String

func (x *PredictRequest) String() string

type PredictResponse

type PredictResponse struct {

	// The predictions that are the output of the predictions call.
	// The schema of any single prediction may be specified via Endpoint's
	// DeployedModels' [Model's
	// ][google.cloud.aiplatform.v1beta1.DeployedModel.model]
	// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
	// [prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri].
	Predictions []*structpb.Value `protobuf:"bytes,1,rep,name=predictions,proto3" json:"predictions,omitempty"`
	// ID of the Endpoint's DeployedModel that served this prediction.
	DeployedModelId string `protobuf:"bytes,2,opt,name=deployed_model_id,json=deployedModelId,proto3" json:"deployed_model_id,omitempty"`
	// Output only. The resource name of the Model which is deployed as the
	// DeployedModel that this prediction hits.
	Model string `protobuf:"bytes,3,opt,name=model,proto3" json:"model,omitempty"`
	// Output only. The version ID of the Model which is deployed as the
	// DeployedModel that this prediction hits.
	ModelVersionId string `protobuf:"bytes,5,opt,name=model_version_id,json=modelVersionId,proto3" json:"model_version_id,omitempty"`
	// Output only. The [display
	// name][google.cloud.aiplatform.v1beta1.Model.display_name] of the Model
	// which is deployed as the DeployedModel that this prediction hits.
	ModelDisplayName string `protobuf:"bytes,4,opt,name=model_display_name,json=modelDisplayName,proto3" json:"model_display_name,omitempty"`
	// Output only. Request-level metadata returned by the model. The metadata
	// type will be dependent upon the model implementation.
	Metadata *structpb.Value `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict].

func (*PredictResponse) Descriptor deprecated

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

Deprecated: Use PredictResponse.ProtoReflect.Descriptor instead.

func (*PredictResponse) GetDeployedModelId

func (x *PredictResponse) GetDeployedModelId() string

func (*PredictResponse) GetMetadata

func (x *PredictResponse) GetMetadata() *structpb.Value

func (*PredictResponse) GetModel

func (x *PredictResponse) GetModel() string

func (*PredictResponse) GetModelDisplayName

func (x *PredictResponse) GetModelDisplayName() string

func (*PredictResponse) GetModelVersionId

func (x *PredictResponse) GetModelVersionId() string

func (*PredictResponse) GetPredictions

func (x *PredictResponse) GetPredictions() []*structpb.Value

func (*PredictResponse) ProtoMessage

func (*PredictResponse) ProtoMessage()

func (*PredictResponse) ProtoReflect

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

func (*PredictResponse) Reset

func (x *PredictResponse) Reset()

func (*PredictResponse) String

func (x *PredictResponse) String() string

type PredictionServiceClient

type PredictionServiceClient interface {
	// Perform an online prediction.
	Predict(ctx context.Context, in *PredictRequest, opts ...grpc.CallOption) (*PredictResponse, error)
	// Perform an online prediction with an arbitrary HTTP payload.
	//
	// The response includes the following HTTP headers:
	//
	// * `X-Vertex-AI-Endpoint-Id`: ID of the
	// [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] that served this
	// prediction.
	//
	// * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's
	// [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] that served
	// this prediction.
	RawPredict(ctx context.Context, in *RawPredictRequest, opts ...grpc.CallOption) (*httpbody.HttpBody, error)
	// Perform an unary online prediction request for Vertex first-party products
	// and frameworks.
	DirectPredict(ctx context.Context, in *DirectPredictRequest, opts ...grpc.CallOption) (*DirectPredictResponse, error)
	// Perform an online prediction request through gRPC.
	DirectRawPredict(ctx context.Context, in *DirectRawPredictRequest, opts ...grpc.CallOption) (*DirectRawPredictResponse, error)
	// Perform a streaming online prediction request for Vertex first-party
	// products and frameworks.
	StreamingPredict(ctx context.Context, opts ...grpc.CallOption) (PredictionService_StreamingPredictClient, error)
	// Perform a server-side streaming online prediction request for Vertex
	// LLM streaming.
	ServerStreamingPredict(ctx context.Context, in *StreamingPredictRequest, opts ...grpc.CallOption) (PredictionService_ServerStreamingPredictClient, error)
	// Perform a streaming online prediction request through gRPC.
	StreamingRawPredict(ctx context.Context, opts ...grpc.CallOption) (PredictionService_StreamingRawPredictClient, error)
	// Perform an online explanation.
	//
	// If
	// [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id]
	// is specified, the corresponding DeployModel must have
	// [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec]
	// populated. If
	// [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id]
	// is not specified, all DeployedModels must have
	// [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec]
	// populated.
	Explain(ctx context.Context, in *ExplainRequest, opts ...grpc.CallOption) (*ExplainResponse, error)
	// Perform a token counting.
	CountTokens(ctx context.Context, in *CountTokensRequest, opts ...grpc.CallOption) (*CountTokensResponse, error)
	// Generate content with multimodal inputs with streaming support.
	StreamGenerateContent(ctx context.Context, in *GenerateContentRequest, opts ...grpc.CallOption) (PredictionService_StreamGenerateContentClient, error)
}

PredictionServiceClient is the client API for PredictionService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type PredictionServiceServer

type PredictionServiceServer interface {
	// Perform an online prediction.
	Predict(context.Context, *PredictRequest) (*PredictResponse, error)
	// Perform an online prediction with an arbitrary HTTP payload.
	//
	// The response includes the following HTTP headers:
	//
	// * `X-Vertex-AI-Endpoint-Id`: ID of the
	// [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] that served this
	// prediction.
	//
	// * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's
	// [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] that served
	// this prediction.
	RawPredict(context.Context, *RawPredictRequest) (*httpbody.HttpBody, error)
	// Perform an unary online prediction request for Vertex first-party products
	// and frameworks.
	DirectPredict(context.Context, *DirectPredictRequest) (*DirectPredictResponse, error)
	// Perform an online prediction request through gRPC.
	DirectRawPredict(context.Context, *DirectRawPredictRequest) (*DirectRawPredictResponse, error)
	// Perform a streaming online prediction request for Vertex first-party
	// products and frameworks.
	StreamingPredict(PredictionService_StreamingPredictServer) error
	// Perform a server-side streaming online prediction request for Vertex
	// LLM streaming.
	ServerStreamingPredict(*StreamingPredictRequest, PredictionService_ServerStreamingPredictServer) error
	// Perform a streaming online prediction request through gRPC.
	StreamingRawPredict(PredictionService_StreamingRawPredictServer) error
	// Perform an online explanation.
	//
	// If
	// [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id]
	// is specified, the corresponding DeployModel must have
	// [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec]
	// populated. If
	// [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id]
	// is not specified, all DeployedModels must have
	// [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec]
	// populated.
	Explain(context.Context, *ExplainRequest) (*ExplainResponse, error)
	// Perform a token counting.
	CountTokens(context.Context, *CountTokensRequest) (*CountTokensResponse, error)
	// Generate content with multimodal inputs with streaming support.
	StreamGenerateContent(*GenerateContentRequest, PredictionService_StreamGenerateContentServer) error
}

PredictionServiceServer is the server API for PredictionService service.

type PredictionService_ServerStreamingPredictClient

type PredictionService_ServerStreamingPredictClient interface {
	Recv() (*StreamingPredictResponse, error)
	grpc.ClientStream
}

type PredictionService_ServerStreamingPredictServer

type PredictionService_ServerStreamingPredictServer interface {
	Send(*StreamingPredictResponse) error
	grpc.ServerStream
}

type PredictionService_StreamGenerateContentClient

type PredictionService_StreamGenerateContentClient interface {
	Recv() (*GenerateContentResponse, error)
	grpc.ClientStream
}

type PredictionService_StreamGenerateContentServer

type PredictionService_StreamGenerateContentServer interface {
	Send(*GenerateContentResponse) error
	grpc.ServerStream
}

type PredictionService_StreamingPredictClient

type PredictionService_StreamingPredictClient interface {
	Send(*StreamingPredictRequest) error
	Recv() (*StreamingPredictResponse, error)
	grpc.ClientStream
}

type PredictionService_StreamingPredictServer

type PredictionService_StreamingPredictServer interface {
	Send(*StreamingPredictResponse) error
	Recv() (*StreamingPredictRequest, error)
	grpc.ServerStream
}

type PredictionService_StreamingRawPredictClient

type PredictionService_StreamingRawPredictClient interface {
	Send(*StreamingRawPredictRequest) error
	Recv() (*StreamingRawPredictResponse, error)
	grpc.ClientStream
}

type PredictionService_StreamingRawPredictServer

type PredictionService_StreamingRawPredictServer interface {
	Send(*StreamingRawPredictResponse) error
	Recv() (*StreamingRawPredictRequest, error)
	grpc.ServerStream
}

type Presets

type Presets struct {

	// Preset option controlling parameters for speed-precision trade-off when
	// querying for examples. If omitted, defaults to `PRECISE`.
	Query *Presets_Query `protobuf:"varint,1,opt,name=query,proto3,enum=google.cloud.aiplatform.v1beta1.Presets_Query,oneof" json:"query,omitempty"`
	// The modality of the uploaded model, which automatically configures the
	// distance measurement and feature normalization for the underlying example
	// index and queries. If your model does not precisely fit one of these types,
	// it is okay to choose the closest type.
	Modality Presets_Modality `protobuf:"varint,2,opt,name=modality,proto3,enum=google.cloud.aiplatform.v1beta1.Presets_Modality" json:"modality,omitempty"`
	// contains filtered or unexported fields
}

Preset configuration for example-based explanations

func (*Presets) Descriptor deprecated

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

Deprecated: Use Presets.ProtoReflect.Descriptor instead.

func (*Presets) GetModality

func (x *Presets) GetModality() Presets_Modality

func (*Presets) GetQuery

func (x *Presets) GetQuery() Presets_Query

func (*Presets) ProtoMessage

func (*Presets) ProtoMessage()

func (*Presets) ProtoReflect

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

func (*Presets) Reset

func (x *Presets) Reset()

func (*Presets) String

func (x *Presets) String() string

type Presets_Modality

type Presets_Modality int32

Preset option controlling parameters for different modalities

const (
	// Should not be set. Added as a recommended best practice for enums
	Presets_MODALITY_UNSPECIFIED Presets_Modality = 0
	// IMAGE modality
	Presets_IMAGE Presets_Modality = 1
	// TEXT modality
	Presets_TEXT Presets_Modality = 2
	// TABULAR modality
	Presets_TABULAR Presets_Modality = 3
)

func (Presets_Modality) Descriptor

func (Presets_Modality) Enum

func (Presets_Modality) EnumDescriptor deprecated

func (Presets_Modality) EnumDescriptor() ([]byte, []int)

Deprecated: Use Presets_Modality.Descriptor instead.

func (Presets_Modality) Number

func (Presets_Modality) String

func (x Presets_Modality) String() string

func (Presets_Modality) Type

type Presets_Query

type Presets_Query int32

Preset option controlling parameters for query speed-precision trade-off

const (
	// More precise neighbors as a trade-off against slower response.
	Presets_PRECISE Presets_Query = 0
	// Faster response as a trade-off against less precise neighbors.
	Presets_FAST Presets_Query = 1
)

func (Presets_Query) Descriptor

func (Presets_Query) Enum

func (x Presets_Query) Enum() *Presets_Query

func (Presets_Query) EnumDescriptor deprecated

func (Presets_Query) EnumDescriptor() ([]byte, []int)

Deprecated: Use Presets_Query.Descriptor instead.

func (Presets_Query) Number

func (Presets_Query) String

func (x Presets_Query) String() string

func (Presets_Query) Type

type RawPredictRequest

type RawPredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// The prediction input. Supports HTTP headers and arbitrary data payload.
	//
	// A [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] may have
	// an upper limit on the number of instances it supports per request. When
	// this limit it is exceeded for an AutoML model, the
	// [RawPredict][google.cloud.aiplatform.v1beta1.PredictionService.RawPredict]
	// method returns an error. When this limit is exceeded for a custom-trained
	// model, the behavior varies depending on the model.
	//
	// You can specify the schema for each instance in the
	// [predict_schemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]
	// field when you create a [Model][google.cloud.aiplatform.v1beta1.Model].
	// This schema applies when you deploy the `Model` as a `DeployedModel` to an
	// [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] and use the
	// `RawPredict` method.
	HttpBody *httpbody.HttpBody `protobuf:"bytes,2,opt,name=http_body,json=httpBody,proto3" json:"http_body,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.RawPredict][google.cloud.aiplatform.v1beta1.PredictionService.RawPredict].

func (*RawPredictRequest) Descriptor deprecated

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

Deprecated: Use RawPredictRequest.ProtoReflect.Descriptor instead.

func (*RawPredictRequest) GetEndpoint

func (x *RawPredictRequest) GetEndpoint() string

func (*RawPredictRequest) GetHttpBody

func (x *RawPredictRequest) GetHttpBody() *httpbody.HttpBody

func (*RawPredictRequest) ProtoMessage

func (*RawPredictRequest) ProtoMessage()

func (*RawPredictRequest) ProtoReflect

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

func (*RawPredictRequest) Reset

func (x *RawPredictRequest) Reset()

func (*RawPredictRequest) String

func (x *RawPredictRequest) String() string

type SafetyRating

type SafetyRating struct {

	// Output only. Harm category.
	Category HarmCategory `protobuf:"varint,1,opt,name=category,proto3,enum=google.cloud.aiplatform.v1beta1.HarmCategory" json:"category,omitempty"`
	// Output only. Harm probability levels in the content.
	Probability SafetyRating_HarmProbability `` /* 142-byte string literal not displayed */
	// Output only. Indicates whether the content was filtered out because of this
	// rating.
	Blocked bool `protobuf:"varint,3,opt,name=blocked,proto3" json:"blocked,omitempty"`
	// contains filtered or unexported fields
}

Safety rating corresponding to the generated content.

func (*SafetyRating) Descriptor deprecated

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

Deprecated: Use SafetyRating.ProtoReflect.Descriptor instead.

func (*SafetyRating) GetBlocked

func (x *SafetyRating) GetBlocked() bool

func (*SafetyRating) GetCategory

func (x *SafetyRating) GetCategory() HarmCategory

func (*SafetyRating) GetProbability

func (x *SafetyRating) GetProbability() SafetyRating_HarmProbability

func (*SafetyRating) ProtoMessage

func (*SafetyRating) ProtoMessage()

func (*SafetyRating) ProtoReflect

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

func (*SafetyRating) Reset

func (x *SafetyRating) Reset()

func (*SafetyRating) String

func (x *SafetyRating) String() string

type SafetyRating_HarmProbability

type SafetyRating_HarmProbability int32

Harm probability levels in the content.

const (
	// Harm probability unspecified.
	SafetyRating_HARM_PROBABILITY_UNSPECIFIED SafetyRating_HarmProbability = 0
	// Negligible level of harm.
	SafetyRating_NEGLIGIBLE SafetyRating_HarmProbability = 1
	// Low level of harm.
	SafetyRating_LOW SafetyRating_HarmProbability = 2
	// Medium level of harm.
	SafetyRating_MEDIUM SafetyRating_HarmProbability = 3
	// High level of harm.
	SafetyRating_HIGH SafetyRating_HarmProbability = 4
)

func (SafetyRating_HarmProbability) Descriptor

func (SafetyRating_HarmProbability) Enum

func (SafetyRating_HarmProbability) EnumDescriptor deprecated

func (SafetyRating_HarmProbability) EnumDescriptor() ([]byte, []int)

Deprecated: Use SafetyRating_HarmProbability.Descriptor instead.

func (SafetyRating_HarmProbability) Number

func (SafetyRating_HarmProbability) String

func (SafetyRating_HarmProbability) Type

type SafetySetting

type SafetySetting struct {

	// Required. Harm category.
	Category HarmCategory `protobuf:"varint,1,opt,name=category,proto3,enum=google.cloud.aiplatform.v1beta1.HarmCategory" json:"category,omitempty"`
	// Required. The harm block threshold.
	Threshold SafetySetting_HarmBlockThreshold `` /* 142-byte string literal not displayed */
	// contains filtered or unexported fields
}

Safety settings.

func (*SafetySetting) Descriptor deprecated

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

Deprecated: Use SafetySetting.ProtoReflect.Descriptor instead.

func (*SafetySetting) GetCategory

func (x *SafetySetting) GetCategory() HarmCategory

func (*SafetySetting) GetThreshold

func (*SafetySetting) ProtoMessage

func (*SafetySetting) ProtoMessage()

func (*SafetySetting) ProtoReflect

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

func (*SafetySetting) Reset

func (x *SafetySetting) Reset()

func (*SafetySetting) String

func (x *SafetySetting) String() string

type SafetySetting_HarmBlockThreshold

type SafetySetting_HarmBlockThreshold int32

Probability based thresholds levels for blocking.

const (
	// Unspecified harm block threshold.
	SafetySetting_HARM_BLOCK_THRESHOLD_UNSPECIFIED SafetySetting_HarmBlockThreshold = 0
	// Block low threshold and above (i.e. block more).
	SafetySetting_BLOCK_LOW_AND_ABOVE SafetySetting_HarmBlockThreshold = 1
	// Block medium threshold and above.
	SafetySetting_BLOCK_MEDIUM_AND_ABOVE SafetySetting_HarmBlockThreshold = 2
	// Block only high threshold (i.e. block less).
	SafetySetting_BLOCK_ONLY_HIGH SafetySetting_HarmBlockThreshold = 3
	// Block none.
	SafetySetting_BLOCK_NONE SafetySetting_HarmBlockThreshold = 4
)

func (SafetySetting_HarmBlockThreshold) Descriptor

func (SafetySetting_HarmBlockThreshold) Enum

func (SafetySetting_HarmBlockThreshold) EnumDescriptor deprecated

func (SafetySetting_HarmBlockThreshold) EnumDescriptor() ([]byte, []int)

Deprecated: Use SafetySetting_HarmBlockThreshold.Descriptor instead.

func (SafetySetting_HarmBlockThreshold) Number

func (SafetySetting_HarmBlockThreshold) String

func (SafetySetting_HarmBlockThreshold) Type

type SampledShapleyAttribution

type SampledShapleyAttribution struct {

	// Required. The number of feature permutations to consider when approximating
	// the Shapley values.
	//
	// Valid range of its value is [1, 50], inclusively.
	PathCount int32 `protobuf:"varint,1,opt,name=path_count,json=pathCount,proto3" json:"path_count,omitempty"`
	// contains filtered or unexported fields
}

An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.

func (*SampledShapleyAttribution) Descriptor deprecated

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

Deprecated: Use SampledShapleyAttribution.ProtoReflect.Descriptor instead.

func (*SampledShapleyAttribution) GetPathCount

func (x *SampledShapleyAttribution) GetPathCount() int32

func (*SampledShapleyAttribution) ProtoMessage

func (*SampledShapleyAttribution) ProtoMessage()

func (*SampledShapleyAttribution) ProtoReflect

func (*SampledShapleyAttribution) Reset

func (x *SampledShapleyAttribution) Reset()

func (*SampledShapleyAttribution) String

func (x *SampledShapleyAttribution) String() string

type Schema

type Schema struct {

	// Optional. The type of the data.
	Type Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.aiplatform.v1beta1.Type" json:"type,omitempty"`
	// Optional. The format of the data.
	// Supported formats:
	//  for NUMBER type: float, double
	//  for INTEGER type: int32, int64
	Format string `protobuf:"bytes,7,opt,name=format,proto3" json:"format,omitempty"`
	// Optional. The description of the data.
	Description string `protobuf:"bytes,8,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. Indicates if the value may be null.
	Nullable bool `protobuf:"varint,6,opt,name=nullable,proto3" json:"nullable,omitempty"`
	// Optional. Schema of the elements of Type.ARRAY.
	Items *Schema `protobuf:"bytes,2,opt,name=items,proto3" json:"items,omitempty"`
	// Optional. Possible values of the element of Type.STRING with enum format.
	// For example we can define an Enum Direction as :
	// {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
	Enum []string `protobuf:"bytes,9,rep,name=enum,proto3" json:"enum,omitempty"`
	// Optional. Properties of Type.OBJECT.
	Properties map[string]*Schema `` /* 161-byte string literal not displayed */
	// Optional. Required properties of Type.OBJECT.
	Required []string `protobuf:"bytes,5,rep,name=required,proto3" json:"required,omitempty"`
	// Optional. Example of the object. Will only populated when the object is the
	// root.
	Example *structpb.Value `protobuf:"bytes,4,opt,name=example,proto3" json:"example,omitempty"`
	// contains filtered or unexported fields
}

Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed.

func (*Schema) Descriptor deprecated

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

Deprecated: Use Schema.ProtoReflect.Descriptor instead.

func (*Schema) GetDescription

func (x *Schema) GetDescription() string

func (*Schema) GetEnum

func (x *Schema) GetEnum() []string

func (*Schema) GetExample

func (x *Schema) GetExample() *structpb.Value

func (*Schema) GetFormat

func (x *Schema) GetFormat() string

func (*Schema) GetItems

func (x *Schema) GetItems() *Schema

func (*Schema) GetNullable

func (x *Schema) GetNullable() bool

func (*Schema) GetProperties

func (x *Schema) GetProperties() map[string]*Schema

func (*Schema) GetRequired

func (x *Schema) GetRequired() []string

func (*Schema) GetType

func (x *Schema) GetType() Type

func (*Schema) ProtoMessage

func (*Schema) ProtoMessage()

func (*Schema) ProtoReflect

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

func (*Schema) Reset

func (x *Schema) Reset()

func (*Schema) String

func (x *Schema) String() string

type SmoothGradConfig

type SmoothGradConfig struct {

	// Represents the standard deviation of the gaussian kernel
	// that will be used to add noise to the interpolated inputs
	// prior to computing gradients.
	//
	// Types that are assignable to GradientNoiseSigma:
	//	*SmoothGradConfig_NoiseSigma
	//	*SmoothGradConfig_FeatureNoiseSigma
	GradientNoiseSigma isSmoothGradConfig_GradientNoiseSigma `protobuf_oneof:"GradientNoiseSigma"`
	// The number of gradient samples to use for
	// approximation. The higher this number, the more accurate the gradient
	// is, but the runtime complexity increases by this factor as well.
	// Valid range of its value is [1, 50]. Defaults to 3.
	NoisySampleCount int32 `protobuf:"varint,3,opt,name=noisy_sample_count,json=noisySampleCount,proto3" json:"noisy_sample_count,omitempty"`
	// contains filtered or unexported fields
}

Config for SmoothGrad approximation of gradients.

When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf

func (*SmoothGradConfig) Descriptor deprecated

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

Deprecated: Use SmoothGradConfig.ProtoReflect.Descriptor instead.

func (*SmoothGradConfig) GetFeatureNoiseSigma

func (x *SmoothGradConfig) GetFeatureNoiseSigma() *FeatureNoiseSigma

func (*SmoothGradConfig) GetGradientNoiseSigma

func (m *SmoothGradConfig) GetGradientNoiseSigma() isSmoothGradConfig_GradientNoiseSigma

func (*SmoothGradConfig) GetNoiseSigma

func (x *SmoothGradConfig) GetNoiseSigma() float32

func (*SmoothGradConfig) GetNoisySampleCount

func (x *SmoothGradConfig) GetNoisySampleCount() int32

func (*SmoothGradConfig) ProtoMessage

func (*SmoothGradConfig) ProtoMessage()

func (*SmoothGradConfig) ProtoReflect

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

func (*SmoothGradConfig) Reset

func (x *SmoothGradConfig) Reset()

func (*SmoothGradConfig) String

func (x *SmoothGradConfig) String() string

type SmoothGradConfig_FeatureNoiseSigma

type SmoothGradConfig_FeatureNoiseSigma struct {
	// This is similar to
	// [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma],
	// but provides additional flexibility. A separate noise sigma can be
	// provided for each feature, which is useful if their distributions are
	// different. No noise is added to features that are not set. If this field
	// is unset,
	// [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma]
	// will be used for all features.
	FeatureNoiseSigma *FeatureNoiseSigma `protobuf:"bytes,2,opt,name=feature_noise_sigma,json=featureNoiseSigma,proto3,oneof"`
}

type SmoothGradConfig_NoiseSigma

type SmoothGradConfig_NoiseSigma struct {
	// This is a single float value and will be used to add noise to all the
	// features. Use this field when all features are normalized to have the
	// same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where
	// features are normalized to have 0-mean and 1-variance. Learn more about
	// [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization).
	//
	// For best results the recommended value is about 10% - 20% of the standard
	// deviation of the input feature. Refer to section 3.2 of the SmoothGrad
	// paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1.
	//
	// If the distribution is different per feature, set
	// [feature_noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.feature_noise_sigma]
	// instead for each feature.
	NoiseSigma float32 `protobuf:"fixed32,1,opt,name=noise_sigma,json=noiseSigma,proto3,oneof"`
}

type StreamingPredictRequest

type StreamingPredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// The prediction input.
	Inputs []*Tensor `protobuf:"bytes,2,rep,name=inputs,proto3" json:"inputs,omitempty"`
	// The parameters that govern the prediction.
	Parameters *Tensor `protobuf:"bytes,3,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.StreamingPredict][google.cloud.aiplatform.v1beta1.PredictionService.StreamingPredict].

The first message must contain [endpoint][google.cloud.aiplatform.v1beta1.StreamingPredictRequest.endpoint] field and optionally [input][]. The subsequent messages must contain [input][].

func (*StreamingPredictRequest) Descriptor deprecated

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

Deprecated: Use StreamingPredictRequest.ProtoReflect.Descriptor instead.

func (*StreamingPredictRequest) GetEndpoint

func (x *StreamingPredictRequest) GetEndpoint() string

func (*StreamingPredictRequest) GetInputs

func (x *StreamingPredictRequest) GetInputs() []*Tensor

func (*StreamingPredictRequest) GetParameters

func (x *StreamingPredictRequest) GetParameters() *Tensor

func (*StreamingPredictRequest) ProtoMessage

func (*StreamingPredictRequest) ProtoMessage()

func (*StreamingPredictRequest) ProtoReflect

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

func (*StreamingPredictRequest) Reset

func (x *StreamingPredictRequest) Reset()

func (*StreamingPredictRequest) String

func (x *StreamingPredictRequest) String() string

type StreamingPredictResponse

type StreamingPredictResponse struct {

	// The prediction output.
	Outputs []*Tensor `protobuf:"bytes,1,rep,name=outputs,proto3" json:"outputs,omitempty"`
	// The parameters that govern the prediction.
	Parameters *Tensor `protobuf:"bytes,2,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.StreamingPredict][google.cloud.aiplatform.v1beta1.PredictionService.StreamingPredict].

func (*StreamingPredictResponse) Descriptor deprecated

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

Deprecated: Use StreamingPredictResponse.ProtoReflect.Descriptor instead.

func (*StreamingPredictResponse) GetOutputs

func (x *StreamingPredictResponse) GetOutputs() []*Tensor

func (*StreamingPredictResponse) GetParameters

func (x *StreamingPredictResponse) GetParameters() *Tensor

func (*StreamingPredictResponse) ProtoMessage

func (*StreamingPredictResponse) ProtoMessage()

func (*StreamingPredictResponse) ProtoReflect

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

func (*StreamingPredictResponse) Reset

func (x *StreamingPredictResponse) Reset()

func (*StreamingPredictResponse) String

func (x *StreamingPredictResponse) String() string

type StreamingRawPredictRequest

type StreamingRawPredictRequest struct {

	// Required. The name of the Endpoint requested to serve the prediction.
	// Format:
	// `projects/{project}/locations/{location}/endpoints/{endpoint}`
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Fully qualified name of the API method being invoked to perform
	// predictions.
	//
	// Format:
	// `/namespace.Service/Method/`
	// Example:
	// `/tensorflow.serving.PredictionService/Predict`
	MethodName string `protobuf:"bytes,2,opt,name=method_name,json=methodName,proto3" json:"method_name,omitempty"`
	// The prediction input.
	Input []byte `protobuf:"bytes,3,opt,name=input,proto3" json:"input,omitempty"`
	// contains filtered or unexported fields
}

Request message for [PredictionService.StreamingRawPredict][google.cloud.aiplatform.v1beta1.PredictionService.StreamingRawPredict].

The first message must contain [endpoint][google.cloud.aiplatform.v1beta1.StreamingRawPredictRequest.endpoint] and [method_name][google.cloud.aiplatform.v1beta1.StreamingRawPredictRequest.method_name] fields and optionally [input][google.cloud.aiplatform.v1beta1.StreamingRawPredictRequest.input]. The subsequent messages must contain [input][google.cloud.aiplatform.v1beta1.StreamingRawPredictRequest.input]. [method_name][google.cloud.aiplatform.v1beta1.StreamingRawPredictRequest.method_name] in the subsequent messages have no effect.

func (*StreamingRawPredictRequest) Descriptor deprecated

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

Deprecated: Use StreamingRawPredictRequest.ProtoReflect.Descriptor instead.

func (*StreamingRawPredictRequest) GetEndpoint

func (x *StreamingRawPredictRequest) GetEndpoint() string

func (*StreamingRawPredictRequest) GetInput

func (x *StreamingRawPredictRequest) GetInput() []byte

func (*StreamingRawPredictRequest) GetMethodName

func (x *StreamingRawPredictRequest) GetMethodName() string

func (*StreamingRawPredictRequest) ProtoMessage

func (*StreamingRawPredictRequest) ProtoMessage()

func (*StreamingRawPredictRequest) ProtoReflect

func (*StreamingRawPredictRequest) Reset

func (x *StreamingRawPredictRequest) Reset()

func (*StreamingRawPredictRequest) String

func (x *StreamingRawPredictRequest) String() string

type StreamingRawPredictResponse

type StreamingRawPredictResponse struct {

	// The prediction output.
	Output []byte `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Response message for [PredictionService.StreamingRawPredict][google.cloud.aiplatform.v1beta1.PredictionService.StreamingRawPredict].

func (*StreamingRawPredictResponse) Descriptor deprecated

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

Deprecated: Use StreamingRawPredictResponse.ProtoReflect.Descriptor instead.

func (*StreamingRawPredictResponse) GetOutput

func (x *StreamingRawPredictResponse) GetOutput() []byte

func (*StreamingRawPredictResponse) ProtoMessage

func (*StreamingRawPredictResponse) ProtoMessage()

func (*StreamingRawPredictResponse) ProtoReflect

func (*StreamingRawPredictResponse) Reset

func (x *StreamingRawPredictResponse) Reset()

func (*StreamingRawPredictResponse) String

func (x *StreamingRawPredictResponse) String() string

type StringArray

type StringArray struct {

	// A list of string values.
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

A list of string values.

func (*StringArray) Descriptor deprecated

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

Deprecated: Use StringArray.ProtoReflect.Descriptor instead.

func (*StringArray) GetValues

func (x *StringArray) GetValues() []string

func (*StringArray) ProtoMessage

func (*StringArray) ProtoMessage()

func (*StringArray) ProtoReflect

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

func (*StringArray) Reset

func (x *StringArray) Reset()

func (*StringArray) String

func (x *StringArray) String() string

type TFRecordDestination

type TFRecordDestination struct {

	// Required. Google Cloud Storage location.
	GcsDestination *GcsDestination `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3" json:"gcs_destination,omitempty"`
	// contains filtered or unexported fields
}

The storage details for TFRecord output content.

func (*TFRecordDestination) Descriptor deprecated

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

Deprecated: Use TFRecordDestination.ProtoReflect.Descriptor instead.

func (*TFRecordDestination) GetGcsDestination

func (x *TFRecordDestination) GetGcsDestination() *GcsDestination

func (*TFRecordDestination) ProtoMessage

func (*TFRecordDestination) ProtoMessage()

func (*TFRecordDestination) ProtoReflect

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

func (*TFRecordDestination) Reset

func (x *TFRecordDestination) Reset()

func (*TFRecordDestination) String

func (x *TFRecordDestination) String() string

type Tensor

type Tensor struct {

	// The data type of tensor.
	Dtype Tensor_DataType `protobuf:"varint,1,opt,name=dtype,proto3,enum=google.cloud.aiplatform.v1beta1.Tensor_DataType" json:"dtype,omitempty"`
	// Shape of the tensor.
	Shape []int64 `protobuf:"varint,2,rep,packed,name=shape,proto3" json:"shape,omitempty"`
	// Type specific representations that make it easy to create tensor protos in
	// all languages.  Only the representation corresponding to "dtype" can
	// be set.  The values hold the flattened representation of the tensor in
	// row major order.
	//
	// [BOOL][google.aiplatform.master.Tensor.DataType.BOOL]
	BoolVal []bool `protobuf:"varint,3,rep,packed,name=bool_val,json=boolVal,proto3" json:"bool_val,omitempty"`
	// [STRING][google.aiplatform.master.Tensor.DataType.STRING]
	StringVal []string `protobuf:"bytes,14,rep,name=string_val,json=stringVal,proto3" json:"string_val,omitempty"`
	// [STRING][google.aiplatform.master.Tensor.DataType.STRING]
	BytesVal [][]byte `protobuf:"bytes,15,rep,name=bytes_val,json=bytesVal,proto3" json:"bytes_val,omitempty"`
	// [FLOAT][google.aiplatform.master.Tensor.DataType.FLOAT]
	FloatVal []float32 `protobuf:"fixed32,5,rep,packed,name=float_val,json=floatVal,proto3" json:"float_val,omitempty"`
	// [DOUBLE][google.aiplatform.master.Tensor.DataType.DOUBLE]
	DoubleVal []float64 `protobuf:"fixed64,6,rep,packed,name=double_val,json=doubleVal,proto3" json:"double_val,omitempty"`
	// [INT_8][google.aiplatform.master.Tensor.DataType.INT8]
	// [INT_16][google.aiplatform.master.Tensor.DataType.INT16]
	// [INT_32][google.aiplatform.master.Tensor.DataType.INT32]
	IntVal []int32 `protobuf:"varint,7,rep,packed,name=int_val,json=intVal,proto3" json:"int_val,omitempty"`
	// [INT64][google.aiplatform.master.Tensor.DataType.INT64]
	Int64Val []int64 `protobuf:"varint,8,rep,packed,name=int64_val,json=int64Val,proto3" json:"int64_val,omitempty"`
	// [UINT8][google.aiplatform.master.Tensor.DataType.UINT8]
	// [UINT16][google.aiplatform.master.Tensor.DataType.UINT16]
	// [UINT32][google.aiplatform.master.Tensor.DataType.UINT32]
	UintVal []uint32 `protobuf:"varint,9,rep,packed,name=uint_val,json=uintVal,proto3" json:"uint_val,omitempty"`
	// [UINT64][google.aiplatform.master.Tensor.DataType.UINT64]
	Uint64Val []uint64 `protobuf:"varint,10,rep,packed,name=uint64_val,json=uint64Val,proto3" json:"uint64_val,omitempty"`
	// A list of tensor values.
	ListVal []*Tensor `protobuf:"bytes,11,rep,name=list_val,json=listVal,proto3" json:"list_val,omitempty"`
	// A map of string to tensor.
	StructVal map[string]*Tensor `` /* 177-byte string literal not displayed */
	// Serialized raw tensor content.
	TensorVal []byte `protobuf:"bytes,13,opt,name=tensor_val,json=tensorVal,proto3" json:"tensor_val,omitempty"`
	// contains filtered or unexported fields
}

A tensor value type.

func (*Tensor) Descriptor deprecated

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

Deprecated: Use Tensor.ProtoReflect.Descriptor instead.

func (*Tensor) GetBoolVal

func (x *Tensor) GetBoolVal() []bool

func (*Tensor) GetBytesVal

func (x *Tensor) GetBytesVal() [][]byte

func (*Tensor) GetDoubleVal

func (x *Tensor) GetDoubleVal() []float64

func (*Tensor) GetDtype

func (x *Tensor) GetDtype() Tensor_DataType

func (*Tensor) GetFloatVal

func (x *Tensor) GetFloatVal() []float32

func (*Tensor) GetInt64Val

func (x *Tensor) GetInt64Val() []int64

func (*Tensor) GetIntVal

func (x *Tensor) GetIntVal() []int32

func (*Tensor) GetListVal

func (x *Tensor) GetListVal() []*Tensor

func (*Tensor) GetShape

func (x *Tensor) GetShape() []int64

func (*Tensor) GetStringVal

func (x *Tensor) GetStringVal() []string

func (*Tensor) GetStructVal

func (x *Tensor) GetStructVal() map[string]*Tensor

func (*Tensor) GetTensorVal

func (x *Tensor) GetTensorVal() []byte

func (*Tensor) GetUint64Val

func (x *Tensor) GetUint64Val() []uint64

func (*Tensor) GetUintVal

func (x *Tensor) GetUintVal() []uint32

func (*Tensor) ProtoMessage

func (*Tensor) ProtoMessage()

func (*Tensor) ProtoReflect

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

func (*Tensor) Reset

func (x *Tensor) Reset()

func (*Tensor) String

func (x *Tensor) String() string

type Tensor_DataType

type Tensor_DataType int32

Data type of the tensor.

const (
	// Not a legal value for DataType. Used to indicate a DataType field has not
	// been set.
	Tensor_DATA_TYPE_UNSPECIFIED Tensor_DataType = 0
	// Data types that all computation devices are expected to be
	// capable to support.
	Tensor_BOOL   Tensor_DataType = 1
	Tensor_STRING Tensor_DataType = 2
	Tensor_FLOAT  Tensor_DataType = 3
	Tensor_DOUBLE Tensor_DataType = 4
	Tensor_INT8   Tensor_DataType = 5
	Tensor_INT16  Tensor_DataType = 6
	Tensor_INT32  Tensor_DataType = 7
	Tensor_INT64  Tensor_DataType = 8
	Tensor_UINT8  Tensor_DataType = 9
	Tensor_UINT16 Tensor_DataType = 10
	Tensor_UINT32 Tensor_DataType = 11
	Tensor_UINT64 Tensor_DataType = 12
)

func (Tensor_DataType) Descriptor

func (Tensor_DataType) Enum

func (x Tensor_DataType) Enum() *Tensor_DataType

func (Tensor_DataType) EnumDescriptor deprecated

func (Tensor_DataType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Tensor_DataType.Descriptor instead.

func (Tensor_DataType) Number

func (Tensor_DataType) String

func (x Tensor_DataType) String() string

func (Tensor_DataType) Type

type Tool

type Tool struct {

	// Optional. One or more function declarations to be passed to the model along
	// with the current user query. Model may decide to call a subset of these
	// functions by populating [FunctionCall][content.part.function_call] in the
	// response. User should provide a
	// [FunctionResponse][content.part.function_response] for each function call
	// in the next turn. Based on the function responses, Model will generate the
	// final response back to the user. Maximum 64 function declarations can be
	// provided.
	FunctionDeclarations []*FunctionDeclaration `protobuf:"bytes,1,rep,name=function_declarations,json=functionDeclarations,proto3" json:"function_declarations,omitempty"`
	// contains filtered or unexported fields
}

Tool details that the model may use to generate response.

A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.

func (*Tool) Descriptor deprecated

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

Deprecated: Use Tool.ProtoReflect.Descriptor instead.

func (*Tool) GetFunctionDeclarations

func (x *Tool) GetFunctionDeclarations() []*FunctionDeclaration

func (*Tool) ProtoMessage

func (*Tool) ProtoMessage()

func (*Tool) ProtoReflect

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

func (*Tool) Reset

func (x *Tool) Reset()

func (*Tool) String

func (x *Tool) String() string

type Type

type Type int32

Type contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/

const (
	// Not specified, should not be used.
	Type_TYPE_UNSPECIFIED Type = 0
	// OpenAPI string type
	Type_STRING Type = 1
	// OpenAPI number type
	Type_NUMBER Type = 2
	// OpenAPI integer type
	Type_INTEGER Type = 3
	// OpenAPI boolean type
	Type_BOOLEAN Type = 4
	// OpenAPI array type
	Type_ARRAY Type = 5
	// OpenAPI object type
	Type_OBJECT Type = 6
)

func (Type) Descriptor

func (Type) Descriptor() protoreflect.EnumDescriptor

func (Type) Enum

func (x Type) Enum() *Type

func (Type) EnumDescriptor deprecated

func (Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Type.Descriptor instead.

func (Type) Number

func (x Type) Number() protoreflect.EnumNumber

func (Type) String

func (x Type) String() string

func (Type) Type

func (Type) Type() protoreflect.EnumType

type UnimplementedPredictionServiceServer

type UnimplementedPredictionServiceServer struct {
}

UnimplementedPredictionServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedPredictionServiceServer) CountTokens

func (*UnimplementedPredictionServiceServer) DirectPredict

func (*UnimplementedPredictionServiceServer) DirectRawPredict

func (*UnimplementedPredictionServiceServer) Explain

func (*UnimplementedPredictionServiceServer) Predict

func (*UnimplementedPredictionServiceServer) RawPredict

func (*UnimplementedPredictionServiceServer) StreamingPredict

func (*UnimplementedPredictionServiceServer) StreamingRawPredict

type Value

type Value struct {

	// Types that are assignable to Value:
	//	*Value_IntValue
	//	*Value_DoubleValue
	//	*Value_StringValue
	Value isValue_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

Value is the value of the field.

func (*Value) Descriptor deprecated

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

Deprecated: Use Value.ProtoReflect.Descriptor instead.

func (*Value) GetDoubleValue

func (x *Value) GetDoubleValue() float64

func (*Value) GetIntValue

func (x *Value) GetIntValue() int64

func (*Value) GetStringValue

func (x *Value) GetStringValue() string

func (*Value) GetValue

func (m *Value) GetValue() isValue_Value

func (*Value) ProtoMessage

func (*Value) ProtoMessage()

func (*Value) ProtoReflect

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

func (*Value) Reset

func (x *Value) Reset()

func (*Value) String

func (x *Value) String() string

type Value_DoubleValue

type Value_DoubleValue struct {
	// A double value.
	DoubleValue float64 `protobuf:"fixed64,2,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type Value_IntValue

type Value_IntValue struct {
	// An integer value.
	IntValue int64 `protobuf:"varint,1,opt,name=int_value,json=intValue,proto3,oneof"`
}

type Value_StringValue

type Value_StringValue struct {
	// A string value.
	StringValue string `protobuf:"bytes,3,opt,name=string_value,json=stringValue,proto3,oneof"`
}

type VideoMetadata

type VideoMetadata struct {

	// Optional. The start offset of the video.
	StartOffset *durationpb.Duration `protobuf:"bytes,1,opt,name=start_offset,json=startOffset,proto3" json:"start_offset,omitempty"`
	// Optional. The end offset of the video.
	EndOffset *durationpb.Duration `protobuf:"bytes,2,opt,name=end_offset,json=endOffset,proto3" json:"end_offset,omitempty"`
	// contains filtered or unexported fields
}

Metadata describes the input video content.

func (*VideoMetadata) Descriptor deprecated

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

Deprecated: Use VideoMetadata.ProtoReflect.Descriptor instead.

func (*VideoMetadata) GetEndOffset

func (x *VideoMetadata) GetEndOffset() *durationpb.Duration

func (*VideoMetadata) GetStartOffset

func (x *VideoMetadata) GetStartOffset() *durationpb.Duration

func (*VideoMetadata) ProtoMessage

func (*VideoMetadata) ProtoMessage()

func (*VideoMetadata) ProtoReflect

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

func (*VideoMetadata) Reset

func (x *VideoMetadata) Reset()

func (*VideoMetadata) String

func (x *VideoMetadata) String() string

type XraiAttribution

type XraiAttribution struct {

	// Required. The number of steps for approximating the path integral.
	// A good value to start is 50 and gradually increase until the
	// sum to diff property is met within the desired error range.
	//
	// Valid range of its value is [1, 100], inclusively.
	StepCount int32 `protobuf:"varint,1,opt,name=step_count,json=stepCount,proto3" json:"step_count,omitempty"`
	// Config for SmoothGrad approximation of gradients.
	//
	// When enabled, the gradients are approximated by averaging the gradients
	// from noisy samples in the vicinity of the inputs. Adding
	// noise can help improve the computed gradients. Refer to this paper for more
	// details: https://arxiv.org/pdf/1706.03825.pdf
	SmoothGradConfig *SmoothGradConfig `protobuf:"bytes,2,opt,name=smooth_grad_config,json=smoothGradConfig,proto3" json:"smooth_grad_config,omitempty"`
	// Config for XRAI with blur baseline.
	//
	// When enabled, a linear path from the maximally blurred image to the input
	// image is created. Using a blurred baseline instead of zero (black image) is
	// motivated by the BlurIG approach explained here:
	// https://arxiv.org/abs/2004.03383
	BlurBaselineConfig *BlurBaselineConfig `protobuf:"bytes,3,opt,name=blur_baseline_config,json=blurBaselineConfig,proto3" json:"blur_baseline_config,omitempty"`
	// contains filtered or unexported fields
}

An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825

Supported only by image Models.

func (*XraiAttribution) Descriptor deprecated

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

Deprecated: Use XraiAttribution.ProtoReflect.Descriptor instead.

func (*XraiAttribution) GetBlurBaselineConfig

func (x *XraiAttribution) GetBlurBaselineConfig() *BlurBaselineConfig

func (*XraiAttribution) GetSmoothGradConfig

func (x *XraiAttribution) GetSmoothGradConfig() *SmoothGradConfig

func (*XraiAttribution) GetStepCount

func (x *XraiAttribution) GetStepCount() int32

func (*XraiAttribution) ProtoMessage

func (*XraiAttribution) ProtoMessage()

func (*XraiAttribution) ProtoReflect

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

func (*XraiAttribution) Reset

func (x *XraiAttribution) Reset()

func (*XraiAttribution) String

func (x *XraiAttribution) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL