- 1.53.0 (latest)
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
Candidate(mapping=None, *, ignore_unknown_fields=False, **kwargs)A response candidate generated from the model.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
|---|---|
| Name | Description |
index |
int
Output only. Index of the candidate. |
content |
google.cloud.aiplatform_v1.types.Content
Output only. Content parts of the candidate. |
finish_reason |
google.cloud.aiplatform_v1.types.Candidate.FinishReason
Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. |
safety_ratings |
MutableSequence[google.cloud.aiplatform_v1.types.SafetyRating]
Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. |
finish_message |
str
Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when finish_reason is set.
This field is a member of oneof_ _finish_message.
|
citation_metadata |
google.cloud.aiplatform_v1.types.CitationMetadata
Output only. Source attribution of the generated content. |
Classes
FinishReason
FinishReason(value)The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
Values: FINISH_REASON_UNSPECIFIED (0): The finish reason is unspecified. STOP (1): Natural stop point of the model or provided stop sequence. MAX_TOKENS (2): The maximum number of tokens as specified in the request was reached. SAFETY (3): The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output. RECITATION (4): The token generation was stopped as the response was flagged for unauthorized citations. OTHER (5): All other reasons that stopped the token generation
Methods
Candidate
Candidate(mapping=None, *, ignore_unknown_fields=False, **kwargs)A response candidate generated from the model.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields