CreateKeywordLib - AI Guardrails: Central de Documentação do Alibaba Cloud

Descrição da operação

Uma biblioteca de palavras-chave armazena termos que o Content Moderation compara com o conteúdo enviado. Crie bibliotecas para três cenários de moderação:

Texto anti-spam: compara termos com o texto enviado ou detecta padrões de texto semelhantes.
Detecção de violações de anúncios: compara termos extraídos de imagens.
Áudio anti-spam: compara termos convertidos de áudio.

Para mais informações sobre como construir uma solicitação HTTP, consulte Estrutura da solicitação. Também é possível usar um cliente HTTP existente. Para mais detalhes, veja Visão geral do SDK.

Para criar uma biblioteca de palavras-chave no console do Alibaba Cloud AI Guardrails em vez de chamar esta operação, consulte Gerencie bibliotecas de texto personalizadas.

Faturamento: esta operação é gratuita.

Limites de QPS

Esta operação tem limite de 10 chamadas por segundo por conta. Exceder esse limite aciona o throttling, o que pode afetar seu serviço.

Parâmetros da solicitação

Para os parâmetros de solicitação comuns exigidos em todas as solicitações da API do AI Guardrails, consulte Parâmetros comuns.

A tabela a seguir descreve os parâmetros no corpo da solicitação.

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
ServiceModule	String	Sim	open_api	Nome do módulo de serviço. Defina este parâmetro como `open_api`.
Name	String	Sim	test1sdkdk	Nome da biblioteca de palavras-chave.
ResourceType	String	Sim	TEXT	Cenário de moderação da biblioteca de palavras-chave. Valores válidos: - `TEXT`: texto anti-spam - `IMAGE`: detecção de violações de anúncios - `VOICE`: áudio anti-spam
BizTypes	StringArray	Não	["bizTypeA","bizTypeB"]	Cenários de negócios a associar à biblioteca de palavras-chave. Para obter os nomes dos cenários de negócios, chame a operação CreateBizType.
Category	String	Sim	BLACK	Categoria da biblioteca de palavras-chave. Valores válidos: - `BLACK`: lista de bloqueios - `WHITE`: lista de permissões - `REVIEW`: lista de revisão
LibType	String	Sim	textKeyword	Tipo de biblioteca dentro do cenário de moderação. Valores válidos: Texto anti-spam (`ResourceType`: `TEXT`): - `textKeyword`: compara termos individuais no texto enviado - `similarText`: compara padrões de texto no texto enviado Detecção de violações de anúncios (`ResourceType`: `IMAGE`): - `textKeyword`: compara termos extraídos de imagens Áudio anti-spam (`ResourceType`: `VOICE`): - `voiceText`: compara termos convertidos de áudio
MatchMode	String	Não	fuzzy	Método de correspondência. Valores válidos: - `fuzzy`: correspondência aproximada - `precise`: correspondência exata
Enable	Boolean	Não	true	Define se a biblioteca de palavras-chave será ativada imediatamente após a criação. Valores válidos: - `true`: ative a biblioteca. Este é o valor padrão. - `false`: desativa a biblioteca.

Parâmetros de resposta

Para os parâmetros de resposta comuns retornados por todas as operações da API do AI Guardrails, consulte Parâmetros de resposta comuns.

Parâmetro	Tipo	Exemplo	Descrição
code	Integer	200	Código de status HTTP. Para obter uma lista de códigos de status, consulte Códigos de erro comuns.
msg	String	OK	Mensagem retornada para a solicitação.
requestId	String	795D8871-4889-4C0F-A8B1-C7D2B990FF61	ID da solicitação. Use este ID para solucionar problemas.
id	String	123	ID da biblioteca de palavras-chave criada. Use este ID para gerenciar a biblioteca em operações subsequentes.

Exemplos

Exemplo de solicitação

http(s)://green.cn-shanghai.aliyuncs.com/?Action=CreateKeywordLib&ServiceModule=open_api
&<Common request parameters>

Corpo da solicitação:

{
  "Name": "test1sdkdk",
  "BizTypes": [],
  "Category": "BLACK",
  "ServiceModule": "open_api",
  "ResourceType": "TEXT",
  "LibType": "textKeyword"
}

Exemplo de resposta de sucesso

{
  "RequestId": "795D8871-4889-4C0F-A8B1-C7D2B990FF61",
  "code": 200,
  "Id": "123"
}