Envie uma única instrução de texto para uma Viagem no modo padrão para impulsionar a geração subsequente de quadros. Apenas creationModel=simple é suportado; uma Viagem scriptlist deve usar a atualização completa do script.
Escopo
Envie uma única instrução de texto para uma Viagem no modo padrão (creationModel=simple) para impulsionar a geração subsequente de quadros. Antes de chamar, confirme o seguinte:
- Autenticação: A Chave de API primária não é obrigatória; tanto a chave primária quanto uma temporária podem chamá-la. Para saber como obtê-las, veja Obter credenciais de autenticação.
- Pré-requisitos: O
creationModelda Viagem deve sersimple, e ela deve estar em um estado capaz de receber instruções. Confirme via Consultar Status da Viagem. - Chamador: Tanto seu servidor quanto seu cliente podem fazer a chamada.
Solicitação HTTP
- Singapore
- EUA (Virgínia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/instructSubstitua {WorkspaceId} pelo seu ID do Workspace real.Parâmetros da solicitação |
|
Content-Typestring(Obrigatório)Tipo de conteúdo da solicitação. Este parâmetro deve ser definido como application/json. | |
Authorization string (Obrigatório)Autenticação por Chave de API. A Chave de API primária não é obrigatória; tanto a chave primária quanto uma temporária podem chamá-lo.
| |
Corpo da solicitação | |
encryptedTravelId string (Obrigatório)O ID de Viagem criptografado de Direção a ser controlado; creationModel deve ser simple. Retornado por Entrar na Viagem. | |
content string (Obrigatório)A instrução de processo de texto. Não vazia, até 2000 caracteres; retorna 400000 quando vazia ou com mais de 2000 caracteres. | |
clientRequestId string (Opcional)Chave de idempotência para novas tentativas de instrução. Reutilize o mesmo valor ao tentar novamente a mesma instrução para evitar cobrança duplicada. Formato recomendado [A-Za-z0-9_-]{1,32}.
| |
userAgent string (Opcional)Identificador de versão do SDK ou cliente. Uma string não vazia; tem precedência sobre o User-Agent HTTP. |
Parâmetros de resposta |
|
code integerCódigo de retorno. 0 indica sucesso; diferente de zero é um código de erro. | |
message stringMensagem de erro. null em caso de sucesso. | |
data objectDados da resposta. null em caso de falha.
Propriedades encryptedTravelId stringO Travel ID criptografado.content stringO texto da instrução aceita.accepted booleanSe a instrução foi aceita e entrou no fluxo de processamento. |
Estados pré-requisitos e notas de chamada
- Apenas
creationModel=simplesuporta este endpoint; uma Viagemscriptlistdeve usar Atualização Completa do Script, e chamarinstructpor engano retorna403006. - O estado atual da Viagem deve ser capaz de receber instruções; uma Viagem que terminou ou falhou não é gravável.
- Quando
contentestá vazio ou tem mais de 2000 caracteres,400000é retornado. - Recomendamos gerar um
clientRequestIdestável para cada instrução lógica e reutilizá-lo em novas tentativas. - Quando a instrução falha na política de segurança de conteúdo,
403004é retornado.
Códigos de erro
Se a chamada do modelo falhar e retornar um erro, consulte Códigos de Erro do HappyOyster para resolvê-lo.
Próximos passos
Após enviar a instrução:
- Query Travel Status: visualizar o status de execução da instrução e informações do capítulo.
- Pausar Viagem / Retomar Viagem / Retroceder Viagem.
- End Travel: encerrar a sessão e processar artefatos.