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.projects.locations.endpoints.html
+34-38Lines changed: 34 additions & 38 deletions
Original file line number
Diff line number
Diff line change
@@ -428,6 +428,12 @@ <h3>Method Details</h3>
428
428
"enabled": True or False, # If logging is enabled or not.
429
429
"samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1].
430
430
},
431
+
"privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.
432
+
"enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect.
433
+
"projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment.
434
+
"A String",
435
+
],
436
+
},
431
437
"trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.
432
438
"a_key": 42,
433
439
},
@@ -1098,7 +1104,7 @@ <h3>Method Details</h3>
1098
1104
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
1099
1105
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
1107
+
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
1185
-
"disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
1186
-
},
1187
1190
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
1188
1191
"disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
1189
1192
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
1257
1260
"finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
1258
1261
"groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
1259
-
"groundingAttributions": [ # Optional. List of grounding attributions.
1260
-
{ # Grounding attribution.
1261
-
"confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.
1262
-
"segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to.
1263
-
"endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
1264
-
"partIndex": 42, # Output only. The index of a Part object within its parent Content object.
1265
-
"startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
1266
-
},
1267
-
"web": { # Attribution from the web. # Optional. Attribution from the web.
1268
-
"title": "A String", # Output only. Title of the attribution.
1269
-
"uri": "A String", # Output only. URI reference of the attribution.
1270
-
},
1271
-
},
1272
-
],
1273
1262
"webSearchQueries": [ # Optional. Web search queries for the following-up web search.
1274
1263
"A String",
1275
1264
],
@@ -1493,6 +1482,12 @@ <h3>Method Details</h3>
1493
1482
"enabled": True or False, # If logging is enabled or not.
1494
1483
"samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1].
1495
1484
},
1485
+
"privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.
1486
+
"enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect.
1487
+
"projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment.
1488
+
"A String",
1489
+
],
1490
+
},
1496
1491
"trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.
1497
1492
"a_key": 42,
1498
1493
},
@@ -1691,6 +1686,12 @@ <h3>Method Details</h3>
1691
1686
"enabled": True or False, # If logging is enabled or not.
1692
1687
"samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1].
1693
1688
},
1689
+
"privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.
1690
+
"enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect.
1691
+
"projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment.
1692
+
"A String",
1693
+
],
1694
+
},
1694
1695
"trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.
1695
1696
"a_key": 42,
1696
1697
},
@@ -2082,6 +2083,12 @@ <h3>Method Details</h3>
2082
2083
"enabled": True or False, # If logging is enabled or not.
2083
2084
"samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1].
2084
2085
},
2086
+
"privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.
2087
+
"enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect.
2088
+
"projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment.
2089
+
"A String",
2090
+
],
2091
+
},
2085
2092
"trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.
2086
2093
"a_key": 42,
2087
2094
},
@@ -2267,6 +2274,12 @@ <h3>Method Details</h3>
2267
2274
"enabled": True or False, # If logging is enabled or not.
2268
2275
"samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1].
2269
2276
},
2277
+
"privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.
2278
+
"enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect.
2279
+
"projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment.
2280
+
"A String",
2281
+
],
2282
+
},
2270
2283
"trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.
2271
2284
"a_key": 42,
2272
2285
},
@@ -2587,7 +2600,7 @@ <h3>Method Details</h3>
2587
2600
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
2588
2601
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
2603
+
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
2674
-
"disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
2675
-
},
2676
2686
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
2677
2687
"disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
2678
2688
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
2746
2756
"finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
2747
2757
"groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
2748
-
"groundingAttributions": [ # Optional. List of grounding attributions.
2749
-
{ # Grounding attribution.
2750
-
"confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.
2751
-
"segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to.
2752
-
"endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
2753
-
"partIndex": 42, # Output only. The index of a Part object within its parent Content object.
2754
-
"startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
2755
-
},
2756
-
"web": { # Attribution from the web. # Optional. Attribution from the web.
2757
-
"title": "A String", # Output only. Title of the attribution.
2758
-
"uri": "A String", # Output only. URI reference of the attribution.
2759
-
},
2760
-
},
2761
-
],
2762
2758
"webSearchQueries": [ # Optional. Web search queries for the following-up web search.
0 commit comments