O Gemini gera texto não estruturado por padrão, mas alguns aplicativos exigem texto estruturado. Para esses casos de uso, você pode restringir o Gemini para responder com JSON, um formato de dados estruturado adequado para processamento automatizado. Também é possível restringir o modelo para responder com uma das opções especificadas em um tipo enumerado.
Confira alguns casos de uso que podem exigir uma saída estruturada do modelo:
- Crie um banco de dados de empresas extraindo informações de artigos de jornal.
- Extrair informações padronizadas de currículos.
- Extrair ingredientes de receitas e mostrar um link para um site de compras para cada ingrediente.
No comando, você pode pedir que o Gemini produza uma saída formatada em JSON, mas não há garantia de que o modelo vai produzir JSON e nada além disso.
Para uma resposta mais determinística, transmita um esquema JSON específico em um campo
responseSchema
para que o Gemini sempre responda com uma estrutura esperada.
Este guia mostra como gerar JSON usando o método
generateContent pelo SDK
de sua preferência ou diretamente pela API REST. Os exemplos mostram entradas somente
em texto, mas o Gemini também pode produzir respostas JSON para solicitações multimodais
que incluem imagens,
vídeos e áudio.
Antes de começar: configure o projeto e a chave de API
Antes de chamar a API Gemini, você precisa configurar seu projeto e a chave de API.
Gerar JSON
Quando o modelo é configurado para gerar JSON, ele responde a qualquer comando com saída formatada em JSON.
É possível controlar a estrutura da resposta JSON fornecendo um esquema. Há duas maneiras de fornecer um esquema ao modelo:
- Como texto no comando
- Como um esquema estruturado fornecido pela configuração do modelo
Ambas as abordagens funcionam no Gemini 1.5 Flash e no Gemini 1.5 Pro.
Fornecer um esquema como texto no comando
O exemplo a seguir solicita que o modelo retorne receitas de biscoitos em um formato JSON específico.
Como o modelo recebe a especificação de formato do texto no comando, você pode ter alguma flexibilidade na representação da especificação. Qualquer formato razoável para representar um esquema JSON pode funcionar.
// Make sure to include these imports:
// import { GoogleGenerativeAI } from "@google/generative-ai";
const genAI = new GoogleGenerativeAI(process.env.API_KEY);
const model = genAI.getGenerativeModel({
model: "gemini-1.5-flash",
});
const prompt = `List a few popular cookie recipes using this JSON schema:
Recipe = {'recipeName': string}
Return: Array<Recipe>`;
const result = await model.generateContent(prompt);
console.log(result.response.text());
A saída pode ser semelhante a esta:
[{"recipeName": "Chocolate Chip Cookies"}, {"recipeName": "Oatmeal Raisin Cookies"}, {"recipeName": "Snickerdoodles"}, {"recipeName": "Sugar Cookies"}, {"recipeName": "Peanut Butter Cookies"}]
Fornecer um esquema pela configuração do modelo
O exemplo a seguir faz o seguinte:
- Cria um modelo configurado por um esquema para responder com JSON.
- Solicita ao modelo que retorne receitas de biscoitos.
// Make sure to include these imports:
// import { GoogleGenerativeAI, SchemaType } from "@google/generative-ai";
const genAI = new GoogleGenerativeAI(process.env.API_KEY);
const schema = {
description: "List of recipes",
type: SchemaType.ARRAY,
items: {
type: SchemaType.OBJECT,
properties: {
recipeName: {
type: SchemaType.STRING,
description: "Name of the recipe",
nullable: false,
},
},
required: ["recipeName"],
},
};
const model = genAI.getGenerativeModel({
model: "gemini-1.5-pro",
generationConfig: {
responseMimeType: "application/json",
responseSchema: schema,
},
});
const result = await model.generateContent(
"List a few popular cookie recipes.",
);
console.log(result.response.text());
A saída pode ser semelhante a esta:
[{"recipeName": "Chocolate Chip Cookies"}, {"recipeName": "Oatmeal Raisin Cookies"}, {"recipeName": "Snickerdoodles"}, {"recipeName": "Sugar Cookies"}, {"recipeName": "Peanut Butter Cookies"}]