跳到主要内容

OpenAI

备注

これは、Quarkus(Quarkus RESTクライアントを使用)とSpring(SpringのRestClientを使用)で最もよく機能するOpenAI REST APIのカスタムJava実装を使用するOpenAI統合のドキュメントです。

LangChain4jは埋め込みモデルを使用するためにOpenAIとの3つの異なる統合を提供しており、これは#1です:

  • OpenAIはOpenAI REST APIのカスタムJava実装を使用し、Quarkus(Quarkus RESTクライアントを使用)とSpring(SpringのRestClientを使用)で最もよく機能します。
  • OpenAI 公式 SDKは公式OpenAI Java SDKを使用します。
  • Azure OpenAIはMicrosoftのAzure SDKを使用し、高度なAzure認証メカニズムを含むMicrosoft Javaスタックを使用している場合に最適です。

Maven依存関係​

通常のJava​

<dependency>
<groupId>dev.langchain4j</groupId>
<artifactId>langchain4j-open-ai</artifactId>
<version>1.23.0</version>
</dependency>

Spring Boot​

<dependency>
<groupId>dev.langchain4j</groupId>
<artifactId>langchain4j-open-ai-spring-boot4-starter</artifactId>
<version>1.23.0-beta33</version>
</dependency>
备注

このスターターには Spring Boot 4 が必要です。Spring Boot 3 では、代わりに langchain4j-open-ai-spring-boot-starter を使用してください。 詳細はSpring Boot 統合を参照してください。

OpenAiEmbeddingModelの作成​

通常のJava​

EmbeddingModel model = OpenAiEmbeddingModel.builder()
.apiKey(System.getenv("OPENAI_API_KEY"))
.modelName("text-embedding-3-small")
.build();

Spring Boot​

application.propertiesに追加します:

# Mandatory properties:
langchain4j.open-ai.embedding-model.api-key=${OPENAI_API_KEY}
langchain4j.open-ai.embedding-model.model-name=text-embedding-3-small

# Optional properties:
langchain4j.open-ai.embedding-model.base-url=...
langchain4j.open-ai.embedding-model.custom-headers=...
langchain4j.open-ai.embedding-model.dimensions=...
langchain4j.open-ai.embedding-model.log-requests=...
langchain4j.open-ai.embedding-model.log-responses=...
langchain4j.open-ai.embedding-model.max-retries=...
langchain4j.open-ai.embedding-model.organization-id=...
langchain4j.open-ai.embedding-model.project-id=...
langchain4j.open-ai.embedding-model.timeout=...
langchain4j.open-ai.embedding-model.user=...

カスタム埋め込みリクエストパラメータの設定​

OpenAiEmbeddingModelを使用する場合、HTTPリクエストのJSONボディ内で 埋め込みリクエストにカスタムパラメータを設定できます。これは、 プロバイダー固有の埋め込みパラメータを必要とするOpenAI互換プロバイダーで便利です:

EmbeddingModel model = OpenAiEmbeddingModel.builder()
.baseUrl("https://integrate.api.nvidia.com/v1")
.apiKey(System.getenv("NVIDIA_API_KEY"))
.modelName("nvidia/nv-embedqa-e5-v5")
.customParameters(Map.of("input_type", "passage"))
.build();

機能​

  • 呼び出しごとのパラメータ(EmbeddingRequest経由):dimensions — text-embedding-3モデルで出力の次元数を削減します。 OpenAI固有のuser、encoding_format、および任意のパススルーパラメータは、 OpenAiEmbeddingRequestParametersを通じて利用できます(たとえばNVIDIAのinput_typeに使用されます)。
  • テキストのみ(画像入力は不可)。
  • リスナー:OpenAiEmbeddingModel.builder().listeners(...)で設定します。

リクエスト/レスポンスAPIについては、埋め込みモデルを参照してください。

例​