- Zapis JSON
- Kandydat
- FinishReason
- SafetyRating
- HarmProbability
- CitationMetadata
- CitationSource
- PromptFeedback
- BlockReason
- UsageMetadata
Odpowiedź modelu obsługującego wielu kandydatów.
Uwaga dotycząca ocen bezpieczeństwa i filtrowania treści. Są zgłaszane zarówno w przypadku promptu w grupie GenerateContentResponse.prompt_feedback
, jak i każdego kandydata w grupie finishReason
i safetyRatings
. Umowa na korzystanie z interfejsu API określa, że: – zwróceni będą wszyscy kandydaci, albo żaden kandydat – żaden kandydat nie zostanie zwrócony tylko wtedy, gdy w prompcie coś poszło nie tak (patrz: promptFeedback
). Opinia na temat każdego kandydata jest zgłaszana finishReason
i safetyRatings
.
Zapis JSON |
---|
{ "candidates": [ { object ( |
Pola | |
---|---|
candidates[] |
Odpowiedzi kandydatów z modelu. |
promptFeedback |
Zwraca opinię dotyczącą promptu związaną z filtrami treści. |
usageMetadata |
Tylko dane wyjściowe. Metadane dotyczące wykorzystania tokena w żądaniach generowania. |
Kandydat
Propozycja odpowiedzi wygenerowana przez model.
Zapis JSON |
---|
{ "content": { object ( |
Pola | |
---|---|
content |
Tylko dane wyjściowe. Wygenerowana treść zwrócona przez model. |
finishReason |
Opcjonalnie. Tylko dane wyjściowe. Przyczyna, dla której model przestał generować tokeny. Jeśli wartość jest pusta, model nie przestał generować tokenów. |
safetyRatings[] |
Lista ocen bezpieczeństwa kandydata do odpowiedzi. Każda kategoria może mieć maksymalnie jedną ocenę. |
citationMetadata |
Tylko dane wyjściowe. Informacje dotyczące cytowania kandydata wygenerowanego przez model. To pole może zawierać informacje dotyczące recytacji dowolnego tekstu zawartego w polu |
tokenCount |
Tylko dane wyjściowe. Liczba tokenów dla kandydata. |
index |
Tylko dane wyjściowe. Indeks kandydata na liście kandydatów. |
FinishReason
Określa przyczynę, dla której model przestał generować tokeny.
Wartości w polu enum | |
---|---|
FINISH_REASON_UNSPECIFIED |
Wartość domyślna. Ta wartość nie jest używana. |
STOP |
Naturalny punkt zatrzymania modelu lub podana sekwencja zatrzymania. |
MAX_TOKENS |
Osiągnięto maksymalną liczbę tokenów określoną w żądaniu. |
SAFETY |
Proponowana treść została zgłoszona ze względów bezpieczeństwa. |
RECITATION |
Proponowane treści zostały zgłoszone z powodu recytacji. |
OTHER |
Przyczyna nieznana. |
SafetyRating
Ocena bezpieczeństwa fragmentu treści.
Ocena bezpieczeństwa zawiera kategorię wyrządzenia szkody oraz poziom prawdopodobieństwa wystąpienia szkody w przypadku danego fragmentu treści w tej kategorii. Treści są klasyfikowane pod kątem bezpieczeństwa według różnych kategorii szkód, a także prawdopodobieństwo zaistnienia szkody.
Zapis JSON |
---|
{ "category": enum ( |
Pola | |
---|---|
category |
Wymagane. Kategoria danej oceny. |
probability |
Wymagane. Prawdopodobieństwo szkody w przypadku danej treści. |
blocked |
Czy te treści zostały zablokowane ze względu na tę ocenę? |
HarmProbability
Prawdopodobieństwo, że fragment treści jest szkodliwy.
System klasyfikacji wskazuje prawdopodobieństwo, że treść jest niebezpieczna. Nie określa to wagi wyrządzenia krzywdy danej treści.
Wartości w polu enum | |
---|---|
HARM_PROBABILITY_UNSPECIFIED |
Prawdopodobieństwo jest nieokreślone. |
NEGLIGIBLE |
Treści z niewielkim prawdopodobieństwem mogą być niebezpieczne. |
LOW |
Treści rzadko są niebezpieczne. |
MEDIUM |
Treści mają średnie prawdopodobieństwo, że są niebezpieczne. |
HIGH |
Treści z dużym prawdopodobieństwem są niebezpieczne. |
CitationMetadata
Zbiór informacji o źródłach dotyczących konkretnego materiału.
Zapis JSON |
---|
{
"citationSources": [
{
object ( |
Pola | |
---|---|
citationSources[] |
Cytowanie konkretnych źródeł w przypadku konkretnej odpowiedzi. |
CitationSource
Cytowanie fragmentów konkretnej odpowiedzi,
Zapis JSON |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
Pola | |
---|---|
startIndex |
Opcjonalnie. Początek segmentu odpowiedzi przypisanej do tego źródła. Indeks wskazuje początek segmentu (wyrażony w bajtach). |
endIndex |
Opcjonalnie. Koniec przypisanego segmentu, wyłącznie. |
uri |
Opcjonalnie. Identyfikator URI przypisany jako źródło dla części tekstu. |
license |
Opcjonalnie. Licencja na projekt GitHuba przypisany jako źródło segmentu. Cytowanie kodu wymaga podania informacji o licencji. |
PromptFeedback
Zestaw metadanych opinii w prompcie określonym w polu GenerateContentRequest.content
.
Zapis JSON |
---|
{ "blockReason": enum ( |
Pola | |
---|---|
blockReason |
Opcjonalnie. Jeśli jest ustawiony, prompt został zablokowany i nie są zwracane żadne kandydaci. Przeformułuj prompt. |
safetyRatings[] |
Oceny pod kątem bezpieczeństwa promptu. Każda kategoria może mieć maksymalnie jedną ocenę. |
BlockReason
Określa powód zablokowania promptu.
Wartości w polu enum | |
---|---|
BLOCK_REASON_UNSPECIFIED |
Wartość domyślna. Ta wartość nie jest używana. |
SAFETY |
Prompt został zablokowany ze względów bezpieczeństwa. Możesz sprawdzić safetyRatings , aby dowiedzieć się, która kategoria bezpieczeństwa go zablokowała. |
OTHER |
Prompt został zablokowany z nieznanych powodów. |
UsageMetadata
Metadane dotyczące wykorzystania tokena w żądaniu wygenerowania.
Zapis JSON |
---|
{ "promptTokenCount": integer, "candidatesTokenCount": integer, "totalTokenCount": integer } |
Pola | |
---|---|
promptTokenCount |
Liczba tokenów w prompcie. |
candidatesTokenCount |
Łączna liczba tokenów u wygenerowanych kandydatów. |
totalTokenCount |
Łączna liczba tokenów dla żądania wygenerowania (komunikat + kandydaci). |