Method: models.generateText

Generuje odpowiedź na podstawie modelu z podanym komunikatem wejściowym.

Żądanie HTTP

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateText

Parametry ścieżki

Parametry
model

string

Wymagane. Nazwa elementu Model lub TunedModel, która ma być wykorzystywana do wygenerowania ukończenia. Przykłady: modele/text-bison-001 dostrojoneModele/sentence-translator-u3b7m

Treść żądania

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

Zapis JSON
{
  "prompt": {
    object (TextPrompt)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "stopSequences": [
    string
  ],
  "temperature": number,
  "candidateCount": integer,
  "maxOutputTokens": integer,
  "topP": number,
  "topK": integer
}
Pola
prompt

object (TextPrompt)

Wymagane. Swobodny tekst wejściowy podany modelowi jako prompt.

Na podstawie promptu model wygeneruje odpowiedź TextComplete, która prognozuje jako zakończenie tekstu wejściowego.

safetySettings[]

object (SafetySetting)

Opcjonalnie. Lista unikalnych instancji SafetySetting do blokowania niebezpiecznych treści.

które będą egzekwowane w GenerateTextRequest.prompt i GenerateTextResponse.candidates. Każdy typ SafetyCategory powinien mieć maksymalnie 1 ustawienie. Interfejs API blokuje wszystkie prompty i odpowiedzi, które nie osiągną progów ustawionych przez te ustawienia. Ta lista zastępuje domyślne ustawienia dla każdego elementu SafetyCategory określonego w ustawieniach bezpieczeństwa. Jeśli na liście nie ma atrybutu SafetySetting dla danego elementu SafetyCategory, interfejs API użyje dla tej kategorii domyślnego ustawienia bezpieczeństwa. Kategorie szkodliwego działania: HARM_CATEGORY_DEROGATORY, HARM_CATEGORY_TOXICITY, HARM_CATEGORY_VIOLENCE, HARM_CATEGORY_SEXUAL, HARM_CATEGORY_MEDical, HARM_CATEGORY_DANGEROUS są obsługiwane w usłudze tekstowej.

stopSequences[]

string

Zestaw sekwencji znaków (maksymalnie 5), które zatrzymują generowanie danych wyjściowych. Jeśli zostanie określony, interfejs API zostanie zatrzymany po pierwszym pojawieniu się sekwencji zatrzymania. Sekwencja zatrzymania nie zostanie uwzględniona w odpowiedzi.

temperature

number

Opcjonalnie. Określa losowość wyników. Uwaga: wartość domyślna różni się w zależności od modelu. Zobacz atrybut Model.temperature elementu Model, który zwrócił funkcję getModel.

Wartości mogą mieścić się w zakresie od [0,0,1,0] włącznie. Wartość bliższa 1,0 daje odpowiedzi, które są bardziej zróżnicowane i kreatywne, a wartość bliższa 0,0 zapewnia zwykle prostsze odpowiedzi na podstawie modelu.

candidateCount

integer

Opcjonalnie. Liczba wygenerowanych odpowiedzi do zwrócenia.

Ta wartość musi mieścić się w zakresie od [1 do 8] włącznie. Jeśli nie są ustawione, domyślna wartość to 1.

maxOutputTokens

integer

Opcjonalnie. Maksymalna liczba tokenów do uwzględnienia w kandydacie.

Jeśli nie jest ustawiona, domyślnie ustawiona jest wartośćoutputTokenLimit określony w specyfikacji Model.

topP

number

Opcjonalnie. Maksymalne skumulowane prawdopodobieństwo tokenów do uwzględnienia podczas próbkowania.

Model wykorzystuje połączone próbkowanie Top-K i jądra.

Tokeny są sortowane na podstawie przypisanych prawdopodobieństw, dzięki czemu brane są pod uwagę tylko te z największym prawdopodobieństwem. Próbkowanie Top-K bezpośrednio ogranicza maksymalną liczbę tokenów do rozważenia, natomiast próbkowanie Nucleusa ogranicza liczbę tokenów na podstawie prawdopodobieństwa skumulowanego.

Uwaga: wartość domyślna różni się w zależności od modelu. Zobacz atrybut Model.top_p elementu Model, który zwrócił funkcję getModel.

topK

integer

Opcjonalnie. Maksymalna liczba tokenów do uwzględnienia podczas próbkowania.

Model wykorzystuje połączone próbkowanie Top-K i jądra.

Próbkowanie Top-K uwzględnia zestaw topK najbardziej prawdopodobnych tokenów. Domyślna wartość to 40.

Uwaga: wartość domyślna różni się w zależności od modelu. Zobacz atrybut Model.top_k elementu Model, który zwrócił funkcję getModel.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu GenerateTextResponse.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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 o uwierzytelnianiu (w języku angielskim).