gcloud-help/gcloud/vector-search/collections/data-objects/batch-update

NAME
    gcloud vector-search collections data-objects batch-update - update a batch
        of data objects

SYNOPSIS
    gcloud vector-search collections data-objects batch-update
        --requests=[dataObject=DATAOBJECT],[updateMask=UPDATEMASK]
        (--collection=COLLECTION : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    Update a batch of data objects.

EXAMPLES
    To update a batch of data objects in collection my-collection, project
    my-project and location us-central1, run:

        $ gcloud vector-search collections data-objects batch-update \
            --collection=my-collection --location=us-central1 \
            --requests='[{"dataObject":{"name":"projects/my-project/location\
        s/us-central1/collections/my-collection/dataObjects/my-do-b1","data"\
        :{"genre":"Thriller"}},"updateMask":"data.genre"},{"dataObject":{"na\
        me":"projects/my-project/locations/us-central1/collections/my-collec\
        tion/dataObjects/my-do-b2","data":{"director":"Different
         Director"}},"updateMask":"data.director"}]' --project=my-project

REQUIRED FLAGS
     --requests=[dataObject=DATAOBJECT],[updateMask=UPDATEMASK]
        Required, The request message specifying the resources to update. A
        maximum of 1000 DataObjects can be updated in a batch.

         dataObject
            The DataObject which replaces the resource on the server.

             data
                The data of the dataObject.

             etag
                The etag of the dataObject.

             name
                Identifier. The fully qualified resource name of the
                dataObject.

                Format:
                projects/{project}/locations/{location}/collections/{collection}/dataObjects/{data_object_id}
                The data_object_id must be 1-63 characters long, and comply
                with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).

             vectors
                The vectors of the dataObject.

                 KEY
                    Sets KEY value.

                 VALUE
                    Sets VALUE value.

                     dense
                        A dense vector.

                         values
                            The values of the vector.

                     sparse
                        A sparse vector.

                         indices
                            The corresponding indices for the values.

                         values
                            The values of the vector.

         updateMask
            The update mask applies to the resource. See
            [google.protobuf.FieldMask][google.protobuf.FieldMask].

        Shorthand Example:

            --requests=dataObject={data={...},etag=string,name=string,vectors={string={dense={values=[float]},sparse={indices=[int],values=[float]}}}},updateMask=string --requests=dataObject={data={...},etag=string,name=string,vectors={string={dense={values=[float]},sparse={indices=[int],values=[float]}}}},updateMask=string

        JSON Example:

            --requests='[{"dataObject": {"data": {...}, "etag": "string", "name": "string", "vectors": {"string": {"dense": {"values": [float]}, "sparse": {"indices": [int], "values": [float]}}}}, "updateMask": "string"}]'

        File Example:

            --requests=path_to_file.(yaml|json)

     Collection resource - The resource name of the Collection to update the
     DataObjects in. Format:
     projects/{project}/locations/{location}/collections/{collection}. The
     parent field in the UpdateDataObjectRequest messages must match this
     field. The arguments in this group can be used to specify the attributes
     of this resource. (NOTE) Some attributes are not given arguments in this
     group but can be set in other ways.

     To set the project attribute:
      ◆ provide the argument --collection on the command line with a fully
        specified name;
      ◆ provide the argument --project on the command line;
      ◆ set the property core/project.

     This must be specified.

       --collection=COLLECTION
          ID of the collection or fully qualified identifier for the
          collection.

          To set the collection attribute:
          ▸ provide the argument --collection on the command line.

          This flag argument must be specified if any of the other arguments in
          this group are specified.

       --location=LOCATION
          The location id of the collection resource.

          To set the location attribute:
          ▸ provide the argument --collection on the command line with a
            fully specified name;
          ▸ provide the argument --location on the command line.

GCLOUD WIDE FLAGS
    These flags are available to all commands: --access-token-file, --account,
    --billing-project, --configuration, --flags-file, --flatten, --format,
    --help, --impersonate-service-account, --log-http, --project, --quiet,
    --trace-token, --user-output-enabled, --verbosity.

    Run $ gcloud help for details.

API REFERENCE
    This command uses the vectorsearch/v1 API. The full documentation for this
    API can be found at:
    https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview

NOTES
    This variant is also available:

        $ gcloud beta vector-search collections data-objects batch-update