Interface EmbeddingModel

All Known Implementing Classes:
EmbeddingModelImpl

public interface EmbeddingModel
Interface for embedding text with OCI GenAI Service.
  • Method Summary

    Modifier and Type
    Method
    Description
    default com.oracle.bmc.generativeaiinference.responses.EmbedTextResponse
    embed(String text)
    Embeds a single line of text.
    List<com.oracle.bmc.generativeaiinference.responses.EmbedTextResponse>
    embedAll(List<String> inputs)
    Embeds a list of text inputs.
    default List<List<Float>>
    fromResponse(com.oracle.bmc.generativeaiinference.responses.EmbedTextResponse response)
    Convert an EmbedTextResponse to a list of embedding vectors.
    default List<List<Float>>
    fromResponses(List<com.oracle.bmc.generativeaiinference.responses.EmbedTextResponse> responses)
    Convert a list of EmbedTextResponses to a list of embedding vectors.
  • Method Details

    • embedAll

      List<com.oracle.bmc.generativeaiinference.responses.EmbedTextResponse> embedAll(List<String> inputs)
      Embeds a list of text inputs.
      Parameters:
      inputs - Text inputs to embed.
      Returns:
      The list of EmbedTextResponses for the input texts.
    • embed

      default com.oracle.bmc.generativeaiinference.responses.EmbedTextResponse embed(String text)
      Embeds a single line of text.
      Parameters:
      text - Text to embed.
      Returns:
      The EmbedTextResponse for the input.
    • fromResponse

      default List<List<Float>> fromResponse(com.oracle.bmc.generativeaiinference.responses.EmbedTextResponse response)
      Convert an EmbedTextResponse to a list of embedding vectors.
      Parameters:
      response - OCI EmbedTextResponse.
      Returns:
      A list of embedding vectors.
    • fromResponses

      default List<List<Float>> fromResponses(List<com.oracle.bmc.generativeaiinference.responses.EmbedTextResponse> responses)
      Convert a list of EmbedTextResponses to a list of embedding vectors.
      Parameters:
      responses - A list of OCI EmbedTextResponses.
      Returns:
      A list of embedding vectors.