Embeddings

Wstawianie to liczbowa reprezentacja tekstu, która umożliwia wiele unikalnych zastosowań, takich jak grupowanie, pomiar podobieństwa i pobieranie informacji. Więcej informacji znajdziesz w przewodniku umieszczania.

Metoda: Modele.embedContent

Generuje wektor embeddingu tekstu na podstawie wejścia Content za pomocą określonego modelu embeddingu Gemini.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedContent

Parametry ścieżki

model string

Wymagane. Nazwa zasobu modelu. Jest to identyfikator modelu, którego chcesz użyć.

Ta nazwa powinna być zgodna z nazwą modelu zwróconą przez metodę models.list.

Format: models/{model} Przyjmuje postać models/{model}.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Pola
content object (Content)

Wymagane. Treści do osadzenia. Zliczane będą tylko pola parts.text.

taskType enum (TaskType)

Opcjonalnie: Opcjonalny typ zadania, w którym mają być używane zaimplementowane embeddingi. Można ustawić tylko w przypadku parametru models/embedding-001.

title string

Opcjonalnie: Opcjonalny tytuł tekstu. Dotyczy tylko wartości RETRIEVAL_DOCUMENT dla parametru TaskType.

Uwaga: określenie title dla RETRIEVAL_DOCUMENT zapewnia lepszą jakość wektorów dystrybucyjnych do pobierania.

outputDimensionality integer

Opcjonalnie: Opcjonalny zredukowany wymiar wektora wyjściowego. Jeśli jest ustawiona, nadmierne wartości w wejściowym embeddingu są obcinane od końca. Obsługiwane tylko przez nowsze modele od 2024 r. Nie możesz ustawić tej wartości, jeśli używasz wcześniejszego modelu (models/embedding-001).

Przykładowe żądanie

Python


text = "Hello World!"
result = genai.embed_content(
    model="models/text-embedding-004", content=text, output_dimensionality=10
)
print(result["embedding"])
embed.py

Node.js

// Make sure to include these imports:
// import { GoogleGenerativeAI } from "@google/generative-ai";
const genAI = new GoogleGenerativeAI(process.env.API_KEY);
const model = genAI.getGenerativeModel({
  model: "text-embedding-004",
});

const result = await model.embedContent("Hello world!");

console.log(result.embedding);
embed.js

Pudrowy róż

curl "https://generativelanguage.googleapis.com/v1beta/models/text-embedding-004:embedContent?key=$GOOGLE_API_KEY" \
-H 'Content-Type: application/json' \
-d '{"model": "models/text-embedding-004",
    "content": {
    "parts":[{
      "text": "Hello world"}]}, }' 2> /dev/null | head
embed.sh

Treść odpowiedzi

Odpowiedź na EmbedContentRequest.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

.
Pola
embedding object (ContentEmbedding)

Tylko dane wyjściowe. Elementy osadzone wygenerowane na podstawie treści wejściowych.

Zapis JSON 
{
  "embedding": {
    object (ContentEmbedding)
  }
}

Metoda: models.batchEmbedContents

Generuje wiele wektorów zanurzonych na podstawie wejścia Content, które składa się z grupy ciągów znaków reprezentowanych jako obiekty EmbedContentRequest.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedContents

Parametry ścieżki

model string

Wymagane. Nazwa zasobu modelu. Jest to identyfikator modelu, którego chcesz użyć.

Ta nazwa powinna być zgodna z nazwą modelu zwróconą przez metodę models.list.

Format: models/{model} Przyjmuje postać models/{model}.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Fields
requests[] object (EmbedContentRequest)

Wymagane. umieszczać prośby w zbiorze. Model w każdym z tych żądań musi być zgodny z modelem określonym w parametryzacji BatchEmbedContentsRequest.model.

Przykładowe żądanie

Python

texts = [
    "What is the meaning of life?",
    "How much wood would a woodchuck chuck?",
    "How does the brain work?",
]
result = genai.embed_content(
    model="models/text-embedding-004", content=texts, output_dimensionality=10
)
print(result)
embed.py

Node.js

// Make sure to include these imports:
// import { GoogleGenerativeAI } from "@google/generative-ai";
const genAI = new GoogleGenerativeAI(process.env.API_KEY);
const model = genAI.getGenerativeModel({
  model: "text-embedding-004",
});

