REST Resource: projects.locations.templates

Recurso: modelo

Mensagem que descreve o recurso de modelo

Representação JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "filterConfig": {
    object (FilterConfig)
  },
  "templateMetadata": {
    object (TemplateMetadata)
  }
}
Campos
name

string

Identifier. name of resource
createTime

string (Timestamp format)

Apenas saída. [Somente saída] Criar carimbo de data/hora

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. [Somente saída] Atualizar carimbo de data/hora

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Opcional. Rótulos como pares de chave-valor

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
filterConfig

object (FilterConfig)

Obrigatório. Configuração do filtro para este modelo
templateMetadata

object (TemplateMetadata)

Opcional. Metadados para este modelo

FilterConfig

Configuração de filtros.

Representação JSON 
{
  "raiSettings": {
    object (RaiFilterSettings)
  },
  "sdpSettings": {
    object (SdpFilterSettings)
  },
  "piAndJailbreakFilterSettings": {
    object (PiAndJailbreakFilterSettings)
  },
  "maliciousUriFilterSettings": {
    object (MaliciousUriFilterSettings)
  }
}
Campos
raiSettings

object (RaiFilterSettings)

Opcional. Configurações de IA responsável.
sdpSettings

object (SdpFilterSettings)

Opcional. Configurações da Proteção de Dados Sensíveis.
piAndJailbreakFilterSettings

object (PiAndJailbreakFilterSettings)

Opcional. Injeção de comando e configurações do filtro de jailbreak.
maliciousUriFilterSettings

object (MaliciousUriFilterSettings)

Opcional. Configurações do filtro de URIs maliciosos.

RaiFilterSettings

Configurações do filtro da IA responsável.

Representação JSON 
{
  "raiFilters": [
    {
      object (RaiFilter)
    }
  ]
}
Campos
raiFilters[]

object (RaiFilter)

Obrigatório. Lista de filtros da IA responsável ativados para o modelo.

RaiFilter

Filtro da IA responsável.

Representação JSON 
{
  "filterType": enum (RaiFilterType),
  "confidenceLevel": enum (DetectionConfidenceLevel)
}
Campos
filterType

enum (RaiFilterType)

Obrigatório. Tipo de filtro da IA responsável.
confidenceLevel

enum (DetectionConfidenceLevel)

Opcional. Nível de confiança deste filtro RAI. Durante a higienização de dados, se os dados forem classificados neste filtro com um nível de confiança igual ou maior que o nível especificado, será relatada uma correspondência positiva. Se o nível de confiança não for especificado (ou seja, 0), o sistema vai usar um nível padrão razoável com base em filterType.

RaiFilterType

Opções para tipos de filtro de IA responsável.

Enums
RAI_FILTER_TYPE_UNSPECIFIED Tipo de filtro não especificado.
SEXUALLY_EXPLICIT Sexualmente explícito.
HATE_SPEECH Discurso de ódio.
HARASSMENT Assédio.
DANGEROUS Perigo

DetectionConfidenceLevel

Níveis de confiança para detectores. Quanto maior o valor, maior o nível de confiança. Para aplicar um nível mais rigoroso, use um valor menor.

Enums
DETECTION_CONFIDENCE_LEVEL_UNSPECIFIED Igual a LOW_AND_ABOVE.
LOW_AND_ABOVE Maior chance de um falso positivo.
MEDIUM_AND_ABOVE Há uma chance de falsos positivos.
HIGH Baixa probabilidade de falsos positivos.

SdpFilterSettings

Configurações da Proteção de Dados Sensíveis.

Representação JSON 
{

  // 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.
}
Campos
Campo de união sdp_configuration. Uma das configurações básicas ou avançadas da Proteção de Dados Sensíveis. sdp_configuration pode ser apenas de um dos tipos a seguir:
basicConfig

object (SdpBasicConfig)

Opcional. A configuração básica de proteção de dados confidenciais inspeciona o conteúdo em busca de dados sensíveis usando um conjunto fixo de seis tipos de informações. Os modelos de Proteção de dados sensíveis não podem ser usados com a configuração básica. Somente a operação de inspeção da Proteção de Dados Sensíveis é compatível com a configuração básica.
advancedConfig

object (SdpAdvancedConfig)

Opcional. Configuração avançada de proteção de dados sensíveis, que permite o uso de modelos de proteção de dados sensíveis. Oferece suporte a operações de inspeção e desidentificação da Proteção de Dados Sensíveis.

SdpBasicConfig

Configuração básica da Proteção de Dados Sensíveis.

Representação JSON 
{
  "filterEnforcement": enum (SdpBasicConfigEnforcement)
}
Campos
filterEnforcement

enum (SdpBasicConfigEnforcement)

Opcional. Informa se a configuração básica da Proteção de Dados Sensíveis está ativada ou desativada.

SdpBasicConfigEnforcement

Opção para especificar o estado da configuração básica da Proteção de Dados Sensíveis (ATIVADA/DESATIVADA).

