feat: A new field response_logprbs is added to message .google.cloud.aiplatform.v1.GenerationConfig (#4410)

* feat: A new field `response_logprbs` is added to message `.google.cloud.aiplatform.v1.GenerationConfig` feat: A new field `logprbs` is added to message `.google.cloud.aiplatform.v1.GenerationConfig` feat: A new field `logprobs_result` is added to message `.google.cloud.aiplatform.v1.Candidate` feat: A new field `model_version` is added to message `.google.cloud.aiplatform.v1.GenerateContentResponse` PiperOrigin-RevId: 676556181 Source-Link: googleapis/googleapis@07b069b Source-Link: googleapis/googleapis-gen@919c469 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOTE5YzQ2OTI5ZDJlYjY0MjcxMTY4OTVhZTQ5MjZmZDg2MzZjN2QyZCJ9 feat: A new field `response_logprbs` is added to message `.google.cloud.aiplatform.v1beta1.GenerationConfig` feat: A new field `logprbs` is added to message `.google.cloud.aiplatform.v1beta1.GenerationConfig` feat: A new field `logprobs_result` is added to message `.google.cloud.aiplatform.v1beta1.Candidate` feat: A new field `model_version` is added to message `.google.cloud.aiplatform.v1beta1.GenerateContentResponse` PiperOrigin-RevId: 676506886 Source-Link: googleapis/googleapis@e88eeaa Source-Link: googleapis/googleapis-gen@35cac65 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMzVjYWM2NTg5NTRkODgxNDhhMDRlYzI2NWEyYTgwZjlhODRmYTQ5MCJ9 feat: A new field `any_of` is added to message `.google.cloud.aiplatform.v1.Schema` PiperOrigin-RevId: 676462752 Source-Link: googleapis/googleapis@bd0c988 Source-Link: googleapis/googleapis-gen@3ac8004 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiM2FjODAwNDU0NTU4OWM2OWI0YjBhZWU1MWVmYWU0MmVjNWIwZjIyZCJ9 feat: A new field `any_of` is added to message `.google.cloud.aiplatform.v1beta1.Schema` PiperOrigin-RevId: 676461662 Source-Link: googleapis/googleapis@b86cd1c Source-Link: googleapis/googleapis-gen@5c6bc1b Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNWM2YmMxYjlhNjkwZTlhOGZiNDczMWMyNGMwOTAxYjQzYmIwM2I5ZCJ9 feat: Add CIVIC_INTEGRITY category to SafetySettings for prediction service PiperOrigin-RevId: 676040944 Source-Link: googleapis/googleapis@2d1f337 Source-Link: googleapis/googleapis-gen@adb1880 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYWRiMTg4MGQ0ZGFmYzhiMTE5ZTQ4NGMyNTBiNTY5NGEyNTA0Mjk3MSJ9 feat: Add CIVIC_INTEGRITY category to SafetySettings for prediction service PiperOrigin-RevId: 676040723 Source-Link: googleapis/googleapis@cf775e2 Source-Link: googleapis/googleapis-gen@17d42e2 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTdkNDJlMjZjZGNiOTBiYjE0YjRlZmJmNDc2MWQ3NzM5YjZiMzA2YiJ9 feat: A new field `generation_config` is added to message `.google.cloud.aiplatform.v1.CountTokensRequest` feat: A new field `labels` is added to message `.google.cloud.aiplatform.v1.GenerateContentRequest` PiperOrigin-RevId: 675839175 Source-Link: googleapis/googleapis@49d2887 Source-Link: googleapis/googleapis-gen@e6a2931 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZTZhMjkzMWM0NWNlZWVhOTIxZTI0NTkwNGVlZjEwNzVjOWU0NDE4MCJ9 feat: add psc_automation_configs to DeployIndex v1beta1 PiperOrigin-RevId: 675732136 Source-Link: googleapis/googleapis@551cdf4 Source-Link: googleapis/googleapis-gen@e18f938 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZTE4ZjkzOGMzZmQwNzQ0YThiNWQ1NzgxYjQxZGI1MzAyZjhmMzBiNyJ9 feat: add new `PipelineTaskRerunConfig` field to `pipeline_job.proto` feat: expose `RuntimeArtifact` proto in `ui_pipeline_spec.proto` PiperOrigin-RevId: 675609590 Source-Link: googleapis/googleapis@9f216d5 Source-Link: googleapis/googleapis-gen@7d8da3d Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiN2Q4ZGEzZGU3OTc0NzFiODQxYmU2MDJiMTFjM2VjNWM3Zjc1YjJkNSJ9 * feat: A new field `response_logprbs` is added to message `.google.cloud.aiplatform.v1.GenerationConfig` feat: A new field `logprbs` is added to message `.google.cloud.aiplatform.v1.GenerationConfig` feat: A new field `logprobs_result` is added to message `.google.cloud.aiplatform.v1.Candidate` feat: A new field `model_version` is added to message `.google.cloud.aiplatform.v1.GenerateContentResponse` PiperOrigin-RevId: 676556181 Source-Link: googleapis/googleapis@07b069b Source-Link: googleapis/googleapis-gen@919c469 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOTE5YzQ2OTI5ZDJlYjY0MjcxMTY4OTVhZTQ5MjZmZDg2MzZjN2QyZCJ9 feat: A new field `response_logprbs` is added to message `.google.cloud.aiplatform.v1beta1.GenerationConfig` feat: A new field `logprbs` is added to message `.google.cloud.aiplatform.v1beta1.GenerationConfig` feat: A new field `logprobs_result` is added to message `.google.cloud.aiplatform.v1beta1.Candidate` feat: A new field `model_version` is added to message `.google.cloud.aiplatform.v1beta1.GenerateContentResponse` PiperOrigin-RevId: 676506886 Source-Link: googleapis/googleapis@e88eeaa Source-Link: googleapis/googleapis-gen@35cac65 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMzVjYWM2NTg5NTRkODgxNDhhMDRlYzI2NWEyYTgwZjlhODRmYTQ5MCJ9 feat: A new field `any_of` is added to message `.google.cloud.aiplatform.v1.Schema` PiperOrigin-RevId: 676462752 Source-Link: googleapis/googleapis@bd0c988 Source-Link: googleapis/googleapis-gen@3ac8004 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiM2FjODAwNDU0NTU4OWM2OWI0YjBhZWU1MWVmYWU0MmVjNWIwZjIyZCJ9 feat: A new field `any_of` is added to message `.google.cloud.aiplatform.v1beta1.Schema` PiperOrigin-RevId: 676461662 Source-Link: googleapis/googleapis@b86cd1c Source-Link: googleapis/googleapis-gen@5c6bc1b Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNWM2YmMxYjlhNjkwZTlhOGZiNDczMWMyNGMwOTAxYjQzYmIwM2I5ZCJ9 feat: Add CIVIC_INTEGRITY category to SafetySettings for prediction service PiperOrigin-RevId: 676040944 Source-Link: googleapis/googleapis@2d1f337 Source-Link: googleapis/googleapis-gen@adb1880 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYWRiMTg4MGQ0ZGFmYzhiMTE5ZTQ4NGMyNTBiNTY5NGEyNTA0Mjk3MSJ9 feat: Add CIVIC_INTEGRITY category to SafetySettings for prediction service PiperOrigin-RevId: 676040723 Source-Link: googleapis/googleapis@cf775e2 Source-Link: googleapis/googleapis-gen@17d42e2 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTdkNDJlMjZjZGNiOTBiYjE0YjRlZmJmNDc2MWQ3NzM5YjZiMzA2YiJ9 feat: A new field `generation_config` is added to message `.google.cloud.aiplatform.v1.CountTokensRequest` feat: A new field `labels` is added to message `.google.cloud.aiplatform.v1.GenerateContentRequest` PiperOrigin-RevId: 675839175 Source-Link: googleapis/googleapis@49d2887 Source-Link: googleapis/googleapis-gen@e6a2931 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZTZhMjkzMWM0NWNlZWVhOTIxZTI0NTkwNGVlZjEwNzVjOWU0NDE4MCJ9 feat: add psc_automation_configs to DeployIndex v1beta1 PiperOrigin-RevId: 675732136 Source-Link: googleapis/googleapis@551cdf4 Source-Link: googleapis/googleapis-gen@e18f938 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZTE4ZjkzOGMzZmQwNzQ0YThiNWQ1NzgxYjQxZGI1MzAyZjhmMzBiNyJ9 feat: add new `PipelineTaskRerunConfig` field to `pipeline_job.proto` feat: expose `RuntimeArtifact` proto in `ui_pipeline_spec.proto` PiperOrigin-RevId: 675609590 Source-Link: googleapis/googleapis@9f216d5 Source-Link: googleapis/googleapis-gen@7d8da3d Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiN2Q4ZGEzZGU3OTc0NzFiODQxYmU2MDJiMTFjM2VjNWM3Zjc1YjJkNSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: gcf-owl-bot[bot]

google/cloud/aiplatform_v1/__init__.py

@@ -101,6 +101,7 @@
 from .types.content import GroundingChunk
 from .types.content import GroundingMetadata
 from .types.content import GroundingSupport
+from .types.content import LogprobsResult
 from .types.content import Part
 from .types.content import SafetyRating
 from .types.content import SafetySetting
@@ -1423,6 +1424,7 @@
  "ListTuningJobsRequest",
  "ListTuningJobsResponse",
  "LlmUtilityServiceClient",
+ "LogprobsResult",
  "LookupStudyRequest",
  "MachineSpec",
  "ManualBatchTuningParameters",

google/cloud/aiplatform_v1/types/__init__.py

@@ -42,6 +42,7 @@
  GroundingChunk,
  GroundingMetadata,
  GroundingSupport,
+ LogprobsResult,
  Part,
  SafetyRating,
  SafetySetting,
@@ -1060,6 +1061,7 @@
  "GroundingChunk",
  "GroundingMetadata",
  "GroundingSupport",
+ "LogprobsResult",
  "Part",
  "SafetyRating",
  "SafetySetting",

google/cloud/aiplatform_v1/types/content.py

@@ -40,6 +40,7 @@
  "CitationMetadata",
  "Citation",
  "Candidate",
+ "LogprobsResult",
  "Segment",
  "GroundingChunk",
  "GroundingSupport",
@@ -64,12 +65,15 @@ class HarmCategory(proto.Enum):
  HARM_CATEGORY_SEXUALLY_EXPLICIT (4):
  The harm category is sexually explicit
  content.
+ HARM_CATEGORY_CIVIC_INTEGRITY (5):
+ The harm category is civic integrity.
  """
  HARM_CATEGORY_UNSPECIFIED = 0
  HARM_CATEGORY_HATE_SPEECH = 1
  HARM_CATEGORY_DANGEROUS_CONTENT = 2
  HARM_CATEGORY_HARASSMENT = 3
  HARM_CATEGORY_SEXUALLY_EXPLICIT = 4
+ HARM_CATEGORY_CIVIC_INTEGRITY = 5
 
 
 class Content(proto.Message):
@@ -294,6 +298,15 @@ class GenerationConfig(proto.Message):
  This field is a member of `oneof`_ ``_max_output_tokens``.
  stop_sequences (MutableSequence[str]):
  Optional. Stop sequences.
+ response_logprobs (bool):
+ Optional. If true, export the logprobs
+ results in response.
+
+ This field is a member of `oneof`_ ``_response_logprobs``.
+ logprobs (int):
+ Optional. Logit probabilities.
+
+ This field is a member of `oneof`_ ``_logprobs``.
  presence_penalty (float):
  Optional. Positive penalties.
 
@@ -457,6 +470,16 @@ class ManualRoutingMode(proto.Message):
  proto.STRING,
  number=6,
  )
+ response_logprobs: bool = proto.Field(
+ proto.BOOL,
+ number=18,
+ optional=True,
+ )
+ logprobs: int = proto.Field(
+ proto.INT32,
+ number=7,
+ optional=True,
+ )
  presence_penalty: float = proto.Field(
  proto.FLOAT,
  number=8,
@@ -734,6 +757,9 @@ class Candidate(proto.Message):
  avg_logprobs (float):
  Output only. Average log probability score of
  the candidate.
+ logprobs_result (google.cloud.aiplatform_v1.types.LogprobsResult):
+ Output only. Log-likelihood scores for the
+ response tokens and top tokens
  finish_reason (google.cloud.aiplatform_v1.types.Candidate.FinishReason):
  Output only. The reason why the model stopped
  generating tokens. If empty, the model has not
@@ -822,6 +848,11 @@ class FinishReason(proto.Enum):
  proto.DOUBLE,
  number=9,
  )
+ logprobs_result: "LogprobsResult" = proto.Field(
+ proto.MESSAGE,
+ number=10,
+ message="LogprobsResult",
+ )
  finish_reason: FinishReason = proto.Field(
  proto.ENUM,
  number=3,
@@ -849,6 +880,80 @@ class FinishReason(proto.Enum):
  )
 
 
+class LogprobsResult(proto.Message):
+ r"""Logprobs Result
+
+ Attributes:
+ top_candidates (MutableSequence[google.cloud.aiplatform_v1.types.LogprobsResult.TopCandidates]):
+ Length = total number of decoding steps.
+ chosen_candidates (MutableSequence[google.cloud.aiplatform_v1.types.LogprobsResult.Candidate]):
+ Length = total number of decoding steps. The chosen
+ candidates may or may not be in top_candidates.
+ """
+
+ class Candidate(proto.Message):
+ r"""Candidate for the logprobs token and score.
+
+ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+ Attributes:
+ token (str):
+ The candidate’s token string value.
+
+ This field is a member of `oneof`_ ``_token``.
+ token_id (int):
+ The candidate’s token id value.
+
+ This field is a member of `oneof`_ ``_token_id``.
+ log_probability (float):
+ The candidate's log probability.
+
+ This field is a member of `oneof`_ ``_log_probability``.
+ """
+
+ token: str = proto.Field(
+ proto.STRING,
+ number=1,
+ optional=True,
+ )
+ token_id: int = proto.Field(
+ proto.INT32,
+ number=3,
+ optional=True,
+ )
+ log_probability: float = proto.Field(
+ proto.FLOAT,
+ number=2,
+ optional=True,
+ )
+
+ class TopCandidates(proto.Message):
+ r"""Candidates with top log probabilities at each decoding step.
+
+ Attributes:
+ candidates (MutableSequence[google.cloud.aiplatform_v1.types.LogprobsResult.Candidate]):
+ Sorted by log probability in descending
+ order.
+ """
+
+ candidates: MutableSequence["LogprobsResult.Candidate"] = proto.RepeatedField(
+ proto.MESSAGE,
+ number=1,
+ message="LogprobsResult.Candidate",
+ )
+
+ top_candidates: MutableSequence[TopCandidates] = proto.RepeatedField(
+ proto.MESSAGE,
+ number=1,
+ message=TopCandidates,
+ )
+ chosen_candidates: MutableSequence[Candidate] = proto.RepeatedField(
+ proto.MESSAGE,
+ number=2,
+ message=Candidate,
+ )
+
+
 class Segment(proto.Message):
  r"""Segment of the content.
 

google/cloud/aiplatform_v1/types/openapi.py

@@ -131,6 +131,10 @@ class Schema(proto.Message):
  example (google.protobuf.struct_pb2.Value):
  Optional. Example of the object. Will only
  populated when the object is the root.
+ any_of (MutableSequence[google.cloud.aiplatform_v1.types.Schema]):
+ Optional. The value should be validated
+ against any (one or more) of the subschemas in
+ the list.
  """
 
  type_: "Type" = proto.Field(
@@ -223,6 +227,11 @@ class Schema(proto.Message):
  number=4,
  message=struct_pb2.Value,
  )
+ any_of: MutableSequence["Schema"] = proto.RepeatedField(
+ proto.MESSAGE,
+ number=11,
+ message="Schema",
+ )
 
 
 __all__ = tuple(sorted(__protobuf__.manifest))

google/cloud/aiplatform_v1/types/prediction_service.py

@@ -709,6 +709,11 @@ class CountTokensRequest(proto.Message):
  A ``Tool`` is 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.
+ generation_config (google.cloud.aiplatform_v1.types.GenerationConfig):
+ Optional. Generation config that the model
+ will use to generate the response.
+
+ This field is a member of `oneof`_ ``_generation_config``.
  """
 
  endpoint: str = proto.Field(
@@ -740,6 +745,12 @@ class CountTokensRequest(proto.Message):
  number=6,
  message=tool.Tool,
  )
+ generation_config: content.GenerationConfig = proto.Field(
+ proto.MESSAGE,
+ number=7,
+ optional=True,
+ message=content.GenerationConfig,
+ )
 
 
 class CountTokensResponse(proto.Message):
@@ -803,6 +814,17 @@ class GenerateContentRequest(proto.Message):
  tool_config (google.cloud.aiplatform_v1.types.ToolConfig):
  Optional. Tool config. This config is shared
  for all tools provided in the request.
+ labels (MutableMapping[str, str]):
+ 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.
  safety_settings (MutableSequence[google.cloud.aiplatform_v1.types.SafetySetting]):
  Optional. Per request settings for blocking
  unsafe content. Enforced on
@@ -836,6 +858,11 @@ class GenerateContentRequest(proto.Message):
  number=7,
  message=tool.ToolConfig,
  )
+ labels: MutableMapping[str, str] = proto.MapField(
+ proto.STRING,
+ proto.STRING,
+ number=10,
+ )
  safety_settings: MutableSequence[content.SafetySetting] = proto.RepeatedField(
  proto.MESSAGE,
  number=3,
@@ -854,6 +881,9 @@ class GenerateContentResponse(proto.Message):
  Attributes:
  candidates (MutableSequence[google.cloud.aiplatform_v1.types.Candidate]):
  Output only. Generated candidates.
+ model_version (str):
+ Output only. The model version used to
+ generate the response.
  prompt_feedback (google.cloud.aiplatform_v1.types.GenerateContentResponse.PromptFeedback):
  Output only. Content filter results for a
  prompt sent in the request. Note: Sent only in
@@ -926,7 +956,8 @@ class UsageMetadata(proto.Message):
  candidates_token_count (int):
  Number of tokens in the response(s).
  total_token_count (int):
-
+ Total token count for prompt and response
+ candidates.
  """
 
  prompt_token_count: int = proto.Field(
@@ -947,6 +978,10 @@ class UsageMetadata(proto.Message):
  number=2,
  message=content.Candidate,
  )
+ model_version: str = proto.Field(
+ proto.STRING,
+ number=11,
+ )
  prompt_feedback: PromptFeedback = proto.Field(
  proto.MESSAGE,
  number=3,

google/cloud/aiplatform_v1beta1/__init__.py

@@ -123,6 +123,7 @@
 from .types.content import GroundingChunk
 from .types.content import GroundingMetadata
 from .types.content import GroundingSupport
+from .types.content import LogprobsResult
 from .types.content import Part
 from .types.content import SafetyRating
 from .types.content import SafetySetting
@@ -822,6 +823,7 @@
 from .types.pipeline_job import PipelineJobDetail
 from .types.pipeline_job import PipelineTaskDetail
 from .types.pipeline_job import PipelineTaskExecutorDetail
+from .types.pipeline_job import PipelineTaskRerunConfig
 from .types.pipeline_job import PipelineTemplateMetadata
 from .types.pipeline_service import BatchCancelPipelineJobsOperationMetadata
 from .types.pipeline_service import BatchCancelPipelineJobsRequest
@@ -893,6 +895,7 @@
 from .types.schedule_service import UpdateScheduleRequest
 from .types.service_networking import PrivateServiceConnectConfig
 from .types.service_networking import PscAutomatedEndpoints
+from .types.service_networking import PSCAutomationConfig
 from .types.service_networking import PscInterfaceConfig
 from .types.specialist_pool import SpecialistPool
 from .types.specialist_pool_service import CreateSpecialistPoolOperationMetadata
@@ -1000,6 +1003,8 @@
 from .types.types import Int64Array
 from .types.types import StringArray
 from .types.types import Tensor
+from .types.ui_pipeline_spec import ArtifactTypeSchema
+from .types.ui_pipeline_spec import RuntimeArtifact
 from .types.unmanaged_container_model import UnmanagedContainerModel
 from .types.user_action_reference import UserActionReference
 from .types.value import Value
@@ -1106,6 +1111,7 @@
  "AnnotationSpec",
  "ApiAuth",
  "Artifact",
+ "ArtifactTypeSchema",
  "AssignNotebookRuntimeOperationMetadata",
  "AssignNotebookRuntimeRequest",
  "Attribution",
@@ -1644,6 +1650,7 @@
  "ListTuningJobsRequest",
  "ListTuningJobsResponse",
  "LlmUtilityServiceClient",
+ "LogprobsResult",
  "LookupStudyRequest",
  "MachineSpec",
  "ManualBatchTuningParameters",
@@ -1717,6 +1724,7 @@
  "NotebookRuntimeTemplateRef",
  "NotebookRuntimeType",
  "NotebookServiceClient",
+ "PSCAutomationConfig",
  "PairwiseChoice",
  "PairwiseMetricInput",
  "PairwiseMetricInstance",
@@ -1743,6 +1751,7 @@
  "PipelineState",
  "PipelineTaskDetail",
  "PipelineTaskExecutorDetail",
+ "PipelineTaskRerunConfig",
  "PipelineTemplateMetadata",
  "PointwiseMetricInput",
  "PointwiseMetricInstance",
@@ -1851,6 +1860,7 @@
  "RougeMetricValue",
  "RougeResults",
  "RougeSpec",
+ "RuntimeArtifact",
  "RuntimeConfig",
  "SafetyInput",
  "SafetyInstance",