google-api-python-client 2.114.0__py2.py3-none-any.whl → 2.116.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/aiplatform.v1.json

@@ -3405,6 +3405,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"streamRawPredict": {
+"description": "",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.streamRawPredict",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:streamRawPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1StreamRawPredictRequest"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "undeployModel": {
 "description": "Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel",
@@ -4212,7 +4240,7 @@
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}'`",
+"description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
@@ -11494,6 +11522,11 @@
 "description": "The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.",
 "location": "query",
 "type": "string"
+},
+"preflightValidations": {
+"description": "Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines.",
+"location": "query",
+"type": "boolean"
 }
 },
 "path": "v1/{+parent}/pipelineJobs",
@@ -11935,6 +11968,34 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"streamRawPredict": {
+"description": "",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.streamRawPredict",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:streamRawPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1StreamRawPredictRequest"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 }
 }
@@ -15332,7 +15393,7 @@
 }
 }
 },
-"revision": "20240105",
+"revision": "20240125",
 "rootUrl": "https://aiplatform.googleapis.com/",
 "schemas": {
 "CloudAiLargeModelsVisionEmbedVideoResponse": {
@@ -15733,6 +15794,10 @@
 ],
 "type": "string"
 },
+"groundingMetadata": {
+"$ref": "LearningGenaiRootGroundingMetadata",
+"description": "Grounding metadata. Combine with the facts list from response to generate grounding citations for this choice."
+},
 "index": {
 "description": "Index of the candidate.",
 "format": "int32",
@@ -15813,6 +15878,29 @@
 },
 "type": "object"
 },
