trieve_ruby_client 0.8.2 → 0.10.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +39 -30
- data/docs/ApiKeyRespBody.md +32 -0
- data/docs/AutocompleteData.md +42 -0
- data/docs/AutocompleteReqPayload.md +50 -0
- data/docs/BoostPhrase.md +20 -0
- data/docs/ChunkApi.md +140 -66
- data/docs/ChunkData.md +3 -1
- data/docs/ChunkFilter.md +3 -3
- data/docs/ChunkGroup.md +1 -1
- data/docs/ChunkGroupApi.md +35 -33
- data/docs/ChunkMetadata.md +5 -1
- data/docs/ChunkMetadataStringTagSet.md +46 -0
- data/docs/ChunkMetadataTypes.md +51 -0
- data/docs/ChunkReqPayload.md +50 -0
- data/docs/ClientDatasetConfiguration.md +0 -2
- data/docs/ConditionType.md +49 -0
- data/docs/ContentChunkMetadata.md +32 -0
- data/docs/CreateChunkGroupReqPayload.md +28 -0
- data/docs/CreateChunkReqPayloadEnum.md +49 -0
- data/docs/CreateDatasetRequest.md +2 -2
- data/docs/CreateMessageData.md +2 -2
- data/docs/CreateMessageReqPayload.md +42 -0
- data/docs/CreateTopicReqPayload.md +22 -0
- data/docs/Dataset.md +2 -0
- data/docs/DatasetApi.md +236 -12
- data/docs/DateRange.md +24 -0
- data/docs/EditMessageReqPayload.md +44 -0
- data/docs/FieldCondition.md +2 -0
- data/docs/File.md +1 -1
- data/docs/FileApi.md +7 -7
- data/docs/GenerateChunksRequest.md +2 -0
- data/docs/GetDatasetsPagination.md +20 -0
- data/docs/HasIDCondition.md +20 -0
- data/docs/InvitationApi.md +1 -1
- data/docs/MatchCondition.md +3 -1
- data/docs/MessageApi.md +42 -42
- data/docs/Organization.md +2 -0
- data/docs/OrganizationApi.md +24 -25
- data/docs/RangeCondition.md +1 -3
- data/docs/RegenerateMessageReqPayload.md +40 -0
- data/docs/RemoveChunkFromGroupReqPayload.md +18 -0
- data/docs/ScoreChunkDTO.md +3 -1
- data/docs/SearchChunkData.md +9 -3
- data/docs/SearchChunksReqPayload.md +54 -0
- data/docs/SearchOverGroupsData.md +10 -2
- data/docs/SearchWithinGroupData.md +12 -2
- data/docs/SetUserApiKeyRequest.md +4 -0
- data/docs/SlimChunkMetadata.md +4 -0
- data/docs/SuggestedQueriesReqPayload.md +18 -0
- data/docs/TopicApi.md +16 -16
- data/docs/UpdateChunkData.md +2 -0
- data/docs/UpdateChunkReqPayload.md +46 -0
- data/docs/UpdateDatasetRequest.md +2 -0
- data/docs/UpdateGroupByTrackingIDReqPayload.md +26 -0
- data/docs/UpdateTopicReqPayload.md +20 -0
- data/docs/UpdateUserOrgRoleData.md +1 -1
- data/docs/UploadFileReqPayload.md +40 -0
- data/docs/UserApi.md +7 -8
- data/lib/trieve_ruby_client/api/auth_api.rb +1 -1
- data/lib/trieve_ruby_client/api/chunk_api.rb +158 -83
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +58 -51
- data/lib/trieve_ruby_client/api/dataset_api.rb +224 -15
- data/lib/trieve_ruby_client/api/events_api.rb +1 -1
- data/lib/trieve_ruby_client/api/file_api.rb +12 -12
- data/lib/trieve_ruby_client/api/health_api.rb +1 -1
- data/lib/trieve_ruby_client/api/invitation_api.rb +3 -3
- data/lib/trieve_ruby_client/api/message_api.rb +50 -50
- data/lib/trieve_ruby_client/api/organization_api.rb +27 -27
- data/lib/trieve_ruby_client/api/stripe_api.rb +1 -1
- data/lib/trieve_ruby_client/api/topic_api.rb +27 -27
- data/lib/trieve_ruby_client/api/user_api.rb +8 -8
- data/lib/trieve_ruby_client/api_client.rb +1 -1
- data/lib/trieve_ruby_client/api_error.rb +1 -1
- data/lib/trieve_ruby_client/configuration.rb +1 -1
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/api_key_resp_body.rb +325 -0
- data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
- data/lib/trieve_ruby_client/models/autocomplete_data.rb +378 -0
- data/lib/trieve_ruby_client/models/autocomplete_req_payload.rb +467 -0
- data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_group_result.rb +1 -1
- data/lib/trieve_ruby_client/models/boost_phrase.rb +240 -0
- data/lib/trieve_ruby_client/models/chat_message_proxy.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_data.rb +16 -9
- data/lib/trieve_ruby_client/models/chunk_filter.rb +4 -4
- data/lib/trieve_ruby_client/models/chunk_group.rb +5 -3
- data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_metadata.rb +28 -4
- data/lib/trieve_ruby_client/models/chunk_metadata_string_tag_set.rb +387 -0
- data/lib/trieve_ruby_client/models/chunk_metadata_types.rb +106 -0
- data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_req_payload.rb +400 -0
- data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +2 -18
- data/lib/trieve_ruby_client/models/condition_type.rb +105 -0
- data/lib/trieve_ruby_client/models/content_chunk_metadata.rb +299 -0
- data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb +273 -0
- data/lib/trieve_ruby_client/models/create_chunk_req_payload_enum.rb +105 -0
- data/lib/trieve_ruby_client/models/create_dataset_request.rb +3 -3
- data/lib/trieve_ruby_client/models/create_message_data.rb +13 -13
- data/lib/trieve_ruby_client/models/create_message_req_payload.rb +378 -0
- data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_topic_req_payload.rb +244 -0
- data/lib/trieve_ruby_client/models/dataset.rb +18 -2
- data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/date_range.rb +245 -0
- data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/edit_message_req_payload.rb +395 -0
- data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/event.rb +1 -1
- data/lib/trieve_ruby_client/models/event_return.rb +1 -1
- data/lib/trieve_ruby_client/models/field_condition.rb +12 -2
- data/lib/trieve_ruby_client/models/file.rb +5 -3
- data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/generate_chunks_request.rb +13 -2
- data/lib/trieve_ruby_client/models/geo_info.rb +1 -1
- data/lib/trieve_ruby_client/models/geo_types.rb +1 -1
- data/lib/trieve_ruby_client/models/get_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_datasets_pagination.rb +225 -0
- data/lib/trieve_ruby_client/models/get_events_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_tracking_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/group_score_chunk.rb +1 -1
- data/lib/trieve_ruby_client/models/has_id_condition.rb +229 -0
- data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
- data/lib/trieve_ruby_client/models/location_bounding_box.rb +1 -1
- data/lib/trieve_ruby_client/models/location_polygon.rb +1 -1
- data/lib/trieve_ruby_client/models/location_radius.rb +1 -1
- data/lib/trieve_ruby_client/models/match_condition.rb +2 -1
- data/lib/trieve_ruby_client/models/message.rb +1 -1
- data/lib/trieve_ruby_client/models/organization.rb +18 -2
- data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/range.rb +1 -1
- data/lib/trieve_ruby_client/models/range_condition.rb +2 -3
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +1 -1
- data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/regenerate_message_req_payload.rb +361 -0
- data/lib/trieve_ruby_client/models/remove_chunk_from_group_req_payload.rb +222 -0
- data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
- data/lib/trieve_ruby_client/models/score_chunk_dto.rb +15 -3
- data/lib/trieve_ruby_client/models/search_chunk_data.rb +40 -5
- data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunks_req_payload.rb +504 -0
- data/lib/trieve_ruby_client/models/search_over_groups_data.rb +93 -4
- data/lib/trieve_ruby_client/models/search_over_groups_results.rb +1 -1
- data/lib/trieve_ruby_client/models/search_within_group_data.rb +106 -4
- data/lib/trieve_ruby_client/models/search_within_group_results.rb +1 -1
- data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +28 -2
- data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
- data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +24 -2
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
- data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_req_payload.rb +222 -0
- data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
- data/lib/trieve_ruby_client/models/topic.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_data.rb +15 -2
- data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_req_payload.rb +376 -0
- data/lib/trieve_ruby_client/models/update_dataset_request.rb +13 -2
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_req_payload.rb +268 -0
- data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_req_payload.rb +239 -0
- data/lib/trieve_ruby_client/models/update_user_org_role_data.rb +2 -2
- data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_req_payload.rb +368 -0
- data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
- data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
- data/lib/trieve_ruby_client/version.rb +2 -2
- data/lib/trieve_ruby_client.rb +25 -20
- data/openapi-generator.yaml +1 -1
- data/openapi.json +1 -7789
- data/spec/models/api_key_resp_body_spec.rb +78 -0
- data/spec/models/autocomplete_data_spec.rb +108 -0
- data/spec/models/autocomplete_req_payload_spec.rb +132 -0
- data/spec/models/boost_phrase_spec.rb +42 -0
- data/spec/models/chunk_metadata_string_tag_set_spec.rb +120 -0
- data/spec/models/chunk_metadata_types_spec.rb +32 -0
- data/spec/models/chunk_req_payload_spec.rb +132 -0
- data/spec/models/condition_type_spec.rb +32 -0
- data/spec/models/content_chunk_metadata_spec.rb +72 -0
- data/spec/models/create_chunk_group_req_payload_spec.rb +66 -0
- data/spec/models/create_chunk_req_payload_enum_spec.rb +32 -0
- data/spec/models/create_message_req_payload_spec.rb +108 -0
- data/spec/models/create_topic_req_payload_spec.rb +48 -0
- data/spec/models/date_range_spec.rb +54 -0
- data/spec/models/edit_message_req_payload_spec.rb +114 -0
- data/spec/models/get_datasets_pagination_spec.rb +42 -0
- data/spec/models/has_id_condition_spec.rb +42 -0
- data/spec/models/regenerate_message_req_payload_spec.rb +102 -0
- data/spec/models/remove_chunk_from_group_req_payload_spec.rb +36 -0
- data/spec/models/search_chunks_req_payload_spec.rb +144 -0
- data/spec/models/suggested_queries_req_payload_spec.rb +36 -0
- data/spec/models/update_chunk_req_payload_spec.rb +120 -0
- data/spec/models/update_group_by_tracking_id_req_payload_spec.rb +60 -0
- data/spec/models/update_topic_req_payload_spec.rb +42 -0
- data/spec/models/upload_file_req_payload_spec.rb +102 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client-0.8.2.gem +0 -0
- data/trieve_ruby_client-0.8.5.gem +0 -0
- data/trieve_ruby_client.gemspec +1 -1
- metadata +104 -2
data/docs/ChunkApi.md
CHANGED
@@ -4,8 +4,8 @@ All URIs are relative to *https://api.trieve.ai*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**autocomplete**](ChunkApi.md#autocomplete) | **POST** /api/chunk/autocomplete | Autocomplete |
|
7
8
|
| [**create_chunk**](ChunkApi.md#create_chunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks |
|
8
|
-
| [**create_suggested_queries_handler**](ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | Generate suggested queries |
|
9
9
|
| [**delete_chunk**](ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{chunk_id} | Delete Chunk |
|
10
10
|
| [**delete_chunk_by_tracking_id**](ChunkApi.md#delete_chunk_by_tracking_id) | **DELETE** /api/chunk/tracking_id/{tracking_id} | Delete Chunk By Tracking Id |
|
11
11
|
| [**generate_off_chunks**](ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on Specified Chunks |
|
@@ -14,18 +14,19 @@ All URIs are relative to *https://api.trieve.ai*
|
|
14
14
|
| [**get_chunks_by_ids**](ChunkApi.md#get_chunks_by_ids) | **POST** /api/chunks | Get Chunks By Ids |
|
15
15
|
| [**get_chunks_by_tracking_ids**](ChunkApi.md#get_chunks_by_tracking_ids) | **POST** /api/chunks/tracking | Get Chunks By TrackingIds |
|
16
16
|
| [**get_recommended_chunks**](ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks |
|
17
|
+
| [**get_suggested_queries**](ChunkApi.md#get_suggested_queries) | **POST** /api/chunk/gen_suggestions | Generate suggested queries |
|
17
18
|
| [**search_chunks**](ChunkApi.md#search_chunks) | **POST** /api/chunk/search | Search |
|
18
19
|
| [**update_chunk**](ChunkApi.md#update_chunk) | **PUT** /api/chunk | Update Chunk |
|
19
20
|
| [**update_chunk_by_tracking_id**](ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | Update Chunk By Tracking Id |
|
20
21
|
|
21
22
|
|
22
|
-
##
|
23
|
+
## autocomplete
|
23
24
|
|
24
|
-
> <
|
25
|
+
> <SearchChunkQueryResponseBody> autocomplete(tr_dataset, autocomplete_req_payload)
|
25
26
|
|
26
|
-
|
27
|
+
Autocomplete
|
27
28
|
|
28
|
-
|
29
|
+
Autocomplete This route provides the primary autocomplete functionality for the API. This prioritize prefix matching with semantic or full-text search.
|
29
30
|
|
30
31
|
### Examples
|
31
32
|
|
@@ -42,32 +43,32 @@ end
|
|
42
43
|
|
43
44
|
api_instance = TrieveRubyClient::ChunkApi.new
|
44
45
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
45
|
-
|
46
|
+
autocomplete_req_payload = TrieveRubyClient::AutocompleteReqPayload.new({query: 'query_example', search_type: 'search_type_example'}) # AutocompleteReqPayload | JSON request payload to semantically search for chunks (chunks)
|
46
47
|
|
47
48
|
begin
|
48
|
-
#
|
49
|
-
result = api_instance.
|
49
|
+
# Autocomplete
|
50
|
+
result = api_instance.autocomplete(tr_dataset, autocomplete_req_payload)
|
50
51
|
p result
|
51
52
|
rescue TrieveRubyClient::ApiError => e
|
52
|
-
puts "Error when calling ChunkApi->
|
53
|
+
puts "Error when calling ChunkApi->autocomplete: #{e}"
|
53
54
|
end
|
54
55
|
```
|
55
56
|
|
56
|
-
#### Using the
|
57
|
+
#### Using the autocomplete_with_http_info variant
|
57
58
|
|
58
59
|
This returns an Array which contains the response data, status code and headers.
|
59
60
|
|
60
|
-
> <Array(<
|
61
|
+
> <Array(<SearchChunkQueryResponseBody>, Integer, Hash)> autocomplete_with_http_info(tr_dataset, autocomplete_req_payload)
|
61
62
|
|
62
63
|
```ruby
|
63
64
|
begin
|
64
|
-
#
|
65
|
-
data, status_code, headers = api_instance.
|
65
|
+
# Autocomplete
|
66
|
+
data, status_code, headers = api_instance.autocomplete_with_http_info(tr_dataset, autocomplete_req_payload)
|
66
67
|
p status_code # => 2xx
|
67
68
|
p headers # => { ... }
|
68
|
-
p data # => <
|
69
|
+
p data # => <SearchChunkQueryResponseBody>
|
69
70
|
rescue TrieveRubyClient::ApiError => e
|
70
|
-
puts "Error when calling ChunkApi->
|
71
|
+
puts "Error when calling ChunkApi->autocomplete_with_http_info: #{e}"
|
71
72
|
end
|
72
73
|
```
|
73
74
|
|
@@ -76,11 +77,11 @@ end
|
|
76
77
|
| Name | Type | Description | Notes |
|
77
78
|
| ---- | ---- | ----------- | ----- |
|
78
79
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
79
|
-
| **
|
80
|
+
| **autocomplete_req_payload** | [**AutocompleteReqPayload**](AutocompleteReqPayload.md) | JSON request payload to semantically search for chunks (chunks) | |
|
80
81
|
|
81
82
|
### Return type
|
82
83
|
|
83
|
-
[**
|
84
|
+
[**SearchChunkQueryResponseBody**](SearchChunkQueryResponseBody.md)
|
84
85
|
|
85
86
|
### Authorization
|
86
87
|
|
@@ -92,13 +93,13 @@ end
|
|
92
93
|
- **Accept**: application/json
|
93
94
|
|
94
95
|
|
95
|
-
##
|
96
|
+
## create_chunk
|
96
97
|
|
97
|
-
> <
|
98
|
+
> <ReturnQueuedChunk> create_chunk(tr_dataset, create_chunk_req_payload_enum)
|
98
99
|
|
99
|
-
|
100
|
+
Create or Upsert Chunk or Chunks
|
100
101
|
|
101
|
-
|
102
|
+
Create or Upsert Chunk or Chunks Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
102
103
|
|
103
104
|
### Examples
|
104
105
|
|
@@ -115,32 +116,32 @@ end
|
|
115
116
|
|
116
117
|
api_instance = TrieveRubyClient::ChunkApi.new
|
117
118
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
118
|
-
|
119
|
+
create_chunk_req_payload_enum = nil # CreateChunkReqPayloadEnum | JSON request payload to create a new chunk (chunk)
|
119
120
|
|
120
121
|
begin
|
121
|
-
#
|
122
|
-
result = api_instance.
|
122
|
+
# Create or Upsert Chunk or Chunks
|
123
|
+
result = api_instance.create_chunk(tr_dataset, create_chunk_req_payload_enum)
|
123
124
|
p result
|
124
125
|
rescue TrieveRubyClient::ApiError => e
|
125
|
-
puts "Error when calling ChunkApi->
|
126
|
+
puts "Error when calling ChunkApi->create_chunk: #{e}"
|
126
127
|
end
|
127
128
|
```
|
128
129
|
|
129
|
-
#### Using the
|
130
|
+
#### Using the create_chunk_with_http_info variant
|
130
131
|
|
131
132
|
This returns an Array which contains the response data, status code and headers.
|
132
133
|
|
133
|
-
> <Array(<
|
134
|
+
> <Array(<ReturnQueuedChunk>, Integer, Hash)> create_chunk_with_http_info(tr_dataset, create_chunk_req_payload_enum)
|
134
135
|
|
135
136
|
```ruby
|
136
137
|
begin
|
137
|
-
#
|
138
|
-
data, status_code, headers = api_instance.
|
138
|
+
# Create or Upsert Chunk or Chunks
|
139
|
+
data, status_code, headers = api_instance.create_chunk_with_http_info(tr_dataset, create_chunk_req_payload_enum)
|
139
140
|
p status_code # => 2xx
|
140
141
|
p headers # => { ... }
|
141
|
-
p data # => <
|
142
|
+
p data # => <ReturnQueuedChunk>
|
142
143
|
rescue TrieveRubyClient::ApiError => e
|
143
|
-
puts "Error when calling ChunkApi->
|
144
|
+
puts "Error when calling ChunkApi->create_chunk_with_http_info: #{e}"
|
144
145
|
end
|
145
146
|
```
|
146
147
|
|
@@ -149,11 +150,11 @@ end
|
|
149
150
|
| Name | Type | Description | Notes |
|
150
151
|
| ---- | ---- | ----------- | ----- |
|
151
152
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
152
|
-
| **
|
153
|
+
| **create_chunk_req_payload_enum** | [**CreateChunkReqPayloadEnum**](CreateChunkReqPayloadEnum.md) | JSON request payload to create a new chunk (chunk) | |
|
153
154
|
|
154
155
|
### Return type
|
155
156
|
|
156
|
-
[**
|
157
|
+
[**ReturnQueuedChunk**](ReturnQueuedChunk.md)
|
157
158
|
|
158
159
|
### Authorization
|
159
160
|
|
@@ -171,7 +172,7 @@ end
|
|
171
172
|
|
172
173
|
Delete Chunk
|
173
174
|
|
174
|
-
Delete Chunk Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
|
175
|
+
Delete Chunk Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
175
176
|
|
176
177
|
### Examples
|
177
178
|
|
@@ -243,7 +244,7 @@ nil (empty response body)
|
|
243
244
|
|
244
245
|
Delete Chunk By Tracking Id
|
245
246
|
|
246
|
-
Delete Chunk By Tracking Id Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
|
247
|
+
Delete Chunk By Tracking Id Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
247
248
|
|
248
249
|
### Examples
|
249
250
|
|
@@ -384,7 +385,7 @@ end
|
|
384
385
|
|
385
386
|
## get_chunk_by_id
|
386
387
|
|
387
|
-
> <
|
388
|
+
> <ChunkMetadataStringTagSet> get_chunk_by_id(tr_dataset, chunk_id)
|
388
389
|
|
389
390
|
Get Chunk By Id
|
390
391
|
|
@@ -420,7 +421,7 @@ end
|
|
420
421
|
|
421
422
|
This returns an Array which contains the response data, status code and headers.
|
422
423
|
|
423
|
-
> <Array(<
|
424
|
+
> <Array(<ChunkMetadataStringTagSet>, Integer, Hash)> get_chunk_by_id_with_http_info(tr_dataset, chunk_id)
|
424
425
|
|
425
426
|
```ruby
|
426
427
|
begin
|
@@ -428,7 +429,7 @@ begin
|
|
428
429
|
data, status_code, headers = api_instance.get_chunk_by_id_with_http_info(tr_dataset, chunk_id)
|
429
430
|
p status_code # => 2xx
|
430
431
|
p headers # => { ... }
|
431
|
-
p data # => <
|
432
|
+
p data # => <ChunkMetadataStringTagSet>
|
432
433
|
rescue TrieveRubyClient::ApiError => e
|
433
434
|
puts "Error when calling ChunkApi->get_chunk_by_id_with_http_info: #{e}"
|
434
435
|
end
|
@@ -443,7 +444,7 @@ end
|
|
443
444
|
|
444
445
|
### Return type
|
445
446
|
|
446
|
-
[**
|
447
|
+
[**ChunkMetadataStringTagSet**](ChunkMetadataStringTagSet.md)
|
447
448
|
|
448
449
|
### Authorization
|
449
450
|
|
@@ -457,7 +458,7 @@ end
|
|
457
458
|
|
458
459
|
## get_chunk_by_tracking_id
|
459
460
|
|
460
|
-
> <
|
461
|
+
> <ChunkMetadataStringTagSet> get_chunk_by_tracking_id(tr_dataset, tracking_id)
|
461
462
|
|
462
463
|
Get Chunk By Tracking Id
|
463
464
|
|
@@ -493,7 +494,7 @@ end
|
|
493
494
|
|
494
495
|
This returns an Array which contains the response data, status code and headers.
|
495
496
|
|
496
|
-
> <Array(<
|
497
|
+
> <Array(<ChunkMetadataStringTagSet>, Integer, Hash)> get_chunk_by_tracking_id_with_http_info(tr_dataset, tracking_id)
|
497
498
|
|
498
499
|
```ruby
|
499
500
|
begin
|
@@ -501,7 +502,7 @@ begin
|
|
501
502
|
data, status_code, headers = api_instance.get_chunk_by_tracking_id_with_http_info(tr_dataset, tracking_id)
|
502
503
|
p status_code # => 2xx
|
503
504
|
p headers # => { ... }
|
504
|
-
p data # => <
|
505
|
+
p data # => <ChunkMetadataStringTagSet>
|
505
506
|
rescue TrieveRubyClient::ApiError => e
|
506
507
|
puts "Error when calling ChunkApi->get_chunk_by_tracking_id_with_http_info: #{e}"
|
507
508
|
end
|
@@ -516,7 +517,7 @@ end
|
|
516
517
|
|
517
518
|
### Return type
|
518
519
|
|
519
|
-
[**
|
520
|
+
[**ChunkMetadataStringTagSet**](ChunkMetadataStringTagSet.md)
|
520
521
|
|
521
522
|
### Authorization
|
522
523
|
|
@@ -530,7 +531,7 @@ end
|
|
530
531
|
|
531
532
|
## get_chunks_by_ids
|
532
533
|
|
533
|
-
> <Array<
|
534
|
+
> <Array<ChunkMetadataStringTagSet>> get_chunks_by_ids(tr_dataset, get_chunks_data)
|
534
535
|
|
535
536
|
Get Chunks By Ids
|
536
537
|
|
@@ -566,7 +567,7 @@ end
|
|
566
567
|
|
567
568
|
This returns an Array which contains the response data, status code and headers.
|
568
569
|
|
569
|
-
> <Array(<Array<
|
570
|
+
> <Array(<Array<ChunkMetadataStringTagSet>>, Integer, Hash)> get_chunks_by_ids_with_http_info(tr_dataset, get_chunks_data)
|
570
571
|
|
571
572
|
```ruby
|
572
573
|
begin
|
@@ -574,7 +575,7 @@ begin
|
|
574
575
|
data, status_code, headers = api_instance.get_chunks_by_ids_with_http_info(tr_dataset, get_chunks_data)
|
575
576
|
p status_code # => 2xx
|
576
577
|
p headers # => { ... }
|
577
|
-
p data # => <Array<
|
578
|
+
p data # => <Array<ChunkMetadataStringTagSet>>
|
578
579
|
rescue TrieveRubyClient::ApiError => e
|
579
580
|
puts "Error when calling ChunkApi->get_chunks_by_ids_with_http_info: #{e}"
|
580
581
|
end
|
@@ -589,7 +590,7 @@ end
|
|
589
590
|
|
590
591
|
### Return type
|
591
592
|
|
592
|
-
[**Array<
|
593
|
+
[**Array<ChunkMetadataStringTagSet>**](ChunkMetadataStringTagSet.md)
|
593
594
|
|
594
595
|
### Authorization
|
595
596
|
|
@@ -603,7 +604,7 @@ end
|
|
603
604
|
|
604
605
|
## get_chunks_by_tracking_ids
|
605
606
|
|
606
|
-
> <
|
607
|
+
> <Array<ChunkMetadataStringTagSet>> get_chunks_by_tracking_ids(tr_dataset, get_tracking_chunks_data)
|
607
608
|
|
608
609
|
Get Chunks By TrackingIds
|
609
610
|
|
@@ -639,7 +640,7 @@ end
|
|
639
640
|
|
640
641
|
This returns an Array which contains the response data, status code and headers.
|
641
642
|
|
642
|
-
> <Array(<
|
643
|
+
> <Array(<Array<ChunkMetadataStringTagSet>>, Integer, Hash)> get_chunks_by_tracking_ids_with_http_info(tr_dataset, get_tracking_chunks_data)
|
643
644
|
|
644
645
|
```ruby
|
645
646
|
begin
|
@@ -647,7 +648,7 @@ begin
|
|
647
648
|
data, status_code, headers = api_instance.get_chunks_by_tracking_ids_with_http_info(tr_dataset, get_tracking_chunks_data)
|
648
649
|
p status_code # => 2xx
|
649
650
|
p headers # => { ... }
|
650
|
-
p data # => <
|
651
|
+
p data # => <Array<ChunkMetadataStringTagSet>>
|
651
652
|
rescue TrieveRubyClient::ApiError => e
|
652
653
|
puts "Error when calling ChunkApi->get_chunks_by_tracking_ids_with_http_info: #{e}"
|
653
654
|
end
|
@@ -662,7 +663,7 @@ end
|
|
662
663
|
|
663
664
|
### Return type
|
664
665
|
|
665
|
-
[**
|
666
|
+
[**Array<ChunkMetadataStringTagSet>**](ChunkMetadataStringTagSet.md)
|
666
667
|
|
667
668
|
### Authorization
|
668
669
|
|
@@ -680,7 +681,7 @@ end
|
|
680
681
|
|
681
682
|
Get Recommended Chunks
|
682
683
|
|
683
|
-
Get Recommended Chunks Get recommendations of chunks similar to the
|
684
|
+
Get Recommended Chunks Get recommendations of chunks similar to the positive samples in the request and dissimilar to the negative. You must provide at least one of either positive_chunk_ids or positive_tracking_ids.
|
684
685
|
|
685
686
|
### Examples
|
686
687
|
|
@@ -747,9 +748,82 @@ end
|
|
747
748
|
- **Accept**: application/json
|
748
749
|
|
749
750
|
|
751
|
+
## get_suggested_queries
|
752
|
+
|
753
|
+
> <SuggestedQueriesResponse> get_suggested_queries(tr_dataset, suggested_queries_req_payload)
|
754
|
+
|
755
|
+
Generate suggested queries
|
756
|
+
|
757
|
+
Generate suggested queries This endpoint will generate 3 suggested queries based off a hybrid search using RAG with the query provided in the request body and return them as a JSON object.
|
758
|
+
|
759
|
+
### Examples
|
760
|
+
|
761
|
+
```ruby
|
762
|
+
require 'time'
|
763
|
+
require 'trieve_ruby_client'
|
764
|
+
# setup authorization
|
765
|
+
TrieveRubyClient.configure do |config|
|
766
|
+
# Configure API key authorization: ApiKey
|
767
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
768
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
769
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
770
|
+
end
|
771
|
+
|
772
|
+
api_instance = TrieveRubyClient::ChunkApi.new
|
773
|
+
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
774
|
+
suggested_queries_req_payload = TrieveRubyClient::SuggestedQueriesReqPayload.new({query: 'query_example'}) # SuggestedQueriesReqPayload | JSON request payload to get alternative suggested queries
|
775
|
+
|
776
|
+
begin
|
777
|
+
# Generate suggested queries
|
778
|
+
result = api_instance.get_suggested_queries(tr_dataset, suggested_queries_req_payload)
|
779
|
+
p result
|
780
|
+
rescue TrieveRubyClient::ApiError => e
|
781
|
+
puts "Error when calling ChunkApi->get_suggested_queries: #{e}"
|
782
|
+
end
|
783
|
+
```
|
784
|
+
|
785
|
+
#### Using the get_suggested_queries_with_http_info variant
|
786
|
+
|
787
|
+
This returns an Array which contains the response data, status code and headers.
|
788
|
+
|
789
|
+
> <Array(<SuggestedQueriesResponse>, Integer, Hash)> get_suggested_queries_with_http_info(tr_dataset, suggested_queries_req_payload)
|
790
|
+
|
791
|
+
```ruby
|
792
|
+
begin
|
793
|
+
# Generate suggested queries
|
794
|
+
data, status_code, headers = api_instance.get_suggested_queries_with_http_info(tr_dataset, suggested_queries_req_payload)
|
795
|
+
p status_code # => 2xx
|
796
|
+
p headers # => { ... }
|
797
|
+
p data # => <SuggestedQueriesResponse>
|
798
|
+
rescue TrieveRubyClient::ApiError => e
|
799
|
+
puts "Error when calling ChunkApi->get_suggested_queries_with_http_info: #{e}"
|
800
|
+
end
|
801
|
+
```
|
802
|
+
|
803
|
+
### Parameters
|
804
|
+
|
805
|
+
| Name | Type | Description | Notes |
|
806
|
+
| ---- | ---- | ----------- | ----- |
|
807
|
+
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
808
|
+
| **suggested_queries_req_payload** | [**SuggestedQueriesReqPayload**](SuggestedQueriesReqPayload.md) | JSON request payload to get alternative suggested queries | |
|
809
|
+
|
810
|
+
### Return type
|
811
|
+
|
812
|
+
[**SuggestedQueriesResponse**](SuggestedQueriesResponse.md)
|
813
|
+
|
814
|
+
### Authorization
|
815
|
+
|
816
|
+
[ApiKey](../README.md#ApiKey)
|
817
|
+
|
818
|
+
### HTTP request headers
|
819
|
+
|
820
|
+
- **Content-Type**: application/json
|
821
|
+
- **Accept**: application/json
|
822
|
+
|
823
|
+
|
750
824
|
## search_chunks
|
751
825
|
|
752
|
-
> <SearchChunkQueryResponseBody> search_chunks(tr_dataset,
|
826
|
+
> <SearchChunkQueryResponseBody> search_chunks(tr_dataset, search_chunks_req_payload)
|
753
827
|
|
754
828
|
Search
|
755
829
|
|
@@ -770,11 +844,11 @@ end
|
|
770
844
|
|
771
845
|
api_instance = TrieveRubyClient::ChunkApi.new
|
772
846
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
773
|
-
|
847
|
+
search_chunks_req_payload = TrieveRubyClient::SearchChunksReqPayload.new({query: 'query_example', search_type: 'search_type_example'}) # SearchChunksReqPayload | JSON request payload to semantically search for chunks (chunks)
|
774
848
|
|
775
849
|
begin
|
776
850
|
# Search
|
777
|
-
result = api_instance.search_chunks(tr_dataset,
|
851
|
+
result = api_instance.search_chunks(tr_dataset, search_chunks_req_payload)
|
778
852
|
p result
|
779
853
|
rescue TrieveRubyClient::ApiError => e
|
780
854
|
puts "Error when calling ChunkApi->search_chunks: #{e}"
|
@@ -785,12 +859,12 @@ end
|
|
785
859
|
|
786
860
|
This returns an Array which contains the response data, status code and headers.
|
787
861
|
|
788
|
-
> <Array(<SearchChunkQueryResponseBody>, Integer, Hash)> search_chunks_with_http_info(tr_dataset,
|
862
|
+
> <Array(<SearchChunkQueryResponseBody>, Integer, Hash)> search_chunks_with_http_info(tr_dataset, search_chunks_req_payload)
|
789
863
|
|
790
864
|
```ruby
|
791
865
|
begin
|
792
866
|
# Search
|
793
|
-
data, status_code, headers = api_instance.search_chunks_with_http_info(tr_dataset,
|
867
|
+
data, status_code, headers = api_instance.search_chunks_with_http_info(tr_dataset, search_chunks_req_payload)
|
794
868
|
p status_code # => 2xx
|
795
869
|
p headers # => { ... }
|
796
870
|
p data # => <SearchChunkQueryResponseBody>
|
@@ -804,7 +878,7 @@ end
|
|
804
878
|
| Name | Type | Description | Notes |
|
805
879
|
| ---- | ---- | ----------- | ----- |
|
806
880
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
807
|
-
| **
|
881
|
+
| **search_chunks_req_payload** | [**SearchChunksReqPayload**](SearchChunksReqPayload.md) | JSON request payload to semantically search for chunks (chunks) | |
|
808
882
|
|
809
883
|
### Return type
|
810
884
|
|
@@ -822,11 +896,11 @@ end
|
|
822
896
|
|
823
897
|
## update_chunk
|
824
898
|
|
825
|
-
> update_chunk(tr_dataset,
|
899
|
+
> update_chunk(tr_dataset, update_chunk_req_payload)
|
826
900
|
|
827
901
|
Update Chunk
|
828
902
|
|
829
|
-
Update Chunk Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail.
|
903
|
+
Update Chunk Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
830
904
|
|
831
905
|
### Examples
|
832
906
|
|
@@ -843,11 +917,11 @@ end
|
|
843
917
|
|
844
918
|
api_instance = TrieveRubyClient::ChunkApi.new
|
845
919
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
846
|
-
|
920
|
+
update_chunk_req_payload = TrieveRubyClient::UpdateChunkReqPayload.new # UpdateChunkReqPayload | JSON request payload to update a chunk (chunk)
|
847
921
|
|
848
922
|
begin
|
849
923
|
# Update Chunk
|
850
|
-
api_instance.update_chunk(tr_dataset,
|
924
|
+
api_instance.update_chunk(tr_dataset, update_chunk_req_payload)
|
851
925
|
rescue TrieveRubyClient::ApiError => e
|
852
926
|
puts "Error when calling ChunkApi->update_chunk: #{e}"
|
853
927
|
end
|
@@ -857,12 +931,12 @@ end
|
|
857
931
|
|
858
932
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
859
933
|
|
860
|
-
> <Array(nil, Integer, Hash)> update_chunk_with_http_info(tr_dataset,
|
934
|
+
> <Array(nil, Integer, Hash)> update_chunk_with_http_info(tr_dataset, update_chunk_req_payload)
|
861
935
|
|
862
936
|
```ruby
|
863
937
|
begin
|
864
938
|
# Update Chunk
|
865
|
-
data, status_code, headers = api_instance.update_chunk_with_http_info(tr_dataset,
|
939
|
+
data, status_code, headers = api_instance.update_chunk_with_http_info(tr_dataset, update_chunk_req_payload)
|
866
940
|
p status_code # => 2xx
|
867
941
|
p headers # => { ... }
|
868
942
|
p data # => nil
|
@@ -876,7 +950,7 @@ end
|
|
876
950
|
| Name | Type | Description | Notes |
|
877
951
|
| ---- | ---- | ----------- | ----- |
|
878
952
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
879
|
-
| **
|
953
|
+
| **update_chunk_req_payload** | [**UpdateChunkReqPayload**](UpdateChunkReqPayload.md) | JSON request payload to update a chunk (chunk) | |
|
880
954
|
|
881
955
|
### Return type
|
882
956
|
|
@@ -898,7 +972,7 @@ nil (empty response body)
|
|
898
972
|
|
899
973
|
Update Chunk By Tracking Id
|
900
974
|
|
901
|
-
Update Chunk By Tracking Id Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk.
|
975
|
+
Update Chunk By Tracking Id Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
902
976
|
|
903
977
|
### Examples
|
904
978
|
|
data/docs/ChunkData.md
CHANGED
@@ -4,11 +4,12 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **chunk_html** | **String** | HTML content of the chunk. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. |
|
7
|
+
| **chunk_html** | **String** | HTML content of the chunk. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. | [optional] |
|
8
8
|
| **chunk_vector** | **Array<Float>** | Chunk_vector is a vector of floats which can be used instead of generating a new embedding. This is useful for when you are using a pre-embedded dataset. If this is not provided, the innerText of the chunk_html will be used to create the embedding. | [optional] |
|
9
9
|
| **convert_html_to_text** | **Boolean** | Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false. | [optional] |
|
10
10
|
| **group_ids** | **Array<String>** | Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response. | [optional] |
|
11
11
|
| **group_tracking_ids** | **Array<String>** | Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into. This is useful for when you want to create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response. | [optional] |
|
12
|
+
| **image_urls** | **Array<String>** | Image urls are a list of urls to images that are associated with the chunk. This is useful for when you want to associate images with a chunk. | [optional] |
|
12
13
|
| **link** | **String** | Link to the chunk. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. | [optional] |
|
13
14
|
| **location** | [**GeoInfo**](GeoInfo.md) | | [optional] |
|
14
15
|
| **metadata** | **Object** | Metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. | [optional] |
|
@@ -30,6 +31,7 @@ instance = TrieveRubyClient::ChunkData.new(
|
|
30
31
|
convert_html_to_text: null,
|
31
32
|
group_ids: null,
|
32
33
|
group_tracking_ids: null,
|
34
|
+
image_urls: null,
|
33
35
|
link: null,
|
34
36
|
location: null,
|
35
37
|
metadata: null,
|
data/docs/ChunkFilter.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **must** | [**Array<
|
8
|
-
| **must_not** | [**Array<
|
9
|
-
| **should** | [**Array<
|
7
|
+
| **must** | [**Array<ConditionType>**](ConditionType.md) | All of these field conditions have to match for the chunk to be included in the result set. | [optional] |
|
8
|
+
| **must_not** | [**Array<ConditionType>**](ConditionType.md) | None of these field conditions can match for the chunk to be included in the result set. | [optional] |
|
9
|
+
| **should** | [**Array<ConditionType>**](ConditionType.md) | Only one of these field conditions has to match for the chunk to be included in the result set. | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
data/docs/ChunkGroup.md
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
| **id** | **String** | | |
|
11
11
|
| **metadata** | **Object** | | [optional] |
|
12
12
|
| **name** | **String** | | |
|
13
|
-
| **tag_set** | **String
|
13
|
+
| **tag_set** | **Array<String>** | | [optional] |
|
14
14
|
| **tracking_id** | **String** | | [optional] |
|
15
15
|
| **updated_at** | **Time** | | |
|
16
16
|
|