interfAIce

interface

L'IA elle-même en tant que votre implémentation

consultez mon article de blog qui présente interfAIce

Caractéristiques

• Génération automatique de proxy alimentée par l'IA pour vos interfaces
• Intégration de Spring Boot
• Prise en charge de Java Reactor et des coroutines Kotlin

Installation et utilisation

Dans le fichier build.gradle.kts de votre projet, ajoutez ce qui suit :

• Kotlin

  dependencies {
      implementation( " io.github.mscheong01:interfAIce-core:1.0.0 " )
  }
  
  // This option is currently required for reflection to work
  // Later releases will remove this requirement for Kotlin projects
  tasks.withType< KotlinCompile > {
      this .kotlinOptions {
          freeCompilerArgs = listOf ( " -Xjsr305=strict " )
          javaParameters = true
      }
  }

• Java

  dependencies {
      implementation( " io.github.mscheong01:interfAIce-core:1.0.0 " )
  }
  
  // This option is currently required for reflection to work
  // If all your classes have a no-arg constructor, you can remove this option
  tasks.withType< JavaCompile > {
      options.compilerArgs.add( " -parameters " )
  }

• botte de printemps
  1. ajoutez la dépendance du démarreur Spring Boot ainsi que la configuration de l'option de paramètre de compilation Java appropriée ci-dessus

  dependencies {
      implementation( " io.github.mscheong01:interfAIce-spring-boot-starter:1.0.0 " )
  }

  2. ajoutez l'annotation @EnableInterfaiceProxies à votre classe d'application Spring Boot ou à l'une de ses classes de configuration

  @EnableInterfaiceProxies(
      basePackages = [ " io.github.mscheong01.interfaice.examples " ]
  )
  @SpringBootApplication
  open class ExampleApplication

  3. spécifiez votre clé API OpenAi dans le fichier application.yml

   spring :
  interfaice :
    openai :
      api-key : ${OPENAI_API_KEY}
      chat :
        default-model : gpt-3.5-turbo # optional, defaults to gpt-3.5-turbo

  4. ajoutez l'annotation @OpenAiInterface à votre interface

  @OpenAiInterface
  interface ExampleInterface {
      fun greet ( name : String ): String
  }

  C'est ça ! Vous pouvez désormais utiliser votre interface comme si elle était implémentée par une vraie classe.

    @RestController
    class ExampleController (
        private val exampleInterface : ExampleInterface
    ) {
        @GetMapping( " /greet " )
        fun greet (@RequestParam name : String ): String {
            return exampleInterface.greet(name)
        }
    }

Versions instantanées

interfAIce fournit des versions d'instantanés qui sont automatiquement publiées lorsque les modifications sont transmises à la branche principale. La version actuelle de l'instantané est la prochaine version mineure de la version actuelle avec un suffixe -SNAPSHOT. Par exemple, si la version actuelle est la 1.2.3, la version de l'instantané sera 1.3.0-SNAPSHOT.

Pour utiliser des versions d'instantanés, ajoutez le référentiel d'instantanés Maven à votre configuration de build

repositories {
    maven {
        url = uri( " https://s01.oss.sonatype.org/content/repositories/snapshots/ " )
    }
}

Contribuer

Les contributions sont les bienvenues ! Veuillez consulter nos directives de contribution pour plus d’informations.

Licence

Ce projet est sous licence Apache 2.0.