REST Resource: projects.locations.templates

Ressource: Vorlage

Nachricht, die die Vorlagenressource beschreibt

JSON-Darstellung 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "filterConfig": {
    object (FilterConfig)
  },
  "templateMetadata": {
    object (TemplateMetadata)
  }
}
Felder
name

string

Kennung. Name der Ressource
createTime

string (Timestamp format)

Nur Ausgabe. [Nur Ausgabe] Erstellungszeitstempel

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Nur Ausgabe. [Nur Ausgabe] Aktualisierungszeitstempel

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. Labels als Schlüssel/Wert-Paare

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
filterConfig

object (FilterConfig)

Erforderlich. Filterkonfiguration für diese Vorlage
templateMetadata

object (TemplateMetadata)

Optional. Metadaten für diese Vorlage

FilterConfig

Filterkonfiguration

JSON-Darstellung 
{
  "raiSettings": {
    object (RaiFilterSettings)
  },
  "sdpSettings": {
    object (SdpFilterSettings)
  },
  "piAndJailbreakFilterSettings": {
    object (PiAndJailbreakFilterSettings)
  },
  "maliciousUriFilterSettings": {
    object (MaliciousUriFilterSettings)
  }
}
Felder
raiSettings

object (RaiFilterSettings)

Optional. Einstellungen für die verantwortungsbewusste Anwendung von KI
sdpSettings

object (SdpFilterSettings)

Optional. Einstellungen für den Schutz sensibler Daten
piAndJailbreakFilterSettings

object (PiAndJailbreakFilterSettings)

Optional. Einstellungen für den Filter für Prompt-Injection und Jailbreaking
maliciousUriFilterSettings

object (MaliciousUriFilterSettings)

Optional. Einstellungen des Filters für schädliche URIs

RaiFilterSettings

Einstellungen für den Filter für verantwortungsbewusste KI

JSON-Darstellung 
{
  "raiFilters": [
    {
      object (RaiFilter)
    }
  ]
}
Felder
raiFilters[]

object (RaiFilter)

Pflichtangabe. Liste der für die Vorlage aktivierten Filter für verantwortungsbewusste Anwendung von KI (Responsible AI, RAI).

RaiFilter

Filter für verantwortungsbewusste Anwendung von KI.

JSON-Darstellung 
{
  "filterType": enum (RaiFilterType),
  "confidenceLevel": enum (DetectionConfidenceLevel)
}
Felder
filterType

enum (RaiFilterType)

Pflichtangabe. Art des Filters für verantwortungsbewusste Anwendung von KI (Responsible AI, RAI).
confidenceLevel

enum (DetectionConfidenceLevel)

Optional. Konfidenzniveau für diesen RAI-Filter. Wenn Daten während der Datenbereinigung unter diesem Filter mit einem Konfidenzniveau klassifiziert werden, das dem angegebenen Niveau entspricht oder höher ist, wird eine positive Übereinstimmung gemeldet. Ist das Konfidenzniveau nicht angegeben (also 0), verwendet das System ein angemessenes Standardniveau, das auf dem filterType basiert.

RaiFilterType

Optionen für Filtertypen für verantwortungsbewusste KI

Enums
RAI_FILTER_TYPE_UNSPECIFIED Nicht angegebener Filtertyp.
SEXUALLY_EXPLICIT Sexuell explizit
HATE_SPEECH Hassrede
HARASSMENT Belästigung
DANGEROUS Gefahr

DetectionConfidenceLevel

Konfidenzniveaus für Erkennungsmechanismen. Je höher der Wert, desto höher ist das Konfidenzniveau. Wenn Sie eine strengere Stufe erzwingen möchten, sollten Sie einen niedrigeren Wert verwenden.

Enums
DETECTION_CONFIDENCE_LEVEL_UNSPECIFIED Identisch mit LOW_AND_ABOVE.
LOW_AND_ABOVE Die höchste Wahrscheinlichkeit für einen False Positive.
MEDIUM_AND_ABOVE Es besteht eine gewisse Wahrscheinlichkeit für falsch positive Ergebnisse.
HIGH Geringe Wahrscheinlichkeit von falsch positiven Ergebnissen.

