typesense-rs 27.0.1

An open source search engine for building delightful search experiences.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281

# \CollectionsApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_collection**](CollectionsApi.md#create_collection) | **POST** /collections | Create a new collection
[**delete_alias**](CollectionsApi.md#delete_alias) | **DELETE** /aliases/{aliasName} | Delete an alias
[**delete_collection**](CollectionsApi.md#delete_collection) | **DELETE** /collections/{collectionName} | Delete a collection
[**get_alias**](CollectionsApi.md#get_alias) | **GET** /aliases/{aliasName} | Retrieve an alias
[**get_aliases**](CollectionsApi.md#get_aliases) | **GET** /aliases | List all aliases
[**get_collection**](CollectionsApi.md#get_collection) | **GET** /collections/{collectionName} | Retrieve a single collection
[**get_collections**](CollectionsApi.md#get_collections) | **GET** /collections | List all collections
[**update_collection**](CollectionsApi.md#update_collection) | **PATCH** /collections/{collectionName} | Update a collection
[**upsert_alias**](CollectionsApi.md#upsert_alias) | **PUT** /aliases/{aliasName} | Create or update a collection alias



## create_collection

> models::CollectionResponse create_collection(collection_schema)
Create a new collection

When a collection is created, we give it a name and describe the fields that will be indexed from the documents added to the collection.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**collection_schema** | [**CollectionSchema**](CollectionSchema.md) | The collection object to be created | [required] |

### Return type

[**models::CollectionResponse**](CollectionResponse.md)

### Authorization

[api_key_header](../README.md#api_key_header)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_alias

> models::CollectionAlias delete_alias(alias_name)
Delete an alias

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**alias_name** | **String** | The name of the alias to delete | [required] |

### Return type

[**models::CollectionAlias**](CollectionAlias.md)

### Authorization

[api_key_header](../README.md#api_key_header)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_collection

> models::CollectionResponse delete_collection(collection_name)
Delete a collection

Permanently drops a collection. This action cannot be undone. For large collections, this might have an impact on read latencies.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**collection_name** | **String** | The name of the collection to delete | [required] |

### Return type

[**models::CollectionResponse**](CollectionResponse.md)

### Authorization

[api_key_header](../README.md#api_key_header)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_alias

> models::CollectionAlias get_alias(alias_name)
Retrieve an alias

Find out which collection an alias points to by fetching it

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**alias_name** | **String** | The name of the alias to retrieve | [required] |

### Return type

[**models::CollectionAlias**](CollectionAlias.md)

### Authorization

[api_key_header](../README.md#api_key_header)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_aliases

> models::CollectionAliasesResponse get_aliases()
List all aliases

List all aliases and the corresponding collections that they map to.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::CollectionAliasesResponse**](CollectionAliasesResponse.md)

### Authorization

[api_key_header](../README.md#api_key_header)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_collection

> models::CollectionResponse get_collection(collection_name)
Retrieve a single collection

Retrieve the details of a collection, given its name.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**collection_name** | **String** | The name of the collection to retrieve | [required] |

### Return type

[**models::CollectionResponse**](CollectionResponse.md)

### Authorization

[api_key_header](../README.md#api_key_header)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_collections

> Vec<models::CollectionResponse> get_collections()
List all collections

Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::CollectionResponse>**](CollectionResponse.md)

### Authorization

[api_key_header](../README.md#api_key_header)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_collection

> models::CollectionUpdateSchema update_collection(collection_name, collection_update_schema)
Update a collection

Update a collection's schema to modify the fields and their types.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**collection_name** | **String** | The name of the collection to update | [required] |
**collection_update_schema** | [**CollectionUpdateSchema**](CollectionUpdateSchema.md) | The document object with fields to be updated | [required] |

### Return type

[**models::CollectionUpdateSchema**](CollectionUpdateSchema.md)

### Authorization

[api_key_header](../README.md#api_key_header)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## upsert_alias

> models::CollectionAlias upsert_alias(alias_name, collection_alias_schema)
Create or update a collection alias

Create or update a collection alias. An alias is a virtual collection name that points to a real collection. If you're familiar with symbolic links on Linux, it's very similar to that. Aliases are useful when you want to reindex your data in the background on a new collection and switch your application to it without any changes to your code.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**alias_name** | **String** | The name of the alias to create/update | [required] |
**collection_alias_schema** | Option<[**CollectionAliasSchema**](CollectionAliasSchema.md)> | Collection alias to be created/updated |  |

### Return type

[**models::CollectionAlias**](CollectionAlias.md)

### Authorization

[api_key_header](../README.md#api_key_header)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)