File: aiplatform_v1beta1.projects.locations.datasets.html

package info (click to toggle)
python-googleapi 2.180.0-1
links: PTS
area: main
in suites: forky, sid
size: 527,124 kB
sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (1599 lines) | stat: -rw-r--r-- 185,711 bytes
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="aiplatform_v1beta1.html">Vertex AI API</a> . <a href="aiplatform_v1beta1.projects.html">projects</a> . <a href="aiplatform_v1beta1.projects.locations.html">locations</a> . <a href="aiplatform_v1beta1.projects.locations.datasets.html">datasets</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="aiplatform_v1beta1.projects.locations.datasets.annotationSpecs.html">annotationSpecs()</a></code>
</p>
<p class="firstline">Returns the annotationSpecs Resource.</p>

<p class="toc_element">
  <code><a href="aiplatform_v1beta1.projects.locations.datasets.dataItems.html">dataItems()</a></code>
</p>
<p class="firstline">Returns the dataItems Resource.</p>

<p class="toc_element">
  <code><a href="aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html">datasetVersions()</a></code>
</p>
<p class="firstline">Returns the datasetVersions Resource.</p>

<p class="toc_element">
  <code><a href="aiplatform_v1beta1.projects.locations.datasets.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>

<p class="toc_element">
  <code><a href="aiplatform_v1beta1.projects.locations.datasets.savedQueries.html">savedQueries()</a></code>
</p>
<p class="firstline">Returns the savedQueries Resource.</p>

