interfAIce

Schnittstelle

KI selbst als Ihre Implementierung

Schauen Sie sich meinen Blog-Beitrag an, der interfAIce vorstellt

Merkmale

• Automatische KI-gestützte Proxy-Generierung für Ihre Schnittstellen
• Spring Boot-Integration
• Unterstützung für Java Reactor und Kotlin-Coroutinen

Installation und Nutzung

Fügen Sie in der Datei build.gradle.kts Ihres Projekts Folgendes hinzu:

• 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 " )
  }

• Frühlingsstiefel
  1. Fügen Sie die Spring-Boot-Starter-Abhängigkeit zusammen mit der entsprechenden Java-Kompilierungsparameter-Optionskonfiguration oben hinzu

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

  2. Fügen Sie die Annotation @EnableInterfaiceProxies zu Ihrer Spring-Boot-Anwendungsklasse oder einer ihrer Konfigurationsklassen hinzu

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

  3. Geben Sie Ihren OpenAi-API-Schlüssel in der Datei application.yml an

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

  4. Fügen Sie die Annotation @OpenAiInterface zu Ihrer Schnittstelle hinzu

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

  Das ist es! Sie können Ihre Schnittstelle jetzt so verwenden, als ob sie von einer echten Klasse implementiert wäre.

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

Snapshot-Versionen

interfAIce stellt Snapshot-Versionen bereit, die automatisch freigegeben werden, wenn Änderungen an den Hauptzweig übertragen werden. Die aktuelle Snapshot-Version ist die nächste Nebenversion der aktuellen Release-Version mit dem Suffix -SNAPSHOT. Wenn die aktuelle Version beispielsweise 1.2.3 ist, lautet die Snapshot-Version 1.3.0-SNAPSHOT.

Um Snapshot-Versionen zu verwenden, fügen Sie das Maven-Snapshot-Repository zu Ihrer Build-Konfiguration hinzu

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

Mitwirken

Beiträge sind willkommen! Weitere Informationen finden Sie in unseren Beitragsrichtlinien.

Lizenz

Dieses Projekt ist unter der Apache 2.0-Lizenz lizenziert.