Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class GenerateContentRequest.
Request message for [PredictionService.GenerateContent].
Generated from protobuf messagegoogle.cloud.aiplatform.v1.GenerateContentRequest
Namespace
Google \ Cloud \ AIPlatform \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ model
string
Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format:projects/{project}/locations/{location}/publishers/*/models/*Tuned model endpoint format:projects/{project}/locations/{location}/endpoints/{endpoint}
Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
↳ cached_content
string
Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format:projects/{project}/locations/{location}/cachedContents/{cachedContent}
Optional. A list ofToolsthe model may use to generate the next response. AToolis a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
Required. The fully qualified name of the publisher model or tuned model
endpoint to use.
Publisher model format:projects/{project}/locations/{location}/publishers/*/models/*Tuned model endpoint format:projects/{project}/locations/{location}/endpoints/{endpoint}
Returns
Type
Description
string
setModel
Required. The fully qualified name of the publisher model or tuned model
endpoint to use.
Publisher model format:projects/{project}/locations/{location}/publishers/*/models/*Tuned model endpoint format:projects/{project}/locations/{location}/endpoints/{endpoint}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getContents
Required. The content of the current conversation with the model.
For single-turn queries, this is a single instance. For multi-turn queries,
this is a repeated field that contains conversation history + latest
request.
Required. The content of the current conversation with the model.
For single-turn queries, this is a single instance. For multi-turn queries,
this is a repeated field that contains conversation history + latest
request.
Optional. The name of the cached content used as context to serve the
prediction. Note: only used in explicit caching, where users can have
control over caching (e.g. what content to cache) and enjoy guaranteed cost
savings. Format:projects/{project}/locations/{location}/cachedContents/{cachedContent}
Returns
Type
Description
string
setCachedContent
Optional. The name of the cached content used as context to serve the
prediction. Note: only used in explicit caching, where users can have
control over caching (e.g. what content to cache) and enjoy guaranteed cost
savings. Format:projects/{project}/locations/{location}/cachedContents/{cachedContent}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTools
Optional. A list ofToolsthe model may use to generate the next
response.
AToolis a piece of code that enables the system to interact with
external systems to perform an action, or set of actions, outside of
knowledge and scope of the model.
Optional. A list ofToolsthe model may use to generate the next
response.
AToolis a piece of code that enables the system to interact with
external systems to perform an action, or set of actions, outside of
knowledge and scope of the model.
Optional. The labels with user-defined metadata for the request. It is used
for billing and reporting only.
Label keys and values can be no longer than 63 characters
(Unicode codepoints) and can only contain lowercase letters, numeric
characters, underscores, and dashes. International characters are allowed.
Label values are optional. Label keys must start with a letter.
Optional. The labels with user-defined metadata for the request. It is used
for billing and reporting only.
Label keys and values can be no longer than 63 characters
(Unicode codepoints) and can only contain lowercase letters, numeric
characters, underscores, and dashes. International characters are allowed.
Label values are optional. Label keys must start with a letter.
Required. The content of the current conversation with the model.
For single-turn queries, this is a single instance. For multi-turn queries,
this is a repeated field that contains conversation history + latest
request.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class GenerateContentRequest (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.GenerateContentRequest)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.GenerateContentRequest)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.GenerateContentRequest)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.GenerateContentRequest)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.GenerateContentRequest)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.GenerateContentRequest)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.GenerateContentRequest)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.GenerateContentRequest)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.GenerateContentRequest)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.GenerateContentRequest)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.GenerateContentRequest)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.GenerateContentRequest)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.GenerateContentRequest)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.GenerateContentRequest)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.GenerateContentRequest)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.GenerateContentRequest)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.GenerateContentRequest)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.GenerateContentRequest)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.GenerateContentRequest)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.GenerateContentRequest)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.GenerateContentRequest)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.GenerateContentRequest)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.GenerateContentRequest)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.GenerateContentRequest)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.GenerateContentRequest)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.GenerateContentRequest)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.GenerateContentRequest)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.GenerateContentRequest)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.GenerateContentRequest)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.GenerateContentRequest)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.GenerateContentRequest)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.GenerateContentRequest)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.GenerateContentRequest)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.GenerateContentRequest)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.GenerateContentRequest)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.GenerateContentRequest)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.GenerateContentRequest)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.GenerateContentRequest)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.GenerateContentRequest)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.GenerateContentRequest)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.GenerateContentRequest)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.GenerateContentRequest)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.GenerateContentRequest)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.GenerateContentRequest)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.GenerateContentRequest)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.GenerateContentRequest)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.GenerateContentRequest)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.GenerateContentRequest)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.GenerateContentRequest)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.GenerateContentRequest)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.GenerateContentRequest)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.GenerateContentRequest)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.GenerateContentRequest)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.GenerateContentRequest)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.GenerateContentRequest)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.GenerateContentRequest) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class GenerateContentRequest.\n\nRequest message for \\[PredictionService.GenerateContent\\].\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.GenerateContentRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getModel\n\nRequired. The fully qualified name of the publisher model or tuned model\nendpoint to use.\n\nPublisher model format:\n`projects/{project}/locations/{location}/publishers/*/models/*`\nTuned model endpoint format:\n`projects/{project}/locations/{location}/endpoints/{endpoint}`\n\n### setModel\n\nRequired. The fully qualified name of the publisher model or tuned model\nendpoint to use.\n\nPublisher model format:\n`projects/{project}/locations/{location}/publishers/*/models/*`\nTuned model endpoint format:\n`projects/{project}/locations/{location}/endpoints/{endpoint}`\n\n### getContents\n\nRequired. The content of the current conversation with the model.\n\nFor single-turn queries, this is a single instance. For multi-turn queries,\nthis is a repeated field that contains conversation history + latest\nrequest.\n\n### setContents\n\nRequired. The content of the current conversation with the model.\n\nFor single-turn queries, this is a single instance. For multi-turn queries,\nthis is a repeated field that contains conversation history + latest\nrequest.\n\n### getSystemInstruction\n\nOptional. The user provided system instructions for the model.\n\nNote: only text should be used in parts and content in each part will be in\na separate paragraph.\n\n### hasSystemInstruction\n\n### clearSystemInstruction\n\n### setSystemInstruction\n\nOptional. The user provided system instructions for the model.\n\nNote: only text should be used in parts and content in each part will be in\na separate paragraph.\n\n### getCachedContent\n\nOptional. The name of the cached content used as context to serve the\nprediction. Note: only used in explicit caching, where users can have\ncontrol over caching (e.g. what content to cache) and enjoy guaranteed cost\nsavings. Format:\n`projects/{project}/locations/{location}/cachedContents/{cachedContent}`\n\n### setCachedContent\n\nOptional. The name of the cached content used as context to serve the\nprediction. Note: only used in explicit caching, where users can have\ncontrol over caching (e.g. what content to cache) and enjoy guaranteed cost\nsavings. Format:\n`projects/{project}/locations/{location}/cachedContents/{cachedContent}`\n\n### getTools\n\nOptional. A list of `Tools` the model may use to generate the next\nresponse.\n\nA `Tool` is a piece of code that enables the system to interact with\nexternal systems to perform an action, or set of actions, outside of\nknowledge and scope of the model.\n\n### setTools\n\nOptional. A list of `Tools` the model may use to generate the next\nresponse.\n\nA `Tool` is a piece of code that enables the system to interact with\nexternal systems to perform an action, or set of actions, outside of\nknowledge and scope of the model.\n\n### getToolConfig\n\nOptional. Tool config. This config is shared for all tools provided in the\nrequest.\n\n### hasToolConfig\n\n### clearToolConfig\n\n### setToolConfig\n\nOptional. Tool config. This config is shared for all tools provided in the\nrequest.\n\n### getLabels\n\nOptional. The labels with user-defined metadata for the request. It is used\nfor billing and reporting only.\n\nLabel keys and values can be no longer than 63 characters\n(Unicode codepoints) and can only contain lowercase letters, numeric\ncharacters, underscores, and dashes. International characters are allowed.\nLabel values are optional. Label keys must start with a letter.\n\n### setLabels\n\nOptional. The labels with user-defined metadata for the request. It is used\nfor billing and reporting only.\n\nLabel keys and values can be no longer than 63 characters\n(Unicode codepoints) and can only contain lowercase letters, numeric\ncharacters, underscores, and dashes. International characters are allowed.\nLabel values are optional. Label keys must start with a letter.\n\n### getSafetySettings\n\nOptional. Per request settings for blocking unsafe content.\n\nEnforced on GenerateContentResponse.candidates.\n\n### setSafetySettings\n\nOptional. Per request settings for blocking unsafe content.\n\nEnforced on GenerateContentResponse.candidates.\n\n### getModelArmorConfig\n\nOptional. Settings for prompt and response sanitization using the Model\nArmor service. If supplied, safety_settings must not be supplied.\n\n### hasModelArmorConfig\n\n### clearModelArmorConfig\n\n### setModelArmorConfig\n\nOptional. Settings for prompt and response sanitization using the Model\nArmor service. If supplied, safety_settings must not be supplied.\n\n### getGenerationConfig\n\nOptional. Generation config.\n\n### hasGenerationConfig\n\n### clearGenerationConfig\n\n### setGenerationConfig\n\nOptional. Generation config.\n\n### static::build"]]