Enums
SDP_BASIC_CONFIG_ENFORCEMENT_UNSPECIFIED Igual a "Desativado"
ENABLED Ativado
DISABLED Desativado

SdpAdvancedConfig

Configuração avançada da proteção de dados sensíveis.

Representação JSON 
{
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
Campos
inspectTemplate

string

Opcional. Nome do recurso do modelo de inspeção de proteção de dados sensíveis

Se apenas o modelo de inspeção for fornecido (sem o modelo de desidentificação), a ação InspectContent da Proteção de dados sensíveis será realizada durante a higienização. Todas as descobertas da proteção de dados sensíveis identificadas durante a inspeção são retornadas como SdpFinding em SdpInsepctionResult.

por exemplo: projects/{project}/locations/{location}/inspectTemplates/{inspectTemplate}
deidentifyTemplate

string

Opcional. Nome do recurso de modelo de desidentificação da Proteção de dados sensíveis opcional.

Se oferecida, a ação DeidentifyContent é realizada durante a higienização usando este modelo e inspeções. Os dados desidentificados serão retornados em SdpDeidentifyResult. Todos os tipos de informações presentes no modelo de desidentificação precisam estar presentes no modelo de inspeção.

por exemplo: projects/{project}/locations/{location}/deidentifyTemplates/{deidentifyTemplate}

PiAndJailbreakFilterSettings

Injeção de comando e configurações do filtro de jailbreak.

Representação JSON 
{
  "filterEnforcement": enum (PiAndJailbreakFilterEnforcement),
  "confidenceLevel": enum (DetectionConfidenceLevel)
}
Campos
filterEnforcement

enum (PiAndJailbreakFilterEnforcement)

Opcional. Informa se o filtro de Injeção de comando e Jailbreak está ativado ou desativado.
confidenceLevel

enum (DetectionConfidenceLevel)

Opcional. O nível de confiança deste filtro. Ele é usado para determinar o limite do filtro. Se a confiança de detecção for igual ou maior que o nível especificado, uma correspondência positiva será relatada. O nível de confiança só será usado se o filtro estiver ativado.

PiAndJailbreakFilterEnforcement

Opção para especificar o estado do filtro de Injeção de comando e Jailbreak (ATIVADO/DESATIVADO).

Enums
PI_AND_JAILBREAK_FILTER_ENFORCEMENT_UNSPECIFIED Igual a "Desativado"
ENABLED Ativado
DISABLED Ativado

MaliciousUriFilterSettings

Configurações do filtro de URIs maliciosos.

Representação JSON 
{
  "filterEnforcement": enum (MaliciousUriFilterEnforcement)
}
Campos
filterEnforcement

enum (MaliciousUriFilterEnforcement)

Opcional. Informa se o filtro de URI malicioso está ativado ou desativado.

MaliciousUriFilterEnforcement

Opção para especificar o estado do filtro de URI malicioso (ATIVADO/DESATIVADO).

Enums
MALICIOUS_URI_FILTER_ENFORCEMENT_UNSPECIFIED Igual a "Desativado"
ENABLED Ativado
DISABLED Desativado

TemplateMetadata

Mensagem que descreve o TemplateMetadata

Representação JSON 
{
  "ignorePartialInvocationFailures": boolean,
  "customPromptSafetyErrorCode": integer,
  "customPromptSafetyErrorMessage": string,
  "customLlmResponseSafetyErrorCode": integer,
  "customLlmResponseSafetyErrorMessage": string,
  "logTemplateOperations": boolean,
  "logSanitizeOperations": boolean
}
Campos
ignorePartialInvocationFailures

boolean

Opcional. Se verdadeiro, as falhas parciais do detector serão ignoradas.
customPromptSafetyErrorCode

integer

Opcional. Indica o código de erro personalizado definido pelo usuário para ser retornado ao usuário final pela extensão de serviço se a solicitação acionar os filtros do Model Armor.
customPromptSafetyErrorMessage

string

Opcional. Indica a mensagem de erro personalizada definida pelo usuário para ser retornada ao usuário final se a solicitação acionar os filtros do Model Armor.
customLlmResponseSafetyErrorCode

integer

Opcional. Indica o código de erro personalizado definido pelo usuário para ser retornado ao usuário final se a resposta do LLM acionar os filtros do Model Armor.
customLlmResponseSafetyErrorMessage

string

Opcional. Indica que a mensagem de erro personalizada definida pelo usuário será retornada ao usuário final se a resposta do LLM acionar os filtros do Model Armor.
logTemplateOperations

boolean

Opcional. Se verdadeiro, registre operações crud de modelos.
logSanitizeOperations

boolean

Opcional. Se verdadeiro, registra as operações de sanitização.

Métodos

create

 Cria um novo modelo em um determinado projeto e local.

delete

 Exclui um único modelo.

get

 Recebe detalhes de um único modelo.

list

 Lista modelos em um determinado projeto e local.

patch

 Atualiza os parâmetros de um único modelo.

sanitizeModelResponse

 Limpa a resposta do modelo.

sanitizeUserPrompt

 Limpa o comando do usuário.