Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,14 @@ docs/KbSearchData.md
docs/KnowledgeApi.md
docs/MemoryApi.md
docs/MessageItem.md
docs/MongoValue.md
docs/ProfileItem.md
docs/PurgeConfirmInput.md
docs/PurgeJobData.md
docs/PurgeRequestData.md
docs/PurgeRequestInput.md
docs/PurgeStepData.md
docs/PurgeSummary.md
docs/Reason.md
docs/RelatedTagUsageBody.md
docs/RelatedTagUsageItem.md
Expand Down Expand Up @@ -103,6 +110,8 @@ docs/SuccessEnvelopeKbData.md
docs/SuccessEnvelopeKbDeleteData.md
docs/SuccessEnvelopeKbListData.md
docs/SuccessEnvelopeKbSearchData.md
docs/SuccessEnvelopePurgeJobData.md
docs/SuccessEnvelopePurgeRequestData.md
docs/SuccessEnvelopeRelatedTagUsageListData.md
docs/SuccessEnvelopeSearchData.md
docs/SuccessEnvelopeTagBindData.md
Expand Down Expand Up @@ -215,7 +224,14 @@ everos_cloud/models/kb_list_data.py
everos_cloud/models/kb_patch_body.py
everos_cloud/models/kb_search_data.py
everos_cloud/models/message_item.py
everos_cloud/models/mongo_value.py
everos_cloud/models/profile_item.py
everos_cloud/models/purge_confirm_input.py
everos_cloud/models/purge_job_data.py
everos_cloud/models/purge_request_data.py
everos_cloud/models/purge_request_input.py
everos_cloud/models/purge_step_data.py
everos_cloud/models/purge_summary.py
everos_cloud/models/reason.py
everos_cloud/models/related_tag_usage_body.py
everos_cloud/models/related_tag_usage_item.py
Expand Down Expand Up @@ -256,6 +272,8 @@ everos_cloud/models/success_envelope_kb_data.py
everos_cloud/models/success_envelope_kb_delete_data.py
everos_cloud/models/success_envelope_kb_list_data.py
everos_cloud/models/success_envelope_kb_search_data.py
everos_cloud/models/success_envelope_purge_job_data.py
everos_cloud/models/success_envelope_purge_request_data.py
everos_cloud/models/success_envelope_related_tag_usage_list_data.py
everos_cloud/models/success_envelope_search_data.py
everos_cloud/models/success_envelope_tag_bind_data.py
Expand Down Expand Up @@ -366,7 +384,14 @@ test/test_kb_search_data.py
test/test_knowledge_api.py
test/test_memory_api.py
test/test_message_item.py
test/test_mongo_value.py
test/test_profile_item.py
test/test_purge_confirm_input.py
test/test_purge_job_data.py
test/test_purge_request_data.py
test/test_purge_request_input.py
test/test_purge_step_data.py
test/test_purge_summary.py
test/test_reason.py
test/test_related_tag_usage_body.py
test/test_related_tag_usage_item.py
Expand Down Expand Up @@ -408,6 +433,8 @@ test/test_success_envelope_kb_data.py
test/test_success_envelope_kb_delete_data.py
test/test_success_envelope_kb_list_data.py
test/test_success_envelope_kb_search_data.py
test/test_success_envelope_purge_job_data.py
test/test_success_envelope_purge_request_data.py
test/test_success_envelope_related_tag_usage_list_data.py
test/test_success_envelope_search_data.py
test/test_success_envelope_tag_bind_data.py
Expand Down
1 change: 1 addition & 0 deletions docs/DeleteByIdsData.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**memory_type** | **str** | The memory type the request named. |
**success** | **bool** | Always true on a 200 — the batch was applied. Failures use the error envelope instead. |
**deleted** | **int** | Records this request removed. Ids that were absent, already deleted, another tenant's or (with `user_id`) another user's are skipped and count 0 alike. |

## Example

Expand Down
1 change: 1 addition & 0 deletions docs/DeleteByIdsInput.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Name | Type | Description | Notes
**memory_type** | **str** | Kind of the memories being deleted. Only \"episode\" is accepted today. |
**memory_ids** | **List[str]** | 1 to 50 memory ids. Every one must be well-formed; duplicates are collapsed. |
**reason** | [**Reason**](Reason.md) | | [optional]
**user_id** | **str** | | [optional]

## Example

Expand Down
258 changes: 256 additions & 2 deletions docs/MemoryApi.md

Large diffs are not rendered by default.

28 changes: 28 additions & 0 deletions docs/MongoValue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# MongoValue


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