function textToRequest(text) {
  return { content: { role: "user", parts: [{ text }] } };
}

const result = await model.batchEmbedContents({
  requests: [
    textToRequest("What is the meaning of life?"),
    textToRequest("How much wood would a woodchuck chuck?"),
    textToRequest("How does the brain work?"),
  ],
});

console.log(result.embeddings);
embed.js

Pudrowy róż

curl "https://generativelanguage.googleapis.com/v1beta/models/text-embedding-004:batchEmbedContents?key=$GOOGLE_API_KEY" \
-H 'Content-Type: application/json' \
-d '{"requests": [{
      "model": "models/text-embedding-004",
      "content": {
      "parts":[{
        "text": "What is the meaning of life?"}]}, },
      {
      "model": "models/text-embedding-004",
      "content": {
      "parts":[{
        "text": "How much wood would a woodchuck chuck?"}]}, },
      {
      "model": "models/text-embedding-004",
      "content": {
      "parts":[{
        "text": "How does the brain work?"}]}, }, ]}' 2> /dev/null | grep -C 5 values
embed.sh

Treść odpowiedzi

Odpowiedź na BatchEmbedContentsRequest.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Pola
embeddings[] object (ContentEmbedding)

Tylko dane wyjściowe. Węzły dla każdego żądania w tej samej kolejności, w jakiej zostały podane w żądaniu zbiorczym.

Zapis JSON 
{
  "embeddings": [
    {
      object (ContentEmbedding)
    }
  ]
}

EmbedContentRequest

Żądanie zawierające Content modelu do osadzenia.

Pola
model string

Wymagane. Nazwa zasobu modelu. Jest to identyfikator modelu, którego chcesz użyć.

Nazwa ta powinna być zgodna z nazwą modelu zwróconą przez metodę models.list.

Format: models/{model}

content object (Content)

Wymagane. Treść do umieszczenia. Zliczane będą tylko pola parts.text.

taskType enum (TaskType)

Opcjonalnie: Opcjonalny typ zadania, w którym mają być używane zaimplementowane embeddingi. Można ustawić tylko w przypadku parametru models/embedding-001.

title string

Opcjonalnie: Opcjonalny tytuł tekstu. Dotyczy tylko wartości RETRIEVAL_DOCUMENT dla parametru TaskType.

Uwaga: określenie title dla RETRIEVAL_DOCUMENT zapewnia lepszą jakość wektorów dystrybucyjnych do pobierania.

outputDimensionality integer

Opcjonalnie: Opcjonalnie zmniejszony wymiar wektora dystrybucyjnego na wyjściu. Jeśli jest ustawiona, nadmierne wartości w wejściowym embeddingu są obcinane od końca. Obsługiwane tylko przez nowsze modele od 2024 r. Nie możesz ustawić tej wartości, jeśli używasz wcześniejszego modelu (models/embedding-001).

Zapis JSON 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}

ContentEmbedding

Lista liczb zmiennoprzecinkowych reprezentujących wektor dystrybucyjny.

.
Pola
values[] number

Wartości wstawiania.

Zapis JSON 
{
  "values": [
    number
  ]
}

TaskType

Typ zadania, w którym zostanie użyte umieszczanie.

Wartości w polu enum
TASK_TYPE_UNSPECIFIED Nieokreślona wartość, która domyślnie zostanie ustawiona na jedną z innych wartości enum.
RETRIEVAL_QUERY Określa, że dany tekst jest zapytaniem w ustawieniach wyszukiwania/pobierania.
RETRIEVAL_DOCUMENT Określa, że podany tekst jest dokumentem z przeszukiwanego korpusu.
SEMANTIC_SIMILARITY Określa, że podany tekst będzie używany do STS.
CLASSIFICATION Określa, że dany tekst zostanie zaklasyfikowany.
CLUSTERING Określa, że wektory dystrybucyjne będą używane do grupowania.
QUESTION_ANSWERING Określa, że podany tekst będzie używany do udzielania odpowiedzi na pytania.
FACT_VERIFICATION Określa, że podany tekst będzie używany do weryfikacji faktów.