Repolode
openai

openai/openai-java

SDK oficial para Java e Kotlin da REST API da OpenAI, com clientes síncronos e assíncronos, streaming e classes tipadas para requisições e respostas.

Estrelas
1,554
Forks
272
Issues abertas
66
Último commit
há 7 horas

O que é?

openai-java é a biblioteca oficial para chamar a API da OpenAI em aplicações Java. Ela encapsula os endpoints REST em builders tipados e classes de resposta, permitindo que desenvolvedores trabalhem com objetos Java em vez de escrever JSON manualmente. O principal ponto de entrada é a Responses API, e a Chat Completions API também é compatível.

O cliente está disponível nas versões síncrona e assíncrona, e os métodos de streaming retornam fluxos de fragmentos que podem ser processados à medida que os dados chegam. Classes auxiliares acumulam os fragmentos de chat completions e responses em objetos completos. É possível gerar saídas estruturadas automaticamente a partir de classes Java simples, com suporte opcional a anotações do Jackson e do Swagger para definir o JSON schema gerado.

O SDK também oferece configuração por propriedades do sistema ou variáveis de ambiente, autenticação por workload identity para Kubernetes, Azure e GCP, além de um artefato opcional para chamar APIs compatíveis com a OpenAI no Amazon Bedrock.

Recursos principais

  • 01Builders Java tipados e classes de resposta para as APIs Responses e Chat Completions.
  • 02Clientes síncronos e assíncronos, com métodos assíncronos que retornam CompletableFuture.
  • 03Streaming via SSE, com auxiliares que acumulam fragmentos em respostas completas.
  • 04Geração de saídas estruturadas a partir de classes Java, com validação local de JSON schema.
  • 05Autenticação por workload identity para Kubernetes, Azure e GCP.

Casos de uso

  • Adicionar geração de texto com tecnologia da OpenAI a um serviço de backend em Java ou Kotlin.
  • Transmitir a saída do modelo para um cliente web ou desktop conforme ela é gerada.
  • Extrair dados estruturados das respostas do modelo para objetos de domínio Java.
  • Chamar modelos compatíveis com a OpenAI no Amazon Bedrock a partir de uma aplicação Java.

Início rápido

  1. 1

    Adicione a dependência do Gradle

    implementation("com.openai:openai-java:4.90.0")
  2. 2

    Crie um cliente a partir de variáveis de ambiente

    OpenAIClient client = OpenAIOkHttpClient.fromEnv();

Antes de usar

  • Os exemplos do README usam a variável de ambiente OPENAI_API_KEY, então você precisa de uma chave de API da OpenAI para fazer solicitações.

Tópicos

Perguntas frequentes

O que é openai-java?
SDK oficial para Java e Kotlin da REST API da OpenAI, com clientes síncronos e assíncronos, streaming e classes tipadas para requisições e respostas. openai-java é a biblioteca oficial para chamar a API da OpenAI em aplicações Java. Ela encapsula os endpoints REST em builders tipados e classes de resposta, permitindo que desenvolvedores trabalhem com objetos Java em vez de escrever JSON manualmente. O principal ponto de entrada é a Responses API, e a Chat Completions API também é compatível.
openai-java é gratuito? Qual é a licença?
openai-java é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
openai-java ainda é mantido?
Manutenção ativa. O último commit de openai-java foi em 22 de out. de 2026.
Para que posso usar openai-java?
Adicionar geração de texto com tecnologia da OpenAI a um serviço de backend em Java ou Kotlin. Transmitir a saída do modelo para um cliente web ou desktop conforme ela é gerada. Extrair dados estruturados das respostas do modelo para objetos de domínio Java. Chamar modelos compatíveis com a OpenAI no Amazon Bedrock a partir de uma aplicação Java.
Como instalar openai-java?
Adicione a dependência do Gradle: implementation("com.openai:openai-java:4.90.0") Crie um cliente a partir de variáveis de ambiente: OpenAIClient client = OpenAIOkHttpClient.fromEnv();
Onde consigo openai-java?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/openai/openai-java

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados