openai kotlin

Cliente de API OpenAI para Kotlin

Cliente de Kotlin para API do OpenAI com recursos multiplataforma e coroutina.

? Configurar

1. Instale o OpenAI API Kotlin Client, adicionando a seguinte dependência ao seu arquivo build.gradle :

repositories {
    mavenCentral()
}

dependencies {
    implementation " com.aallam.openai:openai-client:3.8.2 "
}

2. Escolha e adicione às suas dependências um dos motores da KTOR.

Bom

Como alternativa, você pode usar o OpenI-Client-Bom, adicionando a seguinte dependência ao seu arquivo build.gradle

dependencies {
    // import Kotlin API client BOM
    implementation platform( ' com.aallam.openai:openai-client-bom:3.8.2 ' )

    // define dependencies without versions
    implementation ' com.aallam.openai:openai-client '
    runtimeOnly ' io.ktor:ktor-client-okhttp '
}

Multiplataform

Nos projetos multiplataforma, adicione a dependência do cliente OpenAI ao commonMain e escolha um mecanismo para cada destino.

Maven

O gradle é necessário para o suporte multiplataforma, mas não há nada que o impeça de usar o cliente JVM em um projeto MAVEN. Você ainda precisa adicionar às suas dependências um dos motores da KTOR.

Configure o cliente com maven

< dependencies >
    < dependency >
        < groupId >com.aallam.openai</ groupId >
        < artifactId >openai-client-jvm</ artifactId >
        < version >3.8.0</ version >
    </ dependency >
            
    < dependency >
        < groupId >io.ktor</ groupId >
        < artifactId >ktor-client-okhttp-jvm</ artifactId >
        < version >2.3.2</ version >
        < scope >runtime</ scope >
    </ dependency >
</ dependencies >

O BOM não é suportado para projetos Maven.

⚡️ Introdução

Observação

O OpenAI incentiva o uso de variáveis ​​de ambiente para a chave da API. Leia mais.

Crie uma instância do cliente OpenAI :

 val openai = OpenAI (
    token = " your-api-key " ,
    timeout = Timeout (socket = 60 .seconds),
    // additional configurations...
)

Ou você pode criar uma instância do OpenAI usando um OpenAIConfig pré-configurado:

 val config = OpenAIConfig (
    token = apiKey,
    timeout = Timeout (socket = 60 .seconds),
    // additional configurations...
)

val openAI = OpenAI (config)

Use sua instância OpenAI para fazer solicitações de API. Saber mais.

Recursos suportados

• Modelos
• Bater papo
• Imagens
• Incorporação
• Arquivos
• Afinação
• Moderações
• Áudio

Beta

• Assistentes
• Tópicos
• Mensagens
• Corre

Descontinuado

• Conclusões
• Tunes finos
• Edições

Procurando um tokenizador? Experimente Ktoken, uma biblioteca Kotlin para o texto simbólico.

Guias

Comece e entenda mais sobre como usar o cliente da API OpenAI para Kotlin com estes guias:

• Começando
• Chat & Function Chamada
• Guia do FileRcece
• Assistentes

Aplicativos de amostra

Os aplicativos de exemplo estão disponíveis em sample , verifique o ReadMe para obter instruções em execução.

ProGuard / R8

As regras específicas já estão agrupadas no frasco que podem ser interpretadas por R8 automaticamente.

? Instantâneos

Aprenda a importar versão instantânea

Para importar versões instantâneas para o seu projeto, adicione o seguinte snippet de código ao seu arquivo gradle:

repositories {
   // ...
   maven { url ' https://oss.sonatype.org/content/repositories/snapshots/ ' }
}

Solução de problemas

Para problemas comuns e suas soluções, verifique o guia de solução de problemas.

️ Suporte

Aprecia o projeto? Veja como você pode ajudar:

1. Estrela : Dê uma estrela no canto superior direito. Significa muito!
2. Contribuir : encontrou um problema ou tem uma ideia de recurso? Envie um pr.
3. Feedback : tem sugestões? Abra um problema ou inicie uma discussão.

? Licença

O Openai Kotlin API Client é um software de código aberto licenciado sob a licença do MIT. Esta é uma biblioteca não oficial, não é afiliada a nem endossada pelo Openai . Contribuições são bem -vindas.