Com a tarefa MediaPipe Text Embedder, é possível criar uma representação numérica dos dados de texto para capturar o significado semântico deles. Estas instruções mostram como usar o incorporador de texto para apps da Web e JavaScript.
Para mais informações sobre os recursos, modelos e opções de configuração dessa tarefa, consulte a Visão geral.
Exemplo de código
O código de exemplo do Text Embedder fornece uma implementação completa dessa tarefa em JavaScript para sua referência. Esse código ajuda você a testar essa tarefa e começar a criar seu próprio app de incorporação de texto. É possível ver, executar e editar o exemplo de código do Text Embedder usando apenas seu navegador da Web.
Configuração
Esta seção descreve as principais etapas para configurar seu ambiente de desenvolvimento e projetos de código para usar o Text Embedder. Para informações gerais sobre a configuração do ambiente de desenvolvimento para uso de tarefas do MediaPipe, incluindo requisitos de versão da plataforma, consulte o Guia de configuração para Web.
Pacotes JavaScript
O código do incorporador de texto está disponível no
pacote
@mediapipe/tasks-text. Você pode encontrar essas bibliotecas nos links fornecidos no Guia de configuração da plataforma.
É possível instalar os pacotes necessários com o seguinte código para preparo local usando o seguinte comando:
npm install @mediapipe/tasks-text
Caso queira implantar em um servidor, você pode usar um serviço de rede de fornecimento de conteúdo (CDN, na sigla em inglês), como o jsDelivr, para adicionar código diretamente à sua página HTML, da seguinte maneira:
<head>
<script src="https://cdn.jsdelivr.net/npm/@mediapipe/tasks-text@latest/index.js"
crossorigin="anonymous"></script>
</head>
Modelo
A tarefa MediaPipe Text Embedder requer um modelo treinado compatível com ela. Para mais informações sobre os modelos treinados disponíveis para o incorporador de texto, consulte a seção Modelos de visão geral da tarefa.
Selecione e faça o download de um modelo e armazene-o no diretório do projeto:
<dev-project-root>/app/shared/models
Criar a tarefa
Use uma das funções createFrom...() do incorporador de texto para
preparar a tarefa para executar inferências. Você pode usar a função createFromModelPath() com um caminho relativo ou absoluto para o arquivo de modelo treinado. O exemplo de código abaixo demonstra o uso da função createFromOptions(). Para mais informações sobre as opções de configuração disponíveis, consulte
Opções de configuração.
O código a seguir demonstra como criar e configurar essa tarefa:
async function createEmbedder() {
const textFiles = await FilesetResolver.forTextTasks("https://cdn.jsdelivr.net/npm/@mediapipe/tasks-text@latest/wasm/");
textEmbedder = await TextEmbedder.createFromOptions(
textFiles,
{
baseOptions: {
modelAssetPath: `https://storage.googleapis.com/mediapipe-tasks/text_embedder/universal_sentence_encoder.tflite`
},
quantize: true
}
);
}
createEmbedder();
Opções de configuração
Essa tarefa tem as seguintes opções de configuração para aplicativos da Web e JavaScript:
| Nome da opção | Descrição | Intervalo de valor | Valor padrão |
|---|---|---|---|
l2Normalize |
Define se o vetor de atributo retornado será normalizado com a norma L2. Use essa opção somente se o modelo ainda não tiver uma operação nativa do TFLite L2_NORMALIZATION. Na maioria dos casos, esse já é o caso, e a normalização L2 é, portanto, feita por meio da inferência TFLite sem precisar dessa opção. | Boolean |
False |
quantize |
Define se o embedding retornado precisa ser quantizado em bytes por meio da quantização escalar. Os embeddings são implicitamente considerados padrão de unidade e, portanto, qualquer dimensão tem um valor em [-1.0, 1.0]. Use a opção l2Normalize se esse não for o caso. | Boolean |
False |
preparar dados
O Incorporador de texto funciona com dados de texto (string). A tarefa lida com o pré-processamento da entrada de dados, incluindo a tokenização e o pré-processamento do tensor. Todo o
pré-processamento é processado na função embed. Não é necessário
fazer mais um pré-processamento do texto de entrada com antecedência.
const inputText = "The input text to be embedded.";
Executar a tarefa
O Incorporador de texto usa a função embed para acionar inferências. Na incorporação de texto, isso significa retornar os vetores de embedding do texto de entrada.
O código a seguir demonstra como executar o processamento com o modelo de tarefa.
// Wait to run the function until inner text is set
const embeddingResult = textEmbedder.embed(
inputText
);
Gerenciar e mostrar resultados
O Incorporador de texto gera um TextEmbedderResult que contém uma lista de
embeddings (de ponto flutuante ou quantizado escalar) para o texto de entrada.
Veja a seguir um exemplo dos dados de saída dessa tarefa:
TextEmbedderResult:
Embedding #0 (sole embedding head):
float_embedding: {0.2345f, 0.1234f, ..., 0.6789f}
head_index: 0
É possível comparar a semelhança semântica de dois embeddings usando a função TextEmbedder.cosineSimilarity. Confira um exemplo no código a seguir.
// Compute cosine similarity.
const similarity = TextEmbedder.cosineSimilarity(
embeddingResult.embeddings[0],
otherEmbeddingResult.embeddings[0]);
O código de exemplo do incorporador de texto demonstra como exibir os resultados do incorporador retornados da tarefa. Consulte o exemplo de código para mais detalhes.