Text Embeddings API

API de incorporação de texto

Este projeto fornece uma API REST para gerar incorporações de texto usando o modelo de Transformers de sentenças. Ele é construído usando o Flask e visa simplificar o processo de conversão de texto em incorporação para várias tarefas de PNL.

Características

• Geração de incorporação de texto : converte o texto de entrada em incorporação usando o modelo BAAI/bge-base-zh .
• Manuseio de erros : Manuseio de erro robusto para gerenciar os campos ausentes e erros inesperados.
• Registro : registro abrangente para monitorar solicitações de API e depuração.

Uso

Endpoint da API

• Post / : aceita uma carga útil JSON com um campo text e retorna as incorporações correspondentes.

Solicitação de exemplo

curl -X POST http:// < server_address > / -H " Content-Type: application/json " -d ' {"text": "Your text here"} '

Exemplo de resposta

{
  "Embeddings" : [ ... ]
}

Complexidade e desafios

1. Integração do modelo

• Complexidade : integrando o modelo dos transformadores de frases e garantindo que ele carregue corretamente.
• Solução : Utilizou o pacote SentenceTransformer no pacote sentence_transformers para carregar o modelo pré-treinado.

2. Manuseio de erros

• Complexidade : lidando com erros de manuseio graciosamente, como falta de campos ou falhas de modelo.
• SOLUÇÃO : Os blocos de Try-Except implementados para capturar e registrar erros, retornando os códigos de status HTTP apropriados.

3. registro

• Complexidade : garantindo um registro abrangente para depuração e monitoramento.
• Solução : o log configurado para capturar todos os níveis de logs e incluiu mensagens de log detalhadas.

Começando

Pré -requisitos

• Python 3.6+
• Balão
• transformadores de frases

Instalação

1. Clone o repositório:

   git clone https://github.com/faisal-fida/text-embeddings-API.git
   cd text-embeddings-API

2. Instale dependências:

   pip install -r requirements.txt

3. Execute o aplicativo:

   python main.py

Conclusão

Esta API fornece uma abordagem eficiente e direta para gerar incorporações de texto, com manuseio e log de erros robustos para garantir a confiabilidade. É ideal para aplicativos que precisam de representação de texto rápida e precisa para tarefas de PNL.