<p class="toc_element">
  <code><a href="#assemble">assemble(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Assembles each row of a multimodal dataset and writes the result into a BigQuery table.</p>
<p class="toc_element">
  <code><a href="#assess">assess(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Assesses the state or validity of the dataset with respect to a given use case.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Dataset.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a Dataset.</p>
<p class="toc_element">
  <code><a href="#export">export(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Exports data from a Dataset.</p>
<p class="toc_element">
  <code><a href="#get">get(name, readMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a Dataset.</p>
<p class="toc_element">
  <code><a href="#import_">import_(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Imports data into a Dataset.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Datasets in a Location.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a Dataset.</p>
<p class="toc_element">
  <code><a href="#searchDataItems">searchDataItems(dataset, annotationFilters=None, annotationsFilter=None, annotationsLimit=None, dataItemFilter=None, dataLabelingJob=None, fieldMask=None, orderBy=None, orderByAnnotation_orderBy=None, orderByAnnotation_savedQuery=None, orderByDataItem=None, pageSize=None, pageToken=None, savedQuery=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches DataItems in a Dataset.</p>
<p class="toc_element">
  <code><a href="#searchDataItems_next">searchDataItems_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="assemble">assemble(name, body=None, x__xgafv=None)</code>
  <pre>Assembles each row of a multimodal dataset and writes the result into a BigQuery table.

Args:
  name: string, Required. The name of the Dataset resource (used only for MULTIMODAL datasets). Format: `projects/{project}/locations/{location}/datasets/{dataset}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DatasetService.AssembleData. Used only for MULTIMODAL datasets.
  &quot;geminiRequestReadConfig&quot;: { # Configuration for how to read Gemini requests from a multimodal dataset. # Optional. The read config for the dataset.
    &quot;assembledRequestColumnName&quot;: &quot;A String&quot;, # Optional. Column name in the dataset table that contains already fully assembled Gemini requests.
    &quot;templateConfig&quot;: { # Template configuration to create Gemini examples from a multimodal dataset. # Gemini request template with placeholders.
      &quot;fieldMapping&quot;: { # Required. Map of template parameters to the columns in the dataset table.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;geminiExample&quot;: { # Format for Gemini examples used for Vertex Multimodal datasets. # Required. The template that will be used for assembling the request to use for downstream applications.
        &quot;cachedContent&quot;: &quot;A String&quot;, # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
        &quot;contents&quot;: [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
          { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
            &quot;parts&quot;: [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
              { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
                &quot;codeExecutionResult&quot;: { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
                  &quot;outcome&quot;: &quot;A String&quot;, # Required. Outcome of the code execution.
                  &quot;output&quot;: &quot;A String&quot;, # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                },
                &quot;executableCode&quot;: { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
                  &quot;code&quot;: &quot;A String&quot;, # Required. The code to be executed.
                  &quot;language&quot;: &quot;A String&quot;, # Required. Programming language of the `code`.
                },
                &quot;fileData&quot;: { # URI based data. # Optional. URI based data.
                  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
                  &quot;fileUri&quot;: &quot;A String&quot;, # Required. URI.
                  &quot;mimeType&quot;: &quot;A String&quot;, # Required. The IANA standard MIME type of the source data.
                },
                &quot;functionCall&quot;: { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
                  &quot;args&quot;: { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;id&quot;: &quot;A String&quot;, # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                  &quot;name&quot;: &quot;A String&quot;, # Required. The name of the function to call. Matches [FunctionDeclaration.name].
                },
                &quot;functionResponse&quot;: { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
                  &quot;id&quot;: &quot;A String&quot;, # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                  &quot;name&quot;: &quot;A String&quot;, # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
                  &quot;response&quot;: { # Required. The function response in JSON object format. Use &quot;output&quot; key to specify function output and &quot;error&quot; key to specify error details (if any). If &quot;output&quot; and &quot;error&quot; keys are not specified, then whole &quot;response&quot; is treated as function output.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;inlineData&quot;: { # Content blob. # Optional. Inlined bytes data.
                  &quot;data&quot;: &quot;A String&quot;, # Required. Raw bytes.
                  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
                  &quot;mimeType&quot;: &quot;A String&quot;, # Required. The IANA standard MIME type of the source data.
                },
                &quot;text&quot;: &quot;A String&quot;, # Optional. Text part (can be code).
                &quot;thought&quot;: True or False, # Optional. Indicates if the part is thought from the model.
                &quot;thoughtSignature&quot;: &quot;A String&quot;, # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
                &quot;videoMetadata&quot;: { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                  &quot;endOffset&quot;: &quot;A String&quot;, # Optional. The end offset of the video.
                  &quot;fps&quot;: 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
                  &quot;startOffset&quot;: &quot;A String&quot;, # Optional. The start offset of the video.
                },
              },
            ],
            &quot;role&quot;: &quot;A String&quot;, # Optional. The producer of the content. Must be either &#x27;user&#x27; or &#x27;model&#x27;. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
          },
        ],
        &quot;generationConfig&quot;: { # Generation config. # Optional. Generation config.
          &quot;audioTimestamp&quot;: True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
          &quot;candidateCount&quot;: 42, # Optional. Number of candidates to generate.
          &quot;enableAffectiveDialog&quot;: True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
          &quot;frequencyPenalty&quot;: 3.14, # Optional. Frequency penalties.
          &quot;logprobs&quot;: 42, # Optional. Logit probabilities.
          &quot;maxOutputTokens&quot;: 42, # Optional. The maximum number of output tokens to generate per message.
          &quot;mediaResolution&quot;: &quot;A String&quot;, # Optional. If specified, the media resolution specified will be used.
          &quot;modelConfig&quot;: { # Config for model selection. # Optional. Config for model selection.
            &quot;featureSelectionPreference&quot;: &quot;A String&quot;, # Required. Feature selection preference.
          },
          &quot;presencePenalty&quot;: 3.14, # Optional. Positive penalties.
          &quot;responseJsonSchema&quot;: &quot;&quot;, # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
          &quot;responseLogprobs&quot;: True or False, # Optional. If true, export the logprobs results in response.
          &quot;responseMimeType&quot;: &quot;A String&quot;, # 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.
          &quot;responseModalities&quot;: [ # Optional. The modalities of the response.
            &quot;A String&quot;,
          ],
          &quot;responseSchema&quot;: { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
            &quot;additionalProperties&quot;: &quot;&quot;, # Optional. Can either be a boolean or an object; controls the presence of additional properties.
            &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            ],
            &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
            &quot;defs&quot;: { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
              &quot;a_key&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
            &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
              &quot;A String&quot;,
            ],
            &quot;example&quot;: &quot;&quot;, # Optional. Example of the object. Will only populated when the object is the root.
            &quot;format&quot;: &quot;A String&quot;, # Optional. The format of the data. Supported formats: for NUMBER type: &quot;float&quot;, &quot;double&quot; for INTEGER type: &quot;int32&quot;, &quot;int64&quot; for STRING type: &quot;email&quot;, &quot;byte&quot;, etc
            &quot;items&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
            &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
            &quot;maxLength&quot;: &quot;A String&quot;, # Optional. Maximum length of the Type.STRING
            &quot;maxProperties&quot;: &quot;A String&quot;, # Optional. Maximum number of the properties for Type.OBJECT.
            &quot;maximum&quot;: 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
            &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
            &quot;minLength&quot;: &quot;A String&quot;, # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
            &quot;minProperties&quot;: &quot;A String&quot;, # Optional. Minimum number of the properties for Type.OBJECT.
            &quot;minimum&quot;: 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
            &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
            &quot;pattern&quot;: &quot;A String&quot;, # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
            &quot;properties&quot;: { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
              &quot;a_key&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            &quot;propertyOrdering&quot;: [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
              &quot;A String&quot;,
            ],
            &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring
            &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
              &quot;A String&quot;,
            ],
            &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the Schema.
            &quot;type&quot;: &quot;A String&quot;, # Optional. The type of the data.
          },
          &quot;routingConfig&quot;: { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
            &quot;autoMode&quot;: { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
              &quot;modelRoutingPreference&quot;: &quot;A String&quot;, # The model routing preference.
            },
            &quot;manualMode&quot;: { # When manual routing is set, the specified model will be used directly. # Manual routing.
              &quot;modelName&quot;: &quot;A String&quot;, # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
            },
          },
          &quot;seed&quot;: 42, # Optional. Seed.
          &quot;speechConfig&quot;: { # The speech generation config. # Optional. The speech generation config.
            &quot;languageCode&quot;: &quot;A String&quot;, # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
            &quot;voiceConfig&quot;: { # The configuration for the voice to use. # The configuration for the speaker to use.
              &quot;prebuiltVoiceConfig&quot;: { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
                &quot;voiceName&quot;: &quot;A String&quot;, # The name of the preset voice to use.
              },
            },
          },
          &quot;stopSequences&quot;: [ # Optional. Stop sequences.
            &quot;A String&quot;,
          ],
          &quot;temperature&quot;: 3.14, # Optional. Controls the randomness of predictions.
          &quot;thinkingConfig&quot;: { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don&#x27;t support thinking.
            &quot;includeThoughts&quot;: True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
            &quot;thinkingBudget&quot;: 42, # Optional. Indicates the thinking budget in tokens.
          },
          &quot;topK&quot;: 3.14, # Optional. If specified, top-k sampling will be used.
          &quot;topP&quot;: 3.14, # Optional. If specified, nucleus sampling will be used.
        },
        &quot;labels&quot;: { # 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.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
        &quot;model&quot;: &quot;A String&quot;, # Optional. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
        &quot;safetySettings&quot;: [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
          { # Safety settings.
            &quot;category&quot;: &quot;A String&quot;, # Required. Harm category.
            &quot;method&quot;: &quot;A String&quot;, # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
            &quot;threshold&quot;: &quot;A String&quot;, # Required. The harm block threshold.
          },
        ],
        &quot;systemInstruction&quot;: { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
          &quot;parts&quot;: [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
            { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
              &quot;codeExecutionResult&quot;: { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
                &quot;outcome&quot;: &quot;A String&quot;, # Required. Outcome of the code execution.
                &quot;output&quot;: &quot;A String&quot;, # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
              },
              &quot;executableCode&quot;: { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
                &quot;code&quot;: &quot;A String&quot;, # Required. The code to be executed.
                &quot;language&quot;: &quot;A String&quot;, # Required. Programming language of the `code`.
              },
              &quot;fileData&quot;: { # URI based data. # Optional. URI based data.
                &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
                &quot;fileUri&quot;: &quot;A String&quot;, # Required. URI.
                &quot;mimeType&quot;: &quot;A String&quot;, # Required. The IANA standard MIME type of the source data.
              },
              &quot;functionCall&quot;: { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
                &quot;args&quot;: { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;id&quot;: &quot;A String&quot;, # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                &quot;name&quot;: &quot;A String&quot;, # Required. The name of the function to call. Matches [FunctionDeclaration.name].
              },
              &quot;functionResponse&quot;: { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
                &quot;id&quot;: &quot;A String&quot;, # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                &quot;name&quot;: &quot;A String&quot;, # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
                &quot;response&quot;: { # Required. The function response in JSON object format. Use &quot;output&quot; key to specify function output and &quot;error&quot; key to specify error details (if any). If &quot;output&quot; and &quot;error&quot; keys are not specified, then whole &quot;response&quot; is treated as function output.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
              },
              &quot;inlineData&quot;: { # Content blob. # Optional. Inlined bytes data.
                &quot;data&quot;: &quot;A String&quot;, # Required. Raw bytes.
                &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
                &quot;mimeType&quot;: &quot;A String&quot;, # Required. The IANA standard MIME type of the source data.
              },
              &quot;text&quot;: &quot;A String&quot;, # Optional. Text part (can be code).
              &quot;thought&quot;: True or False, # Optional. Indicates if the part is thought from the model.
              &quot;thoughtSignature&quot;: &quot;A String&quot;, # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
              &quot;videoMetadata&quot;: { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                &quot;endOffset&quot;: &quot;A String&quot;, # Optional. The end offset of the video.
                &quot;fps&quot;: 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
                &quot;startOffset&quot;: &quot;A String&quot;, # Optional. The start offset of the video.
              },
            },
          ],
          &quot;role&quot;: &quot;A String&quot;, # Optional. The producer of the content. Must be either &#x27;user&#x27; or &#x27;model&#x27;. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
        },
        &quot;toolConfig&quot;: { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request.
          &quot;functionCallingConfig&quot;: { # Function calling config. # Optional. Function calling config.
            &quot;allowedFunctionNames&quot;: [ # Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.
              &quot;A String&quot;,
            ],
            &quot;mode&quot;: &quot;A String&quot;, # Optional. Function calling mode.
          },
          &quot;retrievalConfig&quot;: { # Retrieval config. # Optional. Retrieval config.
            &quot;languageCode&quot;: &quot;A String&quot;, # The language code of the user.
            &quot;latLng&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
              &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
            },
          },
        },
        &quot;tools&quot;: [ # Optional. A list of `Tools` the model may use to generate the next response. 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.
          { # Tool details that the model may use to generate response. 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
            &quot;codeExecution&quot;: { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
            },
            &quot;enterpriseWebSearch&quot;: { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
              &quot;excludeDomains&quot;: [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
                &quot;A String&quot;,
              ],
            },
            &quot;functionDeclarations&quot;: [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
              { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
                &quot;description&quot;: &quot;A String&quot;, # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
                &quot;name&quot;: &quot;A String&quot;, # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.
                &quot;parameters&quot;: { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
                  &quot;additionalProperties&quot;: &quot;&quot;, # Optional. Can either be a boolean or an object; controls the presence of additional properties.
                  &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
                    # Object with schema name: GoogleCloudAiplatformV1beta1Schema
                  ],
                  &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
                  &quot;defs&quot;: { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
                    &quot;a_key&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema
                  },
                  &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
                  &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
                    &quot;A String&quot;,
                  ],
                  &quot;example&quot;: &quot;&quot;, # Optional. Example of the object. Will only populated when the object is the root.
                  &quot;format&quot;: &quot;A String&quot;, # Optional. The format of the data. Supported formats: for NUMBER type: &quot;float&quot;, &quot;double&quot; for INTEGER type: &quot;int32&quot;, &quot;int64&quot; for STRING type: &quot;email&quot;, &quot;byte&quot;, etc
                  &quot;items&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
                  &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
                  &quot;maxLength&quot;: &quot;A String&quot;, # Optional. Maximum length of the Type.STRING
                  &quot;maxProperties&quot;: &quot;A String&quot;, # Optional. Maximum number of the properties for Type.OBJECT.
                  &quot;maximum&quot;: 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
                  &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
                  &quot;minLength&quot;: &quot;A String&quot;, # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
                  &quot;minProperties&quot;: &quot;A String&quot;, # Optional. Minimum number of the properties for Type.OBJECT.
                  &quot;minimum&quot;: 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
                  &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
                  &quot;pattern&quot;: &quot;A String&quot;, # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
                  &quot;properties&quot;: { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
                    &quot;a_key&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema
                  },
                  &quot;propertyOrdering&quot;: [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
                    &quot;A String&quot;,
                  ],
                  &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring
                  &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
                    &quot;A String&quot;,
                  ],
                  &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the Schema.
                  &quot;type&quot;: &quot;A String&quot;, # Optional. The type of the data.
                },
                &quot;parametersJsonSchema&quot;: &quot;&quot;, # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { &quot;type&quot;: &quot;object&quot;, &quot;properties&quot;: { &quot;name&quot;: { &quot;type&quot;: &quot;string&quot; }, &quot;age&quot;: { &quot;type&quot;: &quot;integer&quot; } }, &quot;additionalProperties&quot;: false, &quot;required&quot;: [&quot;name&quot;, &quot;age&quot;], &quot;propertyOrdering&quot;: [&quot;name&quot;, &quot;age&quot;] } ``` This field is mutually exclusive with `parameters`.
                &quot;response&quot;: { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
                  &quot;additionalProperties&quot;: &quot;&quot;, # Optional. Can either be a boolean or an object; controls the presence of additional properties.
                  &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
                    # Object with schema name: GoogleCloudAiplatformV1beta1Schema
                  ],
                  &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
                  &quot;defs&quot;: { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
                    &quot;a_key&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema
                  },
                  &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
                  &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
                    &quot;A String&quot;,
                  ],
                  &quot;example&quot;: &quot;&quot;, # Optional. Example of the object. Will only populated when the object is the root.
                  &quot;format&quot;: &quot;A String&quot;, # Optional. The format of the data. Supported formats: for NUMBER type: &quot;float&quot;, &quot;double&quot; for INTEGER type: &quot;int32&quot;, &quot;int64&quot; for STRING type: &quot;email&quot;, &quot;byte&quot;, etc
                  &quot;items&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
                  &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
                  &quot;maxLength&quot;: &quot;A String&quot;, # Optional. Maximum length of the Type.STRING
                  &quot;maxProperties&quot;: &quot;A String&quot;, # Optional. Maximum number of the properties for Type.OBJECT.
                  &quot;maximum&quot;: 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
                  &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
                  &quot;minLength&quot;: &quot;A String&quot;, # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
                  &quot;minProperties&quot;: &quot;A String&quot;, # Optional. Minimum number of the properties for Type.OBJECT.
                  &quot;minimum&quot;: 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
                  &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
                  &quot;pattern&quot;: &quot;A String&quot;, # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
                  &quot;properties&quot;: { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
                    &quot;a_key&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema
                  },
                  &quot;propertyOrdering&quot;: [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
                    &quot;A String&quot;,
                  ],
                  &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring
                  &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
                    &quot;A String&quot;,
                  ],
                  &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the Schema.
                  &quot;type&quot;: &quot;A String&quot;, # Optional. The type of the data.
                },
                &quot;responseJsonSchema&quot;: &quot;&quot;, # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
              },
            ],
            &quot;googleMaps&quot;: { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
            },
            &quot;googleSearch&quot;: { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
              &quot;excludeDomains&quot;: [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: [&quot;amazon.com&quot;, &quot;facebook.com&quot;].
                &quot;A String&quot;,
              ],
            },
            &quot;googleSearchRetrieval&quot;: { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
              &quot;dynamicRetrievalConfig&quot;: { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
                &quot;dynamicThreshold&quot;: 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
                &quot;mode&quot;: &quot;A String&quot;, # The mode of the predictor to be used in dynamic retrieval.
              },
            },
            &quot;retrieval&quot;: { # 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.
              &quot;disableAttribution&quot;: True or False, # Optional. Deprecated. This option is no longer supported.
              &quot;externalApi&quot;: { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
                &quot;apiAuth&quot;: { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
                  &quot;apiKeyConfig&quot;: { # The API secret. # The API secret.
                    &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
                    &quot;apiKeyString&quot;: &quot;A String&quot;, # The API key string. Either this or `api_key_secret_version` must be set.
                  },
                },
                &quot;apiSpec&quot;: &quot;A String&quot;, # The API spec that the external API implements.
                &quot;authConfig&quot;: { # Auth configuration to run the extension. # The authentication config to access the API.
                  &quot;apiKeyConfig&quot;: { # Config for authentication with API key. # Config for API key auth.
                    &quot;apiKeySecret&quot;: &quot;A String&quot;, # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
                    &quot;apiKeyString&quot;: &quot;A String&quot;, # Optional. The API key to be used in the request directly.
                    &quot;httpElementLocation&quot;: &quot;A String&quot;, # Optional. The location of the API key.
                    &quot;name&quot;: &quot;A String&quot;, # Optional. The parameter name of the API key. E.g. If the API request is &quot;https://example.com/act?api_key=&quot;, &quot;api_key&quot; would be the parameter name.
                  },
                  &quot;authType&quot;: &quot;A String&quot;, # Type of auth scheme.
                  &quot;googleServiceAccountConfig&quot;: { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
                    &quot;serviceAccount&quot;: &quot;A String&quot;, # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
                  },
                  &quot;httpBasicAuthConfig&quot;: { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
                    &quot;credentialSecret&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
                  },
                  &quot;oauthConfig&quot;: { # Config for user oauth. # Config for user oauth.
                    &quot;accessToken&quot;: &quot;A String&quot;, # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
                    &quot;serviceAccount&quot;: &quot;A String&quot;, # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
                  },
                  &quot;oidcConfig&quot;: { # Config for user OIDC auth. # Config for user OIDC auth.
                    &quot;idToken&quot;: &quot;A String&quot;, # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
                    &quot;serviceAccount&quot;: &quot;A String&quot;, # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
                  },
                },
                &quot;elasticSearchParams&quot;: { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
                  &quot;index&quot;: &quot;A String&quot;, # The ElasticSearch index to use.
                  &quot;numHits&quot;: 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
                  &quot;searchTemplate&quot;: &quot;A String&quot;, # The ElasticSearch search template to use.
                },
                &quot;endpoint&quot;: &quot;A String&quot;, # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
                &quot;simpleSearchParams&quot;: { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
                },
              },
              &quot;vertexAiSearch&quot;: { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
                &quot;dataStoreSpecs&quot;: [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
                  { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
                    &quot;dataStore&quot;: &quot;A String&quot;, # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
                    &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
                  },
                ],
                &quot;datastore&quot;: &quot;A String&quot;, # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
                &quot;engine&quot;: &quot;A String&quot;, # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
                &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter strings to be passed to the search API.
                &quot;maxResults&quot;: 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
              },
              &quot;vertexRagStore&quot;: { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
                &quot;ragCorpora&quot;: [ # Optional. Deprecated. Please use rag_resources instead.
                  &quot;A String&quot;,
                ],
                &quot;ragResources&quot;: [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
                  { # The definition of the Rag resource.
                    &quot;ragCorpus&quot;: &quot;A String&quot;, # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
                    &quot;ragFileIds&quot;: [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
                      &quot;A String&quot;,
                    ],
                  },
                ],
                &quot;ragRetrievalConfig&quot;: { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
                  &quot;filter&quot;: { # Config for filters. # Optional. Config for filters.
                    &quot;metadataFilter&quot;: &quot;A String&quot;, # Optional. String for metadata filtering.
                    &quot;vectorDistanceThreshold&quot;: 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
                    &quot;vectorSimilarityThreshold&quot;: 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
                  },
                  &quot;hybridSearch&quot;: { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
                    &quot;alpha&quot;: 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
                  },
                  &quot;ranking&quot;: { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
                    &quot;llmRanker&quot;: { # Config for LlmRanker. # Optional. Config for LlmRanker.
                      &quot;modelName&quot;: &quot;A String&quot;, # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
                    },
                    &quot;rankService&quot;: { # Config for Rank Service. # Optional. Config for Rank Service.
                      &quot;modelName&quot;: &quot;A String&quot;, # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
                    },
                  },
                  &quot;topK&quot;: 42, # Optional. The number of contexts to retrieve.
                },
                &quot;similarityTopK&quot;: 42, # Optional. Number of top k results to return from the selected corpora.
                &quot;storeContext&quot;: True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users&#x27; ongoing and future interactions.
                &quot;vectorDistanceThreshold&quot;: 3.14, # Optional. Only return results with vector distance smaller than the threshold.
              },
            },
            &quot;urlContext&quot;: { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
            },
          },
        ],
      },
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="assess">assess(name, body=None, x__xgafv=None)</code>
  <pre>Assesses the state or validity of the dataset with respect to a given use case.

