google-cloud-ai_platform-v1 1.19.0 → 1.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +4 -4
- data/README.md +4 -4
- data/lib/google/cloud/ai_platform/v1/bindings_override.rb +3 -30
- data/lib/google/cloud/ai_platform/v1/data_foundry_service/client.rb +500 -0
- data/lib/google/cloud/ai_platform/v1/data_foundry_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/data_foundry_service/paths.rb +50 -0
- data/lib/google/cloud/ai_platform/v1/data_foundry_service/rest/client.rb +476 -0
- data/lib/google/cloud/ai_platform/v1/data_foundry_service/rest/service_stub.rb +143 -0
- data/lib/google/cloud/ai_platform/v1/data_foundry_service/rest.rb +53 -0
- data/lib/google/cloud/ai_platform/v1/data_foundry_service.rb +55 -0
- data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +5 -3
- data/lib/google/cloud/ai_platform/v1/endpoint_service/rest/client.rb +5 -3
- data/lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb +87 -0
- data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +0 -1
- data/lib/google/cloud/ai_platform/v1/featurestore_service/rest/client.rb +0 -1
- data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb +8 -2
- data/lib/google/cloud/ai_platform/v1/prediction_service/paths.rb +19 -0
- data/lib/google/cloud/ai_platform/v1/prediction_service/rest/client.rb +8 -2
- data/lib/google/cloud/ai_platform/v1/reasoning_engine_service/paths.rb +19 -0
- data/lib/google/cloud/ai_platform/v1/rest.rb +2 -1
- data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
- data/lib/google/cloud/ai_platform/v1.rb +3 -2
- data/lib/google/cloud/aiplatform/v1/accelerator_type_pb.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/content_pb.rb +4 -1
- data/lib/google/cloud/aiplatform/v1/data_foundry_service_pb.rb +55 -0
- data/lib/google/cloud/aiplatform/v1/data_foundry_service_services_pb.rb +45 -0
- data/lib/google/cloud/aiplatform/v1/deployment_stage_pb.rb +42 -0
- data/lib/google/cloud/aiplatform/v1/endpoint_service_pb.rb +2 -1
- data/lib/google/cloud/aiplatform/v1/endpoint_service_services_pb.rb +3 -3
- data/lib/google/cloud/aiplatform/v1/feature_online_store_service_pb.rb +10 -1
- data/lib/google/cloud/aiplatform/v1/feature_online_store_service_services_pb.rb +4 -0
- data/lib/google/cloud/aiplatform/v1/index_endpoint_pb.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/index_pb.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/model_garden_service_pb.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/prediction_service_pb.rb +1 -1
- data/lib/google/cloud/aiplatform/v1/reasoning_engine_pb.rb +5 -1
- data/lib/google/cloud/aiplatform/v1/tool_pb.rb +2 -1
- data/proto_docs/google/cloud/aiplatform/v1/accelerator_type.rb +3 -0
- data/proto_docs/google/cloud/aiplatform/v1/content.rb +59 -13
- data/proto_docs/google/cloud/aiplatform/v1/data_foundry_service.rb +127 -0
- data/proto_docs/google/cloud/aiplatform/v1/deployment_stage.rb +56 -0
- data/proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb +9 -0
- data/proto_docs/google/cloud/aiplatform/v1/feature_online_store_service.rb +81 -0
- data/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb +5 -3
- data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +0 -1
- data/proto_docs/google/cloud/aiplatform/v1/index.rb +3 -0
- data/proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb +12 -0
- data/proto_docs/google/cloud/aiplatform/v1/model_garden_service.rb +46 -5
- data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb +7 -0
- data/proto_docs/google/cloud/aiplatform/v1/reasoning_engine.rb +46 -1
- data/proto_docs/google/cloud/aiplatform/v1/tool.rb +19 -0
- metadata +15 -3
@@ -52,24 +52,24 @@ module Google
|
|
52
52
|
# @return [::String]
|
53
53
|
# Optional. Text part (can be code).
|
54
54
|
#
|
55
|
-
# Note: The following fields are mutually exclusive: `text`, `inline_data`, `file_data`, `function_call`, `function_response`, `executable_code`, `code_execution_result
|
55
|
+
# Note: The following fields are mutually exclusive: `text`, `inline_data`, `file_data`, `function_call`, `function_response`, `executable_code`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
56
56
|
# @!attribute [rw] inline_data
|
57
57
|
# @return [::Google::Cloud::AIPlatform::V1::Blob]
|
58
58
|
# Optional. Inlined bytes data.
|
59
59
|
#
|
60
|
-
# Note: The following fields are mutually exclusive: `inline_data`, `text`, `file_data`, `function_call`, `function_response`, `executable_code`, `code_execution_result
|
60
|
+
# Note: The following fields are mutually exclusive: `inline_data`, `text`, `file_data`, `function_call`, `function_response`, `executable_code`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
61
61
|
# @!attribute [rw] file_data
|
62
62
|
# @return [::Google::Cloud::AIPlatform::V1::FileData]
|
63
63
|
# Optional. URI based data.
|
64
64
|
#
|
65
|
-
# Note: The following fields are mutually exclusive: `file_data`, `text`, `inline_data`, `function_call`, `function_response`, `executable_code`, `code_execution_result
|
65
|
+
# Note: The following fields are mutually exclusive: `file_data`, `text`, `inline_data`, `function_call`, `function_response`, `executable_code`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
66
66
|
# @!attribute [rw] function_call
|
67
67
|
# @return [::Google::Cloud::AIPlatform::V1::FunctionCall]
|
68
68
|
# Optional. A predicted [FunctionCall] returned from the model that
|
69
69
|
# contains a string representing the [FunctionDeclaration.name] with the
|
70
70
|
# parameters and their values.
|
71
71
|
#
|
72
|
-
# Note: The following fields are mutually exclusive: `function_call`, `text`, `inline_data`, `file_data`, `function_response`, `executable_code`, `code_execution_result
|
72
|
+
# Note: The following fields are mutually exclusive: `function_call`, `text`, `inline_data`, `file_data`, `function_response`, `executable_code`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
73
73
|
# @!attribute [rw] function_response
|
74
74
|
# @return [::Google::Cloud::AIPlatform::V1::FunctionResponse]
|
75
75
|
# Optional. The result output of a [FunctionCall] that contains a string
|
@@ -77,28 +77,24 @@ module Google
|
|
77
77
|
# containing any output from the function call. It is used as context to
|
78
78
|
# the model.
|
79
79
|
#
|
80
|
-
# Note: The following fields are mutually exclusive: `function_response`, `text`, `inline_data`, `file_data`, `function_call`, `executable_code`, `code_execution_result
|
80
|
+
# Note: The following fields are mutually exclusive: `function_response`, `text`, `inline_data`, `file_data`, `function_call`, `executable_code`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
81
81
|
# @!attribute [rw] executable_code
|
82
82
|
# @return [::Google::Cloud::AIPlatform::V1::ExecutableCode]
|
83
83
|
# Optional. Code generated by the model that is meant to be executed.
|
84
84
|
#
|
85
|
-
# Note: The following fields are mutually exclusive: `executable_code`, `text`, `inline_data`, `file_data`, `function_call`, `function_response`, `code_execution_result
|
85
|
+
# Note: The following fields are mutually exclusive: `executable_code`, `text`, `inline_data`, `file_data`, `function_call`, `function_response`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
86
86
|
# @!attribute [rw] code_execution_result
|
87
87
|
# @return [::Google::Cloud::AIPlatform::V1::CodeExecutionResult]
|
88
88
|
# Optional. Result of executing the [ExecutableCode].
|
89
89
|
#
|
90
|
-
# Note: The following fields are mutually exclusive: `code_execution_result`, `text`, `inline_data`, `file_data`, `function_call`, `function_response`, `executable_code
|
90
|
+
# Note: The following fields are mutually exclusive: `code_execution_result`, `text`, `inline_data`, `file_data`, `function_call`, `function_response`, `executable_code`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
91
91
|
# @!attribute [rw] thought
|
92
92
|
# @return [::Boolean]
|
93
93
|
# Indicates if the part is thought from the model.
|
94
|
-
#
|
95
|
-
# Note: The following fields are mutually exclusive: `thought`, `text`, `inline_data`, `file_data`, `function_call`, `function_response`, `executable_code`, `code_execution_result`, `thought_signature`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
96
94
|
# @!attribute [rw] thought_signature
|
97
95
|
# @return [::String]
|
98
96
|
# An opaque signature for the thought so it can be reused in subsequent
|
99
97
|
# requests.
|
100
|
-
#
|
101
|
-
# Note: The following fields are mutually exclusive: `thought_signature`, `text`, `inline_data`, `file_data`, `function_call`, `function_response`, `executable_code`, `code_execution_result`, `thought`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
102
98
|
# @!attribute [rw] video_metadata
|
103
99
|
# @return [::Google::Cloud::AIPlatform::V1::VideoMetadata]
|
104
100
|
# Optional. Video metadata. The metadata should only be specified while the
|
@@ -539,6 +535,9 @@ module Google
|
|
539
535
|
|
540
536
|
# The function call generated by the model is invalid.
|
541
537
|
MALFORMED_FUNCTION_CALL = 9
|
538
|
+
|
539
|
+
# The model response was blocked by Model Armor.
|
540
|
+
MODEL_ARMOR = 10
|
542
541
|
end
|
543
542
|
end
|
544
543
|
|
@@ -637,12 +636,17 @@ module Google
|
|
637
636
|
# @return [::Google::Cloud::AIPlatform::V1::GroundingChunk::Web]
|
638
637
|
# Grounding chunk from the web.
|
639
638
|
#
|
640
|
-
# Note: The following fields are mutually exclusive: `web`, `retrieved_context`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
639
|
+
# Note: The following fields are mutually exclusive: `web`, `retrieved_context`, `maps`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
641
640
|
# @!attribute [rw] retrieved_context
|
642
641
|
# @return [::Google::Cloud::AIPlatform::V1::GroundingChunk::RetrievedContext]
|
643
642
|
# Grounding chunk from context retrieved by the retrieval tools.
|
644
643
|
#
|
645
|
-
# Note: The following fields are mutually exclusive: `retrieved_context`, `web`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
644
|
+
# Note: The following fields are mutually exclusive: `retrieved_context`, `web`, `maps`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
645
|
+
# @!attribute [rw] maps
|
646
|
+
# @return [::Google::Cloud::AIPlatform::V1::GroundingChunk::Maps]
|
647
|
+
# Grounding chunk from Google Maps.
|
648
|
+
#
|
649
|
+
# Note: The following fields are mutually exclusive: `maps`, `web`, `retrieved_context`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
646
650
|
class GroundingChunk
|
647
651
|
include ::Google::Protobuf::MessageExts
|
648
652
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -673,10 +677,33 @@ module Google
|
|
673
677
|
# @!attribute [rw] text
|
674
678
|
# @return [::String]
|
675
679
|
# Text of the attribution.
|
680
|
+
# @!attribute [r] document_name
|
681
|
+
# @return [::String]
|
682
|
+
# Output only. The full document name for the referenced Vertex AI Search
|
683
|
+
# document.
|
676
684
|
class RetrievedContext
|
677
685
|
include ::Google::Protobuf::MessageExts
|
678
686
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
679
687
|
end
|
688
|
+
|
689
|
+
# Chunk from Google Maps.
|
690
|
+
# @!attribute [rw] uri
|
691
|
+
# @return [::String]
|
692
|
+
# URI reference of the chunk.
|
693
|
+
# @!attribute [rw] title
|
694
|
+
# @return [::String]
|
695
|
+
# Title of the chunk.
|
696
|
+
# @!attribute [rw] text
|
697
|
+
# @return [::String]
|
698
|
+
# Text of the chunk.
|
699
|
+
# @!attribute [rw] place_id
|
700
|
+
# @return [::String]
|
701
|
+
# This Place's resource name, in `places/{place_id}` format. Can be used
|
702
|
+
# to look up the Place.
|
703
|
+
class Maps
|
704
|
+
include ::Google::Protobuf::MessageExts
|
705
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
706
|
+
end
|
680
707
|
end
|
681
708
|
|
682
709
|
# Grounding support.
|
@@ -715,6 +742,11 @@ module Google
|
|
715
742
|
# @!attribute [r] retrieval_metadata
|
716
743
|
# @return [::Google::Cloud::AIPlatform::V1::RetrievalMetadata]
|
717
744
|
# Optional. Output only. Retrieval metadata.
|
745
|
+
# @!attribute [r] google_maps_widget_context_token
|
746
|
+
# @return [::String]
|
747
|
+
# Optional. Output only. Resource name of the Google Maps widget context
|
748
|
+
# token to be used with the PlacesContextElement widget to render contextual
|
749
|
+
# data. This is populated only for Google Maps grounding.
|
718
750
|
class GroundingMetadata
|
719
751
|
include ::Google::Protobuf::MessageExts
|
720
752
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -747,6 +779,20 @@ module Google
|
|
747
779
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
748
780
|
end
|
749
781
|
|
782
|
+
# Configuration for Model Armor integrations of prompt and responses.
|
783
|
+
# @!attribute [rw] prompt_template_name
|
784
|
+
# @return [::String]
|
785
|
+
# Optional. The name of the Model Armor template to use for prompt
|
786
|
+
# sanitization.
|
787
|
+
# @!attribute [rw] response_template_name
|
788
|
+
# @return [::String]
|
789
|
+
# Optional. The name of the Model Armor template to use for response
|
790
|
+
# sanitization.
|
791
|
+
class ModelArmorConfig
|
792
|
+
include ::Google::Protobuf::MessageExts
|
793
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
794
|
+
end
|
795
|
+
|
750
796
|
# Represents token counting info for a single modality.
|
751
797
|
# @!attribute [rw] modality
|
752
798
|
# @return [::Google::Cloud::AIPlatform::V1::Modality]
|
@@ -0,0 +1,127 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module AIPlatform
|
23
|
+
module V1
|
24
|
+
# Request message for DataFoundryService.GenerateSyntheticData.
|
25
|
+
# @!attribute [rw] task_description
|
26
|
+
# @return [::Google::Cloud::AIPlatform::V1::TaskDescriptionStrategy]
|
27
|
+
# Generate data from a high-level task description.
|
28
|
+
# @!attribute [rw] location
|
29
|
+
# @return [::String]
|
30
|
+
# Required. The resource name of the Location to run the job.
|
31
|
+
# Format: `projects/{project}/locations/{location}`
|
32
|
+
# @!attribute [rw] count
|
33
|
+
# @return [::Integer]
|
34
|
+
# Required. The number of synthetic examples to generate.
|
35
|
+
# For this stateless API, the count is limited to a small number.
|
36
|
+
# @!attribute [rw] output_field_specs
|
37
|
+
# @return [::Array<::Google::Cloud::AIPlatform::V1::OutputFieldSpec>]
|
38
|
+
# Required. The schema of the desired output, defined by a list of fields.
|
39
|
+
# @!attribute [rw] examples
|
40
|
+
# @return [::Array<::Google::Cloud::AIPlatform::V1::SyntheticExample>]
|
41
|
+
# Optional. A list of few-shot examples to guide the model's output style
|
42
|
+
# and format.
|
43
|
+
class GenerateSyntheticDataRequest
|
44
|
+
include ::Google::Protobuf::MessageExts
|
45
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
46
|
+
end
|
47
|
+
|
48
|
+
# Represents a single named field within a SyntheticExample.
|
49
|
+
# @!attribute [rw] field_name
|
50
|
+
# @return [::String]
|
51
|
+
# Optional. The name of the field.
|
52
|
+
# @!attribute [rw] content
|
53
|
+
# @return [::Google::Cloud::AIPlatform::V1::Content]
|
54
|
+
# Required. The content of the field.
|
55
|
+
class SyntheticField
|
56
|
+
include ::Google::Protobuf::MessageExts
|
57
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
58
|
+
end
|
59
|
+
|
60
|
+
# Represents a single synthetic example, composed of multiple fields.
|
61
|
+
# Used for providing few-shot examples in the request and for returning
|
62
|
+
# generated examples in the response.
|
63
|
+
# @!attribute [rw] fields
|
64
|
+
# @return [::Array<::Google::Cloud::AIPlatform::V1::SyntheticField>]
|
65
|
+
# Required. A list of fields that constitute an example.
|
66
|
+
class SyntheticExample
|
67
|
+
include ::Google::Protobuf::MessageExts
|
68
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
69
|
+
end
|
70
|
+
|
71
|
+
# Defines a specification for a single output field.
|
72
|
+
# @!attribute [rw] field_name
|
73
|
+
# @return [::String]
|
74
|
+
# Required. The name of the output field.
|
75
|
+
# @!attribute [rw] guidance
|
76
|
+
# @return [::String]
|
77
|
+
# Optional. Optional, but recommended. Additional guidance specific to this
|
78
|
+
# field to provide targeted instructions for the LLM to generate the content
|
79
|
+
# of a single output field. While the LLM can sometimes infer content from
|
80
|
+
# the field name, providing explicit guidance is preferred.
|
81
|
+
# @!attribute [rw] field_type
|
82
|
+
# @return [::Google::Cloud::AIPlatform::V1::OutputFieldSpec::FieldType]
|
83
|
+
# Optional. The data type of the field. Defaults to CONTENT if not set.
|
84
|
+
class OutputFieldSpec
|
85
|
+
include ::Google::Protobuf::MessageExts
|
86
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
87
|
+
|
88
|
+
# The data type of the field.
|
89
|
+
module FieldType
|
90
|
+
# Field type is unspecified.
|
91
|
+
FIELD_TYPE_UNSPECIFIED = 0
|
92
|
+
|
93
|
+
# Arbitrary content field type.
|
94
|
+
CONTENT = 1
|
95
|
+
|
96
|
+
# Text field type.
|
97
|
+
TEXT = 2
|
98
|
+
|
99
|
+
# Image field type.
|
100
|
+
IMAGE = 3
|
101
|
+
|
102
|
+
# Audio field type.
|
103
|
+
AUDIO = 4
|
104
|
+
end
|
105
|
+
end
|
106
|
+
|
107
|
+
# Defines a generation strategy based on a high-level task description.
|
108
|
+
# @!attribute [rw] task_description
|
109
|
+
# @return [::String]
|
110
|
+
# Required. A high-level description of the synthetic data to be generated.
|
111
|
+
class TaskDescriptionStrategy
|
112
|
+
include ::Google::Protobuf::MessageExts
|
113
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
114
|
+
end
|
115
|
+
|
116
|
+
# The response containing the generated data.
|
117
|
+
# @!attribute [rw] synthetic_examples
|
118
|
+
# @return [::Array<::Google::Cloud::AIPlatform::V1::SyntheticExample>]
|
119
|
+
# A list of generated synthetic examples.
|
120
|
+
class GenerateSyntheticDataResponse
|
121
|
+
include ::Google::Protobuf::MessageExts
|
122
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
123
|
+
end
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
127
|
+
end
|
@@ -0,0 +1,56 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module AIPlatform
|
23
|
+
module V1
|
24
|
+
# Stage field indicating the current progress of a deployment.
|
25
|
+
module DeploymentStage
|
26
|
+
# Default value. This value is unused.
|
27
|
+
DEPLOYMENT_STAGE_UNSPECIFIED = 0
|
28
|
+
|
29
|
+
# The deployment is initializing and setting up the environment.
|
30
|
+
STARTING_DEPLOYMENT = 5
|
31
|
+
|
32
|
+
# The deployment is preparing the model assets.
|
33
|
+
PREPARING_MODEL = 6
|
34
|
+
|
35
|
+
# The deployment is creating the underlying serving cluster.
|
36
|
+
CREATING_SERVING_CLUSTER = 7
|
37
|
+
|
38
|
+
# The deployment is adding nodes to the serving cluster.
|
39
|
+
ADDING_NODES_TO_CLUSTER = 8
|
40
|
+
|
41
|
+
# The deployment is getting the container image for the model server.
|
42
|
+
GETTING_CONTAINER_IMAGE = 9
|
43
|
+
|
44
|
+
# The deployment is starting the model server.
|
45
|
+
STARTING_MODEL_SERVER = 3
|
46
|
+
|
47
|
+
# The deployment is performing finalization steps.
|
48
|
+
FINISHING_UP = 4
|
49
|
+
|
50
|
+
# The deployment has terminated.
|
51
|
+
DEPLOYMENT_TERMINATED = 10
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
@@ -56,6 +56,10 @@ module Google
|
|
56
56
|
# @!attribute [rw] generic_metadata
|
57
57
|
# @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
|
58
58
|
# The operation generic information.
|
59
|
+
# @!attribute [r] deployment_stage
|
60
|
+
# @return [::Google::Cloud::AIPlatform::V1::DeploymentStage]
|
61
|
+
# Output only. The deployment stage of the model. Only populated if this
|
62
|
+
# CreateEndpoint request deploys a model at the same time.
|
59
63
|
class CreateEndpointOperationMetadata
|
60
64
|
include ::Google::Protobuf::MessageExts
|
61
65
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -252,6 +256,9 @@ module Google
|
|
252
256
|
# @!attribute [rw] generic_metadata
|
253
257
|
# @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
|
254
258
|
# The operation generic information.
|
259
|
+
# @!attribute [r] deployment_stage
|
260
|
+
# @return [::Google::Cloud::AIPlatform::V1::DeploymentStage]
|
261
|
+
# Output only. The deployment stage of the model.
|
255
262
|
class DeployModelOperationMetadata
|
256
263
|
include ::Google::Protobuf::MessageExts
|
257
264
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -325,6 +332,8 @@ module Google
|
|
325
332
|
# * `max_replica_count` in either
|
326
333
|
# {::Google::Cloud::AIPlatform::V1::DedicatedResources DedicatedResources} or
|
327
334
|
# {::Google::Cloud::AIPlatform::V1::AutomaticResources AutomaticResources}
|
335
|
+
# * `required_replica_count` in
|
336
|
+
# {::Google::Cloud::AIPlatform::V1::DedicatedResources DedicatedResources}
|
328
337
|
# * {::Google::Cloud::AIPlatform::V1::DedicatedResources#autoscaling_metric_specs autoscaling_metric_specs}
|
329
338
|
# * `disable_container_logging` (v1 only)
|
330
339
|
# * `enable_container_logging` (v1beta1 only)
|
@@ -315,6 +315,87 @@ module Google
|
|
315
315
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
316
316
|
end
|
317
317
|
|
318
|
+
# Request message for
|
319
|
+
# {::Google::Cloud::AIPlatform::V1::FeatureOnlineStoreService::Client#feature_view_direct_write FeatureOnlineStoreService.FeatureViewDirectWrite}.
|
320
|
+
# @!attribute [rw] feature_view
|
321
|
+
# @return [::String]
|
322
|
+
# FeatureView resource format
|
323
|
+
# `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`
|
324
|
+
# @!attribute [rw] data_key_and_feature_values
|
325
|
+
# @return [::Array<::Google::Cloud::AIPlatform::V1::FeatureViewDirectWriteRequest::DataKeyAndFeatureValues>]
|
326
|
+
# Required. The data keys and associated feature values.
|
327
|
+
class FeatureViewDirectWriteRequest
|
328
|
+
include ::Google::Protobuf::MessageExts
|
329
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
330
|
+
|
331
|
+
# A data key and associated feature values to write to the feature view.
|
332
|
+
# @!attribute [rw] data_key
|
333
|
+
# @return [::Google::Cloud::AIPlatform::V1::FeatureViewDataKey]
|
334
|
+
# The data key.
|
335
|
+
# @!attribute [rw] features
|
336
|
+
# @return [::Array<::Google::Cloud::AIPlatform::V1::FeatureViewDirectWriteRequest::DataKeyAndFeatureValues::Feature>]
|
337
|
+
# List of features to write.
|
338
|
+
class DataKeyAndFeatureValues
|
339
|
+
include ::Google::Protobuf::MessageExts
|
340
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
341
|
+
|
342
|
+
# Feature name & value pair.
|
343
|
+
# @!attribute [rw] value
|
344
|
+
# @return [::Google::Cloud::AIPlatform::V1::FeatureValue]
|
345
|
+
# Feature value. A user provided timestamp may be set in the
|
346
|
+
# `FeatureValue.metadata.generate_time` field.
|
347
|
+
# @!attribute [rw] name
|
348
|
+
# @return [::String]
|
349
|
+
# Feature short name.
|
350
|
+
class Feature
|
351
|
+
include ::Google::Protobuf::MessageExts
|
352
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
353
|
+
end
|
354
|
+
end
|
355
|
+
end
|
356
|
+
|
357
|
+
# Response message for
|
358
|
+
# {::Google::Cloud::AIPlatform::V1::FeatureOnlineStoreService::Client#feature_view_direct_write FeatureOnlineStoreService.FeatureViewDirectWrite}.
|
359
|
+
# @!attribute [rw] status
|
360
|
+
# @return [::Google::Rpc::Status]
|
361
|
+
# Response status for the keys listed in
|
362
|
+
# {::Google::Cloud::AIPlatform::V1::FeatureViewDirectWriteResponse#write_responses FeatureViewDirectWriteResponse.write_responses}.
|
363
|
+
#
|
364
|
+
# The error only applies to the
|
365
|
+
# listed data keys - the stream will remain open for further
|
366
|
+
# [FeatureOnlineStoreService.FeatureViewDirectWriteRequest][] requests.
|
367
|
+
#
|
368
|
+
# Partial failures (e.g. if the first 10 keys of a request fail, but the
|
369
|
+
# rest succeed) from a single request may result in multiple responses -
|
370
|
+
# there will be one response for the successful request keys and one response
|
371
|
+
# for the failing request keys.
|
372
|
+
# @!attribute [rw] write_responses
|
373
|
+
# @return [::Array<::Google::Cloud::AIPlatform::V1::FeatureViewDirectWriteResponse::WriteResponse>]
|
374
|
+
# Details about write for each key. If status is not OK,
|
375
|
+
# {::Google::Cloud::AIPlatform::V1::FeatureViewDirectWriteResponse::WriteResponse#data_key WriteResponse.data_key}
|
376
|
+
# will have the key with error, but
|
377
|
+
# {::Google::Cloud::AIPlatform::V1::FeatureViewDirectWriteResponse::WriteResponse#online_store_write_time WriteResponse.online_store_write_time}
|
378
|
+
# will not be present.
|
379
|
+
class FeatureViewDirectWriteResponse
|
380
|
+
include ::Google::Protobuf::MessageExts
|
381
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
382
|
+
|
383
|
+
# Details about the write for each key.
|
384
|
+
# @!attribute [rw] data_key
|
385
|
+
# @return [::Google::Cloud::AIPlatform::V1::FeatureViewDataKey]
|
386
|
+
# What key is this write response associated with.
|
387
|
+
# @!attribute [rw] online_store_write_time
|
388
|
+
# @return [::Google::Protobuf::Timestamp]
|
389
|
+
# When the feature values were written to the online store.
|
390
|
+
# If
|
391
|
+
# {::Google::Cloud::AIPlatform::V1::FeatureViewDirectWriteResponse#status FeatureViewDirectWriteResponse.status}
|
392
|
+
# is not OK, this field is not populated.
|
393
|
+
class WriteResponse
|
394
|
+
include ::Google::Protobuf::MessageExts
|
395
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
396
|
+
end
|
397
|
+
end
|
398
|
+
|
318
399
|
# Format of the data in the Feature View.
|
319
400
|
module FeatureViewDataFormat
|
320
401
|
# Not set. Will be treated as the KeyValue format.
|
@@ -261,9 +261,11 @@ module Google
|
|
261
261
|
# Feature generation timestamp. Typically, it is provided by user at
|
262
262
|
# feature ingestion time. If not, feature store
|
263
263
|
# will use the system timestamp when the data is ingested into feature
|
264
|
-
# store.
|
265
|
-
#
|
266
|
-
#
|
264
|
+
# store.
|
265
|
+
#
|
266
|
+
# Legacy Feature Store: For streaming ingestion, the time, aligned by days,
|
267
|
+
# must be no older than five years (1825 days) and no later than one year
|
268
|
+
# (366 days) in the future.
|
267
269
|
class Metadata
|
268
270
|
include ::Google::Protobuf::MessageExts
|
269
271
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -880,7 +880,6 @@ module Google
|
|
880
880
|
# containing the substring `foo` and description containing the substring
|
881
881
|
# `bar`.
|
882
882
|
#
|
883
|
-
#
|
884
883
|
# Besides field queries, the following exact-match filters are
|
885
884
|
# supported. The exact-match filters do not support wildcards. Unlike
|
886
885
|
# field-restricted queries, exact-match filters are case-sensitive.
|
@@ -152,6 +152,9 @@ module Google
|
|
152
152
|
# @return [::Google::Cloud::AIPlatform::V1::IndexDatapoint::CrowdingTag]
|
153
153
|
# Optional. CrowdingTag of the datapoint, the number of neighbors to return
|
154
154
|
# in each crowding can be configured during query.
|
155
|
+
# @!attribute [rw] embedding_metadata
|
156
|
+
# @return [::Google::Protobuf::Struct]
|
157
|
+
# Optional. The key-value map of additional metadata for the datapoint.
|
155
158
|
class IndexDatapoint
|
156
159
|
include ::Google::Protobuf::MessageExts
|
157
160
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -208,6 +208,18 @@ module Google
|
|
208
208
|
# Note that logs may incur a cost, especially if the deployed
|
209
209
|
# index receives a high queries per second rate (QPS).
|
210
210
|
# Estimate your costs before enabling this option.
|
211
|
+
# @!attribute [rw] enable_datapoint_upsert_logging
|
212
|
+
# @return [::Boolean]
|
213
|
+
# Optional. If true, logs to Cloud Logging errors relating to datapoint
|
214
|
+
# upserts.
|
215
|
+
#
|
216
|
+
# Under normal operation conditions, these log entries should be very rare.
|
217
|
+
# However, if incompatible datapoint updates are being uploaded to an index,
|
218
|
+
# a high volume of log entries may be generated in a short period of time.
|
219
|
+
#
|
220
|
+
# Note that logs may incur a cost, especially if the deployed index receives
|
221
|
+
# a high volume of datapoint upserts. Estimate your costs before enabling
|
222
|
+
# this option.
|
211
223
|
# @!attribute [rw] deployed_index_auth_config
|
212
224
|
# @return [::Google::Cloud::AIPlatform::V1::DeployedIndexAuthConfig]
|
213
225
|
# Optional. If set, the authentication is enabled for the private endpoint.
|
@@ -105,6 +105,15 @@ module Google
|
|
105
105
|
# @return [::Google::Cloud::AIPlatform::V1::ModelContainerSpec]
|
106
106
|
# Optional. The specification of the container that is to be used when
|
107
107
|
# deploying. If not set, the default container spec will be used.
|
108
|
+
# @!attribute [rw] model_user_id
|
109
|
+
# @return [::String]
|
110
|
+
# Optional. The ID to use for the uploaded Model, which will become the
|
111
|
+
# final component of the model resource name. When not provided, Vertex AI
|
112
|
+
# will generate a value for this ID. When Model Registry model is provided,
|
113
|
+
# this field will be ignored.
|
114
|
+
#
|
115
|
+
# This value may be up to 63 characters, and valid characters are
|
116
|
+
# `[a-z0-9_-]`. The first character cannot be a number or hyphen.
|
108
117
|
class ModelConfig
|
109
118
|
include ::Google::Protobuf::MessageExts
|
110
119
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -116,13 +125,45 @@ module Google
|
|
116
125
|
# Optional. The user-specified display name of the endpoint. If not set, a
|
117
126
|
# default name will be used.
|
118
127
|
# @!attribute [rw] dedicated_endpoint_enabled
|
128
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
119
129
|
# @return [::Boolean]
|
120
|
-
# Optional.
|
121
|
-
#
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
130
|
+
# Optional. Deprecated. Use dedicated_endpoint_disabled instead.
|
131
|
+
# If true, the endpoint will be exposed through a
|
132
|
+
# dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the
|
133
|
+
# dedicated DNS will be isolated from other users' traffic and will have
|
134
|
+
# better performance and reliability. Note: Once you enabled dedicated
|
135
|
+
# endpoint, you won't be able to send request to the shared DNS
|
125
136
|
# \\{region}-aiplatform.googleapis.com. The limitations will be removed soon.
|
137
|
+
# @!attribute [rw] dedicated_endpoint_disabled
|
138
|
+
# @return [::Boolean]
|
139
|
+
# Optional. By default, if dedicated endpoint is enabled, the endpoint will
|
140
|
+
# be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns].
|
141
|
+
# Your request to the dedicated DNS will be isolated from other users'
|
142
|
+
# traffic and will have better performance and reliability. Note: Once you
|
143
|
+
# enabled dedicated endpoint, you won't be able to send request to the
|
144
|
+
# shared DNS \\{region}-aiplatform.googleapis.com. The limitations will be
|
145
|
+
# removed soon.
|
146
|
+
#
|
147
|
+
# If this field is set to true, the dedicated endpoint will be disabled
|
148
|
+
# and the deployed model will be exposed through the shared DNS
|
149
|
+
# \\{region}-aiplatform.googleapis.com.
|
150
|
+
# @!attribute [rw] endpoint_user_id
|
151
|
+
# @return [::String]
|
152
|
+
# Optional. Immutable. The ID to use for endpoint, which will become the
|
153
|
+
# final component of the endpoint resource name. If not provided, Vertex AI
|
154
|
+
# will generate a value for this ID.
|
155
|
+
#
|
156
|
+
# If the first character is a letter, this value may be up to 63
|
157
|
+
# characters, and valid characters are `[a-z0-9-]`. The last character must
|
158
|
+
# be a letter or number.
|
159
|
+
#
|
160
|
+
# If the first character is a number, this value may be up to 9 characters,
|
161
|
+
# and valid characters are `[0-9]` with no leading zeros.
|
162
|
+
#
|
163
|
+
# When using HTTP/JSON, this field is populated
|
164
|
+
# based on a query string argument, such as `?endpoint_id=12345`. This is
|
165
|
+
# the fallback for fields that are not included in either the URI or the
|
166
|
+
# body.
|
126
167
|
class EndpointConfig
|
127
168
|
include ::Google::Protobuf::MessageExts
|
128
169
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -534,6 +534,10 @@ module Google
|
|
534
534
|
# @return [::Array<::Google::Cloud::AIPlatform::V1::SafetySetting>]
|
535
535
|
# Optional. Per request settings for blocking unsafe content.
|
536
536
|
# Enforced on GenerateContentResponse.candidates.
|
537
|
+
# @!attribute [rw] model_armor_config
|
538
|
+
# @return [::Google::Cloud::AIPlatform::V1::ModelArmorConfig]
|
539
|
+
# Optional. Settings for prompt and response sanitization using the Model
|
540
|
+
# Armor service. If supplied, safety_settings must not be supplied.
|
537
541
|
# @!attribute [rw] generation_config
|
538
542
|
# @return [::Google::Cloud::AIPlatform::V1::GenerationConfig]
|
539
543
|
# Optional. Generation config.
|
@@ -608,6 +612,9 @@ module Google
|
|
608
612
|
|
609
613
|
# Candidates blocked due to prohibited content.
|
610
614
|
PROHIBITED_CONTENT = 4
|
615
|
+
|
616
|
+
# The user prompt was blocked by Model Armor.
|
617
|
+
MODEL_ARMOR = 5
|
611
618
|
end
|
612
619
|
end
|
613
620
|
|