SdpFilterSettings

Einstellungen für den Schutz sensibler Daten

JSON-Darstellung 
{

  // Union field sdp_configuration can be only one of the following:
  "basicConfig": {
    object (SdpBasicConfig)
  },
  "advancedConfig": {
    object (SdpAdvancedConfig)
  }
  // End of list of possible types for union field sdp_configuration.
}
Felder
Union-Feld sdp_configuration. Einfache oder erweiterte Konfiguration des Schutzes sensibler Daten Für sdp_configuration ist nur einer der folgenden Werte zulässig:
basicConfig

object (SdpBasicConfig)

Optional. Bei der grundlegenden Konfiguration des Schutzes sensibler Daten werden die Inhalte mithilfe von sechs festen Infotypen auf sensible Daten geprüft. Vorlagen für den Schutz sensibler Daten können nicht mit der einfachen Konfiguration verwendet werden. Bei der grundlegenden Konfiguration wird nur der Sensitive Data Protection-Prüfvorgang unterstützt.
advancedConfig

object (SdpAdvancedConfig)

Optional. Erweiterte Konfiguration für den Schutz sensibler Daten, die die Verwendung von Vorlagen für den Schutz sensibler Daten ermöglicht. Unterstützt sowohl die Prüfung als auch die De-Identifikation sensibler Daten.

SdpBasicConfig

Grundlegende Konfiguration für den Schutz sensibler Daten

JSON-Darstellung 
{
  "filterEnforcement": enum (SdpBasicConfigEnforcement)
}
Felder
filterEnforcement

enum (SdpBasicConfigEnforcement)

Optional. Gibt an, ob die grundlegende Konfiguration für den Schutz sensibler Daten aktiviert oder deaktiviert ist.

SdpBasicConfigEnforcement

Option zum Angeben des Status der grundlegenden Konfiguration für den Schutz sensibler Daten (AKTIVIERT/DEAKTIVIERT).

Enums
SDP_BASIC_CONFIG_ENFORCEMENT_UNSPECIFIED Entspricht „Deaktiviert“
ENABLED Aktiviert
DISABLED Deaktiviert

SdpAdvancedConfig

Erweiterte Konfiguration für den Schutz sensibler Daten

