You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/aiplatform_v1.endpoints.html
+10Lines changed: 10 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -814,6 +814,10 @@ <h3>Method Details</h3>
814
814
"labels": { # 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.
815
815
"a_key": "A String",
816
816
},
817
+
"modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
818
+
"promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
819
+
"responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
820
+
},
817
821
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
"uri": "A String", # URI reference of the chunk.
1210
1214
},
1211
1215
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
1216
+
"documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
1212
1217
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
1213
1218
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
1214
1219
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
@@ -1574,6 +1579,10 @@ <h3>Method Details</h3>
1574
1579
"labels": { # 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.
1575
1580
"a_key": "A String",
1576
1581
},
1582
+
"modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
1583
+
"promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
1584
+
"responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
1585
+
},
1577
1586
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
"uri": "A String", # URI reference of the chunk.
1970
1979
},
1971
1980
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
1981
+
"documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
1972
1982
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
1973
1983
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
1974
1984
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
Copy file name to clipboardExpand all lines: docs/dyn/aiplatform_v1.projects.locations.endpoints.html
+10Lines changed: 10 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1761,6 +1761,10 @@ <h3>Method Details</h3>
1761
1761
"labels": { # 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.
1762
1762
"a_key": "A String",
1763
1763
},
1764
+
"modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
1765
+
"promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
1766
+
"responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
1767
+
},
1764
1768
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
"uri": "A String", # URI reference of the chunk.
2157
2161
},
2158
2162
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
2163
+
"documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
2159
2164
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
2160
2165
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
2161
2166
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
@@ -3998,6 +4003,10 @@ <h3>Method Details</h3>
3998
4003
"labels": { # 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.
3999
4004
"a_key": "A String",
4000
4005
},
4006
+
"modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
4007
+
"promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
4008
+
"responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
4009
+
},
4001
4010
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
"uri": "A String", # URI reference of the chunk.
4394
4403
},
4395
4404
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
4405
+
"documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
4396
4406
"ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
4397
4407
"pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
4398
4408
"firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
Copy file name to clipboardExpand all lines: docs/dyn/aiplatform_v1.projects.locations.html
+3-1Lines changed: 3 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -595,8 +595,10 @@ <h3>Method Details</h3>
595
595
},
596
596
},
597
597
"endpointConfig": { # The endpoint config to use for the deployment. # Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used.
598
-
"dedicatedEndpointEnabled": True or False, # Optional. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.
598
+
"dedicatedEndpointDisabled": True or False, # Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.
599
+
"dedicatedEndpointEnabled": True or False, # Optional. Deprecated. Use dedicated_endpoint_disabled instead. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.
599
600
"endpointDisplayName": "A String", # Optional. The user-specified display name of the endpoint. If not set, a default name will be used.
601
+
"endpointUserId": "A String", # Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.
600
602
},
601
603
"huggingFaceModelId": "A String", # The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`.
602
604
"modelConfig": { # The model config to use for the deployment. # Optional. The model config to use for the deployment. If not specified, the default model config will be used.
0 commit comments