REST Resource: projects.locations.ragCorpora.ragFiles.ragMetadata

Resource: RagMetadata

metadata for RagFile provided by users.

Fields
name string

Identifier. Resource name of the RagMetadata. Format: projects/{project}/locations/{location}/ragCorpora/{ragCorpus}/ragFiles/{ragFile}/ragMetadata/{ragMetadata}

userSpecifiedMetadata object (UserSpecifiedMetadata)

user provided metadata.

JSON representation 
{
  "name": string,
  "userSpecifiedMetadata": {
    object (UserSpecifiedMetadata)
  }
}

UserSpecifiedMetadata

metadata provided by users.

Fields
key string

Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.

value object (MetadataValue)

value of the metadata. The value must be able to convert to the type according to the data schema.

JSON representation 
{
  "key": string,
  "value": {
    object (MetadataValue)
  }
}

MetadataValue

value of metadata, including all types available in data schema.

Fields
value Union type
The value of the metadata. value can be only one of the following:
intValue string (int64 format)

value of int type metadata.

floatValue number

value of float type metadata.

strValue string

value of string type metadata.

datetimeValue string

value of date time type metadata.

boolValue boolean

value of boolean type metadata.

listValue object (MetadataList)

value of list type metadata.

JSON representation 
{

  // value
  "intValue": string,
  "floatValue": number,
  "strValue": string,
  "datetimeValue": string,
  "boolValue": boolean,
  "listValue": {
    object (MetadataList)
  }
  // Union type
}

MetadataList

List representation in metadata.

Fields
values[] object (MetadataValue)

The values of LIST data type metadata.

JSON representation 
{
  "values": [
    {
      object (MetadataValue)
    }
  ]
}

Methods

batchCreate

 Batch Create one or more RagMetadatas

batchDelete

 Batch Deletes one or more RagMetadata.

create

 Creates a RagMetadata.

delete

 Deletes a RagMetadata.

get

 Gets a RagMetadata.

list

 Lists RagMetadata in a RagFile.

patch

 Updates a RagMetadata.