Integrando com API

Pré-requisitos:

• Ter um canvas publicado

​

Obtenha os dados do seu canvas

Precisamos de duas coisas para começar a usar nosso canvas:

1. Chave de API
2. Canvas ID

Podemos achar os dois no mesmo local.

​

Construindo o Corpo da Chamada do Canvas

Para alcançar o comportamento desejado para o seu negócio e integração, sua chamada de canvas pode incluir variáveis, mensagens históricas, streaming e respostas de webhook para integrações assíncronas.

​

Usando Variáveis

Variáveis são um conceito chave na construção de prompts com o Tela. Elas são usadas para armazenar e reutilizar dados ao longo dos seus prompts e podem ser uma entrada manual ou um arquivo.

Quando definimos variáveis em nosso prompt, o modal de conexão gerará os trechos de código para nós já preenchidos com as chaves das variáveis.

Preencha as chaves com os valores que você deseja, pode ser um texto, uma URL de arquivo ou uma string base64 de arquivo.

variables: {
    document: tela.createFile('https://www.wmaccess.com/downloads/sample-invoice.pdf'), // It is possible to pass a URL, Buffer, Blob, etc.
},

​

Usando Mensagens

A API do Tela permite que você inclua mensagens em suas requisições, estendendo o corpo da requisição com a chave messages. Esse recurso permite que você forneça contexto ou informações adicionais ao modelo, melhorando a interação e a qualidade da saída.

const completion = await tela.completions.create<{ document: TelaFile }, { fileSummary: string }>({
    canvasId: process.env.TELA_CANVAS_ID,
    variables: {
        document: tela.createFile('https://www.wmaccess.com/downloads/sample-invoice.pdf')
    },
    messages: [
        {
            role: 'user',
            content: {
                type: 'text',
                text: 'Hello, how can I assist you today?'
            }
        },
        {
            role: 'assistant',
            content: {
                type: 'image_url',
                image_url: {
                    url: 'https://example.com/image.png',
                    detail: 'high'
                }
            }
        }
    ]
})

​

Streaming

Para habilitar o streaming na chamada do canvas, basta incluir a chave stream definida como true no corpo da requisição.

const completion = await tela.completions.create<{ document: TelaFile }, { fileSummary: string }>({
    canvasId: process.env.TELA_CANVAS_ID,
    variables: {
        document: tela.createFile('https://www.wmaccess.com/downloads/sample-invoice.pdf')
    },
    stream: true
})

​

Async

Para alcançar um comportamento assíncrono, você tem duas opções:

• Usando a flag async
• Usando um webhook

​

Usando a Flag Async

Para usar a flag async, basta incluí-la no corpo da requisição e defini-la como true. Isso fará com que a execução seja assíncrona, permitindo que você continue com outras tarefas enquanto aguarda a conclusão. Um id sera retornado para que você possa monitorar o status da chamada.

curl -XPOST https://api.tela.com/v2/chat/completions \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer API-KEY' \
    -d '{
        ...,
        "async": true
    }'

​

Usando Webhook

Você pode passar uma URL de webhook para nossa API, estendendo o corpo com uma chave webhook_url, isso tornará a chamada assíncrona, e você receberá a resposta quando a completion for finalizada com uma requisição POST na URL fornecida.

const completion = await tela.completions.create<{ document: TelaFile }, { fileSummary: string }>({
    canvasId: process.env.TELA_CANVAS_ID,
    variables: {
        document: tela.createFile('https://www.wmaccess.com/downloads/sample-invoice.pdf')
    },
    webhook_url: "https://example.com/webhook"
})