interfAIce

介面

人工智慧本身就是你的實現

查看我介紹介面的部落格文章

特徵

• 為您的介面自動產生由人工智慧驅動的代理
• Spring Boot 集成
• Java Reactor 和 Kotlin 協程支援

安裝與使用

在專案的build.gradle.kts檔案中，加入以下內容：

• 科特林

  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
      }
  }

• 爪哇

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

• 彈簧靴
  1. 新增 spring boot starter 依賴項以及上面對應的 java 編譯參數選項配置

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

  2. 將@EnableInterfaiceProxies註解添加到您的 Spring Boot 應用程式類或其任何配置類

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

  3. 在application.yml檔案中指定您的 OpenAi api 金鑰

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

  4. 將@OpenAiInterface註釋加入您的介面

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

  就是這樣！現在您可以使用您的接口，就像它是由真實的類別實現的一樣。

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

快照版本

interfAIce 提供快照版本，當變更推送到主分支時，快照版本會自動發布。目前快照版本是目前發行版本的下一個次要版本，帶有 -SNAPSHOT 後綴。例如，如果目前版本是 1.2.3，則快照版本將為 1.3.0-SNAPSHOT。

若要使用快照版本，請將 Maven 快照儲存庫新增至您的建置設定中

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

貢獻

歡迎貢獻！請參閱我們的貢獻指南以獲取更多資訊。

執照

該專案根據 Apache 2.0 許可證獲得許可。