Todas as respostas da API do AI Guardrails são retornadas em formato JSON e compartilham um conjunto comum de campos de resposta e códigos de erro.
Parâmetros de resposta comuns
Toda resposta de API inclui os seguintes campos.
|
Nome |
Tipo |
Descrição |
|
Code |
Integer |
Código de erro. |
|
Msg |
String |
Descrição do erro. |
|
RequestId |
String |
ID exclusivo da solicitação. Use este ID para localizar problemas. |
|
Data |
Integer / String / JSONObject |
Dados de resposta de negócios retornados pela API. Este campo pode estar vazio se ocorrer um erro. O valor geralmente é um objeto ou array JSON. |
Códigos de erro comuns
| Code | Msg | Description |
|---|---|---|
| 200 | OK | Solicitação bem-sucedida. |
| 280 | PROCESSING | Tarefa em andamento. Aguarde alguns segundos (por exemplo, 5s) e consulte o resultado novamente. |
| 400 | BAD_REQUEST | Solicitação inválida. Verifique os parâmetros da solicitação e tente novamente. |
401 | NOT_ALLOWED | Falha na solicitação. Geralmente causada pelo uso de uma URL insegura para arquivo de imagem ou vídeo. |
404 | NOT_FOUND | Conteúdo a ser moderado não encontrado. Geralmente ocorre quando não é possível baixar a imagem ou o vídeo. Confirme se o conteúdo está acessível pela Internet. |
| 404 | NOT_FOUND | Conteúdo para moderação não encontrado. Imagem ou vídeo indisponível para download. Certifique-se de que o conteúdo esteja acessível pela internet. |
403 | FORBIDDEN | Falha na solicitação de acesso. Normalmente, a URL do arquivo de imagem ou vídeo está inacessível. Confirme se o conteúdo está disponível na Internet e se nenhuma política de proteção contra hotlink está ativada. |
| 403 | FORBIDDEN | Acesso negado. URL da imagem ou vídeo inacessível. Certifique-se de que o conteúdo esteja acessível pela internet e que a proteção contra hotlink não esteja ativada. |
| 480 | DOWNLOAD_FAILED | Falha no download. Certifique-se de que o tamanho e a resolução do conteúdo (se houver) estejam dentro dos limites da API. |
| 500 | GENERAL_ERROR | Erro temporário no servidor. Tente repetir a solicitação. Se o erro persistir, entre em contato com o suporte pelo Online Service. |
| 503 | ServiceUnavailable | Erro no sistema. Verifique se o nome de domínio solicitado é válido. Em caso afirmativo, entre em contato com o suporte pelo Online Service e forneça os detalhes do caso. |
| 580 | DB_FAILED | Falha em operação de banco de dados. Repita a solicitação. Caso o erro persista, entre em contato com o suporte pelo Online Service. |
| 581 | TIMEOUT | Tempo limite da solicitação excedido. Tente novamente. Se o problema persistir, entre em contato com o suporte pelo Online Service. |
| 585 | CACHE_FAILED | Erro de cache. Refaça a solicitação. Se o erro persistir, entre em contato com o suporte pelo Online Service. |
| 586 | ALGO_FAILED | Erro de algoritmo. Entre em contato com o suporte pelo Online Service. |
| 587 | MQ_FAILED | Falha no middleware. Entre em contato com o suporte pelo Online Service. |
| 588 | EXCEED_QUOTA | Taxa de solicitações acima da cota. Cotas padrão: 50 imagens/s para moderação de imagens, 20 endpoints de ingestão/s para moderação de vídeo, 20 endpoints de ingestão/s para moderação de áudio, 100 entradas/s para moderação de texto e 10 imagens/s para OCR de imagens. Para aumentar sua cota, entre em contato com o suporte pelo Online Service. |
| 589 | TOO_LARGE | Conteúdo muito grande. Verifique se ele respeita os limites da API e tente novamente. Se o erro persistir, entre em contato com o suporte pelo Online Service. |
| 590 | BAD_FORMAT | Formato de conteúdo inválido. Certifique-se de que o conteúdo esteja dentro dos limites suportados pela API. |
| 591 | CONNECTION_POOL_FULL | Pool de conexões cheio. Entre em contato com o suporte pelo Online Service. |
| 592 | DOWNLOAD_TIMEOUT | Tempo limite de download excedido. O limite é de 3 segundos. Verifique se o tamanho do conteúdo está dentro dos limites da API. |
| 594 | EXPIRED | Tarefa expirada. Por exemplo, o TaskId pode ter expirado. |
| 595 | CATCH_FRAME_FAILED | Falha na captura de quadros. Entre em contato com o suporte pelo Online Service. |
| 596 | PERMISSION_DENY | Acesso negado. Possíveis causas: conta não autorizada, pagamento em atraso, serviço não ativado ou conta desativada. Consulte a descrição do erro retornada para mais detalhes. |