[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eCandidate\u003c/code\u003e class in the Vertex AI v1beta1 API represents a response candidate generated by a model, and it is part of the \u003ccode\u003eGoogle.Cloud.AIPlatform.V1Beta1\u003c/code\u003e namespace within the \u003ccode\u003eGoogle.Cloud.AIPlatform.V1Beta1.dll\u003c/code\u003e assembly.\u003c/p\u003e\n"],["\u003cp\u003eThis class provides various properties such as \u003ccode\u003eAvgLogprobs\u003c/code\u003e, \u003ccode\u003eCitationMetadata\u003c/code\u003e, \u003ccode\u003eContent\u003c/code\u003e, \u003ccode\u003eFinishMessage\u003c/code\u003e, \u003ccode\u003eFinishReason\u003c/code\u003e, \u003ccode\u003eGroundingMetadata\u003c/code\u003e, \u003ccode\u003eIndex\u003c/code\u003e, \u003ccode\u003eLogprobsResult\u003c/code\u003e, and \u003ccode\u003eSafetyRatings\u003c/code\u003e to describe the candidate, where most are read-only outputs.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCandidate\u003c/code\u003e class implements several interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable<Candidate>\u003c/code\u003e, \u003ccode\u003eIDeepCloneable<Candidate>\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, for functionalities like deep cloning and protocol buffer messaging.\u003c/p\u003e\n"],["\u003cp\u003eConstructors are provided for creating new \u003ccode\u003eCandidate\u003c/code\u003e objects, either as an empty instance or by copying an existing \u003ccode\u003eCandidate\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCandidate\u003c/code\u003e class includes properties like \u003ccode\u003eHasFinishMessage\u003c/code\u003e to check if the "finish_message" field is populated, and \u003ccode\u003eSafetyRatings\u003c/code\u003e, which provides a list of safety ratings for a given response candidate.\u003c/p\u003e\n"]]],[],null,["# Vertex AI v1beta1 API - Class Candidate (1.0.0-beta47)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0-beta47 (latest)](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.Candidate)\n- [1.0.0-beta46](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/1.0.0-beta46/Google.Cloud.AIPlatform.V1Beta1.Candidate) \n\n public sealed class Candidate : IMessage\u003cCandidate\u003e, IEquatable\u003cCandidate\u003e, IDeepCloneable\u003cCandidate\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Vertex AI v1beta1 API class Candidate.\n\nA response candidate generated from the model. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e Candidate \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Candidate](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.Candidate), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Candidate](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.Candidate), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Candidate](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.Candidate), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.AIPlatform.V1Beta1](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1)\n\nAssembly\n--------\n\nGoogle.Cloud.AIPlatform.V1Beta1.dll\n\nConstructors\n------------\n\n### Candidate()\n\n public Candidate()\n\n### Candidate(Candidate)\n\n public Candidate(Candidate other)\n\nProperties\n----------\n\n### AvgLogprobs\n\n public double AvgLogprobs { get; set; }\n\nOutput only. Average log probability score of the candidate.\n\n### CitationMetadata\n\n public CitationMetadata CitationMetadata { get; set; }\n\nOutput only. Source attribution of the generated content.\n\n### Content\n\n public Content Content { get; set; }\n\nOutput only. Content parts of the candidate.\n\n### FinishMessage\n\n public string FinishMessage { get; set; }\n\nOutput only. Describes the reason the mode stopped generating tokens in\nmore detail. This is only filled when `finish_reason` is set.\n\n### FinishReason\n\n public Candidate.Types.FinishReason FinishReason { get; set; }\n\nOutput only. The reason why the model stopped generating tokens.\nIf empty, the model has not stopped generating the tokens.\n\n### GroundingMetadata\n\n public GroundingMetadata GroundingMetadata { get; set; }\n\nOutput only. Metadata specifies sources used to ground generated content.\n\n### HasFinishMessage\n\n public bool HasFinishMessage { get; }\n\nGets whether the \"finish_message\" field is set\n\n### Index\n\n public int Index { get; set; }\n\nOutput only. Index of the candidate.\n\n### LogprobsResult\n\n public LogprobsResult LogprobsResult { get; set; }\n\nOutput only. Log-likelihood scores for the response tokens and top tokens\n\n### SafetyRatings\n\n public RepeatedField\u003cSafetyRating\u003e SafetyRatings { get; }\n\nOutput only. List of ratings for the safety of a response candidate.\n\nThere is at most one rating per category.\n\n### UrlContextMetadata\n\n public UrlContextMetadata UrlContextMetadata { get; set; }\n\nOutput only. Metadata related to url context retrieval tool."]]
