Method: models.embedContent

Generuje osadzanie z modelu o podanej wartości wejściowej Content.

Żądanie HTTP

POST https://generativelanguage.googleapis.com/v1/{model=models/*}:embedContent

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
model

string

Wymagane. Nazwa zasobu modelu. Służy jako identyfikator używanego modelu.

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

Format: models/{model}

Treść żądania

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

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

object (Content)

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

enum (TaskType)

Opcjonalnie. Opcjonalny typ zadania, do którego będą używane wektory dystrybucyjne. Można ją ustawić tylko dla: models/embedding-001.
title

string

Opcjonalnie. Opcjonalny tytuł tekstu. Ma zastosowanie tylko wtedy, gdy TaskType ma wartość RETRIEVAL_DOCUMENT.

Uwaga: określenie właściwości title dla elementu RETRIEVAL_DOCUMENT umożliwia pobieranie blokad o lepszej jakości.
outputDimensionality

integer

Opcjonalnie. Opcjonalny zmniejszony rozmiar umieszczania danych wyjściowych. Jeśli jest ustawiony, nadmiarowe wartości we wektorze dystrybucyjnym są obcinane na końcu. Obsługiwane przez nowsze modele od 2024 roku, a wcześniejszy model (models/embedding-001) nie może określić tej wartości.

Treść odpowiedzi

Odpowiedź na: EmbedContentRequest.

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

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

object (ContentEmbedding)

Tylko dane wyjściowe. Umieszczanie wygenerowane z treści wejściowych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.