+"CloudAiNlLlmProtoServiceFact": {
+"description": "A condense version of WorldFact (assistant/boq/lamda/factuality/proto/factuality.proto) to propagate the essential information about the fact used in factuality to the upstream caller.",
+"id": "CloudAiNlLlmProtoServiceFact",
+"properties": {
+"query": {
+"description": "Query that is used to retrieve this fact.",
+"type": "string"
+},
+"summary": {
+"description": "If present, the summary/snippet of the fact.",
+"type": "string"
+},
+"title": {
+"description": "If present, it refers to the title of this fact.",
+"type": "string"
+},
+"url": {
+"description": "If present, this URL links to the webpage of the fact.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "CloudAiNlLlmProtoServiceFunctionCall": {
 "description": "Function call details.",
 "id": "CloudAiNlLlmProtoServiceFunctionCall",
@@ -15865,6 +15953,13 @@
 "$ref": "CloudAiNlLlmProtoServiceMessageMetadata",
 "description": "Debug information containing message metadata. Clients should not consume this field, and this is only populated for Flow Runner path."
 },
+"facts": {
+"description": "External facts retrieved for factuality/grounding.",
+"items": {
+"$ref": "CloudAiNlLlmProtoServiceFact"
+},
+"type": "array"
+},
 "promptFeedback": {
 "$ref": "CloudAiNlLlmProtoServicePromptFeedback",
 "description": "Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations."
@@ -15976,6 +16071,10 @@
 "format": "google-duration",
 "type": "string"
 },
+"modelLevelMetaData": {
+"$ref": "CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata",
+"description": "Internal only model level metadata."
+},
 "startOffset": {
 "description": "The start offset of the video.",
 "format": "google-duration",
@@ -15984,6 +16083,23 @@
 },
 "type": "object"
 },
+"CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata": {
+"description": "Internal only fields",
+"id": "CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata",
+"properties": {
+"fps": {
+"description": "Frame rate to decode from this video.",
+"format": "float",
+"type": "number"
+},
+"numFrames": {
+"description": "Number of frames to decode from this video.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "CloudAiNlLlmProtoServicePromptFeedback": {
 "description": "Content filter results for a prompt sent in the request.",
 "id": "CloudAiNlLlmProtoServicePromptFeedback",
@@ -16042,7 +16158,7 @@
 "type": "boolean"
 },
 "languageFilterResult": {
-"$ref": "LearningServingLlmLanguageFilterResult",
+"$ref": "LearningGenaiRootLanguageFilterResult",
 "description": "Language filter result from SAFT LangId."
 },
 "raiSignals": {
@@ -18017,6 +18133,10 @@
 "pipelineJobId": {
 "description": "The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.",
 "type": "string"
+},
+"preflightValidations": {
+"description": "Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines.",
+"type": "boolean"
 }
 },
 "type": "object"
@@ -19739,7 +19859,7 @@
 "id": "GoogleCloudAiplatformV1Explanation",
 "properties": {
 "attributions": {
-"description": "Output only. Feature attributions grouped by predicted outputs. For Models that predict only one output, such as regression Models that predict only one score, there is only one attibution that explains the predicted output. For Models that predict multiple outputs, such as multiclass Models that predict multiple classes, each element explains one specific item. Attribution.output_index can be used to identify which output this attribution is explaining. If users set ExplanationParameters.top_k, the attributions are sorted by instance_output_value in descending order. If ExplanationParameters.output_indices is specified, the attributions are stored by Attribution.output_index in the same order as they appear in the output_indices.",
+"description": "Output only. Feature attributions grouped by predicted outputs. For Models that predict only one output, such as regression Models that predict only one score, there is only one attibution that explains the predicted output. For Models that predict multiple outputs, such as multiclass Models that predict multiple classes, each element explains one specific item. Attribution.output_index can be used to identify which output this attribution is explaining. By default, we provide Shapley values for the predicted class. However, you can configure the explanation request to generate Shapley values for any other classes too. For example, if a model predicts a probability of `0.4` for approving a loan application, the model's decision is to reject the application since `p(reject) = 0.6 > p(approve) = 0.4`, and the default Shapley values would be computed for rejection decision and not approval, even though the latter might be the positive class. If users set ExplanationParameters.top_k, the attributions are sorted by instance_output_value in descending order. If ExplanationParameters.output_indices is specified, the attributions are stored by Attribution.output_index in the same order as they appear in the output_indices.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1Attribution"
 },
@@ -22306,6 +22426,14 @@
 "readOnly": true,
 "type": "string"
 },
+"pscAutomatedEndpoints": {
+"description": "Output only. PscAutomatedEndpoints is populated if private service connect is enabled if PscAutomatedConfig is set.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1PscAutomatedEndpoints"
+},
+"readOnly": true,
+"type": "array"
+},
 "serviceAttachment": {
 "description": "Output only. The name of the service attachment resource. Populated if private service connect is enabled.",
 "readOnly": true,
@@ -23820,7 +23948,7 @@
 },
 "modelSourceInfo": {
 "$ref": "GoogleCloudAiplatformV1ModelSourceInfo",
-"description": "Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or existing Vertex AI Model.",
+"description": "Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.",
 "readOnly": true
 },
 "name": {
@@ -25290,7 +25418,12 @@
 "INVALID_AVRO_SYNTAX",
 "INVALID_EMBEDDING_ID",
 "EMBEDDING_SIZE_MISMATCH",
-"NAMESPACE_MISSING"
+"NAMESPACE_MISSING",
+"PARSING_ERROR",
+"DUPLICATE_NAMESPACE",
+"OP_IN_DATAPOINT",
+"MULTIPLE_VALUES",
+"INVALID_NUMERIC_VALUE"
 ],
 "enumDescriptions": [
 "Default, shall not be used.",
@@ -25300,7 +25433,12 @@
 "Invalid avro format.",
 "The embedding id is not valid.",
 "The size of the embedding vectors does not match with the specified dimension.",
-"The `namespace` field is missing."
+"The `namespace` field is missing.",
+"Generic catch-all error. Only used for validation failure where the root cause cannot be easily retrieved programmatically.",
+"There are multiple restricts with the same `namespace` value.",
+"Numeric restrict has operator specified in datapoint.",
+"Numeric restrict has multiple values specified.",
+"Numeric restrict has invalid numeric value specified."
 ],
 "type": "string"
 },
@@ -25903,6 +26041,10 @@
 "description": "The runtime config of a PipelineJob.",
 "id": "GoogleCloudAiplatformV1PipelineJobRuntimeConfig",
 "properties": {
+"defaultRuntime": {
+"$ref": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigDefaultRuntime",
+"description": "Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview"
+},
 "failurePolicy": {
 "description": "Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.",
 "enum": [
@@ -25946,6 +26088,17 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1PipelineJobRuntimeConfigDefaultRuntime": {
+"description": "The default runtime for the PipelineJob.",
+"id": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigDefaultRuntime",
+"properties": {
+"persistentResourceRuntimeDetail": {
+"$ref": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail",
+"description": "Persistent resource based runtime detail."
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact": {
 "description": "The type of an input artifact.",
 "id": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact",
@@ -25957,6 +26110,17 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail": {
+"description": "Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview",
+"id": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail",
+"properties": {
+"persistentResourceName": {
+"description": "Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1PipelineTaskDetail": {
 "description": "The runtime detail of a task execution.",
 "id": "GoogleCloudAiplatformV1PipelineTaskDetail",
@@ -26443,6 +26607,25 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1PscAutomatedEndpoints": {
+"description": "PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig.",
+"id": "GoogleCloudAiplatformV1PscAutomatedEndpoints",
+"properties": {
+"matchAddress": {
+"description": "Ip Address created by the automated forwarding rule.",
+"type": "string"
+},
+"network": {
+"description": "Corresponding network in pscAutomationConfigs.",
+"type": "string"
+},
+"projectId": {
+"description": "Corresponding project_id in pscAutomationConfigs",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1PublisherModel": {
 "description": "A Model Garden Publisher Model.",
 "id": "GoogleCloudAiplatformV1PublisherModel",
@@ -31677,6 +31860,17 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1StreamRawPredictRequest": {
+"description": "Request message for PredictionService.StreamRawPredict.",
+"id": "GoogleCloudAiplatformV1StreamRawPredictRequest",
+"properties": {
+"httpBody": {
+"$ref": "GoogleApiHttpBody",
+"description": "The prediction input. Supports HTTP headers and arbitrary data payload."
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1StreamingPredictRequest": {
 "description": "Request message for PredictionService.StreamingPredict. The first message must contain endpoint field and optionally input. The subsequent messages must contain input.",
 "id": "GoogleCloudAiplatformV1StreamingPredictRequest",
@@ -33738,7 +33932,7 @@ false
 "type": "array"
 },
 "role": {
-"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
+"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
 "type": "string"
 }
 },
@@ -34054,7 +34248,7 @@ false
 "type": "object"
 },
 "LanguageLabsAidaTrustRecitationProtoDocAttribution": {
-"description": "The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id:28",
+"description": "The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id: 30",
 "id": "LanguageLabsAidaTrustRecitationProtoDocAttribution",
 "properties": {
 "amarnaId": {
@@ -34069,6 +34263,10 @@ false
 "bibkey": {
 "type": "string"
 },
+"biorxivId": {
+"description": "ID of the paper in bioarxiv like ddoi.org/{biorxiv_id} eg: https://doi.org/10.1101/343517",
+"type": "string"
+},
 "bookTitle": {
 "type": "string"
 },
@@ -34778,6 +34976,10 @@ false
 "wikipediaArticleTitle": {
 "description": "Wikipedia article title. The Wikipedia TFDS dataset includes article titles but not URLs. While a URL is to the best of our knowledge a deterministic function of the title, we store the original title to reflect the information in the original dataset.",
 "type": "string"
+},
+"youtubeVideoId": {
+"description": "The unique video id from Youtube. Example: AkoGsW52Ir0",
+"type": "string"
 }
 },
 "type": "object"
@@ -35536,7 +35738,7 @@ false
 "type": "object"
 },
 "LearningGenaiRecitationDocAttribution": {
-"description": "The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id: 28",
+"description": "The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id: 30",
 "id": "LearningGenaiRecitationDocAttribution",
 "properties": {
 "amarnaId": {
@@ -35551,6 +35753,10 @@ false
 "bibkey": {
 "type": "string"
 },
+"biorxivId": {
+"description": "ID of the paper in bioarxiv like ddoi.org/{biorxiv_id} eg: https://doi.org/10.1101/343517",
+"type": "string"
+},
 "bookTitle": {
 "type": "string"
 },
@@ -36246,6 +36452,9 @@ false
 "wikipediaArticleTitle": {
 "description": "Wikipedia article title. The Wikipedia TFDS dataset includes article titles but not URLs. While a URL is to the best of our knowledge a deterministic function of the title, we store the original title to reflect the information in the original dataset.",
 "type": "string"
+},
+"youtubeVideoId": {
+"type": "string"
 }
 },
 "type": "object"
@@ -37205,7 +37414,7 @@ false
 "type": "string"
 },
 "languageFilterResult": {
-"$ref": "LearningServingLlmLanguageFilterResult"
+"$ref": "LearningGenaiRootLanguageFilterResult"
 },
 "raiOutput": {
 "$ref": "LearningGenaiRootRAIOutput",
@@ -37231,6 +37440,54 @@ false
 },
 "type": "object"
 },
+"LearningGenaiRootGroundingMetadata": {
+"id": "LearningGenaiRootGroundingMetadata",
+"properties": {
+"citations": {
+"items": {
+"$ref": "LearningGenaiRootGroundingMetadataCitation"
+},
+"type": "array"
+},
+"groundingCancelled": {
+"description": "True if grounding is cancelled, for example, no facts being retrieved.",
+"type": "boolean"
+},
+"searchQueries": {
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"LearningGenaiRootGroundingMetadataCitation": {
+"id": "LearningGenaiRootGroundingMetadataCitation",
+"properties": {
+"endIndex": {
+"description": "Index in the prediction output where the citation ends (exclusive). Must be > start_index and < len(output).",
+"format": "int32",
+"type": "integer"
+},
+"factIndex": {
+"description": "Index of the fact supporting this claim. Should be within the range of the `world_facts` in the GenerateResponse.",
+"format": "int32",
+"type": "integer"
+},
+"score": {
+"description": "Confidence score of this entailment. Value is [0,1] with 1 is the most confidence.",
+"format": "double",
+"type": "number"
+},
+"startIndex": {
+"description": "Index in the prediction output where the citation starts (inclusive). Must be >= 0 and < end_index.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "LearningGenaiRootHarm": {
 "id": "LearningGenaiRootHarm",
 "properties": {
@@ -37465,6 +37722,25 @@ false
 },
 "type": "object"
 },
+"LearningGenaiRootLanguageFilterResult": {
+"id": "LearningGenaiRootLanguageFilterResult",
+"properties": {
+"allowed": {
+"description": "False when query or response should be filtered out due to unsupported language.",
+"type": "boolean"
+},
+"detectedLanguage": {
+"description": "Language of the query or response.",
+"type": "string"
+},
+"detectedLanguageProbability": {
+"description": "Probability of the language predicted as returned by LangID.",
+"format": "float",
+"type": "number"
+}
+},
+"type": "object"
+},
 "LearningGenaiRootMetricOutput": {
 "id": "LearningGenaiRootMetricOutput",
 "properties": {
@@ -37941,25 +38217,6 @@ false
 },
 "type": "object"
 },
-"LearningServingLlmLanguageFilterResult": {
-"id": "LearningServingLlmLanguageFilterResult",
-"properties": {
-"allowed": {
-"description": "False when query or response should be filtered out due to unsupported language.",
-"type": "boolean"
-},
-"detectedLanguage": {
-"description": "Language of the query or response.",
-"type": "string"
-},
-"detectedLanguageProbability": {
-"description": "Probability of the language predicted as returned by LangID.",
-"format": "float",
-"type": "number"
-}
-},
-"type": "object"
-},
 "LearningServingLlmMessageMetadata": {
 "description": "LINT.IfChange This metadata contains additional information required for debugging.",
 "id": "LearningServingLlmMessageMetadata",
@@ -38005,6 +38262,9 @@ false
 ],
 "type": "string"
 },
+"groundingMetadata": {
+"$ref": "LearningGenaiRootGroundingMetadata"
+},
 "isFallback": {
 "description": "Applies to Response message only. Indicates whether the message is a fallback and the response would have otherwise been empty.",
 "type": "boolean"