A API do AI Guardrails aceita solicitações POST HTTP e HTTPS. Os parâmetros da solicitação têm formato JSON e são enviados no corpo da requisição. O parâmetro de consulta clientInfo é transmitido na string de consulta da URL.
Estrutura da solicitação
Todas as solicitações seguem esta estrutura:
{protocol}://{endpoint}/{resource-path}?{query-string}
|
Componente |
Descrição |
|
|
|
|
|
Endpoint da API do AI Guardrails. Exemplo: |
|
|
Caminho da operação. Por exemplo, |
|
|
Parâmetros de consulta. Transmita o parâmetro |
Exemplo: solicitação de moderação síncrona de imagem (não codificada)
http://green.cn-shanghai.aliyuncs.com/green/image/scan?clientInfo={"ip":"127.0.0.2","userId":"120234234","userNick":"Mike","userType":"others"}
Protocolos de comunicação
Os protocolos HTTP e HTTPS são suportados. Use HTTPS ao transmitir dados sensíveis.
Parâmetros da solicitação
Cada solicitação deve incluir dois conjuntos de parâmetros:
|
Tipo de parâmetro |
Localização |
Descrição |
|
Parâmetros comuns da solicitação |
String de consulta da URL ( |
Obrigatórios para todas as operações. Consulte Parâmetros comuns da solicitação. |
|
Parâmetros de serviço da solicitação |
Corpo da solicitação (JSON) |
Específicos da operação. Consulte a descrição de cada operação. |
Codificação
As solicitações e respostas usam codificação UTF-8.