パッケージ org.springframework.ai.embedding

インターフェース EmbeddingModel

すべてのスーパーインターフェース:
Model<EmbeddingRequest,EmbeddingResponse>
すべての既知の実装クラス:
AbstractEmbeddingModel、AzureOpenAiEmbeddingModel、BedrockCohereEmbeddingModel、BedrockTitanEmbeddingModel、MiniMaxEmbeddingModel、MistralAiEmbeddingModel、OCIEmbeddingModel、OllamaEmbeddingModel、OpenAiEmbeddingModel、PostgresMlEmbeddingModel、TransformersEmbeddingModel、VertexAiTextEmbeddingModel、ZhiPuAiEmbeddingModel
public interface EmbeddingModel extends Model<EmbeddingRequest,EmbeddingResponse>
EmbeddingModel はモデルを埋め込むための汎用インターフェースです。
導入:
1.0.0
作成者:
Mark Pollack, Christian Tzolov, Josh Long, Soby Chacko, Jihoon Kim

  • メソッドの詳細

    • call

      EmbeddingResponse call(EmbeddingRequest request)
      インターフェースからコピーされた説明: Model
      AI モデルへのメソッド呼び出しを実行します。
      次で指定:
      インターフェース Model<EmbeddingRequest,EmbeddingResponse> の call 
      パラメーター:
      request - AI モデルに送信されるリクエストオブジェクト
      戻り値:
      AI モデルからのレスポンス

    • embed

      default float[] embed(StringSE text)
      指定されたテキストをベクトルに埋め込みます。
      パラメーター:
      text - 埋め込むテキスト。
      戻り値:
      埋め込まれたベクトル。

    • embed

      float[] embed(Document document)
      指定されたドキュメントのコンテンツをベクトルに埋め込みます。
      パラメーター:
      document - 埋め込むドキュメント。
      戻り値:
      埋め込まれたベクトル。

    • embed

      default ListSE<float[]> embed(ListSE<StringSE> texts)
      一連のテキストをベクトルに埋め込みます。
      パラメーター:
      texts - 埋め込むテキストのリスト。
      戻り値:
      埋め込まれたベクトルのリスト。

    • embed

      default ListSE<float[]> embed(ListSE<Document> documents, EmbeddingOptions options, BatchingStrategy batchingStrategy)
      BatchingStrategy に基づいて、一連の Document をベクトルに埋め込みます。
      パラメーター:
      documents - Document のリスト。
      options - EmbeddingOptions。
      batchingStrategy - BatchingStrategy。
      戻り値:
      入力された Document のベクトルを表す float[] のリスト。返されるリストは Document リストと同じ順序になるはずです。

    • embedForResponse

      default EmbeddingResponse embedForResponse(ListSE<StringSE> texts)
      一連のテキストをベクトルに埋め込み、EmbeddingResponse を返します。
      パラメーター:
      texts - 埋め込むテキストのリスト。
      戻り値:
      埋め込みレスポンス。

    • dimensions

      default int dimensions()
      埋め込みベクトルの次元数を取得します。デフォルトでは、このメソッドはリモート埋め込みエンドポイントを呼び出して埋め込みベクトルの次元数を取得します。次元数が事前にわかっている場合は、このメソッドをオーバーライドすることをお勧めします。
      戻り値:
      埋め込まれたベクトルの次元数。