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

NAME
    gcloud beta vector-search collections data-objects update - update a data
        object

SYNOPSIS
    gcloud beta vector-search collections data-objects update
        (DATA_OBJECT : --collection=COLLECTION --location=LOCATION)
        [--data=DATA] [--etag=ETAG]
        [--vectors=[VECTORS,...]
          | --update-vectors=[UPDATE_VECTORS,...] --clear-vectors
          | --remove-vectors=REMOVE_VECTORS] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    (BETA) Update a data object.

EXAMPLES
    To update data for data object my-do-1 in collection my-collection, project
    my-project and location us-central1, run:

        $ gcloud beta vector-search collections data-objects update \
            my-do-1 --collection=my-collection --location=us-central1 \
            --data='{"year":1995}' --project=my-project

POSITIONAL ARGUMENTS
     DataObject resource - 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). 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 data_object 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.

       DATA_OBJECT
          ID of the dataObject or fully qualified identifier for the
          dataObject.

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

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

       --collection=COLLECTION
          The collection id of the dataObject resource.

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

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

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

FLAGS
     --data=DATA
        The data of the dataObject.

     --etag=ETAG
        The etag of the dataObject.

     Update vectors.

     At most one of these can be specified:

       --vectors=[VECTORS,...]
          Set vectors to new value. 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.

               values
                  Deprecated: Use dense or sparse instead.

          Shorthand Example:

              --vectors=string={dense={values=[float]},sparse={indices=[int],values=[float]},values=[float]}

          JSON Example:

              --vectors='{"string": {"dense": {"values": [float]}, "sparse": {"indices": [int], "values": [float]}, "values": [float]}}'

          File Example:

              --vectors=path_to_file.(yaml|json)

       Or at least one of these can be specified:

         --update-vectors=[UPDATE_VECTORS,...]
            Update vectors value or add key value pair. 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.

                 values
                    Deprecated: Use dense or sparse instead.

            Shorthand Example:

                --update-vectors=string={dense={values=[float]},sparse={indices=[int],values=[float]},values=[float]}

            JSON Example:

                --update-vectors='{"string": {"dense": {"values": [float]}, "sparse": {"indices": [int], "values": [float]}, "values": [float]}}'

            File Example:

                --update-vectors=path_to_file.(yaml|json)

         At most one of these can be specified:

           --clear-vectors
              Clear vectors value and set to empty map.

           --remove-vectors=REMOVE_VECTORS
              Remove existing value from map vectors. Sets remove_vectors
              value.

              Shorthand Example:

                  --remove-vectors=string,string

              JSON Example:

                  --remove-vectors=["string"]

              File Example:

                  --remove-vectors=path_to_file.(yaml|json)

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/v1beta 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 command is currently in beta and might change without notice. This
    variant is also available:

        $ gcloud vector-search collections data-objects update