Constants
ModelArmor_ListTemplates_FullMethodName, ModelArmor_GetTemplate_FullMethodName, ModelArmor_CreateTemplate_FullMethodName, ModelArmor_UpdateTemplate_FullMethodName, ModelArmor_DeleteTemplate_FullMethodName, ModelArmor_GetFloorSetting_FullMethodName, ModelArmor_UpdateFloorSetting_FullMethodName, ModelArmor_SanitizeUserPrompt_FullMethodName, ModelArmor_SanitizeModelResponse_FullMethodName
const (
ModelArmor_ListTemplates_FullMethodName = "/google.cloud.modelarmor.v1beta.ModelArmor/ListTemplates"
ModelArmor_GetTemplate_FullMethodName = "/google.cloud.modelarmor.v1beta.ModelArmor/GetTemplate"
ModelArmor_CreateTemplate_FullMethodName = "/google.cloud.modelarmor.v1beta.ModelArmor/CreateTemplate"
ModelArmor_UpdateTemplate_FullMethodName = "/google.cloud.modelarmor.v1beta.ModelArmor/UpdateTemplate"
ModelArmor_DeleteTemplate_FullMethodName = "/google.cloud.modelarmor.v1beta.ModelArmor/DeleteTemplate"
ModelArmor_GetFloorSetting_FullMethodName = "/google.cloud.modelarmor.v1beta.ModelArmor/GetFloorSetting"
ModelArmor_UpdateFloorSetting_FullMethodName = "/google.cloud.modelarmor.v1beta.ModelArmor/UpdateFloorSetting"
ModelArmor_SanitizeUserPrompt_FullMethodName = "/google.cloud.modelarmor.v1beta.ModelArmor/SanitizeUserPrompt"
ModelArmor_SanitizeModelResponse_FullMethodName = "/google.cloud.modelarmor.v1beta.ModelArmor/SanitizeModelResponse"
)Variables
FilterMatchState_name, FilterMatchState_value
var (
FilterMatchState_name = map[int32]string{
0: "FILTER_MATCH_STATE_UNSPECIFIED",
1: "NO_MATCH_FOUND",
2: "MATCH_FOUND",
}
FilterMatchState_value = map[string]int32{
"FILTER_MATCH_STATE_UNSPECIFIED": 0,
"NO_MATCH_FOUND": 1,
"MATCH_FOUND": 2,
}
)Enum value maps for FilterMatchState.
FilterExecutionState_name, FilterExecutionState_value
var (
FilterExecutionState_name = map[int32]string{
0: "FILTER_EXECUTION_STATE_UNSPECIFIED",
1: "EXECUTION_SUCCESS",
2: "EXECUTION_SKIPPED",
}
FilterExecutionState_value = map[string]int32{
"FILTER_EXECUTION_STATE_UNSPECIFIED": 0,
"EXECUTION_SUCCESS": 1,
"EXECUTION_SKIPPED": 2,
}
)Enum value maps for FilterExecutionState.
RaiFilterType_name, RaiFilterType_value
var (
RaiFilterType_name = map[int32]string{
0: "RAI_FILTER_TYPE_UNSPECIFIED",
2: "SEXUALLY_EXPLICIT",
3: "HATE_SPEECH",
6: "HARASSMENT",
17: "DANGEROUS",
}
RaiFilterType_value = map[string]int32{
"RAI_FILTER_TYPE_UNSPECIFIED": 0,
"SEXUALLY_EXPLICIT": 2,
"HATE_SPEECH": 3,
"HARASSMENT": 6,
"DANGEROUS": 17,
}
)Enum value maps for RaiFilterType.
DetectionConfidenceLevel_name, DetectionConfidenceLevel_value
var (
DetectionConfidenceLevel_name = map[int32]string{
0: "DETECTION_CONFIDENCE_LEVEL_UNSPECIFIED",
1: "LOW_AND_ABOVE",
2: "MEDIUM_AND_ABOVE",
3: "HIGH",
}
DetectionConfidenceLevel_value = map[string]int32{
"DETECTION_CONFIDENCE_LEVEL_UNSPECIFIED": 0,
"LOW_AND_ABOVE": 1,
"MEDIUM_AND_ABOVE": 2,
"HIGH": 3,
}
)Enum value maps for DetectionConfidenceLevel.
SdpFindingLikelihood_name, SdpFindingLikelihood_value
var (
SdpFindingLikelihood_name = map[int32]string{
0: "SDP_FINDING_LIKELIHOOD_UNSPECIFIED",
1: "VERY_UNLIKELY",
2: "UNLIKELY",
3: "POSSIBLE",
4: "LIKELY",
5: "VERY_LIKELY",
}
SdpFindingLikelihood_value = map[string]int32{
"SDP_FINDING_LIKELIHOOD_UNSPECIFIED": 0,
"VERY_UNLIKELY": 1,
"UNLIKELY": 2,
"POSSIBLE": 3,
"LIKELY": 4,
"VERY_LIKELY": 5,
}
)Enum value maps for SdpFindingLikelihood.
InvocationResult_name, InvocationResult_value
var (
InvocationResult_name = map[int32]string{
0: "INVOCATION_RESULT_UNSPECIFIED",
1: "SUCCESS",
2: "PARTIAL",
3: "FAILURE",
}
InvocationResult_value = map[string]int32{
"INVOCATION_RESULT_UNSPECIFIED": 0,
"SUCCESS": 1,
"PARTIAL": 2,
"FAILURE": 3,
}
)Enum value maps for InvocationResult.
Template_TemplateMetadata_EnforcementType_name, Template_TemplateMetadata_EnforcementType_value
var (
Template_TemplateMetadata_EnforcementType_name = map[int32]string{
0: "ENFORCEMENT_TYPE_UNSPECIFIED",
1: "INSPECT_ONLY",
2: "INSPECT_AND_BLOCK",
}
Template_TemplateMetadata_EnforcementType_value = map[string]int32{
"ENFORCEMENT_TYPE_UNSPECIFIED": 0,
"INSPECT_ONLY": 1,
"INSPECT_AND_BLOCK": 2,
}
)Enum value maps for Template_TemplateMetadata_EnforcementType.
FloorSetting_IntegratedService_name, FloorSetting_IntegratedService_value
var (
FloorSetting_IntegratedService_name = map[int32]string{
0: "INTEGRATED_SERVICE_UNSPECIFIED",
1: "AI_PLATFORM",
}
FloorSetting_IntegratedService_value = map[string]int32{
"INTEGRATED_SERVICE_UNSPECIFIED": 0,
"AI_PLATFORM": 1,
}
)Enum value maps for FloorSetting_IntegratedService.
PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement_name, PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement_value
var (
PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement_name = map[int32]string{
0: "PI_AND_JAILBREAK_FILTER_ENFORCEMENT_UNSPECIFIED",
1: "ENABLED",
2: "DISABLED",
}
PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement_value = map[string]int32{
"PI_AND_JAILBREAK_FILTER_ENFORCEMENT_UNSPECIFIED": 0,
"ENABLED": 1,
"DISABLED": 2,
}
)Enum value maps for PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement.
MaliciousUriFilterSettings_MaliciousUriFilterEnforcement_name, MaliciousUriFilterSettings_MaliciousUriFilterEnforcement_value
var (
MaliciousUriFilterSettings_MaliciousUriFilterEnforcement_name = map[int32]string{
0: "MALICIOUS_URI_FILTER_ENFORCEMENT_UNSPECIFIED",
1: "ENABLED",
2: "DISABLED",
}
MaliciousUriFilterSettings_MaliciousUriFilterEnforcement_value = map[string]int32{
"MALICIOUS_URI_FILTER_ENFORCEMENT_UNSPECIFIED": 0,
"ENABLED": 1,
"DISABLED": 2,
}
)Enum value maps for MaliciousUriFilterSettings_MaliciousUriFilterEnforcement.
SdpBasicConfig_SdpBasicConfigEnforcement_name, SdpBasicConfig_SdpBasicConfigEnforcement_value
var (
SdpBasicConfig_SdpBasicConfigEnforcement_name = map[int32]string{
0: "SDP_BASIC_CONFIG_ENFORCEMENT_UNSPECIFIED",
1: "ENABLED",
2: "DISABLED",
}
SdpBasicConfig_SdpBasicConfigEnforcement_value = map[string]int32{
"SDP_BASIC_CONFIG_ENFORCEMENT_UNSPECIFIED": 0,
"ENABLED": 1,
"DISABLED": 2,
}
)Enum value maps for SdpBasicConfig_SdpBasicConfigEnforcement.
ByteDataItem_ByteItemType_name, ByteDataItem_ByteItemType_value
var (
ByteDataItem_ByteItemType_name = map[int32]string{
0: "BYTE_ITEM_TYPE_UNSPECIFIED",
1: "PLAINTEXT_UTF8",
2: "PDF",
3: "WORD_DOCUMENT",
4: "EXCEL_DOCUMENT",
5: "POWERPOINT_DOCUMENT",
6: "TXT",
7: "CSV",
}
ByteDataItem_ByteItemType_value = map[string]int32{
"BYTE_ITEM_TYPE_UNSPECIFIED": 0,
"PLAINTEXT_UTF8": 1,
"PDF": 2,
"WORD_DOCUMENT": 3,
"EXCEL_DOCUMENT": 4,
"POWERPOINT_DOCUMENT": 5,
"TXT": 6,
"CSV": 7,
}
)Enum value maps for ByteDataItem_ByteItemType.
VirusScanFilterResult_ScannedContentType_name, VirusScanFilterResult_ScannedContentType_value
var (
VirusScanFilterResult_ScannedContentType_name = map[int32]string{
0: "SCANNED_CONTENT_TYPE_UNSPECIFIED",
1: "UNKNOWN",
2: "PLAINTEXT",
3: "PDF",
}
VirusScanFilterResult_ScannedContentType_value = map[string]int32{
"SCANNED_CONTENT_TYPE_UNSPECIFIED": 0,
"UNKNOWN": 1,
"PLAINTEXT": 2,
"PDF": 3,
}
)Enum value maps for VirusScanFilterResult_ScannedContentType.
VirusDetail_ThreatType_name, VirusDetail_ThreatType_value
var (
VirusDetail_ThreatType_name = map[int32]string{
0: "THREAT_TYPE_UNSPECIFIED",
1: "UNKNOWN",
2: "VIRUS_OR_WORM",
3: "MALICIOUS_PROGRAM",
4: "POTENTIALLY_HARMFUL_CONTENT",
5: "POTENTIALLY_UNWANTED_CONTENT",
}
VirusDetail_ThreatType_value = map[string]int32{
"THREAT_TYPE_UNSPECIFIED": 0,
"UNKNOWN": 1,
"VIRUS_OR_WORM": 2,
"MALICIOUS_PROGRAM": 3,
"POTENTIALLY_HARMFUL_CONTENT": 4,
"POTENTIALLY_UNWANTED_CONTENT": 5,
}
)Enum value maps for VirusDetail_ThreatType.
MessageItem_MessageType_name, MessageItem_MessageType_value
var (
MessageItem_MessageType_name = map[int32]string{
0: "MESSAGE_TYPE_UNSPECIFIED",
1: "INFO",
2: "WARNING",
3: "ERROR",
}
MessageItem_MessageType_value = map[string]int32{
"MESSAGE_TYPE_UNSPECIFIED": 0,
"INFO": 1,
"WARNING": 2,
"ERROR": 3,
}
)Enum value maps for MessageItem_MessageType.
File_google_cloud_modelarmor_v1beta_service_proto
var File_google_cloud_modelarmor_v1beta_service_proto protoreflect.FileDescriptorModelArmor_ServiceDesc
var ModelArmor_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.modelarmor.v1beta.ModelArmor",
HandlerType: (*ModelArmorServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "ListTemplates",
Handler: _ModelArmor_ListTemplates_Handler,
},
{
MethodName: "GetTemplate",
Handler: _ModelArmor_GetTemplate_Handler,
},
{
MethodName: "CreateTemplate",
Handler: _ModelArmor_CreateTemplate_Handler,
},
{
MethodName: "UpdateTemplate",
Handler: _ModelArmor_UpdateTemplate_Handler,
},
{
MethodName: "DeleteTemplate",
Handler: _ModelArmor_DeleteTemplate_Handler,
},
{
MethodName: "GetFloorSetting",
Handler: _ModelArmor_GetFloorSetting_Handler,
},
{
MethodName: "UpdateFloorSetting",
Handler: _ModelArmor_UpdateFloorSetting_Handler,
},
{
MethodName: "SanitizeUserPrompt",
Handler: _ModelArmor_SanitizeUserPrompt_Handler,
},
{
MethodName: "SanitizeModelResponse",
Handler: _ModelArmor_SanitizeModelResponse_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/modelarmor/v1beta/service.proto",
}ModelArmor_ServiceDesc is the grpc.ServiceDesc for ModelArmor service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions
func RegisterModelArmorServer
func RegisterModelArmorServer(s grpc.ServiceRegistrar, srv ModelArmorServer)AiPlatformFloorSetting
type AiPlatformFloorSetting struct {
// enforcement type for Model Armor filters.
//
// Types that are assignable to EnforcementType:
//
// *AiPlatformFloorSetting_InspectOnly
// *AiPlatformFloorSetting_InspectAndBlock
EnforcementType isAiPlatformFloorSetting_EnforcementType `protobuf_oneof:"enforcement_type"`
// Optional. If true, log Model Armor filter results to Cloud Logging.
EnableCloudLogging bool `protobuf:"varint,3,opt,name=enable_cloud_logging,json=enableCloudLogging,proto3" json:"enable_cloud_logging,omitempty"`
// contains filtered or unexported fields
}message describing AiPlatformFloorSetting
func (*AiPlatformFloorSetting) Descriptor
func (*AiPlatformFloorSetting) Descriptor() ([]byte, []int)Deprecated: Use AiPlatformFloorSetting.ProtoReflect.Descriptor instead.
func (*AiPlatformFloorSetting) GetEnableCloudLogging
func (x *AiPlatformFloorSetting) GetEnableCloudLogging() boolfunc (*AiPlatformFloorSetting) GetEnforcementType
func (m *AiPlatformFloorSetting) GetEnforcementType() isAiPlatformFloorSetting_EnforcementTypefunc (*AiPlatformFloorSetting) GetInspectAndBlock
func (x *AiPlatformFloorSetting) GetInspectAndBlock() boolfunc (*AiPlatformFloorSetting) GetInspectOnly
func (x *AiPlatformFloorSetting) GetInspectOnly() boolfunc (*AiPlatformFloorSetting) ProtoMessage
func (*AiPlatformFloorSetting) ProtoMessage()func (*AiPlatformFloorSetting) ProtoReflect
func (x *AiPlatformFloorSetting) ProtoReflect() protoreflect.Messagefunc (*AiPlatformFloorSetting) Reset
func (x *AiPlatformFloorSetting) Reset()func (*AiPlatformFloorSetting) String
func (x *AiPlatformFloorSetting) String() stringAiPlatformFloorSetting_InspectAndBlock
type AiPlatformFloorSetting_InspectAndBlock struct {
// Optional. If true, Model Armor filters will be run in inspect and block
// mode. Requests that trip Model Armor filters will be blocked.
InspectAndBlock bool `protobuf:"varint,2,opt,name=inspect_and_block,json=inspectAndBlock,proto3,oneof"`
}AiPlatformFloorSetting_InspectOnly
type AiPlatformFloorSetting_InspectOnly struct {
// Optional. If true, Model Armor filters will be run in inspect only mode.
// No action will be taken on the request.
InspectOnly bool `protobuf:"varint,1,opt,name=inspect_only,json=inspectOnly,proto3,oneof"`
}ByteDataItem
type ByteDataItem struct {
// Required. The type of byte data
ByteDataType ByteDataItem_ByteItemType `protobuf:"varint,1,opt,name=byte_data_type,json=byteDataType,proto3,enum=google.cloud.modelarmor.v1beta.ByteDataItem_ByteItemType" json:"byte_data_type,omitempty"`
// Required. Bytes Data
ByteData []byte `protobuf:"bytes,2,opt,name=byte_data,json=byteData,proto3" json:"byte_data,omitempty"`
// contains filtered or unexported fields
}Represents Byte Data item.
func (*ByteDataItem) Descriptor
func (*ByteDataItem) Descriptor() ([]byte, []int)Deprecated: Use ByteDataItem.ProtoReflect.Descriptor instead.
func (*ByteDataItem) GetByteData
func (x *ByteDataItem) GetByteData() []bytefunc (*ByteDataItem) GetByteDataType
func (x *ByteDataItem) GetByteDataType() ByteDataItem_ByteItemTypefunc (*ByteDataItem) ProtoMessage
func (*ByteDataItem) ProtoMessage()func (*ByteDataItem) ProtoReflect
func (x *ByteDataItem) ProtoReflect() protoreflect.Messagefunc (*ByteDataItem) Reset
func (x *ByteDataItem) Reset()func (*ByteDataItem) String
func (x *ByteDataItem) String() stringByteDataItem_ByteItemType
type ByteDataItem_ByteItemType int32Option to specify the type of byte data.
ByteDataItem_BYTE_ITEM_TYPE_UNSPECIFIED, ByteDataItem_PLAINTEXT_UTF8, ByteDataItem_PDF, ByteDataItem_WORD_DOCUMENT, ByteDataItem_EXCEL_DOCUMENT, ByteDataItem_POWERPOINT_DOCUMENT, ByteDataItem_TXT, ByteDataItem_CSV
const (
// Unused
ByteDataItem_BYTE_ITEM_TYPE_UNSPECIFIED ByteDataItem_ByteItemType = 0
// plain text
ByteDataItem_PLAINTEXT_UTF8 ByteDataItem_ByteItemType = 1
// PDF
ByteDataItem_PDF ByteDataItem_ByteItemType = 2
// DOCX, DOCM, DOTX, DOTM
ByteDataItem_WORD_DOCUMENT ByteDataItem_ByteItemType = 3
// XLSX, XLSM, XLTX, XLYM
ByteDataItem_EXCEL_DOCUMENT ByteDataItem_ByteItemType = 4
// PPTX, PPTM, POTX, POTM, POT
ByteDataItem_POWERPOINT_DOCUMENT ByteDataItem_ByteItemType = 5
// TXT
ByteDataItem_TXT ByteDataItem_ByteItemType = 6
// CSV
ByteDataItem_CSV ByteDataItem_ByteItemType = 7
)func (ByteDataItem_ByteItemType) Descriptor
func (ByteDataItem_ByteItemType) Descriptor() protoreflect.EnumDescriptorfunc (ByteDataItem_ByteItemType) Enum
func (x ByteDataItem_ByteItemType) Enum() *ByteDataItem_ByteItemTypefunc (ByteDataItem_ByteItemType) EnumDescriptor
func (ByteDataItem_ByteItemType) EnumDescriptor() ([]byte, []int)Deprecated: Use ByteDataItem_ByteItemType.Descriptor instead.
func (ByteDataItem_ByteItemType) Number
func (x ByteDataItem_ByteItemType) Number() protoreflect.EnumNumberfunc (ByteDataItem_ByteItemType) String
func (x ByteDataItem_ByteItemType) String() stringfunc (ByteDataItem_ByteItemType) Type
func (ByteDataItem_ByteItemType) Type() protoreflect.EnumTypeCreateTemplateRequest
type CreateTemplateRequest struct {
// Required. Value for parent.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Id of the requesting object
// If auto-generating Id server-side, remove this field and
// template_id from the method_signature of Create RPC
TemplateId string `protobuf:"bytes,2,opt,name=template_id,json=templateId,proto3" json:"template_id,omitempty"`
// Required. The resource being created
Template *Template `protobuf:"bytes,3,opt,name=template,proto3" json:"template,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server stores the
// request ID for 60 minutes after the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}Message for creating a Template
func (*CreateTemplateRequest) Descriptor
func (*CreateTemplateRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateTemplateRequest.ProtoReflect.Descriptor instead.
func (*CreateTemplateRequest) GetParent
func (x *CreateTemplateRequest) GetParent() stringfunc (*CreateTemplateRequest) GetRequestId
func (x *CreateTemplateRequest) GetRequestId() stringfunc (*CreateTemplateRequest) GetTemplate
func (x *CreateTemplateRequest) GetTemplate() *Templatefunc (*CreateTemplateRequest) GetTemplateId
func (x *CreateTemplateRequest) GetTemplateId() stringfunc (*CreateTemplateRequest) ProtoMessage
func (*CreateTemplateRequest) ProtoMessage()func (*CreateTemplateRequest) ProtoReflect
func (x *CreateTemplateRequest) ProtoReflect() protoreflect.Messagefunc (*CreateTemplateRequest) Reset
func (x *CreateTemplateRequest) Reset()func (*CreateTemplateRequest) String
func (x *CreateTemplateRequest) String() stringCsamFilterResult
type CsamFilterResult struct {
// Output only. Reports whether the CSAM filter was successfully executed or
// not.
ExecutionState FilterExecutionState `protobuf:"varint,1,opt,name=execution_state,json=executionState,proto3,enum=google.cloud.modelarmor.v1beta.FilterExecutionState" json:"execution_state,omitempty"`
// Optional messages corresponding to the result.
// A message can provide warnings or error details.
// For example, if execution state is skipped then this field provides
// related reason/explanation.
MessageItems []*MessageItem `protobuf:"bytes,2,rep,name=message_items,json=messageItems,proto3" json:"message_items,omitempty"`
// Output only. Match state for CSAM.
MatchState FilterMatchState `protobuf:"varint,3,opt,name=match_state,json=matchState,proto3,enum=google.cloud.modelarmor.v1beta.FilterMatchState" json:"match_state,omitempty"`
// contains filtered or unexported fields
}CSAM (Child Safety Abuse Material) Filter Result
func (*CsamFilterResult) Descriptor
func (*CsamFilterResult) Descriptor() ([]byte, []int)Deprecated: Use CsamFilterResult.ProtoReflect.Descriptor instead.
func (*CsamFilterResult) GetExecutionState
func (x *CsamFilterResult) GetExecutionState() FilterExecutionStatefunc (*CsamFilterResult) GetMatchState
func (x *CsamFilterResult) GetMatchState() FilterMatchStatefunc (*CsamFilterResult) GetMessageItems
func (x *CsamFilterResult) GetMessageItems() []*MessageItemfunc (*CsamFilterResult) ProtoMessage
func (*CsamFilterResult) ProtoMessage()func (*CsamFilterResult) ProtoReflect
func (x *CsamFilterResult) ProtoReflect() protoreflect.Messagefunc (*CsamFilterResult) Reset
func (x *CsamFilterResult) Reset()func (*CsamFilterResult) String
func (x *CsamFilterResult) String() stringDataItem
type DataItem struct {
// Either of text or bytes data.
//
// Types that are assignable to DataItem:
//
// *DataItem_Text
// *DataItem_ByteItem
DataItem isDataItem_DataItem `protobuf_oneof:"data_item"`
// contains filtered or unexported fields
}Represents Data item
func (*DataItem) Descriptor
Deprecated: Use DataItem.ProtoReflect.Descriptor instead.
func (*DataItem) GetByteItem
func (x *DataItem) GetByteItem() *ByteDataItemfunc (*DataItem) GetDataItem
func (m *DataItem) GetDataItem() isDataItem_DataItemfunc (*DataItem) GetText
func (*DataItem) ProtoMessage
func (*DataItem) ProtoMessage()func (*DataItem) ProtoReflect
func (x *DataItem) ProtoReflect() protoreflect.Messagefunc (*DataItem) Reset
func (x *DataItem) Reset()func (*DataItem) String
DataItem_ByteItem
type DataItem_ByteItem struct {
// Data provided in the form of bytes.
ByteItem *ByteDataItem `protobuf:"bytes,2,opt,name=byte_item,json=byteItem,proto3,oneof"`
}DataItem_Text
type DataItem_Text struct {
// Plaintext string data for sanitization.
Text string `protobuf:"bytes,1,opt,name=text,proto3,oneof"`
}DeleteTemplateRequest
type DeleteTemplateRequest struct {
// Required. Name of the resource
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server stores the
// request ID for 60 minutes after the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}Message for deleting a Template
func (*DeleteTemplateRequest) Descriptor
func (*DeleteTemplateRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteTemplateRequest.ProtoReflect.Descriptor instead.
func (*DeleteTemplateRequest) GetName
func (x *DeleteTemplateRequest) GetName() stringfunc (*DeleteTemplateRequest) GetRequestId
func (x *DeleteTemplateRequest) GetRequestId() stringfunc (*DeleteTemplateRequest) ProtoMessage
func (*DeleteTemplateRequest) ProtoMessage()func (*DeleteTemplateRequest) ProtoReflect
func (x *DeleteTemplateRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteTemplateRequest) Reset
func (x *DeleteTemplateRequest) Reset()func (*DeleteTemplateRequest) String
func (x *DeleteTemplateRequest) String() stringDetectionConfidenceLevel
type DetectionConfidenceLevel int32Confidence levels for detectors. Higher value maps to a greater confidence level. To enforce stricter level a lower value should be used.
DetectionConfidenceLevel_DETECTION_CONFIDENCE_LEVEL_UNSPECIFIED, DetectionConfidenceLevel_LOW_AND_ABOVE, DetectionConfidenceLevel_MEDIUM_AND_ABOVE, DetectionConfidenceLevel_HIGH
const (
// Same as LOW_AND_ABOVE.
DetectionConfidenceLevel_DETECTION_CONFIDENCE_LEVEL_UNSPECIFIED DetectionConfidenceLevel = 0
// Highest chance of a false positive.
DetectionConfidenceLevel_LOW_AND_ABOVE DetectionConfidenceLevel = 1
// Some chance of false positives.
DetectionConfidenceLevel_MEDIUM_AND_ABOVE DetectionConfidenceLevel = 2
// Low chance of false positives.
DetectionConfidenceLevel_HIGH DetectionConfidenceLevel = 3
)func (DetectionConfidenceLevel) Descriptor
func (DetectionConfidenceLevel) Descriptor() protoreflect.EnumDescriptorfunc (DetectionConfidenceLevel) Enum
func (x DetectionConfidenceLevel) Enum() *DetectionConfidenceLevelfunc (DetectionConfidenceLevel) EnumDescriptor
func (DetectionConfidenceLevel) EnumDescriptor() ([]byte, []int)Deprecated: Use DetectionConfidenceLevel.Descriptor instead.
func (DetectionConfidenceLevel) Number
func (x DetectionConfidenceLevel) Number() protoreflect.EnumNumberfunc (DetectionConfidenceLevel) String
func (x DetectionConfidenceLevel) String() stringfunc (DetectionConfidenceLevel) Type
func (DetectionConfidenceLevel) Type() protoreflect.EnumTypeFilterConfig
type FilterConfig struct {
// Optional. Responsible AI settings.
RaiSettings *RaiFilterSettings `protobuf:"bytes,1,opt,name=rai_settings,json=raiSettings,proto3" json:"rai_settings,omitempty"`
// Optional. Sensitive Data Protection settings.
SdpSettings *SdpFilterSettings `protobuf:"bytes,2,opt,name=sdp_settings,json=sdpSettings,proto3" json:"sdp_settings,omitempty"`
// Optional. Prompt injection and Jailbreak filter settings.
PiAndJailbreakFilterSettings *PiAndJailbreakFilterSettings `protobuf:"bytes,3,opt,name=pi_and_jailbreak_filter_settings,json=piAndJailbreakFilterSettings,proto3" json:"pi_and_jailbreak_filter_settings,omitempty"`
// Optional. Malicious URI filter settings.
MaliciousUriFilterSettings *MaliciousUriFilterSettings `protobuf:"bytes,4,opt,name=malicious_uri_filter_settings,json=maliciousUriFilterSettings,proto3" json:"malicious_uri_filter_settings,omitempty"`
// contains filtered or unexported fields
}Filters configuration.
func (*FilterConfig) Descriptor
func (*FilterConfig) Descriptor() ([]byte, []int)Deprecated: Use FilterConfig.ProtoReflect.Descriptor instead.
func (*FilterConfig) GetMaliciousUriFilterSettings
func (x *FilterConfig) GetMaliciousUriFilterSettings() *MaliciousUriFilterSettingsfunc (*FilterConfig) GetPiAndJailbreakFilterSettings
func (x *FilterConfig) GetPiAndJailbreakFilterSettings() *PiAndJailbreakFilterSettingsfunc (*FilterConfig) GetRaiSettings
func (x *FilterConfig) GetRaiSettings() *RaiFilterSettingsfunc (*FilterConfig) GetSdpSettings
func (x *FilterConfig) GetSdpSettings() *SdpFilterSettingsfunc (*FilterConfig) ProtoMessage
func (*FilterConfig) ProtoMessage()func (*FilterConfig) ProtoReflect
func (x *FilterConfig) ProtoReflect() protoreflect.Messagefunc (*FilterConfig) Reset
func (x *FilterConfig) Reset()func (*FilterConfig) String
func (x *FilterConfig) String() stringFilterExecutionState
type FilterExecutionState int32Enum which reports whether a specific filter executed successfully or not.
FilterExecutionState_FILTER_EXECUTION_STATE_UNSPECIFIED, FilterExecutionState_EXECUTION_SUCCESS, FilterExecutionState_EXECUTION_SKIPPED
const (
// Unused
FilterExecutionState_FILTER_EXECUTION_STATE_UNSPECIFIED FilterExecutionState = 0
// Filter executed successfully
FilterExecutionState_EXECUTION_SUCCESS FilterExecutionState = 1
// Filter execution was skipped. This can happen due to server-side error
// or permission issue.
FilterExecutionState_EXECUTION_SKIPPED FilterExecutionState = 2
)func (FilterExecutionState) Descriptor
func (FilterExecutionState) Descriptor() protoreflect.EnumDescriptorfunc (FilterExecutionState) Enum
func (x FilterExecutionState) Enum() *FilterExecutionStatefunc (FilterExecutionState) EnumDescriptor
func (FilterExecutionState) EnumDescriptor() ([]byte, []int)Deprecated: Use FilterExecutionState.Descriptor instead.
func (FilterExecutionState) Number
func (x FilterExecutionState) Number() protoreflect.EnumNumberfunc (FilterExecutionState) String
func (x FilterExecutionState) String() stringfunc (FilterExecutionState) Type
func (FilterExecutionState) Type() protoreflect.EnumTypeFilterMatchState
type FilterMatchState int32Option to specify filter match state.
FilterMatchState_FILTER_MATCH_STATE_UNSPECIFIED, FilterMatchState_NO_MATCH_FOUND, FilterMatchState_MATCH_FOUND
const (
// Unused
FilterMatchState_FILTER_MATCH_STATE_UNSPECIFIED FilterMatchState = 0
// Matching criteria is not achieved for filters.
FilterMatchState_NO_MATCH_FOUND FilterMatchState = 1
// Matching criteria is achieved for the filter.
FilterMatchState_MATCH_FOUND FilterMatchState = 2
)func (FilterMatchState) Descriptor
func (FilterMatchState) Descriptor() protoreflect.EnumDescriptorfunc (FilterMatchState) Enum
func (x FilterMatchState) Enum() *FilterMatchStatefunc (FilterMatchState) EnumDescriptor
func (FilterMatchState) EnumDescriptor() ([]byte, []int)Deprecated: Use FilterMatchState.Descriptor instead.
func (FilterMatchState) Number
func (x FilterMatchState) Number() protoreflect.EnumNumberfunc (FilterMatchState) String
func (x FilterMatchState) String() stringfunc (FilterMatchState) Type
func (FilterMatchState) Type() protoreflect.EnumTypeFilterResult
type FilterResult struct {
// Encapsulates one of responsible AI, Sensitive Data Protection, Prompt
// Injection and Jailbreak, Malicious URI, CSAM, Virus Scan related filter
// results.
//
// Types that are assignable to FilterResult:
//
// *FilterResult_RaiFilterResult
// *FilterResult_SdpFilterResult
// *FilterResult_PiAndJailbreakFilterResult
// *FilterResult_MaliciousUriFilterResult
// *FilterResult_CsamFilterFilterResult
// *FilterResult_VirusScanFilterResult
FilterResult isFilterResult_FilterResult `protobuf_oneof:"filter_result"`
// contains filtered or unexported fields
}Filter Result obtained after Sanitization operations.
func (*FilterResult) Descriptor
func (*FilterResult) Descriptor() ([]byte, []int)Deprecated: Use FilterResult.ProtoReflect.Descriptor instead.
func (*FilterResult) GetCsamFilterFilterResult
func (x *FilterResult) GetCsamFilterFilterResult() *CsamFilterResultfunc (*FilterResult) GetFilterResult
func (m *FilterResult) GetFilterResult() isFilterResult_FilterResultfunc (*FilterResult) GetMaliciousUriFilterResult
func (x *FilterResult) GetMaliciousUriFilterResult() *MaliciousUriFilterResultfunc (*FilterResult) GetPiAndJailbreakFilterResult
func (x *FilterResult) GetPiAndJailbreakFilterResult() *PiAndJailbreakFilterResultfunc (*FilterResult) GetRaiFilterResult
func (x *FilterResult) GetRaiFilterResult() *RaiFilterResultfunc (*FilterResult) GetSdpFilterResult
func (x *FilterResult) GetSdpFilterResult() *SdpFilterResultfunc (*FilterResult) GetVirusScanFilterResult
func (x *FilterResult) GetVirusScanFilterResult() *VirusScanFilterResultfunc (*FilterResult) ProtoMessage
func (*FilterResult) ProtoMessage()func (*FilterResult) ProtoReflect
func (x *FilterResult) ProtoReflect() protoreflect.Messagefunc (*FilterResult) Reset
func (x *FilterResult) Reset()func (*FilterResult) String
func (x *FilterResult) String() stringFilterResult_CsamFilterFilterResult
type FilterResult_CsamFilterFilterResult struct {
// CSAM filter results.
CsamFilterFilterResult *CsamFilterResult `protobuf:"bytes,5,opt,name=csam_filter_filter_result,json=csamFilterFilterResult,proto3,oneof"`
}FilterResult_MaliciousUriFilterResult
type FilterResult_MaliciousUriFilterResult struct {
// Malicious URI filter results.
MaliciousUriFilterResult *MaliciousUriFilterResult `protobuf:"bytes,4,opt,name=malicious_uri_filter_result,json=maliciousUriFilterResult,proto3,oneof"`
}FilterResult_PiAndJailbreakFilterResult
type FilterResult_PiAndJailbreakFilterResult struct {
// Prompt injection and Jailbreak filter results.
PiAndJailbreakFilterResult *PiAndJailbreakFilterResult `protobuf:"bytes,3,opt,name=pi_and_jailbreak_filter_result,json=piAndJailbreakFilterResult,proto3,oneof"`
}FilterResult_RaiFilterResult
type FilterResult_RaiFilterResult struct {
// Responsible AI filter results.
RaiFilterResult *RaiFilterResult `protobuf:"bytes,1,opt,name=rai_filter_result,json=raiFilterResult,proto3,oneof"`
}FilterResult_SdpFilterResult
type FilterResult_SdpFilterResult struct {
// Sensitive Data Protection results.
SdpFilterResult *SdpFilterResult `protobuf:"bytes,2,opt,name=sdp_filter_result,json=sdpFilterResult,proto3,oneof"`
}FilterResult_VirusScanFilterResult
type FilterResult_VirusScanFilterResult struct {
// Virus scan results.
VirusScanFilterResult *VirusScanFilterResult `protobuf:"bytes,6,opt,name=virus_scan_filter_result,json=virusScanFilterResult,proto3,oneof"`
}FloorSetting
type FloorSetting struct {
// Identifier. The resource name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. [Output only] Create timestamp
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. [Output only] Update timestamp
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Required. ModelArmor filter configuration.
FilterConfig *FilterConfig `protobuf:"bytes,4,opt,name=filter_config,json=filterConfig,proto3" json:"filter_config,omitempty"`
// Optional. Floor Settings enforcement status.
EnableFloorSettingEnforcement *bool `protobuf:"varint,5,opt,name=enable_floor_setting_enforcement,json=enableFloorSettingEnforcement,proto3,oneof" json:"enable_floor_setting_enforcement,omitempty"`
// Optional. List of integrated services for which the floor setting is
// applicable.
IntegratedServices []FloorSetting_IntegratedService `protobuf:"varint,6,rep,packed,name=integrated_services,json=integratedServices,proto3,enum=google.cloud.modelarmor.v1beta.FloorSetting_IntegratedService" json:"integrated_services,omitempty"`
// Optional. AI Platform floor setting.
AiPlatformFloorSetting *AiPlatformFloorSetting `protobuf:"bytes,7,opt,name=ai_platform_floor_setting,json=aiPlatformFloorSetting,proto3,oneof" json:"ai_platform_floor_setting,omitempty"`
// Optional. Metadata for FloorSetting
FloorSettingMetadata *FloorSetting_FloorSettingMetadata `protobuf:"bytes,8,opt,name=floor_setting_metadata,json=floorSettingMetadata,proto3" json:"floor_setting_metadata,omitempty"`
// contains filtered or unexported fields
}Message describing FloorSetting resource
func (*FloorSetting) Descriptor
func (*FloorSetting) Descriptor() ([]byte, []int)Deprecated: Use FloorSetting.ProtoReflect.Descriptor instead.
func (*FloorSetting) GetAiPlatformFloorSetting
func (x *FloorSetting) GetAiPlatformFloorSetting() *AiPlatformFloorSettingfunc (*FloorSetting) GetCreateTime
func (x *FloorSetting) GetCreateTime() *timestamppb.Timestampfunc (*FloorSetting) GetEnableFloorSettingEnforcement
func (x *FloorSetting) GetEnableFloorSettingEnforcement() boolfunc (*FloorSetting) GetFilterConfig
func (x *FloorSetting) GetFilterConfig() *FilterConfigfunc (*FloorSetting) GetFloorSettingMetadata
func (x *FloorSetting) GetFloorSettingMetadata() *FloorSetting_FloorSettingMetadatafunc (*FloorSetting) GetIntegratedServices
func (x *FloorSetting) GetIntegratedServices() []FloorSetting_IntegratedServicefunc (*FloorSetting) GetName
func (x *FloorSetting) GetName() stringfunc (*FloorSetting) GetUpdateTime
func (x *FloorSetting) GetUpdateTime() *timestamppb.Timestampfunc (*FloorSetting) ProtoMessage
func (*FloorSetting) ProtoMessage()func (*FloorSetting) ProtoReflect
func (x *FloorSetting) ProtoReflect() protoreflect.Messagefunc (*FloorSetting) Reset
func (x *FloorSetting) Reset()func (*FloorSetting) String
func (x *FloorSetting) String() stringFloorSetting_FloorSettingMetadata
type FloorSetting_FloorSettingMetadata struct {
// Optional. Metadata for multi language detection.
MultiLanguageDetection *FloorSetting_FloorSettingMetadata_MultiLanguageDetection `protobuf:"bytes,1,opt,name=multi_language_detection,json=multiLanguageDetection,proto3" json:"multi_language_detection,omitempty"`
// contains filtered or unexported fields
}message describing FloorSetting Metadata
func (*FloorSetting_FloorSettingMetadata) Descriptor
func (*FloorSetting_FloorSettingMetadata) Descriptor() ([]byte, []int)Deprecated: Use FloorSetting_FloorSettingMetadata.ProtoReflect.Descriptor instead.
func (*FloorSetting_FloorSettingMetadata) GetMultiLanguageDetection
func (x *FloorSetting_FloorSettingMetadata) GetMultiLanguageDetection() *FloorSetting_FloorSettingMetadata_MultiLanguageDetectionfunc (*FloorSetting_FloorSettingMetadata) ProtoMessage
func (*FloorSetting_FloorSettingMetadata) ProtoMessage()func (*FloorSetting_FloorSettingMetadata) ProtoReflect
func (x *FloorSetting_FloorSettingMetadata) ProtoReflect() protoreflect.Messagefunc (*FloorSetting_FloorSettingMetadata) Reset
func (x *FloorSetting_FloorSettingMetadata) Reset()func (*FloorSetting_FloorSettingMetadata) String
func (x *FloorSetting_FloorSettingMetadata) String() stringFloorSetting_FloorSettingMetadata_MultiLanguageDetection
type FloorSetting_FloorSettingMetadata_MultiLanguageDetection struct {
// Required. If true, multi language detection will be enabled.
EnableMultiLanguageDetection bool `protobuf:"varint,1,opt,name=enable_multi_language_detection,json=enableMultiLanguageDetection,proto3" json:"enable_multi_language_detection,omitempty"`
// contains filtered or unexported fields
}Metadata to enable multi language detection via floor setting.
func (*FloorSetting_FloorSettingMetadata_MultiLanguageDetection) Descriptor
func (*FloorSetting_FloorSettingMetadata_MultiLanguageDetection) Descriptor() ([]byte, []int)Deprecated: Use FloorSetting_FloorSettingMetadata_MultiLanguageDetection.ProtoReflect.Descriptor instead.
func (*FloorSetting_FloorSettingMetadata_MultiLanguageDetection) GetEnableMultiLanguageDetection
func (x *FloorSetting_FloorSettingMetadata_MultiLanguageDetection) GetEnableMultiLanguageDetection() boolfunc (*FloorSetting_FloorSettingMetadata_MultiLanguageDetection) ProtoMessage
func (*FloorSetting_FloorSettingMetadata_MultiLanguageDetection) ProtoMessage()func (*FloorSetting_FloorSettingMetadata_MultiLanguageDetection) ProtoReflect
func (x *FloorSetting_FloorSettingMetadata_MultiLanguageDetection) ProtoReflect() protoreflect.Messagefunc (*FloorSetting_FloorSettingMetadata_MultiLanguageDetection) Reset
func (x *FloorSetting_FloorSettingMetadata_MultiLanguageDetection) Reset()func (*FloorSetting_FloorSettingMetadata_MultiLanguageDetection) String
func (x *FloorSetting_FloorSettingMetadata_MultiLanguageDetection) String() stringFloorSetting_IntegratedService
type FloorSetting_IntegratedService int32Integrated service for which the floor setting is applicable.
FloorSetting_INTEGRATED_SERVICE_UNSPECIFIED, FloorSetting_AI_PLATFORM
const (
// Unspecified integrated service.
FloorSetting_INTEGRATED_SERVICE_UNSPECIFIED FloorSetting_IntegratedService = 0
// AI Platform.
FloorSetting_AI_PLATFORM FloorSetting_IntegratedService = 1
)func (FloorSetting_IntegratedService) Descriptor
func (FloorSetting_IntegratedService) Descriptor() protoreflect.EnumDescriptorfunc (FloorSetting_IntegratedService) Enum
func (x FloorSetting_IntegratedService) Enum() *FloorSetting_IntegratedServicefunc (FloorSetting_IntegratedService) EnumDescriptor
func (FloorSetting_IntegratedService) EnumDescriptor() ([]byte, []int)Deprecated: Use FloorSetting_IntegratedService.Descriptor instead.
func (FloorSetting_IntegratedService) Number
func (x FloorSetting_IntegratedService) Number() protoreflect.EnumNumberfunc (FloorSetting_IntegratedService) String
func (x FloorSetting_IntegratedService) String() stringfunc (FloorSetting_IntegratedService) Type
func (FloorSetting_IntegratedService) Type() protoreflect.EnumTypeGetFloorSettingRequest
type GetFloorSettingRequest struct {
// Required. The name of the floor setting to get, example
// projects/123/floorsetting.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Message for getting a Floor Setting
func (*GetFloorSettingRequest) Descriptor
func (*GetFloorSettingRequest) Descriptor() ([]byte, []int)Deprecated: Use GetFloorSettingRequest.ProtoReflect.Descriptor instead.
func (*GetFloorSettingRequest) GetName
func (x *GetFloorSettingRequest) GetName() stringfunc (*GetFloorSettingRequest) ProtoMessage
func (*GetFloorSettingRequest) ProtoMessage()func (*GetFloorSettingRequest) ProtoReflect
func (x *GetFloorSettingRequest) ProtoReflect() protoreflect.Messagefunc (*GetFloorSettingRequest) Reset
func (x *GetFloorSettingRequest) Reset()func (*GetFloorSettingRequest) String
func (x *GetFloorSettingRequest) String() stringGetTemplateRequest
type GetTemplateRequest struct {
// Required. Name of the resource
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Message for getting a Template
func (*GetTemplateRequest) Descriptor
func (*GetTemplateRequest) Descriptor() ([]byte, []int)Deprecated: Use GetTemplateRequest.ProtoReflect.Descriptor instead.
func (*GetTemplateRequest) GetName
func (x *GetTemplateRequest) GetName() stringfunc (*GetTemplateRequest) ProtoMessage
func (*GetTemplateRequest) ProtoMessage()func (*GetTemplateRequest) ProtoReflect
func (x *GetTemplateRequest) ProtoReflect() protoreflect.Messagefunc (*GetTemplateRequest) Reset
func (x *GetTemplateRequest) Reset()func (*GetTemplateRequest) String
func (x *GetTemplateRequest) String() stringInvocationResult
type InvocationResult int32A field indicating the outcome of the invocation, irrespective of match status.
InvocationResult_INVOCATION_RESULT_UNSPECIFIED, InvocationResult_SUCCESS, InvocationResult_PARTIAL, InvocationResult_FAILURE
const (
// Unused. Default value.
InvocationResult_INVOCATION_RESULT_UNSPECIFIED InvocationResult = 0
// All filters were invoked successfully.
InvocationResult_SUCCESS InvocationResult = 1
// Some filters were skipped or failed.
InvocationResult_PARTIAL InvocationResult = 2
// All filters were skipped or failed.
InvocationResult_FAILURE InvocationResult = 3
)func (InvocationResult) Descriptor
func (InvocationResult) Descriptor() protoreflect.EnumDescriptorfunc (InvocationResult) Enum
func (x InvocationResult) Enum() *InvocationResultfunc (InvocationResult) EnumDescriptor
func (InvocationResult) EnumDescriptor() ([]byte, []int)Deprecated: Use InvocationResult.Descriptor instead.
func (InvocationResult) Number
func (x InvocationResult) Number() protoreflect.EnumNumberfunc (InvocationResult) String
func (x InvocationResult) String() stringfunc (InvocationResult) Type
func (InvocationResult) Type() protoreflect.EnumTypeListTemplatesRequest
type ListTemplatesRequest struct {
// Required. Parent value for ListTemplatesRequest
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Requested page size. Server may return fewer items than
// requested. If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A token identifying a page of results the server should return.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filtering results
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. Hint for how to order the results
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}Message for requesting list of Templates
func (*ListTemplatesRequest) Descriptor
func (*ListTemplatesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListTemplatesRequest.ProtoReflect.Descriptor instead.
func (*ListTemplatesRequest) GetFilter
func (x *ListTemplatesRequest) GetFilter() stringfunc (*ListTemplatesRequest) GetOrderBy
func (x *ListTemplatesRequest) GetOrderBy() stringfunc (*ListTemplatesRequest) GetPageSize
func (x *ListTemplatesRequest) GetPageSize() int32func (*ListTemplatesRequest) GetPageToken
func (x *ListTemplatesRequest) GetPageToken() stringfunc (*ListTemplatesRequest) GetParent
func (x *ListTemplatesRequest) GetParent() stringfunc (*ListTemplatesRequest) ProtoMessage
func (*ListTemplatesRequest) ProtoMessage()func (*ListTemplatesRequest) ProtoReflect
func (x *ListTemplatesRequest) ProtoReflect() protoreflect.Messagefunc (*ListTemplatesRequest) Reset
func (x *ListTemplatesRequest) Reset()func (*ListTemplatesRequest) String
func (x *ListTemplatesRequest) String() stringListTemplatesResponse
type ListTemplatesResponse struct {
// The list of Template
Templates []*Template `protobuf:"bytes,1,rep,name=templates,proto3" json:"templates,omitempty"`
// A token identifying a page of results the server should return.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Locations that could not be reached.
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}Message for response to listing Templates
func (*ListTemplatesResponse) Descriptor
func (*ListTemplatesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListTemplatesResponse.ProtoReflect.Descriptor instead.
func (*ListTemplatesResponse) GetNextPageToken
func (x *ListTemplatesResponse) GetNextPageToken() stringfunc (*ListTemplatesResponse) GetTemplates
func (x *ListTemplatesResponse) GetTemplates() []*Templatefunc (*ListTemplatesResponse) GetUnreachable
func (x *ListTemplatesResponse) GetUnreachable() []stringfunc (*ListTemplatesResponse) ProtoMessage
func (*ListTemplatesResponse) ProtoMessage()func (*ListTemplatesResponse) ProtoReflect
func (x *ListTemplatesResponse) ProtoReflect() protoreflect.Messagefunc (*ListTemplatesResponse) Reset
func (x *ListTemplatesResponse) Reset()func (*ListTemplatesResponse) String
func (x *ListTemplatesResponse) String() stringMaliciousUriFilterResult
type MaliciousUriFilterResult struct {
// Output only. Reports whether Malicious URI filter was successfully executed
// or not.
ExecutionState FilterExecutionState `protobuf:"varint,1,opt,name=execution_state,json=executionState,proto3,enum=google.cloud.modelarmor.v1beta.FilterExecutionState" json:"execution_state,omitempty"`
// Optional messages corresponding to the result.
// A message can provide warnings or error details.
// For example, if execution state is skipped then this field provides
// related reason/explanation.
MessageItems []*MessageItem `protobuf:"bytes,2,rep,name=message_items,json=messageItems,proto3" json:"message_items,omitempty"`
// Output only. Match state for this Malicious URI.
// Value is MATCH_FOUND if at least one Malicious URI is found.
MatchState FilterMatchState `protobuf:"varint,3,opt,name=match_state,json=matchState,proto3,enum=google.cloud.modelarmor.v1beta.FilterMatchState" json:"match_state,omitempty"`
// List of Malicious URIs found in data.
MaliciousUriMatchedItems []*MaliciousUriFilterResult_MaliciousUriMatchedItem `protobuf:"bytes,4,rep,name=malicious_uri_matched_items,json=maliciousUriMatchedItems,proto3" json:"malicious_uri_matched_items,omitempty"`
// contains filtered or unexported fields
}Malicious URI Filter Result.
func (*MaliciousUriFilterResult) Descriptor
func (*MaliciousUriFilterResult) Descriptor() ([]byte, []int)Deprecated: Use MaliciousUriFilterResult.ProtoReflect.Descriptor instead.
func (*MaliciousUriFilterResult) GetExecutionState
func (x *MaliciousUriFilterResult) GetExecutionState() FilterExecutionStatefunc (*MaliciousUriFilterResult) GetMaliciousUriMatchedItems
func (x *MaliciousUriFilterResult) GetMaliciousUriMatchedItems() []*MaliciousUriFilterResult_MaliciousUriMatchedItemfunc (*MaliciousUriFilterResult) GetMatchState
func (x *MaliciousUriFilterResult) GetMatchState() FilterMatchStatefunc (*MaliciousUriFilterResult) GetMessageItems
func (x *MaliciousUriFilterResult) GetMessageItems() []*MessageItemfunc (*MaliciousUriFilterResult) ProtoMessage
func (*MaliciousUriFilterResult) ProtoMessage()func (*MaliciousUriFilterResult) ProtoReflect
func (x *MaliciousUriFilterResult) ProtoReflect() protoreflect.Messagefunc (*MaliciousUriFilterResult) Reset
func (x *MaliciousUriFilterResult) Reset()func (*MaliciousUriFilterResult) String
func (x *MaliciousUriFilterResult) String() stringMaliciousUriFilterResult_MaliciousUriMatchedItem
type MaliciousUriFilterResult_MaliciousUriMatchedItem struct {
// Malicious URI.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// List of locations where Malicious URI is identified.
// The `locations` field is supported only for plaintext content i.e.
// ByteItemType.PLAINTEXT_UTF8
Locations []*RangeInfo `protobuf:"bytes,2,rep,name=locations,proto3" json:"locations,omitempty"`
// contains filtered or unexported fields
}Information regarding malicious URI and its location within the input content.
func (*MaliciousUriFilterResult_MaliciousUriMatchedItem) Descriptor
func (*MaliciousUriFilterResult_MaliciousUriMatchedItem) Descriptor() ([]byte, []int)Deprecated: Use MaliciousUriFilterResult_MaliciousUriMatchedItem.ProtoReflect.Descriptor instead.
func (*MaliciousUriFilterResult_MaliciousUriMatchedItem) GetLocations
func (x *MaliciousUriFilterResult_MaliciousUriMatchedItem) GetLocations() []*RangeInfofunc (*MaliciousUriFilterResult_MaliciousUriMatchedItem) GetUri
func (x *MaliciousUriFilterResult_MaliciousUriMatchedItem) GetUri() stringfunc (*MaliciousUriFilterResult_MaliciousUriMatchedItem) ProtoMessage
func (*MaliciousUriFilterResult_MaliciousUriMatchedItem) ProtoMessage()func (*MaliciousUriFilterResult_MaliciousUriMatchedItem) ProtoReflect
func (x *MaliciousUriFilterResult_MaliciousUriMatchedItem) ProtoReflect() protoreflect.Messagefunc (*MaliciousUriFilterResult_MaliciousUriMatchedItem) Reset
func (x *MaliciousUriFilterResult_MaliciousUriMatchedItem) Reset()func (*MaliciousUriFilterResult_MaliciousUriMatchedItem) String
func (x *MaliciousUriFilterResult_MaliciousUriMatchedItem) String() stringMaliciousUriFilterSettings
type MaliciousUriFilterSettings struct {
// Optional. Tells whether the Malicious URI filter is enabled or disabled.
FilterEnforcement MaliciousUriFilterSettings_MaliciousUriFilterEnforcement `protobuf:"varint,1,opt,name=filter_enforcement,json=filterEnforcement,proto3,enum=google.cloud.modelarmor.v1beta.MaliciousUriFilterSettings_MaliciousUriFilterEnforcement" json:"filter_enforcement,omitempty"`
// contains filtered or unexported fields
}Malicious URI filter settings.
func (*MaliciousUriFilterSettings) Descriptor
func (*MaliciousUriFilterSettings) Descriptor() ([]byte, []int)Deprecated: Use MaliciousUriFilterSettings.ProtoReflect.Descriptor instead.
func (*MaliciousUriFilterSettings) GetFilterEnforcement
func (x *MaliciousUriFilterSettings) GetFilterEnforcement() MaliciousUriFilterSettings_MaliciousUriFilterEnforcementfunc (*MaliciousUriFilterSettings) ProtoMessage
func (*MaliciousUriFilterSettings) ProtoMessage()func (*MaliciousUriFilterSettings) ProtoReflect
func (x *MaliciousUriFilterSettings) ProtoReflect() protoreflect.Messagefunc (*MaliciousUriFilterSettings) Reset
func (x *MaliciousUriFilterSettings) Reset()func (*MaliciousUriFilterSettings) String
func (x *MaliciousUriFilterSettings) String() stringMaliciousUriFilterSettings_MaliciousUriFilterEnforcement
type MaliciousUriFilterSettings_MaliciousUriFilterEnforcement int32Option to specify the state of Malicious URI filter (ENABLED/DISABLED).
MaliciousUriFilterSettings_MALICIOUS_URI_FILTER_ENFORCEMENT_UNSPECIFIED, MaliciousUriFilterSettings_ENABLED, MaliciousUriFilterSettings_DISABLED
const (
// Same as Disabled
MaliciousUriFilterSettings_MALICIOUS_URI_FILTER_ENFORCEMENT_UNSPECIFIED MaliciousUriFilterSettings_MaliciousUriFilterEnforcement = 0
// Enabled
MaliciousUriFilterSettings_ENABLED MaliciousUriFilterSettings_MaliciousUriFilterEnforcement = 1
// Disabled
MaliciousUriFilterSettings_DISABLED MaliciousUriFilterSettings_MaliciousUriFilterEnforcement = 2
)func (MaliciousUriFilterSettings_MaliciousUriFilterEnforcement) Descriptor
func (MaliciousUriFilterSettings_MaliciousUriFilterEnforcement) Descriptor() protoreflect.EnumDescriptorfunc (MaliciousUriFilterSettings_MaliciousUriFilterEnforcement) Enum
func (x MaliciousUriFilterSettings_MaliciousUriFilterEnforcement) Enum() *MaliciousUriFilterSettings_MaliciousUriFilterEnforcementfunc (MaliciousUriFilterSettings_MaliciousUriFilterEnforcement) EnumDescriptor
func (MaliciousUriFilterSettings_MaliciousUriFilterEnforcement) EnumDescriptor() ([]byte, []int)Deprecated: Use MaliciousUriFilterSettings_MaliciousUriFilterEnforcement.Descriptor instead.
func (MaliciousUriFilterSettings_MaliciousUriFilterEnforcement) Number
func (x MaliciousUriFilterSettings_MaliciousUriFilterEnforcement) Number() protoreflect.EnumNumberfunc (MaliciousUriFilterSettings_MaliciousUriFilterEnforcement) String
func (x MaliciousUriFilterSettings_MaliciousUriFilterEnforcement) String() stringfunc (MaliciousUriFilterSettings_MaliciousUriFilterEnforcement) Type
MessageItem
type MessageItem struct {
// Type of message.
MessageType MessageItem_MessageType `protobuf:"varint,1,opt,name=message_type,json=messageType,proto3,enum=google.cloud.modelarmor.v1beta.MessageItem_MessageType" json:"message_type,omitempty"`
// The message content.
Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
// contains filtered or unexported fields
}Message item to report information, warning or error messages.
func (*MessageItem) Descriptor
func (*MessageItem) Descriptor() ([]byte, []int)Deprecated: Use MessageItem.ProtoReflect.Descriptor instead.
func (*MessageItem) GetMessage
func (x *MessageItem) GetMessage() stringfunc (*MessageItem) GetMessageType
func (x *MessageItem) GetMessageType() MessageItem_MessageTypefunc (*MessageItem) ProtoMessage
func (*MessageItem) ProtoMessage()func (*MessageItem) ProtoReflect
func (x *MessageItem) ProtoReflect() protoreflect.Messagefunc (*MessageItem) Reset
func (x *MessageItem) Reset()func (*MessageItem) String
func (x *MessageItem) String() stringMessageItem_MessageType
type MessageItem_MessageType int32Option to specify the type of message.
MessageItem_MESSAGE_TYPE_UNSPECIFIED, MessageItem_INFO, MessageItem_WARNING, MessageItem_ERROR
const (
// Unused
MessageItem_MESSAGE_TYPE_UNSPECIFIED MessageItem_MessageType = 0
// Information related message.
MessageItem_INFO MessageItem_MessageType = 1
// Warning related message.
MessageItem_WARNING MessageItem_MessageType = 2
// Error message.
MessageItem_ERROR MessageItem_MessageType = 3
)func (MessageItem_MessageType) Descriptor
func (MessageItem_MessageType) Descriptor() protoreflect.EnumDescriptorfunc (MessageItem_MessageType) Enum
func (x MessageItem_MessageType) Enum() *MessageItem_MessageTypefunc (MessageItem_MessageType) EnumDescriptor
func (MessageItem_MessageType) EnumDescriptor() ([]byte, []int)Deprecated: Use MessageItem_MessageType.Descriptor instead.
func (MessageItem_MessageType) Number
func (x MessageItem_MessageType) Number() protoreflect.EnumNumberfunc (MessageItem_MessageType) String
func (x MessageItem_MessageType) String() stringfunc (MessageItem_MessageType) Type
func (MessageItem_MessageType) Type() protoreflect.EnumTypeModelArmorClient
type ModelArmorClient interface {
// Lists Templates in a given project and location.
ListTemplates(ctx context.Context, in *ListTemplatesRequest, opts ...grpc.CallOption) (*ListTemplatesResponse, error)
// Gets details of a single Template.
GetTemplate(ctx context.Context, in *GetTemplateRequest, opts ...grpc.CallOption) (*Template, error)
// Creates a new Template in a given project and location.
CreateTemplate(ctx context.Context, in *CreateTemplateRequest, opts ...grpc.CallOption) (*Template, error)
// Updates the parameters of a single Template.
UpdateTemplate(ctx context.Context, in *UpdateTemplateRequest, opts ...grpc.CallOption) (*Template, error)
// Deletes a single Template.
DeleteTemplate(ctx context.Context, in *DeleteTemplateRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Gets details of a single floor setting of a project
GetFloorSetting(ctx context.Context, in *GetFloorSettingRequest, opts ...grpc.CallOption) (*FloorSetting, error)
// Updates the parameters of a single floor setting of a project
UpdateFloorSetting(ctx context.Context, in *UpdateFloorSettingRequest, opts ...grpc.CallOption) (*FloorSetting, error)
// Sanitizes User Prompt.
SanitizeUserPrompt(ctx context.Context, in *SanitizeUserPromptRequest, opts ...grpc.CallOption) (*SanitizeUserPromptResponse, error)
// Sanitizes Model Response.
SanitizeModelResponse(ctx context.Context, in *SanitizeModelResponseRequest, opts ...grpc.CallOption) (*SanitizeModelResponseResponse, error)
}ModelArmorClient is the client API for ModelArmor service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewModelArmorClient
func NewModelArmorClient(cc grpc.ClientConnInterface) ModelArmorClientModelArmorServer
type ModelArmorServer interface {
// Lists Templates in a given project and location.
ListTemplates(context.Context, *ListTemplatesRequest) (*ListTemplatesResponse, error)
// Gets details of a single Template.
GetTemplate(context.Context, *GetTemplateRequest) (*Template, error)
// Creates a new Template in a given project and location.
CreateTemplate(context.Context, *CreateTemplateRequest) (*Template, error)
// Updates the parameters of a single Template.
UpdateTemplate(context.Context, *UpdateTemplateRequest) (*Template, error)
// Deletes a single Template.
DeleteTemplate(context.Context, *DeleteTemplateRequest) (*emptypb.Empty, error)
// Gets details of a single floor setting of a project
GetFloorSetting(context.Context, *GetFloorSettingRequest) (*FloorSetting, error)
// Updates the parameters of a single floor setting of a project
UpdateFloorSetting(context.Context, *UpdateFloorSettingRequest) (*FloorSetting, error)
// Sanitizes User Prompt.
SanitizeUserPrompt(context.Context, *SanitizeUserPromptRequest) (*SanitizeUserPromptResponse, error)
// Sanitizes Model Response.
SanitizeModelResponse(context.Context, *SanitizeModelResponseRequest) (*SanitizeModelResponseResponse, error)
}ModelArmorServer is the server API for ModelArmor service. All implementations should embed UnimplementedModelArmorServer for forward compatibility
MultiLanguageDetectionMetadata
type MultiLanguageDetectionMetadata struct {
// Optional. Optional Source language of the user prompt.
//
// If multi-language detection is enabled but language is not set in that case
// we would automatically detect the source language.
SourceLanguage string `protobuf:"bytes,1,opt,name=source_language,json=sourceLanguage,proto3" json:"source_language,omitempty"`
// Optional. Enable detection of multi-language prompts and responses.
EnableMultiLanguageDetection bool `protobuf:"varint,2,opt,name=enable_multi_language_detection,json=enableMultiLanguageDetection,proto3" json:"enable_multi_language_detection,omitempty"`
// contains filtered or unexported fields
}Message for Enabling Multi Language Detection.
func (*MultiLanguageDetectionMetadata) Descriptor
func (*MultiLanguageDetectionMetadata) Descriptor() ([]byte, []int)Deprecated: Use MultiLanguageDetectionMetadata.ProtoReflect.Descriptor instead.
func (*MultiLanguageDetectionMetadata) GetEnableMultiLanguageDetection
func (x *MultiLanguageDetectionMetadata) GetEnableMultiLanguageDetection() boolfunc (*MultiLanguageDetectionMetadata) GetSourceLanguage
func (x *MultiLanguageDetectionMetadata) GetSourceLanguage() stringfunc (*MultiLanguageDetectionMetadata) ProtoMessage
func (*MultiLanguageDetectionMetadata) ProtoMessage()func (*MultiLanguageDetectionMetadata) ProtoReflect
func (x *MultiLanguageDetectionMetadata) ProtoReflect() protoreflect.Messagefunc (*MultiLanguageDetectionMetadata) Reset
func (x *MultiLanguageDetectionMetadata) Reset()func (*MultiLanguageDetectionMetadata) String
func (x *MultiLanguageDetectionMetadata) String() stringPiAndJailbreakFilterResult
type PiAndJailbreakFilterResult struct {
// Output only. Reports whether Prompt injection and Jailbreak filter was
// successfully executed or not.
ExecutionState FilterExecutionState `protobuf:"varint,1,opt,name=execution_state,json=executionState,proto3,enum=google.cloud.modelarmor.v1beta.FilterExecutionState" json:"execution_state,omitempty"`
// Optional messages corresponding to the result.
// A message can provide warnings or error details.
// For example, if execution state is skipped then this field provides
// related reason/explanation.
MessageItems []*MessageItem `protobuf:"bytes,2,rep,name=message_items,json=messageItems,proto3" json:"message_items,omitempty"`
// Output only. Match state for Prompt injection and Jailbreak.
MatchState FilterMatchState `protobuf:"varint,3,opt,name=match_state,json=matchState,proto3,enum=google.cloud.modelarmor.v1beta.FilterMatchState" json:"match_state,omitempty"`
// Confidence level identified for Prompt injection and Jailbreak.
ConfidenceLevel DetectionConfidenceLevel `protobuf:"varint,5,opt,name=confidence_level,json=confidenceLevel,proto3,enum=google.cloud.modelarmor.v1beta.DetectionConfidenceLevel" json:"confidence_level,omitempty"`
// contains filtered or unexported fields
}Prompt injection and Jailbreak Filter Result.
func (*PiAndJailbreakFilterResult) Descriptor
func (*PiAndJailbreakFilterResult) Descriptor() ([]byte, []int)Deprecated: Use PiAndJailbreakFilterResult.ProtoReflect.Descriptor instead.
func (*PiAndJailbreakFilterResult) GetConfidenceLevel
func (x *PiAndJailbreakFilterResult) GetConfidenceLevel() DetectionConfidenceLevelfunc (*PiAndJailbreakFilterResult) GetExecutionState
func (x *PiAndJailbreakFilterResult) GetExecutionState() FilterExecutionStatefunc (*PiAndJailbreakFilterResult) GetMatchState
func (x *PiAndJailbreakFilterResult) GetMatchState() FilterMatchStatefunc (*PiAndJailbreakFilterResult) GetMessageItems
func (x *PiAndJailbreakFilterResult) GetMessageItems() []*MessageItemfunc (*PiAndJailbreakFilterResult) ProtoMessage
func (*PiAndJailbreakFilterResult) ProtoMessage()func (*PiAndJailbreakFilterResult) ProtoReflect
func (x *PiAndJailbreakFilterResult) ProtoReflect() protoreflect.Messagefunc (*PiAndJailbreakFilterResult) Reset
func (x *PiAndJailbreakFilterResult) Reset()func (*PiAndJailbreakFilterResult) String
func (x *PiAndJailbreakFilterResult) String() stringPiAndJailbreakFilterSettings
type PiAndJailbreakFilterSettings struct {
// Optional. Tells whether Prompt injection and Jailbreak filter is enabled or
// disabled.
FilterEnforcement PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement `protobuf:"varint,1,opt,name=filter_enforcement,json=filterEnforcement,proto3,enum=google.cloud.modelarmor.v1beta.PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement" json:"filter_enforcement,omitempty"`
// Optional. Confidence level for this filter.
// Confidence level is used to determine the threshold for the filter. If
// detection confidence is equal to or greater than the specified level, a
// positive match is reported. Confidence level will only be used if the
// filter is enabled.
ConfidenceLevel DetectionConfidenceLevel `protobuf:"varint,3,opt,name=confidence_level,json=confidenceLevel,proto3,enum=google.cloud.modelarmor.v1beta.DetectionConfidenceLevel" json:"confidence_level,omitempty"`
// contains filtered or unexported fields
}Prompt injection and Jailbreak Filter settings.
func (*PiAndJailbreakFilterSettings) Descriptor
func (*PiAndJailbreakFilterSettings) Descriptor() ([]byte, []int)Deprecated: Use PiAndJailbreakFilterSettings.ProtoReflect.Descriptor instead.
func (*PiAndJailbreakFilterSettings) GetConfidenceLevel
func (x *PiAndJailbreakFilterSettings) GetConfidenceLevel() DetectionConfidenceLevelfunc (*PiAndJailbreakFilterSettings) GetFilterEnforcement
func (x *PiAndJailbreakFilterSettings) GetFilterEnforcement() PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcementfunc (*PiAndJailbreakFilterSettings) ProtoMessage
func (*PiAndJailbreakFilterSettings) ProtoMessage()func (*PiAndJailbreakFilterSettings) ProtoReflect
func (x *PiAndJailbreakFilterSettings) ProtoReflect() protoreflect.Messagefunc (*PiAndJailbreakFilterSettings) Reset
func (x *PiAndJailbreakFilterSettings) Reset()func (*PiAndJailbreakFilterSettings) String
func (x *PiAndJailbreakFilterSettings) String() stringPiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement
type PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement int32Option to specify the state of Prompt Injection and Jailbreak filter (ENABLED/DISABLED).
PiAndJailbreakFilterSettings_PI_AND_JAILBREAK_FILTER_ENFORCEMENT_UNSPECIFIED, PiAndJailbreakFilterSettings_ENABLED, PiAndJailbreakFilterSettings_DISABLED
const (
// Same as Disabled
PiAndJailbreakFilterSettings_PI_AND_JAILBREAK_FILTER_ENFORCEMENT_UNSPECIFIED PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement = 0
// Enabled
PiAndJailbreakFilterSettings_ENABLED PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement = 1
// Enabled
PiAndJailbreakFilterSettings_DISABLED PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement = 2
)func (PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement) Descriptor
func (PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement) Descriptor() protoreflect.EnumDescriptorfunc (PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement) Enum
func (x PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement) Enum() *PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcementfunc (PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement) EnumDescriptor
func (PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement) EnumDescriptor() ([]byte, []int)Deprecated: Use PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement.Descriptor instead.
func (PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement) Number
func (x PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement) Number() protoreflect.EnumNumberfunc (PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement) String
func (x PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement) String() stringfunc (PiAndJailbreakFilterSettings_PiAndJailbreakFilterEnforcement) Type
RaiFilterResult
type RaiFilterResult struct {
// Output only. Reports whether the RAI filter was successfully executed or
// not.
ExecutionState FilterExecutionState `protobuf:"varint,1,opt,name=execution_state,json=executionState,proto3,enum=google.cloud.modelarmor.v1beta.FilterExecutionState" json:"execution_state,omitempty"`
// Optional messages corresponding to the result.
// A message can provide warnings or error details.
// For example, if execution state is skipped then this field provides
// related reason/explanation.
MessageItems []*MessageItem `protobuf:"bytes,2,rep,name=message_items,json=messageItems,proto3" json:"message_items,omitempty"`
// Output only. Overall filter match state for RAI.
// Value is MATCH_FOUND if at least one RAI filter confidence level is
// equal to or higher than the confidence level defined in configuration.
MatchState FilterMatchState `protobuf:"varint,3,opt,name=match_state,json=matchState,proto3,enum=google.cloud.modelarmor.v1beta.FilterMatchState" json:"match_state,omitempty"`
// The map of RAI filter results where key is RAI filter type - either of
// "sexually_explicit", "hate_speech", "harassment", "dangerous".
RaiFilterTypeResults map[string]*RaiFilterResult_RaiFilterTypeResult `protobuf:"bytes,4,rep,name=rai_filter_type_results,json=raiFilterTypeResults,proto3" json:"rai_filter_type_results,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}Responsible AI Result.
func (*RaiFilterResult) Descriptor
func (*RaiFilterResult) Descriptor() ([]byte, []int)Deprecated: Use RaiFilterResult.ProtoReflect.Descriptor instead.
func (*RaiFilterResult) GetExecutionState
func (x *RaiFilterResult) GetExecutionState() FilterExecutionStatefunc (*RaiFilterResult) GetMatchState
func (x *RaiFilterResult) GetMatchState() FilterMatchStatefunc (*RaiFilterResult) GetMessageItems
func (x *RaiFilterResult) GetMessageItems() []*MessageItemfunc (*RaiFilterResult) GetRaiFilterTypeResults
func (x *RaiFilterResult) GetRaiFilterTypeResults() map[string]*RaiFilterResult_RaiFilterTypeResultfunc (*RaiFilterResult) ProtoMessage
func (*RaiFilterResult) ProtoMessage()func (*RaiFilterResult) ProtoReflect
func (x *RaiFilterResult) ProtoReflect() protoreflect.Messagefunc (*RaiFilterResult) Reset
func (x *RaiFilterResult) Reset()func (*RaiFilterResult) String
func (x *RaiFilterResult) String() stringRaiFilterResult_RaiFilterTypeResult
type RaiFilterResult_RaiFilterTypeResult struct {
// Type of responsible AI filter.
FilterType RaiFilterType `protobuf:"varint,1,opt,name=filter_type,json=filterType,proto3,enum=google.cloud.modelarmor.v1beta.RaiFilterType" json:"filter_type,omitempty"`
// Confidence level identified for this RAI filter.
ConfidenceLevel DetectionConfidenceLevel `protobuf:"varint,2,opt,name=confidence_level,json=confidenceLevel,proto3,enum=google.cloud.modelarmor.v1beta.DetectionConfidenceLevel" json:"confidence_level,omitempty"`
// Output only. Match state for this RAI filter.
MatchState FilterMatchState `protobuf:"varint,3,opt,name=match_state,json=matchState,proto3,enum=google.cloud.modelarmor.v1beta.FilterMatchState" json:"match_state,omitempty"`
// contains filtered or unexported fields
}Detailed Filter result for each of the responsible AI Filter Types.
func (*RaiFilterResult_RaiFilterTypeResult) Descriptor
func (*RaiFilterResult_RaiFilterTypeResult) Descriptor() ([]byte, []int)Deprecated: Use RaiFilterResult_RaiFilterTypeResult.ProtoReflect.Descriptor instead.
func (*RaiFilterResult_RaiFilterTypeResult) GetConfidenceLevel
func (x *RaiFilterResult_RaiFilterTypeResult) GetConfidenceLevel() DetectionConfidenceLevelfunc (*RaiFilterResult_RaiFilterTypeResult) GetFilterType
func (x *RaiFilterResult_RaiFilterTypeResult) GetFilterType() RaiFilterTypefunc (*RaiFilterResult_RaiFilterTypeResult) GetMatchState
func (x *RaiFilterResult_RaiFilterTypeResult) GetMatchState() FilterMatchStatefunc (*RaiFilterResult_RaiFilterTypeResult) ProtoMessage
func (*RaiFilterResult_RaiFilterTypeResult) ProtoMessage()func (*RaiFilterResult_RaiFilterTypeResult) ProtoReflect
func (x *RaiFilterResult_RaiFilterTypeResult) ProtoReflect() protoreflect.Messagefunc (*RaiFilterResult_RaiFilterTypeResult) Reset
func (x *RaiFilterResult_RaiFilterTypeResult) Reset()func (*RaiFilterResult_RaiFilterTypeResult) String
func (x *RaiFilterResult_RaiFilterTypeResult) String() stringRaiFilterSettings
type RaiFilterSettings struct {
// Required. List of Responsible AI filters enabled for template.
RaiFilters []*RaiFilterSettings_RaiFilter `protobuf:"bytes,1,rep,name=rai_filters,json=raiFilters,proto3" json:"rai_filters,omitempty"`
// contains filtered or unexported fields
}Responsible AI Filter settings.
func (*RaiFilterSettings) Descriptor
func (*RaiFilterSettings) Descriptor() ([]byte, []int)Deprecated: Use RaiFilterSettings.ProtoReflect.Descriptor instead.
func (*RaiFilterSettings) GetRaiFilters
func (x *RaiFilterSettings) GetRaiFilters() []*RaiFilterSettings_RaiFilterfunc (*RaiFilterSettings) ProtoMessage
func (*RaiFilterSettings) ProtoMessage()func (*RaiFilterSettings) ProtoReflect
func (x *RaiFilterSettings) ProtoReflect() protoreflect.Messagefunc (*RaiFilterSettings) Reset
func (x *RaiFilterSettings) Reset()func (*RaiFilterSettings) String
func (x *RaiFilterSettings) String() stringRaiFilterSettings_RaiFilter
type RaiFilterSettings_RaiFilter struct {
// Required. Type of responsible AI filter.
FilterType RaiFilterType `protobuf:"varint,1,opt,name=filter_type,json=filterType,proto3,enum=google.cloud.modelarmor.v1beta.RaiFilterType" json:"filter_type,omitempty"`
// Optional. Confidence level for this RAI filter.
// During data sanitization, if data is classified under this filter with a
// confidence level equal to or greater than the specified level, a positive
// match is reported. If the confidence level is unspecified (i.e., 0), the
// system will use a reasonable default level based on the `filter_type`.
ConfidenceLevel DetectionConfidenceLevel `protobuf:"varint,2,opt,name=confidence_level,json=confidenceLevel,proto3,enum=google.cloud.modelarmor.v1beta.DetectionConfidenceLevel" json:"confidence_level,omitempty"`
// contains filtered or unexported fields
}Responsible AI filter.
func (*RaiFilterSettings_RaiFilter) Descriptor
func (*RaiFilterSettings_RaiFilter) Descriptor() ([]byte, []int)Deprecated: Use RaiFilterSettings_RaiFilter.ProtoReflect.Descriptor instead.
func (*RaiFilterSettings_RaiFilter) GetConfidenceLevel
func (x *RaiFilterSettings_RaiFilter) GetConfidenceLevel() DetectionConfidenceLevelfunc (*RaiFilterSettings_RaiFilter) GetFilterType
func (x *RaiFilterSettings_RaiFilter) GetFilterType() RaiFilterTypefunc (*RaiFilterSettings_RaiFilter) ProtoMessage
func (*RaiFilterSettings_RaiFilter) ProtoMessage()func (*RaiFilterSettings_RaiFilter) ProtoReflect
func (x *RaiFilterSettings_RaiFilter) ProtoReflect() protoreflect.Messagefunc (*RaiFilterSettings_RaiFilter) Reset
func (x *RaiFilterSettings_RaiFilter) Reset()func (*RaiFilterSettings_RaiFilter) String
func (x *RaiFilterSettings_RaiFilter) String() stringRaiFilterType
type RaiFilterType int32Options for responsible AI Filter Types.
RaiFilterType_RAI_FILTER_TYPE_UNSPECIFIED, RaiFilterType_SEXUALLY_EXPLICIT, RaiFilterType_HATE_SPEECH, RaiFilterType_HARASSMENT, RaiFilterType_DANGEROUS
const (
// Unspecified filter type.
RaiFilterType_RAI_FILTER_TYPE_UNSPECIFIED RaiFilterType = 0
// Sexually Explicit.
RaiFilterType_SEXUALLY_EXPLICIT RaiFilterType = 2
// Hate Speech.
RaiFilterType_HATE_SPEECH RaiFilterType = 3
// Harassment.
RaiFilterType_HARASSMENT RaiFilterType = 6
// Danger
RaiFilterType_DANGEROUS RaiFilterType = 17
)func (RaiFilterType) Descriptor
func (RaiFilterType) Descriptor() protoreflect.EnumDescriptorfunc (RaiFilterType) Enum
func (x RaiFilterType) Enum() *RaiFilterTypefunc (RaiFilterType) EnumDescriptor
func (RaiFilterType) EnumDescriptor() ([]byte, []int)Deprecated: Use RaiFilterType.Descriptor instead.
func (RaiFilterType) Number
func (x RaiFilterType) Number() protoreflect.EnumNumberfunc (RaiFilterType) String
func (x RaiFilterType) String() stringfunc (RaiFilterType) Type
func (RaiFilterType) Type() protoreflect.EnumTypeRangeInfo
type RangeInfo struct {
// For proto3, value cannot be set to 0 unless the field is optional.
// Ref: https://protobuf.dev/programming-guides/proto3/#default
// Index of first character (inclusive).
Start *int64 `protobuf:"varint,1,opt,name=start,proto3,oneof" json:"start,omitempty"`
// Index of last character (exclusive).
End *int64 `protobuf:"varint,2,opt,name=end,proto3,oneof" json:"end,omitempty"`
// contains filtered or unexported fields
}Half-open range interval [start, end)
func (*RangeInfo) Descriptor
Deprecated: Use RangeInfo.ProtoReflect.Descriptor instead.
func (*RangeInfo) GetEnd
func (*RangeInfo) GetStart
func (*RangeInfo) ProtoMessage
func (*RangeInfo) ProtoMessage()func (*RangeInfo) ProtoReflect
func (x *RangeInfo) ProtoReflect() protoreflect.Messagefunc (*RangeInfo) Reset
func (x *RangeInfo) Reset()func (*RangeInfo) String
SanitizationResult
type SanitizationResult struct {
// Output only. Overall filter match state for Sanitization.
// The state can have below two values.
//
// 1) NO_MATCH_FOUND: No filters in configuration satisfy matching criteria.
// In other words, input passed all filters.
//
// 2) MATCH_FOUND: At least one filter in configuration satisfies matching.
// In other words, input did not pass one or more filters.
FilterMatchState FilterMatchState `protobuf:"varint,1,opt,name=filter_match_state,json=filterMatchState,proto3,enum=google.cloud.modelarmor.v1beta.FilterMatchState" json:"filter_match_state,omitempty"`
// Output only. Results for all filters where the key is the filter name -
// either of "csam", "malicious_uris", "rai", "pi_and_jailbreak" ,"sdp".
FilterResults map[string]*FilterResult `protobuf:"bytes,2,rep,name=filter_results,json=filterResults,proto3" json:"filter_results,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Output only. A field indicating the outcome of the invocation, irrespective
// of match status. It can have the following three values: SUCCESS: All
// filters were executed successfully. PARTIAL: Some filters were skipped or
// failed execution. FAILURE: All filters were skipped or failed execution.
InvocationResult InvocationResult `protobuf:"varint,4,opt,name=invocation_result,json=invocationResult,proto3,enum=google.cloud.modelarmor.v1beta.InvocationResult" json:"invocation_result,omitempty"`
// Output only. Metadata related to Sanitization.
SanitizationMetadata *SanitizationResult_SanitizationMetadata `protobuf:"bytes,3,opt,name=sanitization_metadata,json=sanitizationMetadata,proto3" json:"sanitization_metadata,omitempty"`
// contains filtered or unexported fields
}Sanitization result after applying all the filters on input content.
func (*SanitizationResult) Descriptor
func (*SanitizationResult) Descriptor() ([]byte, []int)Deprecated: Use SanitizationResult.ProtoReflect.Descriptor instead.
func (*SanitizationResult) GetFilterMatchState
func (x *SanitizationResult) GetFilterMatchState() FilterMatchStatefunc (*SanitizationResult) GetFilterResults
func (x *SanitizationResult) GetFilterResults() map[string]*FilterResultfunc (*SanitizationResult) GetInvocationResult
func (x *SanitizationResult) GetInvocationResult() InvocationResultfunc (*SanitizationResult) GetSanitizationMetadata
func (x *SanitizationResult) GetSanitizationMetadata() *SanitizationResult_SanitizationMetadatafunc (*SanitizationResult) ProtoMessage
func (*SanitizationResult) ProtoMessage()func (*SanitizationResult) ProtoReflect
func (x *SanitizationResult) ProtoReflect() protoreflect.Messagefunc (*SanitizationResult) Reset
func (x *SanitizationResult) Reset()func (*SanitizationResult) String
func (x *SanitizationResult) String() stringSanitizationResult_SanitizationMetadata
type SanitizationResult_SanitizationMetadata struct {
// Error code if any.
ErrorCode int64 `protobuf:"varint,1,opt,name=error_code,json=errorCode,proto3" json:"error_code,omitempty"`
// Error message if any.
ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
// Passthrough field defined in TemplateMetadata to indicate whether to
// ignore partial invocation failures.
IgnorePartialInvocationFailures bool `protobuf:"varint,3,opt,name=ignore_partial_invocation_failures,json=ignorePartialInvocationFailures,proto3" json:"ignore_partial_invocation_failures,omitempty"`
// contains filtered or unexported fields
}Message describing Sanitization metadata.
func (*SanitizationResult_SanitizationMetadata) Descriptor
func (*SanitizationResult_SanitizationMetadata) Descriptor() ([]byte, []int)Deprecated: Use SanitizationResult_SanitizationMetadata.ProtoReflect.Descriptor instead.
func (*SanitizationResult_SanitizationMetadata) GetErrorCode
func (x *SanitizationResult_SanitizationMetadata) GetErrorCode() int64func (*SanitizationResult_SanitizationMetadata) GetErrorMessage
func (x *SanitizationResult_SanitizationMetadata) GetErrorMessage() stringfunc (*SanitizationResult_SanitizationMetadata) GetIgnorePartialInvocationFailures
func (x *SanitizationResult_SanitizationMetadata) GetIgnorePartialInvocationFailures() boolfunc (*SanitizationResult_SanitizationMetadata) ProtoMessage
func (*SanitizationResult_SanitizationMetadata) ProtoMessage()func (*SanitizationResult_SanitizationMetadata) ProtoReflect
func (x *SanitizationResult_SanitizationMetadata) ProtoReflect() protoreflect.Messagefunc (*SanitizationResult_SanitizationMetadata) Reset
func (x *SanitizationResult_SanitizationMetadata) Reset()func (*SanitizationResult_SanitizationMetadata) String
func (x *SanitizationResult_SanitizationMetadata) String() stringSanitizeModelResponseRequest
type SanitizeModelResponseRequest struct {
// Required. Represents resource name of template
// e.g. name=projects/sample-project/locations/us-central1/templates/templ01
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Model response data to sanitize.
ModelResponseData *DataItem `protobuf:"bytes,2,opt,name=model_response_data,json=modelResponseData,proto3" json:"model_response_data,omitempty"`
// Optional. User Prompt associated with Model response.
UserPrompt string `protobuf:"bytes,4,opt,name=user_prompt,json=userPrompt,proto3" json:"user_prompt,omitempty"`
// Optional. Metadata related for multi language detection.
MultiLanguageDetectionMetadata *MultiLanguageDetectionMetadata `protobuf:"bytes,7,opt,name=multi_language_detection_metadata,json=multiLanguageDetectionMetadata,proto3" json:"multi_language_detection_metadata,omitempty"`
// contains filtered or unexported fields
}Sanitize Model Response request.
func (*SanitizeModelResponseRequest) Descriptor
func (*SanitizeModelResponseRequest) Descriptor() ([]byte, []int)Deprecated: Use SanitizeModelResponseRequest.ProtoReflect.Descriptor instead.
func (*SanitizeModelResponseRequest) GetModelResponseData
func (x *SanitizeModelResponseRequest) GetModelResponseData() *DataItemfunc (*SanitizeModelResponseRequest) GetMultiLanguageDetectionMetadata
func (x *SanitizeModelResponseRequest) GetMultiLanguageDetectionMetadata() *MultiLanguageDetectionMetadatafunc (*SanitizeModelResponseRequest) GetName
func (x *SanitizeModelResponseRequest) GetName() stringfunc (*SanitizeModelResponseRequest) GetUserPrompt
func (x *SanitizeModelResponseRequest) GetUserPrompt() stringfunc (*SanitizeModelResponseRequest) ProtoMessage
func (*SanitizeModelResponseRequest) ProtoMessage()func (*SanitizeModelResponseRequest) ProtoReflect
func (x *SanitizeModelResponseRequest) ProtoReflect() protoreflect.Messagefunc (*SanitizeModelResponseRequest) Reset
func (x *SanitizeModelResponseRequest) Reset()func (*SanitizeModelResponseRequest) String
func (x *SanitizeModelResponseRequest) String() stringSanitizeModelResponseResponse
type SanitizeModelResponseResponse struct {
// Output only. Sanitization Result.
SanitizationResult *SanitizationResult `protobuf:"bytes,1,opt,name=sanitization_result,json=sanitizationResult,proto3" json:"sanitization_result,omitempty"`
// contains filtered or unexported fields
}Sanitized Model Response Response.
func (*SanitizeModelResponseResponse) Descriptor
func (*SanitizeModelResponseResponse) Descriptor() ([]byte, []int)Deprecated: Use SanitizeModelResponseResponse.ProtoReflect.Descriptor instead.
func (*SanitizeModelResponseResponse) GetSanitizationResult
func (x *SanitizeModelResponseResponse) GetSanitizationResult() *SanitizationResultfunc (*SanitizeModelResponseResponse) ProtoMessage
func (*SanitizeModelResponseResponse) ProtoMessage()func (*SanitizeModelResponseResponse) ProtoReflect
func (x *SanitizeModelResponseResponse) ProtoReflect() protoreflect.Messagefunc (*SanitizeModelResponseResponse) Reset
func (x *SanitizeModelResponseResponse) Reset()func (*SanitizeModelResponseResponse) String
func (x *SanitizeModelResponseResponse) String() stringSanitizeUserPromptRequest
type SanitizeUserPromptRequest struct {
// Required. Represents resource name of template
// e.g. name=projects/sample-project/locations/us-central1/templates/templ01
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. User prompt data to sanitize.
UserPromptData *DataItem `protobuf:"bytes,2,opt,name=user_prompt_data,json=userPromptData,proto3" json:"user_prompt_data,omitempty"`
// Optional. Metadata related to Multi Language Detection.
MultiLanguageDetectionMetadata *MultiLanguageDetectionMetadata `protobuf:"bytes,6,opt,name=multi_language_detection_metadata,json=multiLanguageDetectionMetadata,proto3" json:"multi_language_detection_metadata,omitempty"`
// contains filtered or unexported fields
}Sanitize User Prompt request.
func (*SanitizeUserPromptRequest) Descriptor
func (*SanitizeUserPromptRequest) Descriptor() ([]byte, []int)Deprecated: Use SanitizeUserPromptRequest.ProtoReflect.Descriptor instead.
func (*SanitizeUserPromptRequest) GetMultiLanguageDetectionMetadata
func (x *SanitizeUserPromptRequest) GetMultiLanguageDetectionMetadata() *MultiLanguageDetectionMetadatafunc (*SanitizeUserPromptRequest) GetName
func (x *SanitizeUserPromptRequest) GetName() stringfunc (*SanitizeUserPromptRequest) GetUserPromptData
func (x *SanitizeUserPromptRequest) GetUserPromptData() *DataItemfunc (*SanitizeUserPromptRequest) ProtoMessage
func (*SanitizeUserPromptRequest) ProtoMessage()func (*SanitizeUserPromptRequest) ProtoReflect
func (x *SanitizeUserPromptRequest) ProtoReflect() protoreflect.Messagefunc (*SanitizeUserPromptRequest) Reset
func (x *SanitizeUserPromptRequest) Reset()func (*SanitizeUserPromptRequest) String
func (x *SanitizeUserPromptRequest) String() stringSanitizeUserPromptResponse
type SanitizeUserPromptResponse struct {
// Output only. Sanitization Result.
SanitizationResult *SanitizationResult `protobuf:"bytes,1,opt,name=sanitization_result,json=sanitizationResult,proto3" json:"sanitization_result,omitempty"`
// contains filtered or unexported fields
}Sanitized User Prompt Response.
func (*SanitizeUserPromptResponse) Descriptor
func (*SanitizeUserPromptResponse) Descriptor() ([]byte, []int)Deprecated: Use SanitizeUserPromptResponse.ProtoReflect.Descriptor instead.
func (*SanitizeUserPromptResponse) GetSanitizationResult
func (x *SanitizeUserPromptResponse) GetSanitizationResult() *SanitizationResultfunc (*SanitizeUserPromptResponse) ProtoMessage
func (*SanitizeUserPromptResponse) ProtoMessage()func (*SanitizeUserPromptResponse) ProtoReflect
func (x *SanitizeUserPromptResponse) ProtoReflect() protoreflect.Messagefunc (*SanitizeUserPromptResponse) Reset
func (x *SanitizeUserPromptResponse) Reset()func (*SanitizeUserPromptResponse) String
func (x *SanitizeUserPromptResponse) String() stringSdpAdvancedConfig
type SdpAdvancedConfig struct {
// Optional. Sensitive Data Protection inspect template resource name
//
// If only inspect template is provided (de-identify template not provided),
// then Sensitive Data Protection InspectContent action is performed during
// Sanitization. All Sensitive Data Protection findings identified during
// inspection will be returned as SdpFinding in SdpInsepctionResult.
//
// e.g.
// `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}`
InspectTemplate string `protobuf:"bytes,1,opt,name=inspect_template,json=inspectTemplate,proto3" json:"inspect_template,omitempty"`
// Optional. Optional Sensitive Data Protection Deidentify template resource
// name.
//
// If provided then DeidentifyContent action is performed during Sanitization
// using this template and inspect template. The De-identified data will
// be returned in SdpDeidentifyResult.
// Note that all info-types present in the deidentify template must be present
// in inspect template.
//
// e.g.
// `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}`
DeidentifyTemplate string `protobuf:"bytes,2,opt,name=deidentify_template,json=deidentifyTemplate,proto3" json:"deidentify_template,omitempty"`
// contains filtered or unexported fields
}Sensitive Data Protection Advanced configuration.
func (*SdpAdvancedConfig) Descriptor
func (*SdpAdvancedConfig) Descriptor() ([]byte, []int)Deprecated: Use SdpAdvancedConfig.ProtoReflect.Descriptor instead.
func (*SdpAdvancedConfig) GetDeidentifyTemplate
func (x *SdpAdvancedConfig) GetDeidentifyTemplate() stringfunc (*SdpAdvancedConfig) GetInspectTemplate
func (x *SdpAdvancedConfig) GetInspectTemplate() stringfunc (*SdpAdvancedConfig) ProtoMessage
func (*SdpAdvancedConfig) ProtoMessage()func (*SdpAdvancedConfig) ProtoReflect
func (x *SdpAdvancedConfig) ProtoReflect() protoreflect.Messagefunc (*SdpAdvancedConfig) Reset
func (x *SdpAdvancedConfig) Reset()func (*SdpAdvancedConfig) String
func (x *SdpAdvancedConfig) String() stringSdpBasicConfig
type SdpBasicConfig struct {
// Optional. Tells whether the Sensitive Data Protection basic config is
// enabled or disabled.
FilterEnforcement SdpBasicConfig_SdpBasicConfigEnforcement `protobuf:"varint,3,opt,name=filter_enforcement,json=filterEnforcement,proto3,enum=google.cloud.modelarmor.v1beta.SdpBasicConfig_SdpBasicConfigEnforcement" json:"filter_enforcement,omitempty"`
// contains filtered or unexported fields
}Sensitive Data Protection basic configuration.
func (*SdpBasicConfig) Descriptor
func (*SdpBasicConfig) Descriptor() ([]byte, []int)Deprecated: Use SdpBasicConfig.ProtoReflect.Descriptor instead.
func (*SdpBasicConfig) GetFilterEnforcement
func (x *SdpBasicConfig) GetFilterEnforcement() SdpBasicConfig_SdpBasicConfigEnforcementfunc (*SdpBasicConfig) ProtoMessage
func (*SdpBasicConfig) ProtoMessage()func (*SdpBasicConfig) ProtoReflect
func (x *SdpBasicConfig) ProtoReflect() protoreflect.Messagefunc (*SdpBasicConfig) Reset
func (x *SdpBasicConfig) Reset()func (*SdpBasicConfig) String
func (x *SdpBasicConfig) String() stringSdpBasicConfig_SdpBasicConfigEnforcement
type SdpBasicConfig_SdpBasicConfigEnforcement int32Option to specify the state of Sensitive Data Protection basic config (ENABLED/DISABLED).
SdpBasicConfig_SDP_BASIC_CONFIG_ENFORCEMENT_UNSPECIFIED, SdpBasicConfig_ENABLED, SdpBasicConfig_DISABLED
const (
// Same as Disabled
SdpBasicConfig_SDP_BASIC_CONFIG_ENFORCEMENT_UNSPECIFIED SdpBasicConfig_SdpBasicConfigEnforcement = 0
// Enabled
SdpBasicConfig_ENABLED SdpBasicConfig_SdpBasicConfigEnforcement = 1
// Disabled
SdpBasicConfig_DISABLED SdpBasicConfig_SdpBasicConfigEnforcement = 2
)func (SdpBasicConfig_SdpBasicConfigEnforcement) Descriptor
func (SdpBasicConfig_SdpBasicConfigEnforcement) Descriptor() protoreflect.EnumDescriptorfunc (SdpBasicConfig_SdpBasicConfigEnforcement) Enum
func (SdpBasicConfig_SdpBasicConfigEnforcement) EnumDescriptor
func (SdpBasicConfig_SdpBasicConfigEnforcement) EnumDescriptor() ([]byte, []int)Deprecated: Use SdpBasicConfig_SdpBasicConfigEnforcement.Descriptor instead.
func (SdpBasicConfig_SdpBasicConfigEnforcement) Number
func (x SdpBasicConfig_SdpBasicConfigEnforcement) Number() protoreflect.EnumNumberfunc (SdpBasicConfig_SdpBasicConfigEnforcement) String
func (x SdpBasicConfig_SdpBasicConfigEnforcement) String() stringfunc (SdpBasicConfig_SdpBasicConfigEnforcement) Type
func (SdpBasicConfig_SdpBasicConfigEnforcement) Type() protoreflect.EnumTypeSdpDeidentifyResult
type SdpDeidentifyResult struct {
// Output only. Reports whether Sensitive Data Protection deidentification was
// successfully executed or not.
ExecutionState FilterExecutionState `protobuf:"varint,1,opt,name=execution_state,json=executionState,proto3,enum=google.cloud.modelarmor.v1beta.FilterExecutionState" json:"execution_state,omitempty"`
// Optional messages corresponding to the result.
// A message can provide warnings or error details.
// For example, if execution state is skipped then this field provides
// related reason/explanation.
MessageItems []*MessageItem `protobuf:"bytes,2,rep,name=message_items,json=messageItems,proto3" json:"message_items,omitempty"`
// Output only. Match state for Sensitive Data Protection Deidentification.
// Value is MATCH_FOUND if content is de-identified.
MatchState FilterMatchState `protobuf:"varint,3,opt,name=match_state,json=matchState,proto3,enum=google.cloud.modelarmor.v1beta.FilterMatchState" json:"match_state,omitempty"`
// De-identified data.
Data *DataItem `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
// Total size in bytes that were transformed during deidentification.
TransformedBytes int64 `protobuf:"varint,5,opt,name=transformed_bytes,json=transformedBytes,proto3" json:"transformed_bytes,omitempty"`
// List of Sensitive Data Protection info-types that were de-identified.
InfoTypes []string `protobuf:"bytes,6,rep,name=info_types,json=infoTypes,proto3" json:"info_types,omitempty"`
// contains filtered or unexported fields
}Sensitive Data Protection Deidentification Result.
func (*SdpDeidentifyResult) Descriptor
func (*SdpDeidentifyResult) Descriptor() ([]byte, []int)Deprecated: Use SdpDeidentifyResult.ProtoReflect.Descriptor instead.
func (*SdpDeidentifyResult) GetData
func (x *SdpDeidentifyResult) GetData() *DataItemfunc (*SdpDeidentifyResult) GetExecutionState
func (x *SdpDeidentifyResult) GetExecutionState() FilterExecutionStatefunc (*SdpDeidentifyResult) GetInfoTypes
func (x *SdpDeidentifyResult) GetInfoTypes() []stringfunc (*SdpDeidentifyResult) GetMatchState
func (x *SdpDeidentifyResult) GetMatchState() FilterMatchStatefunc (*SdpDeidentifyResult) GetMessageItems
func (x *SdpDeidentifyResult) GetMessageItems() []*MessageItemfunc (*SdpDeidentifyResult) GetTransformedBytes
func (x *SdpDeidentifyResult) GetTransformedBytes() int64func (*SdpDeidentifyResult) ProtoMessage
func (*SdpDeidentifyResult) ProtoMessage()func (*SdpDeidentifyResult) ProtoReflect
func (x *SdpDeidentifyResult) ProtoReflect() protoreflect.Messagefunc (*SdpDeidentifyResult) Reset
func (x *SdpDeidentifyResult) Reset()func (*SdpDeidentifyResult) String
func (x *SdpDeidentifyResult) String() stringSdpFilterResult
type SdpFilterResult struct {
// Either of Sensitive Data Protection Inspect result or Deidentify result.
//
// Types that are assignable to Result:
//
// *SdpFilterResult_InspectResult
// *SdpFilterResult_DeidentifyResult
Result isSdpFilterResult_Result `protobuf_oneof:"result"`
// contains filtered or unexported fields
}Sensitive Data Protection filter result.
func (*SdpFilterResult) Descriptor
func (*SdpFilterResult) Descriptor() ([]byte, []int)Deprecated: Use SdpFilterResult.ProtoReflect.Descriptor instead.
func (*SdpFilterResult) GetDeidentifyResult
func (x *SdpFilterResult) GetDeidentifyResult() *SdpDeidentifyResultfunc (*SdpFilterResult) GetInspectResult
func (x *SdpFilterResult) GetInspectResult() *SdpInspectResultfunc (*SdpFilterResult) GetResult
func (m *SdpFilterResult) GetResult() isSdpFilterResult_Resultfunc (*SdpFilterResult) ProtoMessage
func (*SdpFilterResult) ProtoMessage()func (*SdpFilterResult) ProtoReflect
func (x *SdpFilterResult) ProtoReflect() protoreflect.Messagefunc (*SdpFilterResult) Reset
func (x *SdpFilterResult) Reset()func (*SdpFilterResult) String
func (x *SdpFilterResult) String() stringSdpFilterResult_DeidentifyResult
type SdpFilterResult_DeidentifyResult struct {
// Sensitive Data Protection Deidentification result if deidentification is
// performed.
DeidentifyResult *SdpDeidentifyResult `protobuf:"bytes,2,opt,name=deidentify_result,json=deidentifyResult,proto3,oneof"`
}SdpFilterResult_InspectResult
type SdpFilterResult_InspectResult struct {
// Sensitive Data Protection Inspection result if inspection is performed.
InspectResult *SdpInspectResult `protobuf:"bytes,1,opt,name=inspect_result,json=inspectResult,proto3,oneof"`
}SdpFilterSettings
type SdpFilterSettings struct {
// Either of Sensitive Data Protection basic or advanced configuration.
//
// Types that are assignable to SdpConfiguration:
//
// *SdpFilterSettings_BasicConfig
// *SdpFilterSettings_AdvancedConfig
SdpConfiguration isSdpFilterSettings_SdpConfiguration `protobuf_oneof:"sdp_configuration"`
// contains filtered or unexported fields
}Sensitive Data Protection settings.
func (*SdpFilterSettings) Descriptor
func (*SdpFilterSettings) Descriptor() ([]byte, []int)Deprecated: Use SdpFilterSettings.ProtoReflect.Descriptor instead.
func (*SdpFilterSettings) GetAdvancedConfig
func (x *SdpFilterSettings) GetAdvancedConfig() *SdpAdvancedConfigfunc (*SdpFilterSettings) GetBasicConfig
func (x *SdpFilterSettings) GetBasicConfig() *SdpBasicConfigfunc (*SdpFilterSettings) GetSdpConfiguration
func (m *SdpFilterSettings) GetSdpConfiguration() isSdpFilterSettings_SdpConfigurationfunc (*SdpFilterSettings) ProtoMessage
func (*SdpFilterSettings) ProtoMessage()func (*SdpFilterSettings) ProtoReflect
func (x *SdpFilterSettings) ProtoReflect() protoreflect.Messagefunc (*SdpFilterSettings) Reset
func (x *SdpFilterSettings) Reset()func (*SdpFilterSettings) String
func (x *SdpFilterSettings) String() stringSdpFilterSettings_AdvancedConfig
type SdpFilterSettings_AdvancedConfig struct {
// Optional. Advanced Sensitive Data Protection configuration which enables
// use of Sensitive Data Protection templates. Supports both Sensitive Data
// Protection inspection and de-identification operations.
AdvancedConfig *SdpAdvancedConfig `protobuf:"bytes,2,opt,name=advanced_config,json=advancedConfig,proto3,oneof"`
}SdpFilterSettings_BasicConfig
type SdpFilterSettings_BasicConfig struct {
// Optional. Basic Sensitive Data Protection configuration inspects the
// content for sensitive data using a fixed set of six info-types. Sensitive
// Data Protection templates cannot be used with basic configuration. Only
// Sensitive Data Protection inspection operation is supported with basic
// configuration.
BasicConfig *SdpBasicConfig `protobuf:"bytes,1,opt,name=basic_config,json=basicConfig,proto3,oneof"`
}SdpFinding
type SdpFinding struct {
// Name of Sensitive Data Protection info type for this finding.
InfoType string `protobuf:"bytes,1,opt,name=info_type,json=infoType,proto3" json:"info_type,omitempty"`
// Identified confidence likelihood for `info_type`.
Likelihood SdpFindingLikelihood `protobuf:"varint,2,opt,name=likelihood,proto3,enum=google.cloud.modelarmor.v1beta.SdpFindingLikelihood" json:"likelihood,omitempty"`
// Location for this finding.
Location *SdpFinding_SdpFindingLocation `protobuf:"bytes,3,opt,name=location,proto3" json:"location,omitempty"`
// contains filtered or unexported fields
}Finding corresponding to Sensitive Data Protection filter.
func (*SdpFinding) Descriptor
func (*SdpFinding) Descriptor() ([]byte, []int)Deprecated: Use SdpFinding.ProtoReflect.Descriptor instead.
func (*SdpFinding) GetInfoType
func (x *SdpFinding) GetInfoType() stringfunc (*SdpFinding) GetLikelihood
func (x *SdpFinding) GetLikelihood() SdpFindingLikelihoodfunc (*SdpFinding) GetLocation
func (x *SdpFinding) GetLocation() *SdpFinding_SdpFindingLocationfunc (*SdpFinding) ProtoMessage
func (*SdpFinding) ProtoMessage()func (*SdpFinding) ProtoReflect
func (x *SdpFinding) ProtoReflect() protoreflect.Messagefunc (*SdpFinding) Reset
func (x *SdpFinding) Reset()func (*SdpFinding) String
func (x *SdpFinding) String() stringSdpFindingLikelihood
type SdpFindingLikelihood int32For more information about each Sensitive Data Protection likelihood level, see https://cloud.google.com/sensitive-data-protection/docs/likelihood.
SdpFindingLikelihood_SDP_FINDING_LIKELIHOOD_UNSPECIFIED, SdpFindingLikelihood_VERY_UNLIKELY, SdpFindingLikelihood_UNLIKELY, SdpFindingLikelihood_POSSIBLE, SdpFindingLikelihood_LIKELY, SdpFindingLikelihood_VERY_LIKELY
const (
// Default value; same as POSSIBLE.
SdpFindingLikelihood_SDP_FINDING_LIKELIHOOD_UNSPECIFIED SdpFindingLikelihood = 0
// Highest chance of a false positive.
SdpFindingLikelihood_VERY_UNLIKELY SdpFindingLikelihood = 1
// High chance of a false positive.
SdpFindingLikelihood_UNLIKELY SdpFindingLikelihood = 2
// Some matching signals. The default value.
SdpFindingLikelihood_POSSIBLE SdpFindingLikelihood = 3
// Low chance of a false positive.
SdpFindingLikelihood_LIKELY SdpFindingLikelihood = 4
// Confidence level is high. Lowest chance of a false positive.
SdpFindingLikelihood_VERY_LIKELY SdpFindingLikelihood = 5
)func (SdpFindingLikelihood) Descriptor
func (SdpFindingLikelihood) Descriptor() protoreflect.EnumDescriptorfunc (SdpFindingLikelihood) Enum
func (x SdpFindingLikelihood) Enum() *SdpFindingLikelihoodfunc (SdpFindingLikelihood) EnumDescriptor
func (SdpFindingLikelihood) EnumDescriptor() ([]byte, []int)Deprecated: Use SdpFindingLikelihood.Descriptor instead.
func (SdpFindingLikelihood) Number
func (x SdpFindingLikelihood) Number() protoreflect.EnumNumberfunc (SdpFindingLikelihood) String
func (x SdpFindingLikelihood) String() stringfunc (SdpFindingLikelihood) Type
func (SdpFindingLikelihood) Type() protoreflect.EnumTypeSdpFinding_SdpFindingLocation
type SdpFinding_SdpFindingLocation struct {
// Zero-based byte offsets delimiting the finding.
// These are relative to the finding's containing element.
// Note that when the content is not textual, this references
// the UTF-8 encoded textual representation of the content.
ByteRange *RangeInfo `protobuf:"bytes,1,opt,name=byte_range,json=byteRange,proto3" json:"byte_range,omitempty"`
// Unicode character offsets delimiting the finding.
// These are relative to the finding's containing element.
// Provided when the content is text.
CodepointRange *RangeInfo `protobuf:"bytes,2,opt,name=codepoint_range,json=codepointRange,proto3" json:"codepoint_range,omitempty"`
// contains filtered or unexported fields
}Location of this Sensitive Data Protection Finding within input content.
func (*SdpFinding_SdpFindingLocation) Descriptor
func (*SdpFinding_SdpFindingLocation) Descriptor() ([]byte, []int)Deprecated: Use SdpFinding_SdpFindingLocation.ProtoReflect.Descriptor instead.
func (*SdpFinding_SdpFindingLocation) GetByteRange
func (x *SdpFinding_SdpFindingLocation) GetByteRange() *RangeInfofunc (*SdpFinding_SdpFindingLocation) GetCodepointRange
func (x *SdpFinding_SdpFindingLocation) GetCodepointRange() *RangeInfofunc (*SdpFinding_SdpFindingLocation) ProtoMessage
func (*SdpFinding_SdpFindingLocation) ProtoMessage()func (*SdpFinding_SdpFindingLocation) ProtoReflect
func (x *SdpFinding_SdpFindingLocation) ProtoReflect() protoreflect.Messagefunc (*SdpFinding_SdpFindingLocation) Reset
func (x *SdpFinding_SdpFindingLocation) Reset()func (*SdpFinding_SdpFindingLocation) String
func (x *SdpFinding_SdpFindingLocation) String() stringSdpInspectResult
type SdpInspectResult struct {
// Output only. Reports whether Sensitive Data Protection inspection was
// successfully executed or not.
ExecutionState FilterExecutionState `protobuf:"varint,1,opt,name=execution_state,json=executionState,proto3,enum=google.cloud.modelarmor.v1beta.FilterExecutionState" json:"execution_state,omitempty"`
// Optional messages corresponding to the result.
// A message can provide warnings or error details.
// For example, if execution state is skipped then this field provides
// related reason/explanation.
MessageItems []*MessageItem `protobuf:"bytes,2,rep,name=message_items,json=messageItems,proto3" json:"message_items,omitempty"`
// Output only. Match state for SDP Inspection.
// Value is MATCH_FOUND if at least one Sensitive Data Protection finding is
// identified.
MatchState FilterMatchState `protobuf:"varint,3,opt,name=match_state,json=matchState,proto3,enum=google.cloud.modelarmor.v1beta.FilterMatchState" json:"match_state,omitempty"`
// List of Sensitive Data Protection findings.
Findings []*SdpFinding `protobuf:"bytes,4,rep,name=findings,proto3" json:"findings,omitempty"`
// If true, then there is possibility that more findings were identified and
// the findings returned are a subset of all findings. The findings
// list might be truncated because the input items were too large, or because
// the server reached the maximum amount of resources allowed for a single API
// call.
FindingsTruncated bool `protobuf:"varint,5,opt,name=findings_truncated,json=findingsTruncated,proto3" json:"findings_truncated,omitempty"`
// contains filtered or unexported fields
}Sensitive Data Protection Inspection Result.
func (*SdpInspectResult) Descriptor
func (*SdpInspectResult) Descriptor() ([]byte, []int)Deprecated: Use SdpInspectResult.ProtoReflect.Descriptor instead.
func (*SdpInspectResult) GetExecutionState
func (x *SdpInspectResult) GetExecutionState() FilterExecutionStatefunc (*SdpInspectResult) GetFindings
func (x *SdpInspectResult) GetFindings() []*SdpFindingfunc (*SdpInspectResult) GetFindingsTruncated
func (x *SdpInspectResult) GetFindingsTruncated() boolfunc (*SdpInspectResult) GetMatchState
func (x *SdpInspectResult) GetMatchState() FilterMatchStatefunc (*SdpInspectResult) GetMessageItems
func (x *SdpInspectResult) GetMessageItems() []*MessageItemfunc (*SdpInspectResult) ProtoMessage
func (*SdpInspectResult) ProtoMessage()func (*SdpInspectResult) ProtoReflect
func (x *SdpInspectResult) ProtoReflect() protoreflect.Messagefunc (*SdpInspectResult) Reset
func (x *SdpInspectResult) Reset()func (*SdpInspectResult) String
func (x *SdpInspectResult) String() stringTemplate
type Template struct {
// Identifier. name of resource
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. [Output only] Create time stamp
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. [Output only] Update time stamp
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. Labels as key value pairs
Labels map[string]string `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Required. filter configuration for this template
FilterConfig *FilterConfig `protobuf:"bytes,5,opt,name=filter_config,json=filterConfig,proto3" json:"filter_config,omitempty"`
// Optional. metadata for this template
TemplateMetadata *Template_TemplateMetadata `protobuf:"bytes,6,opt,name=template_metadata,json=templateMetadata,proto3" json:"template_metadata,omitempty"`
// contains filtered or unexported fields
}Message describing Template resource
func (*Template) Descriptor
Deprecated: Use Template.ProtoReflect.Descriptor instead.
func (*Template) GetCreateTime
func (x *Template) GetCreateTime() *timestamppb.Timestampfunc (*Template) GetFilterConfig
func (x *Template) GetFilterConfig() *FilterConfigfunc (*Template) GetLabels
func (*Template) GetName
func (*Template) GetTemplateMetadata
func (x *Template) GetTemplateMetadata() *Template_TemplateMetadatafunc (*Template) GetUpdateTime
func (x *Template) GetUpdateTime() *timestamppb.Timestampfunc (*Template) ProtoMessage
func (*Template) ProtoMessage()func (*Template) ProtoReflect
func (x *Template) ProtoReflect() protoreflect.Messagefunc (*Template) Reset
func (x *Template) Reset()func (*Template) String
Template_TemplateMetadata
type Template_TemplateMetadata struct {
// Optional. If true, partial detector failures should be ignored.
IgnorePartialInvocationFailures bool `protobuf:"varint,1,opt,name=ignore_partial_invocation_failures,json=ignorePartialInvocationFailures,proto3" json:"ignore_partial_invocation_failures,omitempty"`
// Optional. Indicates the custom error code set by the user to be returned
// to the end user by the service extension if the prompt trips Model Armor
// filters.
CustomPromptSafetyErrorCode int32 `protobuf:"varint,2,opt,name=custom_prompt_safety_error_code,json=customPromptSafetyErrorCode,proto3" json:"custom_prompt_safety_error_code,omitempty"`
// Optional. Indicates the custom error message set by the user to be
// returned to the end user if the prompt trips Model Armor filters.
CustomPromptSafetyErrorMessage string `protobuf:"bytes,3,opt,name=custom_prompt_safety_error_message,json=customPromptSafetyErrorMessage,proto3" json:"custom_prompt_safety_error_message,omitempty"`
// Optional. Indicates the custom error code set by the user to be returned
// to the end user if the LLM response trips Model Armor filters.
CustomLlmResponseSafetyErrorCode int32 `protobuf:"varint,4,opt,name=custom_llm_response_safety_error_code,json=customLlmResponseSafetyErrorCode,proto3" json:"custom_llm_response_safety_error_code,omitempty"`
// Optional. Indicates the custom error message set by the user to be
// returned to the end user if the LLM response trips Model Armor filters.
CustomLlmResponseSafetyErrorMessage string `protobuf:"bytes,5,opt,name=custom_llm_response_safety_error_message,json=customLlmResponseSafetyErrorMessage,proto3" json:"custom_llm_response_safety_error_message,omitempty"`
// Optional. If true, log template crud operations.
LogTemplateOperations bool `protobuf:"varint,6,opt,name=log_template_operations,json=logTemplateOperations,proto3" json:"log_template_operations,omitempty"`
// Optional. If true, log sanitize operations.
LogSanitizeOperations bool `protobuf:"varint,7,opt,name=log_sanitize_operations,json=logSanitizeOperations,proto3" json:"log_sanitize_operations,omitempty"`
// Optional. Enforcement type for Model Armor filters.
EnforcementType Template_TemplateMetadata_EnforcementType `protobuf:"varint,8,opt,name=enforcement_type,json=enforcementType,proto3,enum=google.cloud.modelarmor.v1beta.Template_TemplateMetadata_EnforcementType" json:"enforcement_type,omitempty"`
// Optional. Metadata for multi language detection.
MultiLanguageDetection *Template_TemplateMetadata_MultiLanguageDetection `protobuf:"bytes,9,opt,name=multi_language_detection,json=multiLanguageDetection,proto3" json:"multi_language_detection,omitempty"`
// contains filtered or unexported fields
}Message describing TemplateMetadata
func (*Template_TemplateMetadata) Descriptor
func (*Template_TemplateMetadata) Descriptor() ([]byte, []int)Deprecated: Use Template_TemplateMetadata.ProtoReflect.Descriptor instead.
func (*Template_TemplateMetadata) GetCustomLlmResponseSafetyErrorCode
func (x *Template_TemplateMetadata) GetCustomLlmResponseSafetyErrorCode() int32func (*Template_TemplateMetadata) GetCustomLlmResponseSafetyErrorMessage
func (x *Template_TemplateMetadata) GetCustomLlmResponseSafetyErrorMessage() stringfunc (*Template_TemplateMetadata) GetCustomPromptSafetyErrorCode
func (x *Template_TemplateMetadata) GetCustomPromptSafetyErrorCode() int32func (*Template_TemplateMetadata) GetCustomPromptSafetyErrorMessage
func (x *Template_TemplateMetadata) GetCustomPromptSafetyErrorMessage() stringfunc (*Template_TemplateMetadata) GetEnforcementType
func (x *Template_TemplateMetadata) GetEnforcementType() Template_TemplateMetadata_EnforcementTypefunc (*Template_TemplateMetadata) GetIgnorePartialInvocationFailures
func (x *Template_TemplateMetadata) GetIgnorePartialInvocationFailures() boolfunc (*Template_TemplateMetadata) GetLogSanitizeOperations
func (x *Template_TemplateMetadata) GetLogSanitizeOperations() boolfunc (*Template_TemplateMetadata) GetLogTemplateOperations
func (x *Template_TemplateMetadata) GetLogTemplateOperations() boolfunc (*Template_TemplateMetadata) GetMultiLanguageDetection
func (x *Template_TemplateMetadata) GetMultiLanguageDetection() *Template_TemplateMetadata_MultiLanguageDetectionfunc (*Template_TemplateMetadata) ProtoMessage
func (*Template_TemplateMetadata) ProtoMessage()func (*Template_TemplateMetadata) ProtoReflect
func (x *Template_TemplateMetadata) ProtoReflect() protoreflect.Messagefunc (*Template_TemplateMetadata) Reset
func (x *Template_TemplateMetadata) Reset()func (*Template_TemplateMetadata) String
func (x *Template_TemplateMetadata) String() stringTemplate_TemplateMetadata_EnforcementType
type Template_TemplateMetadata_EnforcementType int32Enforcement type for Model Armor filters.
Template_TemplateMetadata_ENFORCEMENT_TYPE_UNSPECIFIED, Template_TemplateMetadata_INSPECT_ONLY, Template_TemplateMetadata_INSPECT_AND_BLOCK
const (
// Default value. Same as INSPECT_AND_BLOCK.
Template_TemplateMetadata_ENFORCEMENT_TYPE_UNSPECIFIED Template_TemplateMetadata_EnforcementType = 0
// Model Armor filters will run in inspect only mode. No action will be
// taken on the request.
Template_TemplateMetadata_INSPECT_ONLY Template_TemplateMetadata_EnforcementType = 1
// Model Armor filters will run in inspect and block mode. Requests
// that trip Model Armor filters will be blocked.
Template_TemplateMetadata_INSPECT_AND_BLOCK Template_TemplateMetadata_EnforcementType = 2
)func (Template_TemplateMetadata_EnforcementType) Descriptor
func (Template_TemplateMetadata_EnforcementType) Descriptor() protoreflect.EnumDescriptorfunc (Template_TemplateMetadata_EnforcementType) Enum
func (x Template_TemplateMetadata_EnforcementType) Enum() *Template_TemplateMetadata_EnforcementTypefunc (Template_TemplateMetadata_EnforcementType) EnumDescriptor
func (Template_TemplateMetadata_EnforcementType) EnumDescriptor() ([]byte, []int)Deprecated: Use Template_TemplateMetadata_EnforcementType.Descriptor instead.
func (Template_TemplateMetadata_EnforcementType) Number
func (x Template_TemplateMetadata_EnforcementType) Number() protoreflect.EnumNumberfunc (Template_TemplateMetadata_EnforcementType) String
func (x Template_TemplateMetadata_EnforcementType) String() stringfunc (Template_TemplateMetadata_EnforcementType) Type
func (Template_TemplateMetadata_EnforcementType) Type() protoreflect.EnumTypeTemplate_TemplateMetadata_MultiLanguageDetection
type Template_TemplateMetadata_MultiLanguageDetection struct {
// Required. If true, multi language detection will be enabled.
EnableMultiLanguageDetection bool `protobuf:"varint,1,opt,name=enable_multi_language_detection,json=enableMultiLanguageDetection,proto3" json:"enable_multi_language_detection,omitempty"`
// contains filtered or unexported fields
}Metadata to enable multi language detection via template.
func (*Template_TemplateMetadata_MultiLanguageDetection) Descriptor
func (*Template_TemplateMetadata_MultiLanguageDetection) Descriptor() ([]byte, []int)Deprecated: Use Template_TemplateMetadata_MultiLanguageDetection.ProtoReflect.Descriptor instead.
func (*Template_TemplateMetadata_MultiLanguageDetection) GetEnableMultiLanguageDetection
func (x *Template_TemplateMetadata_MultiLanguageDetection) GetEnableMultiLanguageDetection() boolfunc (*Template_TemplateMetadata_MultiLanguageDetection) ProtoMessage
func (*Template_TemplateMetadata_MultiLanguageDetection) ProtoMessage()func (*Template_TemplateMetadata_MultiLanguageDetection) ProtoReflect
func (x *Template_TemplateMetadata_MultiLanguageDetection) ProtoReflect() protoreflect.Messagefunc (*Template_TemplateMetadata_MultiLanguageDetection) Reset
func (x *Template_TemplateMetadata_MultiLanguageDetection) Reset()func (*Template_TemplateMetadata_MultiLanguageDetection) String
func (x *Template_TemplateMetadata_MultiLanguageDetection) String() stringUnimplementedModelArmorServer
type UnimplementedModelArmorServer struct {
}UnimplementedModelArmorServer should be embedded to have forward compatible implementations.
func (UnimplementedModelArmorServer) CreateTemplate
func (UnimplementedModelArmorServer) CreateTemplate(context.Context, *CreateTemplateRequest) (*Template, error)func (UnimplementedModelArmorServer) DeleteTemplate
func (UnimplementedModelArmorServer) DeleteTemplate(context.Context, *DeleteTemplateRequest) (*emptypb.Empty, error)func (UnimplementedModelArmorServer) GetFloorSetting
func (UnimplementedModelArmorServer) GetFloorSetting(context.Context, *GetFloorSettingRequest) (*FloorSetting, error)func (UnimplementedModelArmorServer) GetTemplate
func (UnimplementedModelArmorServer) GetTemplate(context.Context, *GetTemplateRequest) (*Template, error)func (UnimplementedModelArmorServer) ListTemplates
func (UnimplementedModelArmorServer) ListTemplates(context.Context, *ListTemplatesRequest) (*ListTemplatesResponse, error)func (UnimplementedModelArmorServer) SanitizeModelResponse
func (UnimplementedModelArmorServer) SanitizeModelResponse(context.Context, *SanitizeModelResponseRequest) (*SanitizeModelResponseResponse, error)func (UnimplementedModelArmorServer) SanitizeUserPrompt
func (UnimplementedModelArmorServer) SanitizeUserPrompt(context.Context, *SanitizeUserPromptRequest) (*SanitizeUserPromptResponse, error)func (UnimplementedModelArmorServer) UpdateFloorSetting
func (UnimplementedModelArmorServer) UpdateFloorSetting(context.Context, *UpdateFloorSettingRequest) (*FloorSetting, error)func (UnimplementedModelArmorServer) UpdateTemplate
func (UnimplementedModelArmorServer) UpdateTemplate(context.Context, *UpdateTemplateRequest) (*Template, error)UnsafeModelArmorServer
type UnsafeModelArmorServer interface {
// contains filtered or unexported methods
}UnsafeModelArmorServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ModelArmorServer will result in compilation errors.
UpdateFloorSettingRequest
type UpdateFloorSettingRequest struct {
// Required. The floor setting being updated.
FloorSetting *FloorSetting `protobuf:"bytes,1,opt,name=floor_setting,json=floorSetting,proto3" json:"floor_setting,omitempty"`
// Optional. Field mask is used to specify the fields to be overwritten in the
// FloorSetting resource by the update.
// The fields specified in the update_mask are relative to the resource, not
// the full request. A field will be overwritten if it is in the mask. If the
// user does not provide a mask then all fields will be overwritten.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Message for Updating a Floor Setting
func (*UpdateFloorSettingRequest) Descriptor
func (*UpdateFloorSettingRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateFloorSettingRequest.ProtoReflect.Descriptor instead.
func (*UpdateFloorSettingRequest) GetFloorSetting
func (x *UpdateFloorSettingRequest) GetFloorSetting() *FloorSettingfunc (*UpdateFloorSettingRequest) GetUpdateMask
func (x *UpdateFloorSettingRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateFloorSettingRequest) ProtoMessage
func (*UpdateFloorSettingRequest) ProtoMessage()func (*UpdateFloorSettingRequest) ProtoReflect
func (x *UpdateFloorSettingRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateFloorSettingRequest) Reset
func (x *UpdateFloorSettingRequest) Reset()func (*UpdateFloorSettingRequest) String
func (x *UpdateFloorSettingRequest) String() stringUpdateTemplateRequest
type UpdateTemplateRequest struct {
// Required. Field mask is used to specify the fields to be overwritten in the
// Template resource by the update.
// The fields specified in the update_mask are relative to the resource, not
// the full request. A field will be overwritten if it is in the mask. If the
// user does not provide a mask then all fields will be overwritten.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Required. The resource being updated
Template *Template `protobuf:"bytes,2,opt,name=template,proto3" json:"template,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server stores the
// request ID for 60 minutes after the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}Message for updating a Template
func (*UpdateTemplateRequest) Descriptor
func (*UpdateTemplateRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateTemplateRequest.ProtoReflect.Descriptor instead.
func (*UpdateTemplateRequest) GetRequestId
func (x *UpdateTemplateRequest) GetRequestId() stringfunc (*UpdateTemplateRequest) GetTemplate
func (x *UpdateTemplateRequest) GetTemplate() *Templatefunc (*UpdateTemplateRequest) GetUpdateMask
func (x *UpdateTemplateRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateTemplateRequest) ProtoMessage
func (*UpdateTemplateRequest) ProtoMessage()func (*UpdateTemplateRequest) ProtoReflect
func (x *UpdateTemplateRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateTemplateRequest) Reset
func (x *UpdateTemplateRequest) Reset()func (*UpdateTemplateRequest) String
func (x *UpdateTemplateRequest) String() stringVirusDetail
type VirusDetail struct {
// Name of vendor that produced this virus identification.
Vendor string `protobuf:"bytes,1,opt,name=vendor,proto3" json:"vendor,omitempty"`
// Names of this Virus.
Names []string `protobuf:"bytes,2,rep,name=names,proto3" json:"names,omitempty"`
// Threat type of the identified virus
ThreatType VirusDetail_ThreatType `protobuf:"varint,3,opt,name=threat_type,json=threatType,proto3,enum=google.cloud.modelarmor.v1beta.VirusDetail_ThreatType" json:"threat_type,omitempty"`
// contains filtered or unexported fields
}Details of an identified virus
func (*VirusDetail) Descriptor
func (*VirusDetail) Descriptor() ([]byte, []int)Deprecated: Use VirusDetail.ProtoReflect.Descriptor instead.
func (*VirusDetail) GetNames
func (x *VirusDetail) GetNames() []stringfunc (*VirusDetail) GetThreatType
func (x *VirusDetail) GetThreatType() VirusDetail_ThreatTypefunc (*VirusDetail) GetVendor
func (x *VirusDetail) GetVendor() stringfunc (*VirusDetail) ProtoMessage
func (*VirusDetail) ProtoMessage()func (*VirusDetail) ProtoReflect
func (x *VirusDetail) ProtoReflect() protoreflect.Messagefunc (*VirusDetail) Reset
func (x *VirusDetail) Reset()func (*VirusDetail) String
func (x *VirusDetail) String() stringVirusDetail_ThreatType
type VirusDetail_ThreatType int32Defines all the threat types of a virus
VirusDetail_THREAT_TYPE_UNSPECIFIED, VirusDetail_UNKNOWN, VirusDetail_VIRUS_OR_WORM, VirusDetail_MALICIOUS_PROGRAM, VirusDetail_POTENTIALLY_HARMFUL_CONTENT, VirusDetail_POTENTIALLY_UNWANTED_CONTENT
const (
// Unused
VirusDetail_THREAT_TYPE_UNSPECIFIED VirusDetail_ThreatType = 0
// Unable to categorize threat
VirusDetail_UNKNOWN VirusDetail_ThreatType = 1
// Virus or Worm threat.
VirusDetail_VIRUS_OR_WORM VirusDetail_ThreatType = 2
// Malicious program. E.g. Spyware, Trojan.
VirusDetail_MALICIOUS_PROGRAM VirusDetail_ThreatType = 3
// Potentially harmful content. E.g. Injected code, Macro
VirusDetail_POTENTIALLY_HARMFUL_CONTENT VirusDetail_ThreatType = 4
// Potentially unwanted content. E.g. Adware.
VirusDetail_POTENTIALLY_UNWANTED_CONTENT VirusDetail_ThreatType = 5
)func (VirusDetail_ThreatType) Descriptor
func (VirusDetail_ThreatType) Descriptor() protoreflect.EnumDescriptorfunc (VirusDetail_ThreatType) Enum
func (x VirusDetail_ThreatType) Enum() *VirusDetail_ThreatTypefunc (VirusDetail_ThreatType) EnumDescriptor
func (VirusDetail_ThreatType) EnumDescriptor() ([]byte, []int)Deprecated: Use VirusDetail_ThreatType.Descriptor instead.
func (VirusDetail_ThreatType) Number
func (x VirusDetail_ThreatType) Number() protoreflect.EnumNumberfunc (VirusDetail_ThreatType) String
func (x VirusDetail_ThreatType) String() stringfunc (VirusDetail_ThreatType) Type
func (VirusDetail_ThreatType) Type() protoreflect.EnumTypeVirusScanFilterResult
type VirusScanFilterResult struct {
// Output only. Reports whether Virus Scan was successfully executed or not.
ExecutionState FilterExecutionState `protobuf:"varint,1,opt,name=execution_state,json=executionState,proto3,enum=google.cloud.modelarmor.v1beta.FilterExecutionState" json:"execution_state,omitempty"`
// Optional messages corresponding to the result.
// A message can provide warnings or error details.
// For example, if execution status is skipped then this field provides
// related reason/explanation.
MessageItems []*MessageItem `protobuf:"bytes,2,rep,name=message_items,json=messageItems,proto3" json:"message_items,omitempty"`
// Output only. Match status for Virus.
// Value is MATCH_FOUND if the data is infected with a virus.
MatchState FilterMatchState `protobuf:"varint,3,opt,name=match_state,json=matchState,proto3,enum=google.cloud.modelarmor.v1beta.FilterMatchState" json:"match_state,omitempty"`
// Type of content scanned.
ScannedContentType VirusScanFilterResult_ScannedContentType `protobuf:"varint,4,opt,name=scanned_content_type,json=scannedContentType,proto3,enum=google.cloud.modelarmor.v1beta.VirusScanFilterResult_ScannedContentType" json:"scanned_content_type,omitempty"`
// Size of scanned content in bytes.
ScannedSize *int64 `protobuf:"varint,5,opt,name=scanned_size,json=scannedSize,proto3,oneof" json:"scanned_size,omitempty"`
// List of Viruses identified.
// This field will be empty if no virus was detected.
VirusDetails []*VirusDetail `protobuf:"bytes,6,rep,name=virus_details,json=virusDetails,proto3" json:"virus_details,omitempty"`
// contains filtered or unexported fields
}Virus scan results.
func (*VirusScanFilterResult) Descriptor
func (*VirusScanFilterResult) Descriptor() ([]byte, []int)Deprecated: Use VirusScanFilterResult.ProtoReflect.Descriptor instead.
func (*VirusScanFilterResult) GetExecutionState
func (x *VirusScanFilterResult) GetExecutionState() FilterExecutionStatefunc (*VirusScanFilterResult) GetMatchState
func (x *VirusScanFilterResult) GetMatchState() FilterMatchStatefunc (*VirusScanFilterResult) GetMessageItems
func (x *VirusScanFilterResult) GetMessageItems() []*MessageItemfunc (*VirusScanFilterResult) GetScannedContentType
func (x *VirusScanFilterResult) GetScannedContentType() VirusScanFilterResult_ScannedContentTypefunc (*VirusScanFilterResult) GetScannedSize
func (x *VirusScanFilterResult) GetScannedSize() int64func (*VirusScanFilterResult) GetVirusDetails
func (x *VirusScanFilterResult) GetVirusDetails() []*VirusDetailfunc (*VirusScanFilterResult) ProtoMessage
func (*VirusScanFilterResult) ProtoMessage()func (*VirusScanFilterResult) ProtoReflect
func (x *VirusScanFilterResult) ProtoReflect() protoreflect.Messagefunc (*VirusScanFilterResult) Reset
func (x *VirusScanFilterResult) Reset()func (*VirusScanFilterResult) String
func (x *VirusScanFilterResult) String() stringVirusScanFilterResult_ScannedContentType
type VirusScanFilterResult_ScannedContentType int32Type of content scanned.
VirusScanFilterResult_SCANNED_CONTENT_TYPE_UNSPECIFIED, VirusScanFilterResult_UNKNOWN, VirusScanFilterResult_PLAINTEXT, VirusScanFilterResult_PDF
const (
// Unused
VirusScanFilterResult_SCANNED_CONTENT_TYPE_UNSPECIFIED VirusScanFilterResult_ScannedContentType = 0
// Unknown content
VirusScanFilterResult_UNKNOWN VirusScanFilterResult_ScannedContentType = 1
// Plaintext
VirusScanFilterResult_PLAINTEXT VirusScanFilterResult_ScannedContentType = 2
// PDF
// Scanning for only PDF is supported.
VirusScanFilterResult_PDF VirusScanFilterResult_ScannedContentType = 3
)func (VirusScanFilterResult_ScannedContentType) Descriptor
func (VirusScanFilterResult_ScannedContentType) Descriptor() protoreflect.EnumDescriptorfunc (VirusScanFilterResult_ScannedContentType) Enum
func (VirusScanFilterResult_ScannedContentType) EnumDescriptor
func (VirusScanFilterResult_ScannedContentType) EnumDescriptor() ([]byte, []int)Deprecated: Use VirusScanFilterResult_ScannedContentType.Descriptor instead.
func (VirusScanFilterResult_ScannedContentType) Number
func (x VirusScanFilterResult_ScannedContentType) Number() protoreflect.EnumNumberfunc (VirusScanFilterResult_ScannedContentType) String
func (x VirusScanFilterResult_ScannedContentType) String() stringfunc (VirusScanFilterResult_ScannedContentType) Type
func (VirusScanFilterResult_ScannedContentType) Type() protoreflect.EnumType