gcloud-help/gcloud/beta/vector-search/collections/data-objects/batch-create

NAME
    gcloud beta vector-search collections data-objects batch-create - create a
        batch of data objects

SYNOPSIS
    gcloud beta vector-search collections data-objects batch-create
        --requests=[dataObject=DATAOBJECT],
          [dataObjectId=DATAOBJECTID],[parent=PARENT]
        (--collection=COLLECTION : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    (BETA) Create a batch of data objects.

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

        $ gcloud beta vector-search collections data-objects batch-create \
            --collection=my-collection --location=us-central1 \
            --requests='[{"parent":"projects/my-project/locations/us-central\
        1/collections/my-collection","dataObjectId":"my-do-b1","dataObject":\
        {"data":{"title":"Batched Movie
         1"},"vectors":{"plot_embedding":{"dense":{"values":[0.1,0.8,0.3]}}}\
        }},
         {"parent":"projects/my-project/locations/us-central1/collections/my\
        -collection","dataObjectId":"my-do-b2","dataObject":{"data":{"title"\
        :"Batched Movie
         2"},"vectors":{"plot_embedding":{"dense":{"values":[0.4,0.5,0.6]}}}\
        }}]' --project=my-project

REQUIRED FLAGS
     --requests=[dataObject=DATAOBJECT],[dataObjectId=DATAOBJECTID],[parent=PARENT]
        Required, The request message specifying the resources to create. A
        maximum of 1000 DataObjects can be created in a batch.

         dataObject
            The DataObject to create.

             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.

                     values
                        Deprecated: Use dense or sparse instead.

         dataObjectId
            The id of the dataObject to create. The id must be 1-63 characters
            long, and comply with RFC1035
            (https://www.ietf.org/rfc/rfc1035.txt). Specifically, it must be
            1-63 characters long and match the regular expression
            [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?.

         parent
            The resource name of the Collection to create the DataObject in.
            Format:
            projects/{project}/locations/{location}/collections/{collection}.

        Shorthand Example:

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

        JSON Example:

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

        File Example:

            --requests=path_to_file.(yaml|json)

     Collection resource - The resource name of the Collection to create the
     DataObjects in. Format:
     projects/{project}/locations/{location}/collections/{collection}. The
     parent field in the CreateDataObjectRequest 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/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 batch-create