Args:
  name: string, Required. The name of the Dataset resource. Used only for MULTIMODAL datasets. Format: `projects/{project}/locations/{location}/datasets/{dataset}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DatasetService.AssessData. Used only for MULTIMODAL datasets.
  &quot;batchPredictionResourceUsageAssessmentConfig&quot;: { # Configuration for the batch prediction resource usage assessment. # Optional. Configuration for the batch prediction resource usage assessment.
    &quot;modelName&quot;: &quot;A String&quot;, # Required. The name of the model used for batch prediction.
  },
  &quot;batchPredictionValidationAssessmentConfig&quot;: { # Configuration for the batch prediction validation assessment. # Optional. Configuration for the batch prediction validation assessment.
    &quot;modelName&quot;: &quot;A String&quot;, # Required. The name of the model used for batch prediction.
  },
  &quot;geminiRequestReadConfig&quot;: { # Configuration for how to read Gemini requests from a multimodal dataset. # Optional. The Gemini request read config for the dataset.
    &quot;assembledRequestColumnName&quot;: &quot;A String&quot;, # Optional. Column name in the dataset table that contains already fully assembled Gemini requests.
    &quot;templateConfig&quot;: { # Template configuration to create Gemini examples from a multimodal dataset. # Gemini request template with placeholders.
      &quot;fieldMapping&quot;: { # Required. Map of template parameters to the columns in the dataset table.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;geminiExample&quot;: { # Format for Gemini examples used for Vertex Multimodal datasets. # Required. The template that will be used for assembling the request to use for downstream applications.
        &quot;cachedContent&quot;: &quot;A String&quot;, # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
        &quot;contents&quot;: [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
          { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
            &quot;parts&quot;: [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
              { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
                &quot;codeExecutionResult&quot;: { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
                  &quot;outcome&quot;: &quot;A String&quot;, # Required. Outcome of the code execution.
                  &quot;output&quot;: &quot;A String&quot;, # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                },
                &quot;executableCode&quot;: { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
                  &quot;code&quot;: &quot;A String&quot;, # Required. The code to be executed.
                  &quot;language&quot;: &quot;A String&quot;, # Required. Programming language of the `code`.
                },
                &quot;fileData&quot;: { # URI based data. # Optional. URI based data.
                  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
                  &quot;fileUri&quot;: &quot;A String&quot;, # Required. URI.
                  &quot;mimeType&quot;: &quot;A String&quot;, # Required. The IANA standard MIME type of the source data.
                },
                &quot;functionCall&quot;: { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
                  &quot;args&quot;: { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;id&quot;: &quot;A String&quot;, # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                  &quot;name&quot;: &quot;A String&quot;, # Required. The name of the function to call. Matches [FunctionDeclaration.name].
                },
                &quot;functionResponse&quot;: { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
                  &quot;id&quot;: &quot;A String&quot;, # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                  &quot;name&quot;: &quot;A String&quot;, # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
                  &quot;response&quot;: { # Required. The function response in JSON object format. Use &quot;output&quot; key to specify function output and &quot;error&quot; key to specify error details (if any). If &quot;output&quot; and &quot;error&quot; keys are not specified, then whole &quot;response&quot; is treated as function output.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;inlineData&quot;: { # Content blob. # Optional. Inlined bytes data.
                  &quot;data&quot;: &quot;A String&quot;, # Required. Raw bytes.
                  &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
                  &quot;mimeType&quot;: &quot;A String&quot;, # Required. The IANA standard MIME type of the source data.
                },
                &quot;text&quot;: &quot;A String&quot;, # Optional. Text part (can be code).
                &quot;thought&quot;: True or False, # Optional. Indicates if the part is thought from the model.
                &quot;thoughtSignature&quot;: &quot;A String&quot;, # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
                &quot;videoMetadata&quot;: { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                  &quot;endOffset&quot;: &quot;A String&quot;, # Optional. The end offset of the video.
                  &quot;fps&quot;: 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
                  &quot;startOffset&quot;: &quot;A String&quot;, # Optional. The start offset of the video.
                },
              },
            ],
            &quot;role&quot;: &quot;A String&quot;, # Optional. The producer of the content. Must be either &#x27;user&#x27; or &#x27;model&#x27;. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
          },
        ],
        &quot;generationConfig&quot;: { # Generation config. # Optional. Generation config.
          &quot;audioTimestamp&quot;: True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
          &quot;candidateCount&quot;: 42, # Optional. Number of candidates to generate.
          &quot;enableAffectiveDialog&quot;: True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
          &quot;frequencyPenalty&quot;: 3.14, # Optional. Frequency penalties.
          &quot;logprobs&quot;: 42, # Optional. Logit probabilities.
          &quot;maxOutputTokens&quot;: 42, # Optional. The maximum number of output tokens to generate per message.
          &quot;mediaResolution&quot;: &quot;A String&quot;, # Optional. If specified, the media resolution specified will be used.
          &quot;modelConfig&quot;: { # Config for model selection. # Optional. Config for model selection.
            &quot;featureSelectionPreference&quot;: &quot;A String&quot;, # Required. Feature selection preference.
          },
          &quot;presencePenalty&quot;: 3.14, # Optional. Positive penalties.
          &quot;responseJsonSchema&quot;: &quot;&quot;, # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
          &quot;responseLogprobs&quot;: True or False, # Optional. If true, export the logprobs results in response.
          &quot;responseMimeType&quot;: &quot;A String&quot;, # 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.
          &quot;responseModalities&quot;: [ # Optional. The modalities of the response.
            &quot;A String&quot;,
          ],
          &quot;responseSchema&quot;: { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
            &quot;additionalProperties&quot;: &quot;&quot;, # Optional. Can either be a boolean or an object; controls the presence of additional properties.
            &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            ],
            &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
            &quot;defs&quot;: { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
              &quot;a_key&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
            &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
              &quot;A String&quot;,
            ],
            &quot;example&quot;: &quot;&quot;, # Optional. Example of the object. Will only populated when the object is the root.
            &quot;format&quot;: &quot;A String&quot;, # Optional. The format of the data. Supported formats: for NUMBER type: &quot;float&quot;, &quot;double&quot; for INTEGER type: &quot;int32&quot;, &quot;int64&quot; for STRING type: &quot;email&quot;, &quot;byte&quot;, etc
            &quot;items&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
            &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
            &quot;maxLength&quot;: &quot;A String&quot;, # Optional. Maximum length of the Type.STRING
            &quot;maxProperties&quot;: &quot;A String&quot;, # Optional. Maximum number of the properties for Type.OBJECT.
            &quot;maximum&quot;: 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
            &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
            &quot;minLength&quot;: &quot;A String&quot;, # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
            &quot;minProperties&quot;: &quot;A String&quot;, # Optional. Minimum number of the properties for Type.OBJECT.
            &quot;minimum&quot;: 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
            &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
            &quot;pattern&quot;: &quot;A String&quot;, # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
            &quot;properties&quot;: { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
              &quot;a_key&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            &quot;propertyOrdering&quot;: [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
              &quot;A String&quot;,
            ],
            &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring
            &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
              &quot;A String&quot;,
            ],
            &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the Schema.
            &quot;type&quot;: &quot;A String&quot;, # Optional. The type of the data.
          },
          &quot;routingConfig&quot;: { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
            &quot;autoMode&quot;: { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
              &quot;modelRoutingPreference&quot;: &quot;A String&quot;, # The model routing preference.
            },
            &quot;manualMode&quot;: { # When manual routing is set, the specified model will be used directly. # Manual routing.
              &quot;modelName&quot;: &quot;A String&quot;, # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
            },
          },
          &quot;seed&quot;: 42, # Optional. Seed.
          &quot;speechConfig&quot;: { # The speech generation config. # Optional. The speech generation config.
            &quot;languageCode&quot;: &quot;A String&quot;, # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
            &quot;voiceConfig&quot;: { # The configuration for the voice to use. # The configuration for the speaker to use.
              &quot;prebuiltVoiceConfig&quot;: { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
                &quot;voiceName&quot;: &quot;A String&quot;, # The name of the preset voice to use.
              },
            },
          },
          &quot;stopSequences&quot;: [ # Optional. Stop sequences.
            &quot;A String&quot;,
          ],
          &quot;temperature&quot;: 3.14, # Optional. Controls the randomness of predictions.
          &quot;thinkingConfig&quot;: { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don&#x27;t support thinking.
            &quot;includeThoughts&quot;: True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
            &quot;thinkingBudget&quot;: 42, # Optional. Indicates the thinking budget in tokens.
          },
          &quot;topK&quot;: 3.14, # Optional. If specified, top-k sampling will be used.
          &quot;topP&quot;: 3.14, # Optional. If specified, nucleus sampling will be used.
        },
        &quot;labels&quot;: { # 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.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
        &quot;model&quot;: &quot;A String&quot;, # Optional. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
        &quot;safetySettings&quot;: [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
          { # Safety settings.
            &quot;category&quot;: &quot;A String&quot;, # Required. Harm category.
            &quot;method&quot;: &quot;A String&quot;, # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
            &quot;threshold&quot;: &quot;A String&quot;, # Required. The harm block threshold.
          },
        ],
        &quot;systemInstruction&quot;: { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
          &quot;parts&quot;: [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
            { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
              &quot;codeExecutionResult&quot;: { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
                &quot;outcome&quot;: &quot;A String&quot;, # Required. Outcome of the code execution.
                &quot;output&quot;: &quot;A String&quot;, # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
              },
              &quot;executableCode&quot;: { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
                &quot;code&quot;: &quot;A String&quot;, # Required. The code to be executed.
                &quot;language&quot;: &quot;A String&quot;, # Required. Programming language of the `code`.
              },
              &quot;fileData&quot;: { # URI based data. # Optional. URI based data.
                &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
                &quot;fileUri&quot;: &quot;A String&quot;, # Required. URI.
                &quot;mimeType&quot;: &quot;A String&quot;, # Required. The IANA standard MIME type of the source data.
              },
              &quot;functionCall&quot;: { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
                &quot;args&quot;: { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;id&quot;: &quot;A String&quot;, # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                &quot;name&quot;: &quot;A String&quot;, # Required. The name of the function to call. Matches [FunctionDeclaration.name].
              },
              &quot;functionResponse&quot;: { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
                &quot;id&quot;: &quot;A String&quot;, # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                &quot;name&quot;: &quot;A String&quot;, # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
                &quot;response&quot;: { # Required. The function response in JSON object format. Use &quot;output&quot; key to specify function output and &quot;error&quot; key to specify error details (if any). If &quot;output&quot; and &quot;error&quot; keys are not specified, then whole &quot;response&quot; is treated as function output.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
              },
              &quot;inlineData&quot;: { # Content blob. # Optional. Inlined bytes data.
                &quot;data&quot;: &quot;A String&quot;, # Required. Raw bytes.
                &quot;displayName&quot;: &quot;A String&quot;, # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
                &quot;mimeType&quot;: &quot;A String&quot;, # Required. The IANA standard MIME type of the source data.
              },
              &quot;text&quot;: &quot;A String&quot;, # Optional. Text part (can be code).
              &quot;thought&quot;: True or False, # Optional. Indicates if the part is thought from the model.
              &quot;thoughtSignature&quot;: &quot;A String&quot;, # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
              &quot;videoMetadata&quot;: { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                &quot;endOffset&quot;: &quot;A String&quot;, # Optional. The end offset of the video.
                &quot;fps&quot;: 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
                &quot;startOffset&quot;: &quot;A String&quot;, # Optional. The start offset of the video.
              },
            },
          ],
          &quot;role&quot;: &quot;A String&quot;, # Optional. The producer of the content. Must be either &#x27;user&#x27; or &#x27;model&#x27;. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
        },
        &quot;toolConfig&quot;: { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request.
          &quot;functionCallingConfig&quot;: { # Function calling config. # Optional. Function calling config.
            &quot;allowedFunctionNames&quot;: [ # Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.
              &quot;A String&quot;,
            ],
            &quot;mode&quot;: &quot;A String&quot;, # Optional. Function calling mode.
          },
          &quot;retrievalConfig&quot;: { # Retrieval config. # Optional. Retrieval config.
            &quot;languageCode&quot;: &quot;A String&quot;, # The language code of the user.
            &quot;latLng&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
              &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
              &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
            },
          },
        },
        &quot;tools&quot;: [ # Optional. A list of `Tools` the model may use to generate the next response. 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.
          { # Tool details that the model may use to generate response. 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
            &quot;codeExecution&quot;: { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
            },
            &quot;enterpriseWebSearch&quot;: { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
              &quot;excludeDomains&quot;: [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
                &quot;A String&quot;,
              ],
            },
            &quot;functionDeclarations&quot;: [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
              { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
                &quot;description&quot;: &quot;A String&quot;, # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
                &quot;name&quot;: &quot;A String&quot;, # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.
                &quot;parameters&quot;: { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
                  &quot;additionalProperties&quot;: &quot;&quot;, # Optional. Can either be a boolean or an object; controls the presence of additional properties.
                  &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
                    # Object with schema name: GoogleCloudAiplatformV1beta1Schema
                  ],
                  &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
                  &quot;defs&quot;: { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
                    &quot;a_key&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema
                  },
                  &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
                  &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
                    &quot;A String&quot;,
                  ],
                  &quot;example&quot;: &quot;&quot;, # Optional. Example of the object. Will only populated when the object is the root.
                  &quot;format&quot;: &quot;A String&quot;, # Optional. The format of the data. Supported formats: for NUMBER type: &quot;float&quot;, &quot;double&quot; for INTEGER type: &quot;int32&quot;, &quot;int64&quot; for STRING type: &quot;email&quot;, &quot;byte&quot;, etc
                  &quot;items&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
                  &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
                  &quot;maxLength&quot;: &quot;A String&quot;, # Optional. Maximum length of the Type.STRING
                  &quot;maxProperties&quot;: &quot;A String&quot;, # Optional. Maximum number of the properties for Type.OBJECT.
                  &quot;maximum&quot;: 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
                  &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
                  &quot;minLength&quot;: &quot;A String&quot;, # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
                  &quot;minProperties&quot;: &quot;A String&quot;, # Optional. Minimum number of the properties for Type.OBJECT.
                  &quot;minimum&quot;: 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
                  &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
                  &quot;pattern&quot;: &quot;A String&quot;, # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
                  &quot;properties&quot;: { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
                    &quot;a_key&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema
                  },
                  &quot;propertyOrdering&quot;: [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
                    &quot;A String&quot;,
                  ],
                  &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring
                  &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
                    &quot;A String&quot;,
                  ],
                  &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the Schema.
                  &quot;type&quot;: &quot;A String&quot;, # Optional. The type of the data.
                },
                &quot;parametersJsonSchema&quot;: &quot;&quot;, # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { &quot;type&quot;: &quot;object&quot;, &quot;properties&quot;: { &quot;name&quot;: { &quot;type&quot;: &quot;string&quot; }, &quot;age&quot;: { &quot;type&quot;: &quot;integer&quot; } }, &quot;additionalProperties&quot;: false, &quot;required&quot;: [&quot;name&quot;, &quot;age&quot;], &quot;propertyOrdering&quot;: [&quot;name&quot;, &quot;age&quot;] } ``` This field is mutually exclusive with `parameters`.
                &quot;response&quot;: { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
                  &quot;additionalProperties&quot;: &quot;&quot;, # Optional. Can either be a boolean or an object; controls the presence of additional properties.
                  &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
                    # Object with schema name: GoogleCloudAiplatformV1beta1Schema
                  ],
                  &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
                  &quot;defs&quot;: { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
                    &quot;a_key&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema
                  },
                  &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
                  &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
                    &quot;A String&quot;,
                  ],
                  &quot;example&quot;: &quot;&quot;, # Optional. Example of the object. Will only populated when the object is the root.
                  &quot;format&quot;: &quot;A String&quot;, # Optional. The format of the data. Supported formats: for NUMBER type: &quot;float&quot;, &quot;double&quot; for INTEGER type: &quot;int32&quot;, &quot;int64&quot; for STRING type: &quot;email&quot;, &quot;byte&quot;, etc
                  &quot;items&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
                  &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
                  &quot;maxLength&quot;: &quot;A String&quot;, # Optional. Maximum length of the Type.STRING
                  &quot;maxProperties&quot;: &quot;A String&quot;, # Optional. Maximum number of the properties for Type.OBJECT.
                  &quot;maximum&quot;: 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
                  &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
                  &quot;minLength&quot;: &quot;A String&quot;, # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
                  &quot;minProperties&quot;: &quot;A String&quot;, # Optional. Minimum number of the properties for Type.OBJECT.
                  &quot;minimum&quot;: 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
                  &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
                  &quot;pattern&quot;: &quot;A String&quot;, # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
                  &quot;properties&quot;: { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
                    &quot;a_key&quot;: # Object with schema name: GoogleCloudAiplatformV1beta1Schema
                  },
                  &quot;propertyOrdering&quot;: [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
                    &quot;A String&quot;,
                  ],
                  &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring
                  &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
                    &quot;A String&quot;,
                  ],
                  &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the Schema.
                  &quot;type&quot;: &quot;A String&quot;, # Optional. The type of the data.
                },
                &quot;responseJsonSchema&quot;: &quot;&quot;, # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
              },
            ],
            &quot;googleMaps&quot;: { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
            },
            &quot;googleSearch&quot;: { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
              &quot;excludeDomains&quot;: [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: [&quot;amazon.com&quot;, &quot;facebook.com&quot;].
                &quot;A String&quot;,
              ],
            },
            &quot;googleSearchRetrieval&quot;: { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
              &quot;dynamicRetrievalConfig&quot;: { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
                &quot;dynamicThreshold&quot;: 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
                &quot;mode&quot;: &quot;A String&quot;, # The mode of the predictor to be used in dynamic retrieval.
              },
            },
            &quot;retrieval&quot;: { # 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.
              &quot;disableAttribution&quot;: True or False, # Optional. Deprecated. This option is no longer supported.
              &quot;externalApi&quot;: { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
                &quot;apiAuth&quot;: { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
                  &quot;apiKeyConfig&quot;: { # The API secret. # The API secret.
                    &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
                    &quot;apiKeyString&quot;: &quot;A String&quot;, # The API key string. Either this or `api_key_secret_version` must be set.
                  },
                },
                &quot;apiSpec&quot;: &quot;A String&quot;, # The API spec that the external API implements.
                &quot;authConfig&quot;: { # Auth configuration to run the extension. # The authentication config to access the API.
                  &quot;apiKeyConfig&quot;: { # Config for authentication with API key. # Config for API key auth.
                    &quot;apiKeySecret&quot;: &quot;A String&quot;, # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
                    &quot;apiKeyString&quot;: &quot;A String&quot;, # Optional. The API key to be used in the request directly.
                    &quot;httpElementLocation&quot;: &quot;A String&quot;, # Optional. The location of the API key.
                    &quot;name&quot;: &quot;A String&quot;, # Optional. The parameter name of the API key. E.g. If the API request is &quot;https://example.com/act?api_key=&quot;, &quot;api_key&quot; would be the parameter name.
                  },
                  &quot;authType&quot;: &quot;A String&quot;, # Type of auth scheme.
                  &quot;googleServiceAccountConfig&quot;: { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
                    &quot;serviceAccount&quot;: &quot;A String&quot;, # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
                  },
                  &quot;httpBasicAuthConfig&quot;: { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
                    &quot;credentialSecret&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
                  },
                  &quot;oauthConfig&quot;: { # Config for user oauth. # Config for user oauth.
                    &quot;accessToken&quot;: &quot;A String&quot;, # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
                    &quot;serviceAccount&quot;: &quot;A String&quot;, # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
                  },
                  &quot;oidcConfig&quot;: { # Config for user OIDC auth. # Config for user OIDC auth.
                    &quot;idToken&quot;: &quot;A String&quot;, # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
                    &quot;serviceAccount&quot;: &quot;A String&quot;, # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
                  },
                },
                &quot;elasticSearchParams&quot;: { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
                  &quot;index&quot;: &quot;A String&quot;, # The ElasticSearch index to use.
                  &quot;numHits&quot;: 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
                  &quot;searchTemplate&quot;: &quot;A String&quot;, # The ElasticSearch search template to use.
                },
                &quot;endpoint&quot;: &quot;A String&quot;, # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
                &quot;simpleSearchParams&quot;: { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
                },
              },
              &quot;vertexAiSearch&quot;: { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
                &quot;dataStoreSpecs&quot;: [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
                  { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
                    &quot;dataStore&quot;: &quot;A String&quot;, # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
                    &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
                  },
                ],
                &quot;datastore&quot;: &quot;A String&quot;, # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
                &quot;engine&quot;: &quot;A String&quot;, # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
                &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter strings to be passed to the search API.
                &quot;maxResults&quot;: 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
              },
              &quot;vertexRagStore&quot;: { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
                &quot;ragCorpora&quot;: [ # Optional. Deprecated. Please use rag_resources instead.
                  &quot;A String&quot;,
                ],
                &quot;ragResources&quot;: [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
                  { # The definition of the Rag resource.
                    &quot;ragCorpus&quot;: &quot;A String&quot;, # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
                    &quot;ragFileIds&quot;: [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
                      &quot;A String&quot;,
                    ],
                  },
                ],
                &quot;ragRetrievalConfig&quot;: { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
                  &quot;filter&quot;: { # Config for filters. # Optional. Config for filters.
                    &quot;metadataFilter&quot;: &quot;A String&quot;, # Optional. String for metadata filtering.
                    &quot;vectorDistanceThreshold&quot;: 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
                    &quot;vectorSimilarityThreshold&quot;: 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
                  },
                  &quot;hybridSearch&quot;: { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
                    &quot;alpha&quot;: 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
                  },
                  &quot;ranking&quot;: { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
                    &quot;llmRanker&quot;: { # Config for LlmRanker. # Optional. Config for LlmRanker.
                      &quot;modelName&quot;: &quot;A String&quot;, # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
                    },
                    &quot;rankService&quot;: { # Config for Rank Service. # Optional. Config for Rank Service.
                      &quot;modelName&quot;: &quot;A String&quot;, # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
                    },
                  },
                  &quot;topK&quot;: 42, # Optional. The number of contexts to retrieve.
                },
                &quot;similarityTopK&quot;: 42, # Optional. Number of top k results to return from the selected corpora.
                &quot;storeContext&quot;: True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users&#x27; ongoing and future interactions.
                &quot;vectorDistanceThreshold&quot;: 3.14, # Optional. Only return results with vector distance smaller than the threshold.
              },
            },
            &quot;urlContext&quot;: { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
            },
          },
        ],
      },
    },
  },
  &quot;tuningResourceUsageAssessmentConfig&quot;: { # Configuration for the tuning resource usage assessment. # Optional. Configuration for the tuning resource usage assessment.
    &quot;modelName&quot;: &quot;A String&quot;, # Required. The name of the model used for tuning.
  },
  &quot;tuningValidationAssessmentConfig&quot;: { # Configuration for the tuning validation assessment. # Optional. Configuration for the tuning validation assessment.
    &quot;datasetUsage&quot;: &quot;A String&quot;, # Required. The dataset usage (e.g. training/validation).
    &quot;modelName&quot;: &quot;A String&quot;, # Required. The name of the model used for tuning.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a Dataset.

Args:
  parent: string, Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A collection of DataItems and Annotations on them.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was created.
  &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.
  &quot;description&quot;: &quot;A String&quot;, # The description of the Dataset.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.
    &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
  },
  &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
  &quot;labels&quot;: { # The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable. Following system labels exist for each Dataset: * &quot;aiplatform.googleapis.com/dataset_metadata_schema&quot;: output only, its value is the metadata_schema&#x27;s title.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;metadata&quot;: &quot;&quot;, # Required. Additional information about the Dataset.
  &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
  &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
  &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
  &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
  &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
  &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
    { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
      &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
      &quot;annotationSpecCount&quot;: 42, # Output only. Number of AnnotationSpecs in the context of the SavedQuery.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this SavedQuery was created.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters.
      &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write update. If not set, a blind &quot;overwrite&quot; update happens.
      &quot;metadata&quot;: &quot;&quot;, # Some additional information about the SavedQuery.
      &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the SavedQuery.
      &quot;problemType&quot;: &quot;A String&quot;, # Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
      &quot;supportAutomlTraining&quot;: True or False, # Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when SavedQuery was last updated.
    },
  ],
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was last updated.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a Dataset.

