File: aiplatform_v1beta1.projects.locations.exampleStores.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 (1012 lines) | stat: -rw-r--r-- 103,304 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.exampleStores.html">exampleStores</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="aiplatform_v1beta1.projects.locations.exampleStores.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</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, exampleStore_createTime=None, exampleStore_description=None, exampleStore_displayName=None, exampleStore_exampleStoreConfig_vertexEmbeddingModel=None, exampleStore_name=None, exampleStore_updateTime=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create an ExampleStore.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete an ExampleStore.</p>
<p class="toc_element">
  <code><a href="#fetchExamples">fetchExamples(exampleStore, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get Examples from the Example Store.</p>
<p class="toc_element">
  <code><a href="#fetchExamples_next">fetchExamples_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get an ExampleStore.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List ExampleStores 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">Update an ExampleStore.</p>
<p class="toc_element">
  <code><a href="#removeExamples">removeExamples(exampleStore, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Remove Examples from the Example Store.</p>
<p class="toc_element">
  <code><a href="#searchExamples">searchExamples(exampleStore, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Search for similar Examples for given selection criteria.</p>
<p class="toc_element">
  <code><a href="#upsertExamples">upsertExamples(exampleStore, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create or update Examples in the Example Store.</p>
<h3>Method Details</h3>
<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, exampleStore_createTime=None, exampleStore_description=None, exampleStore_displayName=None, exampleStore_exampleStoreConfig_vertexEmbeddingModel=None, exampleStore_name=None, exampleStore_updateTime=None, x__xgafv=None)</code>
  <pre>Create an ExampleStore.

Args:
  parent: string, Required. The resource name of the Location to create the ExampleStore in. Format: `projects/{project}/locations/{location}` (required)
  exampleStore_createTime: string, Output only. Timestamp when this ExampleStore was created.
  exampleStore_description: string, Optional. Description of the ExampleStore.
  exampleStore_displayName: string, Required. Display name of the ExampleStore.
  exampleStore_exampleStoreConfig_vertexEmbeddingModel: string, Required. The embedding model to be used for vector embedding. Immutable. Supported models: * &quot;text-embedding-005&quot; * &quot;text-multilingual-embedding-002&quot;
  exampleStore_name: string, Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}
  exampleStore_updateTime: string, Output only. Timestamp when this ExampleStore was most recently 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>Delete an ExampleStore.

Args:
  name: string, Required. The resource name of the ExampleStore to be deleted. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}` (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="fetchExamples">fetchExamples(exampleStore, body=None, x__xgafv=None)</code>
  <pre>Get Examples from the Example Store.

Args:
  exampleStore: string, Required. The name of the ExampleStore resource that the examples should be fetched from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ExampleStoreService.FetchExamples.
  &quot;exampleIds&quot;: [ # Optional. Example IDs to fetch. If both metadata filters and Example IDs are specified, then both ID and metadata filtering will be applied.
    &quot;A String&quot;,
  ],
  &quot;pageSize&quot;: 42, # Optional. The maximum number of examples to return. The service may return fewer than this value. If unspecified, at most 100 examples will be returned.
  &quot;pageToken&quot;: &quot;A String&quot;, # Optional. The next_page_token value returned from a previous list ExampleStoreService.FetchExamplesResponse call.
  &quot;storedContentsExampleFilter&quot;: { # The metadata filters that will be used to remove or fetch StoredContentsExamples. If a field is unspecified, then no filtering for that field will be applied. # The metadata filters for StoredContentsExamples.
    &quot;functionNames&quot;: { # Filters for examples&#x27; array metadata fields. An array field is example metadata where multiple values are attributed to a single example. # Optional. The function names for filtering.
      &quot;arrayOperator&quot;: &quot;A String&quot;, # Required. The operator logic to use for filtering.
      &quot;values&quot;: [ # Required. The values by which to filter examples.
        &quot;A String&quot;,
      ],
    },
    &quot;searchKeys&quot;: [ # Optional. The search keys for filtering. Only examples with one of the specified search keys (StoredContentsExample.search_key) are eligible to be returned.
      &quot;A String&quot;,
    ],
  },
}

  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 ExampleStoreService.FetchExamples.
  &quot;examples&quot;: [ # The examples in the Example Store that satisfy the metadata filters.
    {
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Example was created.
      &quot;displayName&quot;: &quot;A String&quot;, # Optional. The display name for Example.
      &quot;exampleId&quot;: &quot;A String&quot;, # Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.
      &quot;storedContentsExample&quot;: { # A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store. # An example of chat history and its expected outcome to be used with GenerateContent.
        &quot;contentsExample&quot;: { # A single example of a conversation with the model. # Required. The example to be used with GenerateContent.
          &quot;contents&quot;: [ # Required. The content of the conversation with the model that resulted in the expected output.
            { # 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;expectedContents&quot;: [ # Required. The expected output for the given `contents`. To represent multi-step reasoning, this is a repeated field that contains the iterative steps of the expected output.
            { # A single step of the expected output.
              &quot;content&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. # Required. A single step&#x27;s content.
                &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;searchKey&quot;: &quot;A String&quot;, # Optional. (Optional) the search key used for retrieval. If not provided at upload-time, the search key will be generated from `contents_example.contents` using the method provided by `search_key_generation_method`. The generated search key will be included in retrieved examples.
        &quot;searchKeyGenerationMethod&quot;: { # Options for generating the search key from the conversation history. # Optional. The method used to generate the search key from `contents_example.contents`. This is ignored when uploading an example if `search_key` is provided.
          &quot;lastEntry&quot;: { # Configuration for using only the last entry of the conversation history as the search key. # Use only the last entry of the conversation history (`contents_example.contents`) as the search key.
          },
        },
      },
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as FetchExamplesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
}</pre>
</div>

<div class="method">
    <code class="details" id="fetchExamples_next">fetchExamples_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="get">get(name, x__xgafv=None)</code>
  <pre>Get an ExampleStore.

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

Returns:
  An object of the form:

    { # Represents an executable service to manage and retrieve examples.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this ExampleStore was created.
  &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the ExampleStore.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the ExampleStore.
  &quot;exampleStoreConfig&quot;: { # Configuration for the Example Store. # Required. Example Store config.
    &quot;vertexEmbeddingModel&quot;: &quot;A String&quot;, # Required. The embedding model to be used for vector embedding. Immutable. Supported models: * &quot;text-embedding-005&quot; * &quot;text-multilingual-embedding-002&quot;
  },
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this ExampleStore was most recently updated.
}</pre>
</div>

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

Args:
  parent: string, Required. The resource name of the Location to list the ExampleStores from. Format: `projects/{project}/locations/{location}` (required)
  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
  pageSize: integer, Optional. The standard list page size.
  pageToken: string, Optional. The standard list page token.
  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 ExampleStoreService.ListExampleStores.
  &quot;exampleStores&quot;: [ # List of ExampleStore in the requested page.
    { # Represents an executable service to manage and retrieve examples.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this ExampleStore was created.
      &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the ExampleStore.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the ExampleStore.
      &quot;exampleStoreConfig&quot;: { # Configuration for the Example Store. # Required. Example Store config.
        &quot;vertexEmbeddingModel&quot;: &quot;A String&quot;, # Required. The embedding model to be used for vector embedding. Immutable. Supported models: * &quot;text-embedding-005&quot; * &quot;text-multilingual-embedding-002&quot;
      },
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this ExampleStore was most recently updated.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Pass to ListExampleStoresRequest.page_token to obtain that page.
}</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>Update an ExampleStore.

Args:
  name: string, Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store} (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents an executable service to manage and retrieve examples.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this ExampleStore was created.
  &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the ExampleStore.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the ExampleStore.
  &quot;exampleStoreConfig&quot;: { # Configuration for the Example Store. # Required. Example Store config.
    &quot;vertexEmbeddingModel&quot;: &quot;A String&quot;, # Required. The embedding model to be used for vector embedding. Immutable. Supported models: * &quot;text-embedding-005&quot; * &quot;text-multilingual-embedding-002&quot;
  },
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this ExampleStore was most recently updated.
}

  updateMask: string, Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description`
  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="removeExamples">removeExamples(exampleStore, body=None, x__xgafv=None)</code>
  <pre>Remove Examples from the Example Store.

Args:
  exampleStore: string, Required. The name of the ExampleStore resource that the examples should be removed from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ExampleStoreService.RemoveExamples.
  &quot;exampleIds&quot;: [ # Optional. Example IDs to remove. If both metadata filters and Example IDs are specified, the metadata filters will be applied to the specified examples in order to identify which should be removed.
    &quot;A String&quot;,
  ],
  &quot;storedContentsExampleFilter&quot;: { # The metadata filters that will be used to remove or fetch StoredContentsExamples. If a field is unspecified, then no filtering for that field will be applied. # The metadata filters for StoredContentsExamples.
    &quot;functionNames&quot;: { # Filters for examples&#x27; array metadata fields. An array field is example metadata where multiple values are attributed to a single example. # Optional. The function names for filtering.
      &quot;arrayOperator&quot;: &quot;A String&quot;, # Required. The operator logic to use for filtering.
      &quot;values&quot;: [ # Required. The values by which to filter examples.
        &quot;A String&quot;,
      ],
    },
    &quot;searchKeys&quot;: [ # Optional. The search keys for filtering. Only examples with one of the specified search keys (StoredContentsExample.search_key) are eligible to be returned.
      &quot;A String&quot;,
    ],
  },
}

  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 ExampleStoreService.RemoveExamples.
  &quot;exampleIds&quot;: [ # The IDs for the removed examples.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="searchExamples">searchExamples(exampleStore, body=None, x__xgafv=None)</code>
  <pre>Search for similar Examples for given selection criteria.

Args:
  exampleStore: string, Required. The name of the ExampleStore resource that examples are retrieved from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ExampleStoreService.SearchExamples.
  &quot;storedContentsExampleParameters&quot;: { # The metadata filters that will be used to search StoredContentsExamples. If a field is unspecified, then no filtering for that field will be applied # The parameters of StoredContentsExamples to be searched.
    &quot;contentSearchKey&quot;: { # The chat history to use to generate the search key for retrieval. # The chat history to use to generate the search key for retrieval.
      &quot;contents&quot;: [ # Required. The conversation for generating a search key.
        { # 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;searchKeyGenerationMethod&quot;: { # Options for generating the search key from the conversation history. # Required. The method of generating a search key.
        &quot;lastEntry&quot;: { # Configuration for using only the last entry of the conversation history as the search key. # Use only the last entry of the conversation history (`contents_example.contents`) as the search key.
        },
      },
    },
    &quot;functionNames&quot;: { # Filters for examples&#x27; array metadata fields. An array field is example metadata where multiple values are attributed to a single example. # Optional. The function names for filtering.
      &quot;arrayOperator&quot;: &quot;A String&quot;, # Required. The operator logic to use for filtering.
      &quot;values&quot;: [ # Required. The values by which to filter examples.
        &quot;A String&quot;,
      ],
    },
    &quot;searchKey&quot;: &quot;A String&quot;, # The exact search key to use for retrieval.
  },
  &quot;topK&quot;: &quot;A String&quot;, # Optional. The number of similar examples to return.
}

  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 ExampleStoreService.SearchExamples.
  &quot;results&quot;: [ # The results of searching for similar examples.
    { # The result of the similar example.
      &quot;example&quot;: { # The example that is similar to the searched query.
        &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Example was created.
        &quot;displayName&quot;: &quot;A String&quot;, # Optional. The display name for Example.
        &quot;exampleId&quot;: &quot;A String&quot;, # Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.
        &quot;storedContentsExample&quot;: { # A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store. # An example of chat history and its expected outcome to be used with GenerateContent.
          &quot;contentsExample&quot;: { # A single example of a conversation with the model. # Required. The example to be used with GenerateContent.
            &quot;contents&quot;: [ # Required. The content of the conversation with the model that resulted in the expected output.
              { # 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;expectedContents&quot;: [ # Required. The expected output for the given `contents`. To represent multi-step reasoning, this is a repeated field that contains the iterative steps of the expected output.
              { # A single step of the expected output.
                &quot;content&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. # Required. A single step&#x27;s content.
                  &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;searchKey&quot;: &quot;A String&quot;, # Optional. (Optional) the search key used for retrieval. If not provided at upload-time, the search key will be generated from `contents_example.contents` using the method provided by `search_key_generation_method`. The generated search key will be included in retrieved examples.
          &quot;searchKeyGenerationMethod&quot;: { # Options for generating the search key from the conversation history. # Optional. The method used to generate the search key from `contents_example.contents`. This is ignored when uploading an example if `search_key` is provided.
            &quot;lastEntry&quot;: { # Configuration for using only the last entry of the conversation history as the search key. # Use only the last entry of the conversation history (`contents_example.contents`) as the search key.
            },
          },
        },
      },
      &quot;similarityScore&quot;: 3.14, # The similarity score of this example.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="upsertExamples">upsertExamples(exampleStore, body=None, x__xgafv=None)</code>
  <pre>Create or update Examples in the Example Store.

Args:
  exampleStore: string, Required. The name of the ExampleStore resource that examples are added to or updated in. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ExampleStoreService.UpsertExamples.
  &quot;examples&quot;: [ # Required. A list of examples to be created/updated.
    {
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Example was created.
      &quot;displayName&quot;: &quot;A String&quot;, # Optional. The display name for Example.
      &quot;exampleId&quot;: &quot;A String&quot;, # Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.
      &quot;storedContentsExample&quot;: { # A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store. # An example of chat history and its expected outcome to be used with GenerateContent.
        &quot;contentsExample&quot;: { # A single example of a conversation with the model. # Required. The example to be used with GenerateContent.
          &quot;contents&quot;: [ # Required. The content of the conversation with the model that resulted in the expected output.
            { # 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;expectedContents&quot;: [ # Required. The expected output for the given `contents`. To represent multi-step reasoning, this is a repeated field that contains the iterative steps of the expected output.
            { # A single step of the expected output.
              &quot;content&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. # Required. A single step&#x27;s content.
                &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;searchKey&quot;: &quot;A String&quot;, # Optional. (Optional) the search key used for retrieval. If not provided at upload-time, the search key will be generated from `contents_example.contents` using the method provided by `search_key_generation_method`. The generated search key will be included in retrieved examples.
        &quot;searchKeyGenerationMethod&quot;: { # Options for generating the search key from the conversation history. # Optional. The method used to generate the search key from `contents_example.contents`. This is ignored when uploading an example if `search_key` is provided.
          &quot;lastEntry&quot;: { # Configuration for using only the last entry of the conversation history as the search key. # Use only the last entry of the conversation history (`contents_example.contents`) as the search key.
          },
        },
      },
    },
  ],
  &quot;overwrite&quot;: True or False, # Optional. A flag indicating whether an example can be overwritten if it already exists. If False (default) and the example already exists, the example will not be updated. This does not affect behavior if the example does not exist already.
}

  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 ExampleStoreService.UpsertExamples.
  &quot;results&quot;: [ # A list of results for creating/updating. It&#x27;s either a successfully created/updated example or a status with an error message.
    { # The result for creating/updating a single example.
      &quot;example&quot;: { # The example created/updated successfully.
        &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Example was created.
        &quot;displayName&quot;: &quot;A String&quot;, # Optional. The display name for Example.
        &quot;exampleId&quot;: &quot;A String&quot;, # Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.
        &quot;storedContentsExample&quot;: { # A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store. # An example of chat history and its expected outcome to be used with GenerateContent.
          &quot;contentsExample&quot;: { # A single example of a conversation with the model. # Required. The example to be used with GenerateContent.
            &quot;contents&quot;: [ # Required. The content of the conversation with the model that resulted in the expected output.
              { # 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;expectedContents&quot;: [ # Required. The expected output for the given `contents`. To represent multi-step reasoning, this is a repeated field that contains the iterative steps of the expected output.
              { # A single step of the expected output.
                &quot;content&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. # Required. A single step&#x27;s content.
                  &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;searchKey&quot;: &quot;A String&quot;, # Optional. (Optional) the search key used for retrieval. If not provided at upload-time, the search key will be generated from `contents_example.contents` using the method provided by `search_key_generation_method`. The generated search key will be included in retrieved examples.
          &quot;searchKeyGenerationMethod&quot;: { # Options for generating the search key from the conversation history. # Optional. The method used to generate the search key from `contents_example.contents`. This is ignored when uploading an example if `search_key` is provided.
            &quot;lastEntry&quot;: { # Configuration for using only the last entry of the conversation history as the search key. # Use only the last entry of the conversation history (`contents_example.contents`) as the search key.
            },
          },
        },
      },
      &quot;status&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 message of the example that was not created/updated successfully.
        &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.
      },
    },
  ],
}</pre>
</div>

</body></html>