GenerateContentResponse

Odpowiedź modelu obsługującego wiele kandydatów.

Uwaga dotycząca ocen bezpieczeństwa i filtrowania treści. Są one zgłaszane w przypadku promptu w grupie GenerateContentResponse.prompt_feedback oraz dla każdego kandydata w grupie finishReason i w safetyRatings. Umowa dotycząca interfejsu API brzmi w ten sposób: – zwracający wszyscy żądane kandydaci lub żaden kandydat nie jest zwracany – żaden kandydat nie jest zwracany tylko wtedy, gdy w prompcie coś jest nie tak (patrz: promptFeedback). – Opinia na temat każdego kandydata jest przesyłana finishReason i safetyRatings.

Zapis JSON
{
  "candidates": [
    {
      object (Candidate)
    }
  ],
  "promptFeedback": {
    object (PromptFeedback)
  }
}
Pola
candidates[]

object (Candidate)

Odpowiedzi kandydatów z modelu.

promptFeedback

object (PromptFeedback)

Zwraca opinię dotyczącą promptu związane z filtrami treści.

Kandydat

Kandydat do odpowiedzi wygenerowany na podstawie modelu.

Zapis JSON
{
  "content": {
    object (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "index": integer
}
Pola
content

object (Content)

Tylko dane wyjściowe. Wygenerowana treść zwrócona przez model.

finishReason

enum (FinishReason)

Opcjonalnie. Tylko dane wyjściowe. Przyczyna, dla której model przestał generować tokeny.

Jeśli jest puste, model nie przestał generować tokenów.

safetyRatings[]

object (SafetyRating)

Lista ocen bezpieczeństwa kandydata do odpowiedzi.

Kategoria może mieć maksymalnie jedną ocenę.

citationMetadata

object (CitationMetadata)

Tylko dane wyjściowe. Informacje o cytatach dotyczące kandydata wygenerowanego przez model.

To pole może być wypełnione informacjami o recytacji dowolnego tekstu zawartego w content. Są to fragmenty „cytowane” z materiału chronionego prawem autorskim w danych treningowych podstawowego LLM.

tokenCount

integer

Tylko dane wyjściowe. Liczba tokenów dla tego kandydata.

index

integer

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 konieczności recytowania.
OTHER Przyczyna nieznana.

SafetyRating

Ocena bezpieczeństwa dotycząca treści.

Ocena bezpieczeństwa zawiera kategorię wyrządzenia szkody oraz poziom prawdopodobieństwa szkody, jaki należy do tej kategorii w przypadku danego materiału. Treści są klasyfikowane pod kątem bezpieczeństwa w różnych kategoriach szkód, a w tym miejscu znajduje się też prawdopodobieństwo zaistnienia szkody.

Zapis JSON
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "blocked": boolean
}
Pola
category

enum (HarmCategory)

To pole jest wymagane. Kategoria tej oceny.

probability

enum (HarmProbability)

To pole jest wymagane. Prawdopodobieństwo wyrządzenia szkody w przypadku tych treści.

blocked

boolean

Czy te treści zostały zablokowane ze względu na tę ocenę?

HarmProbability

Prawdopodobieństwo, że fragment treści jest szkodliwy.

System klasyfikacji podaje prawdopodobieństwo, że treść jest niebezpieczna. Nie określa to, jak poważne jest szkody, jakie miałyby miejsce w przypadku danego materiału.

Wartości w polu enum
HARM_PROBABILITY_UNSPECIFIED Prawdopodobieństwo jest nieokreślone.
NEGLIGIBLE Treści mają znikome szanse na niebezpieczeństwo.
LOW Treści rzadko są niebezpieczne.
MEDIUM Treści z średnim prawdopodobieństwem są niebezpieczne.
HIGH Treści z dużym prawdopodobieństwem są niebezpieczne.

CitationMetadata

Zbiór informacji o źródle danego materiału.

Zapis JSON
{
  "citationSources": [
    {
      object (CitationSource)
    }
  ]
}
Pola
citationSources[]

object (CitationSource)

cytowania konkretnych źródeł w przypadku konkretnej odpowiedzi;

CitationSource

Cytowanie źródła w przypadku fragmentu konkretnej odpowiedzi.

Zapis JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "license": string
}
Pola
startIndex

integer

Opcjonalnie. Początek segmentu odpowiedzi przypisanej do tego źródła.

Indeks wskazuje początek segmentu (mierzony w bajtach).

endIndex

integer

Opcjonalnie. Koniec przypisanego segmentu (bez uwzględniania).

uri

string

Opcjonalnie. Identyfikator URI przypisany jako źródło dla części tekstu.

license

string

Opcjonalnie. Licencja na projekt GitHub, który jest przypisany jako źródło segmentu.

Cytowanie kodu wymaga podania informacji o licencji.

PromptFeedback

Zestaw metadanych opinii podanych w prompcie określony w polu GenerateContentRequest.content.

Zapis JSON
{
  "blockReason": enum (BlockReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ]
}
Pola
blockReason

enum (BlockReason)

Opcjonalnie. Jeśli zasada jest skonfigurowana, prompt został zablokowany i żaden kandydaci nie są zwracane. Zmodyfikuj prompt.

safetyRatings[]

object (SafetyRating)

Oceny związane z bezpieczeństwem promptu. 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 przyczyn.