Args:
  name: string, Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="export">export(name, body=None, x__xgafv=None)</code>
  <pre>Exports data from a Dataset.

Args:
  name: string, Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DatasetService.ExportData.
  &quot;exportConfig&quot;: { # Describes what part of the Dataset is to be exported, the destination of the export and how to export. # Required. The desired output location.
    &quot;annotationsFilter&quot;: &quot;A String&quot;, # An expression for filtering what part of the Dataset is to be exported. Only Annotations that match this filter will be exported. The filter syntax is the same as in ListAnnotations.
    &quot;fractionSplit&quot;: { # Assigns the input data to training, validation, and test sets as per the given fractions. Any of `training_fraction`, `validation_fraction` and `test_fraction` may optionally be provided, they must sum to up to 1. If the provided ones sum to less than 1, the remainder is assigned to sets as decided by Vertex AI. If none of the fractions are set, by default roughly 80% of data is used for training, 10% for validation, and 10% for test. # Split based on fractions defining the size of each set.
      &quot;testFraction&quot;: 3.14, # The fraction of the input data that is to be used to evaluate the Model.
      &quot;trainingFraction&quot;: 3.14, # The fraction of the input data that is to be used to train the Model.
      &quot;validationFraction&quot;: 3.14, # The fraction of the input data that is to be used to validate the Model.
    },
    &quot;gcsDestination&quot;: { # The Google Cloud Storage location where the output is to be written to. # The Google Cloud Storage location where the output is to be written to. In the given directory a new directory will be created with name: `export-data--` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export output will be written into that directory. Inside that directory, annotations with the same schema will be grouped into sub directories which are named with the corresponding annotations&#x27; schema title. Inside these sub directories, a schema.yaml will be created to describe the output format.
      &quot;outputUriPrefix&quot;: &quot;A String&quot;, # Required. Google Cloud Storage URI to output directory. If the uri doesn&#x27;t end with &#x27;/&#x27;, a &#x27;/&#x27; will be automatically appended. The directory is created if it doesn&#x27;t exist.
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, readMask=None, x__xgafv=None)</code>
  <pre>Gets a Dataset.

Args:
  name: string, Required. The name of the Dataset resource. (required)
  readMask: string, Mask specifying which fields to read.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A collection of DataItems and Annotations on them.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was created.
  &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.
  &quot;description&quot;: &quot;A String&quot;, # The description of the Dataset.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.
    &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
  },
  &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
  &quot;labels&quot;: { # The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable. Following system labels exist for each Dataset: * &quot;aiplatform.googleapis.com/dataset_metadata_schema&quot;: output only, its value is the metadata_schema&#x27;s title.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;metadata&quot;: &quot;&quot;, # Required. Additional information about the Dataset.
  &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
  &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
  &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
  &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
  &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
  &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
    { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
      &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
      &quot;annotationSpecCount&quot;: 42, # Output only. Number of AnnotationSpecs in the context of the SavedQuery.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this SavedQuery was created.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters.
      &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write update. If not set, a blind &quot;overwrite&quot; update happens.
      &quot;metadata&quot;: &quot;&quot;, # Some additional information about the SavedQuery.
      &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the SavedQuery.
      &quot;problemType&quot;: &quot;A String&quot;, # Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
      &quot;supportAutomlTraining&quot;: True or False, # Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when SavedQuery was last updated.
    },
  ],
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was last updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="import_">import_(name, body=None, x__xgafv=None)</code>
  <pre>Imports data into a Dataset.

