Estado

O que é o estado, como estruturá-lo e como dar a um modelo System One o contexto de que ele precisa.

O estado é o conteúdo que você pede a um modelo System One para avaliar. Pode ser uma mensagem de suporte, um trecho de texto ou o estado atual da sua aplicação. Você o passa no campo state de uma requisição à API, junto com as perguntas que quer que sejam respondidas.

Cada requisição avalia um estado em relação a uma ou mais perguntas. Todas as perguntas veem o mesmo estado e são avaliadas de forma independente. Você pode misturar perguntas Choice, Score e Noul numa mesma requisição.

O estado pode ser uma string simples ou um valor JSON estruturado

O estado mais simples é uma string simples:

state = "My card was charged twice."

O estado também pode ser um objeto ou array JSON com contexto relacionado, exemplos e outras informações que ajudam o modelo a responder às perguntas associadas. Pense no estado como o material que você apresentaria a um painel de especialistas antes de pedir que emitam um julgamento. Em Python, passe a string, o dicionário ou a lista correspondente diretamente para client.system_one(state=...).

Use um objeto na maioria das requisições, para que cada parte do estado tenha um nome descritivo e suas relações continuem claras. Uma string é adequada quando o caso de uso é simples e exige apenas um trecho de texto.

Uma conversa de suporte como estado

{
  "ticket": {
    "subject": "Duplicate charge",
    "messages": [
      {"from": "customer", "text": "I was charged twice for order A-104. Please refund the duplicate."},
      {"from": "support", "text": "We are checking the charges."}
    ]
  },
  "order": {
    "id": "A-104",
    "charges": [
      {"amount_usd": 49, "status": "captured"},
      {"amount_usd": 49, "status": "captured"}
    ]
  },
  "refund_policy": "Duplicate charges are eligible for a refund."
}

Esse objeto é um único estado, mesmo contendo uma conversa, um pedido e uma política. Junte as informações relacionadas quando a decisão exigir comparar essas partes.

Separar o conteúdo das perguntas

O estado contém o conteúdo e os fatos de apoio. As perguntas definem os julgamentos que o modelo deve emitir sobre esse material. Por exemplo, mantenha a solicitação de reembolso e a política no estado e depois pergunte se o cliente pediu um reembolso e se a política o sustenta.

Consulte Primitivas (perguntas) para orientação sobre instruções, critérios, tipos de pergunta e como fazer várias perguntas sobre um mesmo estado.

Consulte a referência da API para o esquema da requisição e os SDKs de cliente para instalação, entradas tipadas e tratamento de respostas.