- Żądanie HTTP
- Parametry ścieżki
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- GroundingPassages
- GroundingPassage
- SemanticRetrieverConfig
- AnswerStyle
- InputFeedback
- BlockReason
Generuje opartą na danych odpowiedź modelu na podstawie danych wejściowych GenerateAnswerRequest
.
Żądanie HTTP
POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateAnswer
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
model |
To pole jest wymagane. Nazwa obiektu Format: |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "contents": [ { object ( |
Pola | |
---|---|
contents[] |
To pole jest wymagane. Treść bieżącej rozmowy z modelem. W przypadku zapytań jednoetapowych należy odpowiedzieć na to pytanie. W przypadku zapytań wieloetapowych jest to pole powtarzane zawierające historię rozmowy oraz ostatni Uwaga: parametr model.generateAnswer obecnie obsługuje tylko zapytania w języku angielskim. |
answerStyle |
To pole jest wymagane. Styl, w którym odpowiedzi mają być zwracane. |
safetySettings[] |
Opcjonalnie. Lista unikalnych wystąpień Ta zasada będzie egzekwowana w |
Pole sumy grounding_source . Źródła, w których podstawą odpowiedzi będą wiarygodne odpowiedzi. grounding_source może być tylko jedną z tych wartości: |
|
inlinePassages |
Fragmenty udostępnione w treści żądania. |
semanticRetriever |
Zawartość pobrana z zasobów utworzonych za pomocą interfejsu Semantic Retriever API. |
temperature |
Opcjonalnie. Określa losowość danych wyjściowych. Wartości muszą mieścić się w zakresie od [0,0;1,0] włącznie. Wartość bliższa 1,0 daje bardziej zróżnicowane i kreatywne odpowiedzi, a wartość bliższa 0,0 oznacza zwykle prostsze odpowiedzi modelu. W przypadku korzystania z przypisanych odpowiedzi na pytania zwykle zalecana jest niska temperatura (~0,2). |
Treść odpowiedzi
Odpowiedź modelu jako uzasadniona odpowiedź.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "answer": { object ( |
Pola | |
---|---|
answer |
Proponowana odpowiedź modelu. Uwaga: model zawsze próbuje podać ugruntowaną odpowiedź, nawet jeśli odpowiedź na pytanie jest mało prawdopodobna z danych fragmentów. W takim przypadku może zostać podana odpowiedź niskiej jakości lub bezpodstawna, wraz z niską wartością |
answerableProbability |
Tylko dane wyjściowe. Szacunkowe prawdopodobieństwo tego, że odpowiedź modelu jest poprawna i opiera się na fragmentach wejściowych. Niska wartość answerableProbability wskazuje, że odpowiedź może nie być oparta na źródłach. Gdy
|
inputFeedback |
Tylko dane wyjściowe. Opinia dotycząca danych wejściowych użytych do udzielenia odpowiedzi na pytanie, w odróżnieniu od odpowiedzi wygenerowanej przez model na to pytanie. „Dane wejściowe” mogą być dowolnymi z tych rodzajów danych:
|
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/generative-language
https://www.googleapis.com/auth/generative-language.retriever
https://www.googleapis.com/auth/generative-language.retriever.readonly
https://www.googleapis.com/auth/generative-language.tuning
https://www.googleapis.com/auth/generative-language.tuning.readonly
Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
GroundingPassages
Powtórzona lista fragmentów.
Zapis JSON |
---|
{
"passages": [
{
object ( |
Pola | |
---|---|
passages[] |
Lista fragmentów. |
GroundingPassage
Fragment został dołączony w linii z konfiguracją umocowania.
Zapis JSON |
---|
{
"id": string,
"content": {
object ( |
Pola | |
---|---|
id |
Identyfikator fragmentu używany do przypisywania tego fragmentu do ugruntowanych odpowiedzi. |
content |
Treść pasażu. |
SemanticRetrieverConfig
Konfiguracja pobierania treści umocowania z Corpus
lub Document
, która została utworzona za pomocą interfejsu Semantic Retriever API.
Zapis JSON |
---|
{ "source": string, "query": { object ( |
Pola | |
---|---|
source |
To pole jest wymagane. Nazwa zasobu do pobrania, np. korpus/123 lub korpus/123/dokumenty/abc. |
query |
To pole jest wymagane. Zapytanie, które ma służyć do dopasowywania podobieństwa elementów |
metadataFilters[] |
Opcjonalnie. Filtry umożliwiające wybór typu |
maxChunksCount |
Opcjonalnie. Maksymalna liczba odpowiednich elementów |
minimumRelevanceScore |
Opcjonalnie. Minimalny wynik trafności dla pobranych odpowiednich elementów |
AnswerStyle
Wybierz styl, aby uzyskać uzasadnione odpowiedzi.
Wartości w polu enum | |
---|---|
ANSWER_STYLE_UNSPECIFIED |
Nieokreślony styl odpowiedzi. |
ABSTRACTIVE |
Zwięzły, ale abstrakcyjny. |
EXTRACTIVE |
Bardzo zwięzły i intuicyjny styl. |
VERBOSE |
Styl szczegółowy z dodatkowymi szczegółami. Odpowiedź może być sformatowana jako zdanie, akapit, wiele akapitów, punktor itp. |
InputFeedback
Opinia dotycząca danych wejściowych użytych do udzielenia odpowiedzi na pytanie, w odróżnieniu od odpowiedzi wygenerowanej przez model na to pytanie.
Zapis JSON |
---|
{ "safetyRatings": [ { object ( |
Pola | |
---|---|
safetyRatings[] |
Oceny bezpieczeństwa danych wejściowych. Każda kategoria może mieć maksymalnie jedną ocenę. |
blockReason |
Opcjonalnie. Jeśli jest ustawiony, dane wejściowe zostały zablokowane i nie są zwracane żadne kandydaci. Zmodyfikuj dane. |
BlockReason
Określa powód zablokowania danych wejściowych.
Wartości w polu enum | |
---|---|
BLOCK_REASON_UNSPECIFIED |
Wartość domyślna. Ta wartość nie jest używana. |
SAFETY |
Dane wejściowe zostały zablokowane ze względów bezpieczeństwa. Możesz sprawdzić safetyRatings , aby dowiedzieć się, która kategoria bezpieczeństwa go zablokowała. |
OTHER |
Dane wejściowe zostały zablokowane z innych powodów. |