Args:
  name: string, Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DatasetService.ImportData.
  &quot;importConfigs&quot;: [ # Required. The desired input locations. The contents of all input locations will be imported in one batch.
    { # Describes the location from where we import data into a Dataset, together with the labels that will be applied to the DataItems and the Annotations.
      &quot;annotationLabels&quot;: { # Labels that will be applied to newly imported Annotations. If two Annotations are identical, one of them will be deduped. Two Annotations are considered identical if their payload, payload_schema_uri and all of their labels are the same. These labels will be overridden by Annotation labels specified inside index file referenced by import_schema_uri, e.g. jsonl file.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;dataItemLabels&quot;: { # Labels that will be applied to newly imported DataItems. If an identical DataItem as one being imported already exists in the Dataset, then these labels will be appended to these of the already existing one, and if labels with identical key is imported before, the old label value will be overwritten. If two DataItems are identical in the same import data operation, the labels will be combined and if key collision happens in this case, one of the values will be picked randomly. Two DataItems are considered identical if their content bytes are identical (e.g. image bytes or pdf bytes). These labels will be overridden by Annotation labels specified inside index file referenced by import_schema_uri, e.g. jsonl file.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;gcsSource&quot;: { # The Google Cloud Storage location for the input content. # The Google Cloud Storage location for the input content.
        &quot;uris&quot;: [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
          &quot;A String&quot;,
        ],
      },
      &quot;importSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing the import format. Validation will be done against the schema. The schema is defined as an [OpenAPI 3.0.2 Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</code>
  <pre>Lists Datasets in a Location.

Args:
  parent: string, Required. The name of the Dataset&#x27;s parent resource. Format: `projects/{project}/locations/{location}` (required)
  filter: string, An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.&quot;a key&quot;`. Some examples: * `displayName=&quot;myDisplayName&quot;` * `labels.myKey=&quot;myValue&quot;`
  orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use &quot;desc&quot; after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`
  pageSize: integer, The standard list page size.
  pageToken: string, The standard list page token.
  readMask: string, Mask specifying which fields to read.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for DatasetService.ListDatasets.
  &quot;datasets&quot;: [ # A list of Datasets that matches the specified filter in the request.
    { # A collection of DataItems and Annotations on them.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was created.
      &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.
      &quot;description&quot;: &quot;A String&quot;, # The description of the Dataset.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
      &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.
        &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
      },
      &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
      &quot;labels&quot;: { # The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable. Following system labels exist for each Dataset: * &quot;aiplatform.googleapis.com/dataset_metadata_schema&quot;: output only, its value is the metadata_schema&#x27;s title.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;metadata&quot;: &quot;&quot;, # Required. Additional information about the Dataset.
      &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
      &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
      &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
      &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
      &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
      &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
      &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
        { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
          &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
          &quot;annotationSpecCount&quot;: 42, # Output only. Number of AnnotationSpecs in the context of the SavedQuery.
          &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this SavedQuery was created.
          &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters.
          &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write update. If not set, a blind &quot;overwrite&quot; update happens.
          &quot;metadata&quot;: &quot;&quot;, # Some additional information about the SavedQuery.
          &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the SavedQuery.
          &quot;problemType&quot;: &quot;A String&quot;, # Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
          &quot;supportAutomlTraining&quot;: True or False, # Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
          &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when SavedQuery was last updated.
        },
      ],
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was last updated.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates a Dataset.

Args:
  name: string, Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A collection of DataItems and Annotations on them.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was created.
  &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.
  &quot;description&quot;: &quot;A String&quot;, # The description of the Dataset.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.
    &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
  },
  &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
  &quot;labels&quot;: { # The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable. Following system labels exist for each Dataset: * &quot;aiplatform.googleapis.com/dataset_metadata_schema&quot;: output only, its value is the metadata_schema&#x27;s title.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;metadata&quot;: &quot;&quot;, # Required. Additional information about the Dataset.
  &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
  &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
  &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
  &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
  &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
  &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
    { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
      &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
      &quot;annotationSpecCount&quot;: 42, # Output only. Number of AnnotationSpecs in the context of the SavedQuery.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this SavedQuery was created.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters.
      &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write update. If not set, a blind &quot;overwrite&quot; update happens.
      &quot;metadata&quot;: &quot;&quot;, # Some additional information about the SavedQuery.
      &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the SavedQuery.
      &quot;problemType&quot;: &quot;A String&quot;, # Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
      &quot;supportAutomlTraining&quot;: True or False, # Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when SavedQuery was last updated.
    },
  ],
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was last updated.
}

  updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A collection of DataItems and Annotations on them.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was created.
  &quot;dataItemCount&quot;: &quot;A String&quot;, # Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.
  &quot;description&quot;: &quot;A String&quot;, # The description of the Dataset.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.
    &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
  },
  &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
  &quot;labels&quot;: { # The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable. Following system labels exist for each Dataset: * &quot;aiplatform.googleapis.com/dataset_metadata_schema&quot;: output only, its value is the metadata_schema&#x27;s title.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;metadata&quot;: &quot;&quot;, # Required. Additional information about the Dataset.
  &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
  &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
  &quot;modelReference&quot;: &quot;A String&quot;, # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
  &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
  &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
  &quot;savedQueries&quot;: [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
    { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
      &quot;annotationFilter&quot;: &quot;A String&quot;, # Output only. Filters on the Annotations in the dataset.
      &quot;annotationSpecCount&quot;: 42, # Output only. Number of AnnotationSpecs in the context of the SavedQuery.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this SavedQuery was created.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters.
      &quot;etag&quot;: &quot;A String&quot;, # Used to perform a consistent read-modify-write update. If not set, a blind &quot;overwrite&quot; update happens.
      &quot;metadata&quot;: &quot;&quot;, # Some additional information about the SavedQuery.
      &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the SavedQuery.
      &quot;problemType&quot;: &quot;A String&quot;, # Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
      &quot;supportAutomlTraining&quot;: True or False, # Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when SavedQuery was last updated.
    },
  ],
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Dataset was last updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="searchDataItems">searchDataItems(dataset, annotationFilters=None, annotationsFilter=None, annotationsLimit=None, dataItemFilter=None, dataLabelingJob=None, fieldMask=None, orderBy=None, orderByAnnotation_orderBy=None, orderByAnnotation_savedQuery=None, orderByDataItem=None, pageSize=None, pageToken=None, savedQuery=None, x__xgafv=None)</code>
  <pre>Searches DataItems in a Dataset.

Args:
  dataset: string, Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}` (required)
  annotationFilters: string, An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to. (repeated)
  annotationsFilter: string, An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
  annotationsLimit: integer, If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.
  dataItemFilter: string, An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`
  dataLabelingJob: string, The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.
  fieldMask: string, Mask specifying which fields of DataItemView to read.
  orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use &quot;desc&quot; after a field name for descending.
  orderByAnnotation_orderBy: string, A comma-separated list of annotation fields to order by, sorted in ascending order. Use &quot;desc&quot; after a field name for descending. Must also specify saved_query.
  orderByAnnotation_savedQuery: string, Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.
  orderByDataItem: string, A comma-separated list of data item fields to order by, sorted in ascending order. Use &quot;desc&quot; after a field name for descending.
  pageSize: integer, Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.
  pageToken: string, A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.
  savedQuery: string, The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for DatasetService.SearchDataItems.
  &quot;dataItemViews&quot;: [ # The DataItemViews read.
    { # A container for a single DataItem and Annotations on it.
      &quot;annotations&quot;: [ # The Annotations on the DataItem. If too many Annotations should be returned for the DataItem, this field will be truncated per annotations_limit in request. If it was, then the has_truncated_annotations will be set to true.
        { # Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.
          &quot;annotationSource&quot;: { # References an API call. It contains more information about long running operation and Jobs that are triggered by the API call. # Output only. The source of the Annotation.
            &quot;dataLabelingJob&quot;: &quot;A String&quot;, # For API calls that start a LabelingJob. Resource name of the LabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
            &quot;method&quot;: &quot;A String&quot;, # The method name of the API RPC call. For example, &quot;/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset&quot;
            &quot;operation&quot;: &quot;A String&quot;, # For API calls that return a long running operation. Resource name of the long running operation. Format: `projects/{project}/locations/{location}/operations/{operation}`
          },
          &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Annotation was created.
          &quot;etag&quot;: &quot;A String&quot;, # Optional. Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
          &quot;labels&quot;: { # Optional. The labels with user-defined metadata to organize your Annotations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Annotation(System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable. Following system labels exist for each Annotation: * &quot;aiplatform.googleapis.com/annotation_set_name&quot;: optional, name of the UI&#x27;s annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI. * &quot;aiplatform.googleapis.com/payload_schema&quot;: output only, its value is the payload_schema&#x27;s title.
            &quot;a_key&quot;: &quot;A String&quot;,
          },
          &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Annotation.
          &quot;payload&quot;: &quot;&quot;, # Required. The schema of the payload can be found in payload_schema.
          &quot;payloadSchemaUri&quot;: &quot;A String&quot;, # Required. Google Cloud Storage URI points to a YAML file describing payload. The schema is defined as an [OpenAPI 3.0.2 Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with the parent Dataset&#x27;s metadata.
          &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Annotation was last updated.
        },
      ],
      &quot;dataItem&quot;: { # A piece of data in a Dataset. Could be an image, a video, a document or plain text. # The DataItem.
        &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DataItem was created.
        &quot;etag&quot;: &quot;A String&quot;, # Optional. Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
        &quot;labels&quot;: { # Optional. The labels with user-defined metadata to organize your DataItems. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one DataItem(System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
        &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the DataItem.
        &quot;payload&quot;: &quot;&quot;, # Required. The data that the DataItem represents (for example, an image or a text snippet). The schema of the payload is stored in the parent Dataset&#x27;s metadata schema&#x27;s dataItemSchemaUri field.
        &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
        &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
        &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DataItem was last updated.
      },
      &quot;hasTruncatedAnnotations&quot;: True or False, # True if and only if the Annotations field has been truncated. It happens if more Annotations for this DataItem met the request&#x27;s annotation_filter than are allowed to be returned by annotations_limit. Note that if Annotations field is not being returned due to field mask, then this field will not be set to true no matter how many Annotations are there.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve next page of results. Pass to SearchDataItemsRequest.page_token to obtain that page.
}</pre>
</div>

<div class="method">
    <code class="details" id="searchDataItems_next">searchDataItems_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>