Pular para o conteúdo
Sursa Developers

Objetos

ChatRequest

Requisição de uma resposta do assistente: os últimos turnos da conversa, a coleção, as configurações de busca, o modo de resposta, a exportação, a limitação a cartões específicos, a conversa, a origem da pergunta e as ferramentas.

Campos

  • messagesarray of ChatMessageobrigatório

    items ≥ 1

  • collectionstring

    Padrão: "default"

  • tagsarray of string | null
  • exportstring | null
  • card_idsarray of string | null

    items ≤ 50

  • streamboolean

    Padrão: false

  • conversation_idstring | null

    length ≤ 64

  • originstring | null
  • toolsboolean | null
  • bypass_cacheboolean

    Não usar a resposta do cache de respostas (o botão “Get a fresh answer” (obter uma resposta nova) sob uma resposta do cache). A resposta nova substitui a entrada do cache.

    Padrão: false

  • languagestring | null

    Idioma da resposta: um código ISO 639-1 (de, en, ru, …) para responder nesse idioma. Com auto ou sem o campo, o idioma é detectado a partir da pergunta. A interface passa explicitamente o idioma de uma sugestão em outro idioma (Starter.language).

  • scopeChatScope | null

    Abrangência da pergunta: várias coleções, uma fonte, etiquetas e um período. As coleções da abrangência substituem collection. Uma fonte restringe a resposta à coleção dela (e aos cartões dela). As etiquetas são acrescentadas a tags. O período limita as respostas financeiras a esse período. Só é possível selecionar o que o usuário pode ver (coleções: collections.no_access/collections.not_found; fonte: sources.not_found). Com conversation_id, a abrangência é salva na conversa. Sem o campo, vale a abrangência da conversa; null ou uma abrangência vazia a limpa.

  • request_idstring

    Chave de idempotência da pergunta. Envie a mesma chave em cada nova tentativa do stream de uma pergunta (uma nova tentativa após uma desconexão; aqui Last-Event-ID não continua o stream e só é registrado). Uma nova tentativa com a chave de uma resposta já salva não cria uma segunda pergunta: o resultado salvo é enviado de novo como um único evento done (e um token com o texto), mesmo que o limite de perguntas ou de créditos tenha se esgotado. Se a resposta anterior ainda estiver sendo gerada para um cliente desconectado, essa geração para e a resposta é gerada de novo.

    length ≤ 64

  • version_ofinteger (int64)

    Cria uma nova versão do turno desta pergunta na conversa (question_id do histórico da conversa): uma pergunta editada (novo texto em messages), uma resposta gerada de novo (o mesmo texto, em geral com bypass_cache) ou a mesma pergunta com outro quality (por exemplo, precise depois de uma resposta fast). O par anterior de pergunta e resposta é mantido. Os turnos posteriores ficam no ramo dele e são ocultados do histórico enquanto a nova versão estiver selecionada (FeedItem.versions, POST /v1/conversations/{conv_id}/versions). O histórico usado para a resposta é o ramo selecionado até este turno. O quality de uma versão não altera as configurações da conversa. Requer conversation_id; uma pergunta de outra conversa retorna 404 questions.not_found.

  • qualitystring

    Equilíbrio entre velocidade e precisão da busca por trás do resultado: fast é mais rápido, precise é mais preciso. Padrão: precise.

    Valores permitidos: fastprecise

Usado em