JSON-Darstellung 
{
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
Felder
inspectTemplate

string

Optional. Ressourcenname der Inspektionsvorlage für den Schutz sensibler Daten

Wenn nur eine Prüfungsvorlage (und keine De-Identifikationsvorlage) angegeben ist, wird die SDP-Aktion „InspectContent“ während der Bereinigung ausgeführt. Alle während der Prüfung gefundenen Verstöße gegen den Schutz sensibler Daten werden als „SdpFinding“ in „SdpInsepctionResult“ zurückgegeben.

z. B. projects/{project}/locations/{location}/inspectTemplates/{inspectTemplate}
deidentifyTemplate

string

Optional. Optionaler Ressourcenname der De-Identifikationsvorlage für den Schutz sensibler Daten.

Wenn angegeben, wird die Aktion „DeidentifyContent“ während der Bereinigung mit dieser Vorlage und der Prüfungsvorlage ausgeführt. Die de-identifizierten Daten werden in „SdpDeidentifyResult“ zurückgegeben. Hinweis: Alle in der De-Identifikationsvorlage vorhandenen Infotypen müssen auch in der Inspektionsvorlage vorhanden sein.

z. B. projects/{project}/locations/{location}/deidentifyTemplates/{deidentifyTemplate}

PiAndJailbreakFilterSettings

Einstellungen für den Filter für Prompt-Injection und Jailbreaking

JSON-Darstellung 
{
  "filterEnforcement": enum (PiAndJailbreakFilterEnforcement),
  "confidenceLevel": enum (DetectionConfidenceLevel)
}
Felder
filterEnforcement

enum (PiAndJailbreakFilterEnforcement)

Optional. Gibt an, ob der Filter für Prompt-Einschleusung und Jailbreaking aktiviert oder deaktiviert ist.
confidenceLevel

enum (DetectionConfidenceLevel)

Optional. Konfidenzniveau für diesen Filter. Das Konfidenzniveau wird verwendet, um den Schwellenwert für den Filter zu bestimmen. Wenn die Erkennungskonfidenz dem angegebenen Niveau entspricht oder höher ist, wird eine positive Übereinstimmung gemeldet. Das Konfidenzniveau wird nur verwendet, wenn der Filter aktiviert ist.

PiAndJailbreakFilterEnforcement

Option zum Angeben des Status des Filters für Prompt-Injection und Jailbreaking (AKTIVIERT/DEAKTIVIERT).

Enums
PI_AND_JAILBREAK_FILTER_ENFORCEMENT_UNSPECIFIED Entspricht „Deaktiviert“
ENABLED Aktiviert
DISABLED Aktiviert

MaliciousUriFilterSettings

Einstellungen des Filters für schädliche URIs

JSON-Darstellung 
{
  "filterEnforcement": enum (MaliciousUriFilterEnforcement)
}
Felder
filterEnforcement

enum (MaliciousUriFilterEnforcement)

Optional. Gibt an, ob der Filter für schädliche URIs aktiviert oder deaktiviert ist.

MaliciousUriFilterEnforcement

Option zum Angeben des Status des Filters für schädliche URIs (AKTIVIERT/DEAKTIVIERT).

Enums
MALICIOUS_URI_FILTER_ENFORCEMENT_UNSPECIFIED Entspricht „Deaktiviert“
ENABLED Aktiviert
DISABLED Deaktiviert

TemplateMetadata

Nachricht, die TemplateMetadata beschreibt

JSON-Darstellung 
{
  "ignorePartialInvocationFailures": boolean,
  "customPromptSafetyErrorCode": integer,
  "customPromptSafetyErrorMessage": string,
  "customLlmResponseSafetyErrorCode": integer,
  "customLlmResponseSafetyErrorMessage": string,
  "logTemplateOperations": boolean,
  "logSanitizeOperations": boolean
}
Felder
ignorePartialInvocationFailures

boolean

Optional. Wenn diese Option aktiviert ist, werden teilweise Detektorfehler ignoriert.
customPromptSafetyErrorCode

integer

Optional. Gibt den vom Nutzer festgelegten benutzerdefinierten Fehlercode an, der von der Diensterweiterung an den Endnutzer zurückgegeben wird, wenn die Aufforderung Model Armor-Filter auslöst.
customPromptSafetyErrorMessage

string

Optional. Gibt die vom Nutzer festgelegte benutzerdefinierte Fehlermeldung an, die an den Endnutzer zurückgegeben wird, wenn die Aufforderung Model Armor-Filter auslöst.
customLlmResponseSafetyErrorCode

integer

Optional. Gibt den vom Nutzer festgelegten benutzerdefinierten Fehlercode an, der an den Endnutzer zurückgegeben werden soll, wenn die LLM-Antwort Model Armor-Filter auslöst.
customLlmResponseSafetyErrorMessage

string

Optional. Gibt die vom Nutzer festgelegte benutzerdefinierte Fehlermeldung an, die an den Endnutzer zurückgegeben werden soll, wenn die LLM-Antwort Model Armor-Filter auslöst.
logTemplateOperations

boolean

Optional. Wenn „wahr“ ist, werden CRUD-Vorgänge für die Vorlage protokolliert.
logSanitizeOperations

boolean

Optional. Wenn „wahr“ ist, werden Sanierungsvorgänge protokolliert.

Methoden

create

 Erstellt eine neue Vorlage in einem bestimmten Projekt und an einem bestimmten Standort.

delete

 Löscht eine einzelne Vorlage.

get

 Ruft Details zu einer einzelnen Vorlage ab.

list

 Listet Vorlagen in einem angegebenen Projekt und an einem angegebenen Standort auf.

patch

 Aktualisiert die Parameter einer einzelnen Vorlage.

sanitizeModelResponse

 Die Modellantwort wird bereinigt.

sanitizeUserPrompt

 Der Nutzer-Prompt wird bereinigt.