openai kotlin

Kotlin의 OpenAI API 클라이언트

Multiplatform 및 Corootines 기능을 갖춘 OpenAI의 API 용 Kotlin 클라이언트.

? 설정

1. build.gradle 파일에 다음 종속성을 추가하여 OpenAi API Kotlin 클라이언트를 설치하십시오.

repositories {
    mavenCentral()
}

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

2. KTOR 엔진 중 하나의 종속성을 선택하고 추가하십시오.

Bom

또는 build.gradle 파일에 다음 종속성을 추가하여 OpenAi-Client-Bom을 사용할 수 있습니다.

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

멀티 플랫폼

Multiplatform 프로젝트에서는 commonMain 에 OpenAI 클라이언트 종속성을 추가하고 각 대상의 엔진을 선택하십시오.

Maven

Maven 프로젝트에서 Maven 프로젝트에서 JVM 클라이언트를 사용하는 것을 막을 수있는 것은 아무것도 없지만 Gradle은 필요합니다. KTOR 엔진 중 하나의 종속성에 추가해야합니다.

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 >

BOM은 Maven 프로젝트를 위해 지원되지 않습니다.

⚡️ 시작합니다

메모

OpenAI는 API 키에 환경 변수를 사용하도록 권장합니다. 더 읽으십시오.

OpenAI 클라이언트 인스턴스 생성 :

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

또는 사전 구성된 OpenAIConfig 사용하여 OpenAI 인스턴스를 만들 수 있습니다.

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

val openAI = OpenAI (config)

OpenAI 인스턴스를 사용하여 API 요청을하십시오. 자세히 알아보십시오.

지원되는 기능

• 모델
• 채팅
• 이미지
• 임베딩
• 파일
• 미세 조정
• 중재
• 오디오

베타

• 조수
• 스레드
• 메시지
• 실행

더 이상 사용되지 않았습니다

• 완성
• 미세 조정
• 편집

토큰 화기를 찾고 계십니까? 텍스트 토큰 화를위한 Kotlin 라이브러리 인 Ktoken을 사용해보십시오.

가이드

이 안내서와 함께 Kotlin에 OpenAI API 클라이언트를 사용하는 방법에 대한 자세한 내용은 다음과 같습니다.

• 시작하기
• 채팅 및 기능 호출
• 파일 소스 가이드
• 조수

샘플 앱

샘플 앱은 sample 에서 사용할 수 있습니다. readme에서 실행 지침을 확인하십시오.

Proguard / R8

특정 규칙은 이미 R8로 자동으로 해석 할 수있는 항아리에 묶여 있습니다.

? 스냅 샷

스냅 샷 버전을 가져 오는 방법을 알아보십시오

스냅 샷 버전을 프로젝트로 가져 오려면 다음 코드 스 니펫을 Gradle 파일에 추가하십시오.

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

문제 해결

일반적인 문제와 솔루션은 문제 해결 안내서를 확인하십시오.

️ 지원

프로젝트에 감사합니까? 도움을 줄 수있는 방법은 다음과 같습니다.

1. 별 : 오른쪽 상단에 별을 줘. 그것은 많은 것을 의미합니다!
2. 기여 : 문제를 찾거나 기능 아이디어가 있습니까? PR을 제출하십시오.
3. 피드백 : 제안이 있습니까? 문제를 열거나 토론을 시작하십시오.

? 특허

OpenAi Kotlin API 클라이언트는 MIT 라이센스에 따라 라이센스가 부여 된 오픈 소프트웨어 소프트웨어입니다. 이것은 비공식 도서관이며 OpenAI와의 계약이나 승인이 아닙니다 . 기부금을 환영합니다.