[Enhancement]Adding additional info for memory metadata

[Hailong-am]

Description

Adding additional info for memory metadata

index mapping, additional_info is new added field with flat_object type

{
 ".plugins-ml-memory-meta": {
  "mappings": {
   "_meta": {
    "schema_version": 2
   },
   "properties": {
    "additional_info": {
     "type": "flat_object"
    },
    "application_type": {
     "type": "keyword"
    },
    "create_time": {
     "type": "date",
     "format": "strict_date_time||epoch_millis"
    },
    "name": {
     "type": "text"
    },
    "updated_time": {
     "type": "date",
     "format": "strict_date_time||epoch_millis"
    },
    "user": {
     "type": "keyword"
    }
   }
  }
 }
}

API request/response samples

Create memory without additional info

curl --request POST \
  --url http://localhost:9200/_plugins/_ml/memory \
  --header 'Content-Type: application/json' \
  --data '{"name": "test memory1"}'
}

# response
{
 "memory_id": "qDjoBpEB_JGSOCujgATn"
}

# get a memory
curl http://localhost:9200/_plugins/_ml/memory/qDjoBpEB_JGSOCujgATn

{
 "memory_id": "qDjoBpEB_JGSOCujgATn",
 "create_time": "2024-07-31T03:49:46.343662Z",
 "updated_time": "2024-07-31T03:49:46.343662Z",
 "name": "test memory1",
 "user": "admin",
 "additional_info": {}
}

Create new memory with additional info

curl --request POST \
  --url http://localhost:9200/_plugins/_ml/memory \
  --header 'Content-Type: application/json' \
  --data '{
 "name": "test memory",
 "additional_info": {
  "x": "yz"
 }
}'

# response
{
 "memory_id": "ZTjeBpEB_JGSOCuj5ARu"
}

## Get memory

curl http://localhost:9200/_plugins/_ml/memory/ZTjeBpEB_JGSOCuj5ARu

# response
{
 "memory_id": "ZTjeBpEB_JGSOCuj5ARu",
 "create_time": "2024-07-31T03:39:16.462676Z",
 "updated_time": "2024-07-31T03:39:16.462676Z",
 "name": "test memory",
 "user": "admin",
 "additional_info": {
  "x": "yz"
 }
}

Search memory

curl --request POST \
  --url https://localhost:9200/_plugins/_ml/memory/_search \
  --header 'Content-Type: application/json' \
  --data '{ 
  "query": {
    "match": {
     "name": "test memory"
    }
  }
}'

# response
{
 "took": 1,
 "timed_out": false,
 "_shards": {
  "total": 1,
  "successful": 1,
  "skipped": 0,
  "failed": 0
 },
 "hits": {
  "total": {
   "value": 2,
   "relation": "eq"
  },
  "max_score": 1.0577903,
  "hits": [
   {
    "_index": ".plugins-ml-memory-meta",
    "_id": "mjjmBpEB_JGSOCujnwTA",
    "_version": 1,
    "_seq_no": 0,
    "_primary_term": 1,
    "_score": 1.0577903,
    "_source": {
     "updated_time": "2024-07-31T03:47:43.168654Z",
     "create_time": "2024-07-31T03:47:43.168654Z",
     "application_type": null,
     "additional_info": {
      "x": "yz"
     },
     "name": "test memory",
     "user": "admin"
    }
   },
   {
    "_index": ".plugins-ml-memory-meta",
    "_id": "qDjoBpEB_JGSOCujgATn",
    "_version": 1,
    "_seq_no": 1,
    "_primary_term": 1,
    "_score": 0.36464313,
    "_source": {
     "updated_time": "2024-07-31T03:49:46.343662Z",
     "create_time": "2024-07-31T03:49:46.343662Z",
     "application_type": null,
     "additional_info": {},
     "name": "test memory1",
     "user": "admin"
    }
   }
  ]
 }
}

Issues Resolved

#2755

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[ylwu-amzn]

@Zhangxunmt help review ?

[Zhangxunmt]

This would allow update/delete anything inside META_ADDITIONAL_INFO_FIELD. I think you need to put some restrictions to not allow updating certain fields inside it like the application/memory type, etc?

[Hailong-am]

Yes, that makes sense. We can initially make it open and then add restrictions when the need arises.