Korzystanie z interfejsów API osadzania
Nauczy się Pan/Pani integrować i wykorzystywać usługi generowania osadzeń dostawców takich jak OpenAI i Hugging Face.
Korzystanie z interfejsów API osadzania to bezpłatna lekcja Vector Databases: Pinecone, Weaviate & pgvector na CoddyKit. To lekcja 2 z 4. Możesz przeczytać całą lekcję poniżej za darmo — a potem ćwiczyć ją interaktywnie w przeglądarce z wbudowanym edytorem kodu i tutorem AI dostępnym 24/7. To część ścieżki edukacyjnej Vector Databases: Pinecone, Weaviate & pgvector, a Twój postęp synchronizuje się między webem a aplikacją CoddyKit. Kurs Vector Databases: Pinecone, Weaviate & pgvector zawiera 4 lekcji w sumie.
Części tej lekcji nie zostały jeszcze przetłumaczone i są wyświetlane po angielsku.
What are Embedding APIs?
Embedding APIs are services that let you easily convert various types of data, like text or images, into vector embeddings.
Think of them as ready-to-use tools. Instead of building and training your own complex models, you send your data to the API, and it returns the numerical vector representation.
Why Use Embedding APIs?
Using an API for embeddings offers significant advantages, especially for beginners or those wanting quick integration:
- Pre-trained Models: Access to powerful, state-of-the-art models without the need for training.
- Ease of Use: Simple integration into your applications with just a few lines of code.
- Scalability: The API provider handles the underlying infrastructure, allowing your application to scale easily.
- Cost-Effective: Often more economical than maintaining your own models and hardware.
OpenAI: A Leading Provider
OpenAI is a well-known provider of AI models, including powerful embedding services. Their API makes it straightforward to generate high-quality embeddings.
A popular model they offer is text-embedding-ada-002, which is known for its balance of performance, versatility, and cost-effectiveness across many use cases.
OpenAI API: Initial Setup
To get started with OpenAI's embedding API, you'll need an API key from their website. It's crucial to keep this key confidential!
You'll also need to install the official Python client library. Open your terminal and run:
pip install openaiFor security, always store your API key in an environment variable rather than directly in your code.
Generate Embeddings with OpenAI
This Python program demonstrates how to generate an embedding for a text using the OpenAI API. Remember to replace "YOUR_OPENAI_API_KEY_HERE" with your actual key.
import os
from openai import OpenAI
# Replace with your actual API key or set as environment variable
# client = OpenAI(api_key=os.environ.get("OPENAI_API_KEY"))
client = OpenAI(api_key="YOUR_OPENAI_API_KEY_HERE") # For demonstration
def get_openai_embedding(text, model="text-embedding-ada-002"):
# OpenAI recommends replacing newlines with spaces for best results
text = text.replace("\n", " ")
response = client.embeddings.create(input=[text], model=model)
return response.data[0].embedding
if __name__ == "__main__":
example_text = "CoddyKit makes learning to code easy and fun."
embedding = get_openai_embedding(example_text)
print(f"Text: '{example_text}'")
print(f"Embedding length: {len(embedding)}")
print(f"First 5 dimensions: {embedding[:5]}")Hugging Face: Open-Source Models
Hugging Face is renowned for its vast hub of open-source machine learning models. They also provide an Inference API that allows you to use many of these models without complex local setup.
This is fantastic for experimenting with different models, especially various sentence transformer models that are excellent for text embeddings.
Embeddings with Hugging Face API
You can access the Hugging Face Inference API using standard HTTP requests. You'll need an API token from your Hugging Face account.
Here's a Python example using the requests library to get an embedding from a popular sentence transformer model.
import requests
import json
import os
# Replace with your Hugging Face API token or set as environment variable
# HF_API_TOKEN = os.environ.get("HF_API_TOKEN")
HF_API_TOKEN = "YOUR_HUGGINGFACE_API_TOKEN_HERE" # For demonstration
# Example model for sentence embeddings
API_URL = "https://api-inference.huggingface.co/models/sentence-transformers/all-MiniLM-L6-v2"
HEADERS = {"Authorization": f"Bearer {HF_API_TOKEN}"}
def query_hf_api(payload):
response = requests.post(API_URL, headers=HEADERS, json=payload)
return response.json()
if __name__ == "__main__":
text_to_embed = "Mobile learning platforms are convenient."
data = query_hf_api({"inputs": text_to_embed})
if isinstance(data, list) and len(data) > 0 and isinstance(data[0], list):
embedding = data[0]
print(f"Text: '{text_to_embed}'")
print(f"Embedding length: {len(embedding)}")
print(f"First 5 dimensions: {embedding[:5]}")
else:
print(f"Error or unexpected response: {data}")
print("Please check your API token and ensure the model is available.")Secure Your API Keys!
API keys are like passwords for your services. Always handle them with extreme care:
- Environment Variables: The most secure method is to store keys as environment variables, never hardcode them.
- Version Control: Never commit API keys directly into your code repository (e.g., Git, GitHub).
- Access Control: Limit who has access to your API keys and rotate them regularly if your provider allows.
Costs & Rate Limits
When using embedding APIs, be aware of:
- Pricing Models: Most APIs charge per token or per character processed. Costs can vary significantly between models and providers. Always check their pricing pages.
- Rate Limits: APIs often have limits on the number of requests you can make per minute or second. Exceeding these limits can lead to temporary blocks or errors.
- Model Choice: Different models offer different performance vs. cost trade-offs. Choose a model that fits your application's requirements and budget.
API Benefits Check
Which of the following are key benefits of using a third-party Embedding API (like OpenAI or Hugging Face) compared to training your own model locally?
Recap: Using Embedding APIs
In this lesson, you learned how to leverage embedding generation services from providers like OpenAI and Hugging Face:
- We explored the benefits of using pre-trained models via APIs for convenience and scalability.
- You saw practical Python examples for integrating with both OpenAI and Hugging Face Inference APIs to generate text embeddings.
- We discussed crucial aspects like API key security, understanding costs, and rate limits.
These APIs are powerful tools for quickly integrating semantic understanding into your applications, enabling features like semantic search, recommendations, and more!
Często zadawane pytania
Czy lekcja „Korzystanie z interfejsów API osadzania” jest bezpłatna?
Tak — pełny tekst „Korzystanie z interfejsów API osadzania” jest dostępny za darmo tutaj w sieci. Aby ćwiczyć ją interaktywnie (wbudowany edytor kodu i tutor AI dostępny 24/7) i odblokować resztę kursu Vector Databases: Pinecone, Weaviate & pgvector, przejdź na CoddyKit PRO. Kurs Vector Databases: Pinecone, Weaviate & pgvector zawiera 4 lekcji w sumie.
Co nauczysz się w „Korzystanie z interfejsów API osadzania”?
Nauczy się Pan/Pani integrować i wykorzystywać usługi generowania osadzeń dostawców takich jak OpenAI i Hugging Face. Ćwiczysz Vector Databases: Pinecone, Weaviate & pgvector z praktycznym kodem, który uruchamiasz bezpośrednio w przeglądarce, a tutor AI dostępny 24/7 odpowiada na Twoje pytania podczas pracy nad lekcją.
Czy potrzebuję doświadczenia, aby zacząć Vector Databases: Pinecone, Weaviate & pgvector?
Nie wymagamy żadnego doświadczenia. Vector Databases: Pinecone, Weaviate & pgvector w CoddyKit jest strukturyzowany dla początkujących i zaawansowanych użytkowników, więc możesz zacząć tutaj lub od początku i uczyć się w swoim tempie. To lekcja 2 z 4.
Ile czasu zajmuje lekcja „Korzystanie z interfejsów API osadzania”?
Większość lekcji CoddyKit trwa około 5–10 minut. Każda lekcja to mały, interaktywny krok, dzięki czemu robisz systematyczne postępy i zawsze wracasz dokładnie do tego samego miejsca — na webie i w aplikacji.
Czy mogę pisać i uruchamiać kod w tej lekcji Vector Databases: Pinecone, Weaviate & pgvector?
Tak. Każda lekcja Vector Databases: Pinecone, Weaviate & pgvector zawiera wbudowany edytor kodu, więc piszesz i uruchamiasz prawdziwy kod bezpośrednio w przeglądarce i od razu otrzymujesz sprzężenie zwrotne od AI — bez konfiguracji na komputerze.
Wszystkie lekcje w tym kursie
- Modele osadzania tekstu
- Korzystanie z interfejsów API osadzania
- Przechowywanie i aktualizowanie osadzeń
- Dzielenie tekstu na fragmenty dla lepszych embeddingów