## Example

```python
from everos_cloud.models.mongo_value import MongoValue

# TODO update the JSON string below
json = "{}"
# create an instance of MongoValue from a JSON string
mongo_value_instance = MongoValue.from_json(json)
# print the JSON string representation of the object
print(MongoValue.to_json())

# convert the object into a dict
mongo_value_dict = mongo_value_instance.to_dict()
# create an instance of MongoValue from a dict
mongo_value_from_dict = MongoValue.from_dict(mongo_value_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


30 changes: 30 additions & 0 deletions docs/PurgeConfirmInput.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# PurgeConfirmInput

Step 2: confirm. The scope is the one bound to the nonce.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**nonce** | **str** | |

## Example

```python
from everos_cloud.models.purge_confirm_input import PurgeConfirmInput

# TODO update the JSON string below
json = "{}"
# create an instance of PurgeConfirmInput from a JSON string
purge_confirm_input_instance = PurgeConfirmInput.from_json(json)
# print the JSON string representation of the object
print(PurgeConfirmInput.to_json())

# convert the object into a dict
purge_confirm_input_dict = purge_confirm_input_instance.to_dict()
# create an instance of PurgeConfirmInput from a dict
purge_confirm_input_from_dict = PurgeConfirmInput.from_dict(purge_confirm_input_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


39 changes: 39 additions & 0 deletions docs/PurgeJobData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# PurgeJobData

A purge job as the caller sees it.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**job_id** | **str** | |
**status** | **str** | |
**scope** | **str** | |
**app_id** | **str** | | [optional]
**project_id** | **str** | | [optional]
**created_at** | **datetime** | |
**started_at** | **datetime** | | [optional]
**heartbeat_at** | **datetime** | | [optional]
**finished_at** | **datetime** | | [optional]
**steps** | [**List[PurgeStepData]**](PurgeStepData.md) | | [optional]

## Example

```python
from everos_cloud.models.purge_job_data import PurgeJobData

# TODO update the JSON string below
json = "{}"
# create an instance of PurgeJobData from a JSON string
purge_job_data_instance = PurgeJobData.from_json(json)
# print the JSON string representation of the object
print(PurgeJobData.to_json())

# convert the object into a dict
purge_job_data_dict = purge_job_data_instance.to_dict()
# create an instance of PurgeJobData from a dict
purge_job_data_from_dict = PurgeJobData.from_dict(purge_job_data_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


35 changes: 35 additions & 0 deletions docs/PurgeRequestData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# PurgeRequestData

The nonce to confirm, and what it will purge.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**nonce** | **str** | Send to /purge/confirm before `expires_at`. |
**expires_at** | **datetime** | |
**scope** | **str** | |
**app_id** | **str** | | [optional]
**project_id** | **str** | | [optional]
**summary** | [**PurgeSummary**](PurgeSummary.md) | |

## Example

```python
from everos_cloud.models.purge_request_data import PurgeRequestData

# TODO update the JSON string below
json = "{}"
# create an instance of PurgeRequestData from a JSON string
purge_request_data_instance = PurgeRequestData.from_json(json)
# print the JSON string representation of the object
print(PurgeRequestData.to_json())

# convert the object into a dict
purge_request_data_dict = purge_request_data_instance.to_dict()
# create an instance of PurgeRequestData from a dict
purge_request_data_from_dict = PurgeRequestData.from_dict(purge_request_data_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


32 changes: 32 additions & 0 deletions docs/PurgeRequestInput.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# PurgeRequestInput

Step 1: ask for a purge. Nothing is deleted.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**scope** | **str** | `space` purges the whole memory space; `app` one app in it (`app_id`); `project` one project of one app (`app_id` + `project_id`). |
**app_id** | **str** | | [optional]
**project_id** | **str** | | [optional]

## Example

```python
from everos_cloud.models.purge_request_input import PurgeRequestInput

# TODO update the JSON string below
json = "{}"
# create an instance of PurgeRequestInput from a JSON string
purge_request_input_instance = PurgeRequestInput.from_json(json)
# print the JSON string representation of the object
print(PurgeRequestInput.to_json())

# convert the object into a dict
purge_request_input_dict = purge_request_input_instance.to_dict()
# create an instance of PurgeRequestInput from a dict
purge_request_input_from_dict = PurgeRequestInput.from_dict(purge_request_input_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


33 changes: 33 additions & 0 deletions docs/PurgeStepData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# PurgeStepData

One store of one purge step, e.g. ``mongo:v2_episodes`` or ``es:episode``.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**store** | **str** | |
**state** | **str** | |
**deleted** | **int** | | [optional] [default to 0]
**error** | **str** | | [optional]

## Example

```python
from everos_cloud.models.purge_step_data import PurgeStepData

# TODO update the JSON string below
json = "{}"
# create an instance of PurgeStepData from a JSON string
purge_step_data_instance = PurgeStepData.from_json(json)
# print the JSON string representation of the object
print(PurgeStepData.to_json())

# convert the object into a dict
purge_step_data_dict = purge_step_data_instance.to_dict()
# create an instance of PurgeStepData from a dict
purge_step_data_from_dict = PurgeStepData.from_dict(purge_step_data_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


37 changes: 37 additions & 0 deletions docs/PurgeSummary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# PurgeSummary

What the purge would delete right now, counted per store. A snapshot at request time: data written before the purge runs is deleted too. Counts include soft-deleted rows (the purge removes those as well), so they can be higher than what ``get`` shows. Feedback is not memory data and is not counted. A count that did not finish in time is ``null`` and ``complete`` is ``false``.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mongo** | [**Dict[str, MongoValue]**](MongoValue.md) | MongoDB documents per memory type (collection without the `v2_` prefix), the source of truth. |
**mongo_total** | **int** | |
**elasticsearch_total** | **int** | |
**milvus_total** | **int** | |
**complete** | **bool** | False when any count timed out or failed. |
**counted_at** | **datetime** | |
**comment** | **str** | What the counts include and exclude (soft-deleted rows, feedback). |
**error** | **str** | | [optional]

## Example

```python
from everos_cloud.models.purge_summary import PurgeSummary

# TODO update the JSON string below
json = "{}"
# create an instance of PurgeSummary from a JSON string
purge_summary_instance = PurgeSummary.from_json(json)
# print the JSON string representation of the object
print(PurgeSummary.to_json())

# convert the object into a dict
purge_summary_dict = purge_summary_instance.to_dict()
# create an instance of PurgeSummary from a dict
purge_summary_from_dict = PurgeSummary.from_dict(purge_summary_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


30 changes: 30 additions & 0 deletions docs/SuccessEnvelopePurgeJobData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# SuccessEnvelopePurgeJobData


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**request_id** | **str** | Request trace id (peer to data) |
**data** | [**PurgeJobData**](PurgeJobData.md) | Endpoint-defined business result |

## Example

```python
from everos_cloud.models.success_envelope_purge_job_data import SuccessEnvelopePurgeJobData

# TODO update the JSON string below
json = "{}"
# create an instance of SuccessEnvelopePurgeJobData from a JSON string
success_envelope_purge_job_data_instance = SuccessEnvelopePurgeJobData.from_json(json)
# print the JSON string representation of the object
print(SuccessEnvelopePurgeJobData.to_json())

# convert the object into a dict
success_envelope_purge_job_data_dict = success_envelope_purge_job_data_instance.to_dict()
# create an instance of SuccessEnvelopePurgeJobData from a dict
success_envelope_purge_job_data_from_dict = SuccessEnvelopePurgeJobData.from_dict(success_envelope_purge_job_data_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


30 changes: 30 additions & 0 deletions docs/SuccessEnvelopePurgeRequestData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# SuccessEnvelopePurgeRequestData


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**request_id** | **str** | Request trace id (peer to data) |
**data** | [**PurgeRequestData**](PurgeRequestData.md) | Endpoint-defined business result |

## Example

```python
from everos_cloud.models.success_envelope_purge_request_data import SuccessEnvelopePurgeRequestData

# TODO update the JSON string below
json = "{}"
# create an instance of SuccessEnvelopePurgeRequestData from a JSON string
success_envelope_purge_request_data_instance = SuccessEnvelopePurgeRequestData.from_json(json)
# print the JSON string representation of the object
print(SuccessEnvelopePurgeRequestData.to_json())

# convert the object into a dict
success_envelope_purge_request_data_dict = success_envelope_purge_request_data_instance.to_dict()
# create an instance of SuccessEnvelopePurgeRequestData from a dict
success_envelope_purge_request_data_from_dict = SuccessEnvelopePurgeRequestData.from_dict(success_envelope_purge_request_data_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/UpdateInput.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**memory_id** | **str** | The memory's `id` as returned by /api/v2/memory/get or /search. |
**patch** | [**EpisodePatch**](EpisodePatch.md) | The fields to rewrite — at least one. Fields left out keep their current value. |
**reason** | [**Reason**](Reason.md) | | [optional]
**user_id** | **str** | | [optional]

## Example

Expand Down
Loading
Loading