Skip to content

Search Api

immichpy.client.generated.api.search_api.SearchApi 

SearchApi(api_client=None)

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Source code in immichpy/client/generated/api/search_api.py 
49
50
51
52
def __init__(self, api_client=None) -> None:
    if api_client is None:
        api_client = ApiClient.get_default()
    self.api_client = api_client

get_assets_by_city async 

get_assets_by_city(_request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> List[AssetResponseDto]

Retrieve assets by city

Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in.

Parameters:

Name Type Description Default
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
List[AssetResponseDto]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
 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
@validate_call
async def get_assets_by_city(
    self,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> List[AssetResponseDto]:
    """Retrieve assets by city

    Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in.

    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._get_assets_by_city_serialize(
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[AssetResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    ).data

get_assets_by_city_with_http_info async 

get_assets_by_city_with_http_info(_request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> ApiResponse[List[AssetResponseDto]]

Retrieve assets by city

Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in.

Parameters:

Name Type Description Default
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
ApiResponse[List[AssetResponseDto]]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
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
@validate_call
async def get_assets_by_city_with_http_info(
    self,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[List[AssetResponseDto]]:
    """Retrieve assets by city

    Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in.

    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._get_assets_by_city_serialize(
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[AssetResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    )

get_assets_by_city_without_preload_content async 

get_assets_by_city_without_preload_content(_request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> RESTResponseType

Retrieve assets by city

Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in.

Parameters:

Name Type Description Default
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
RESTResponseType

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
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
@validate_call
async def get_assets_by_city_without_preload_content(
    self,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
    """Retrieve assets by city

    Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in.

    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._get_assets_by_city_serialize(
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[AssetResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    return response_data.response

get_explore_data async 

get_explore_data(_request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> List[SearchExploreResponseDto]

Retrieve explore data

Retrieve data for the explore section, such as popular people and places.

Parameters:

Name Type Description Default
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
List[SearchExploreResponseDto]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
@validate_call
async def get_explore_data(
    self,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> List[SearchExploreResponseDto]:
    """Retrieve explore data

    Retrieve data for the explore section, such as popular people and places.

    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._get_explore_data_serialize(
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[SearchExploreResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    ).data

get_explore_data_with_http_info async 

get_explore_data_with_http_info(_request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> ApiResponse[List[SearchExploreResponseDto]]

Retrieve explore data

Retrieve data for the explore section, such as popular people and places.

Parameters:

Name Type Description Default
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
ApiResponse[List[SearchExploreResponseDto]]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
@validate_call
async def get_explore_data_with_http_info(
    self,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[List[SearchExploreResponseDto]]:
    """Retrieve explore data

    Retrieve data for the explore section, such as popular people and places.

    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._get_explore_data_serialize(
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[SearchExploreResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    )

get_explore_data_without_preload_content async 

get_explore_data_without_preload_content(_request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> RESTResponseType

Retrieve explore data

Retrieve data for the explore section, such as popular people and places.

Parameters:

Name Type Description Default
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
RESTResponseType

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
@validate_call
async def get_explore_data_without_preload_content(
    self,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
    """Retrieve explore data

    Retrieve data for the explore section, such as popular people and places.

    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._get_explore_data_serialize(
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[SearchExploreResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    return response_data.response

get_search_suggestions async 

get_search_suggestions(type: Annotated[SearchSuggestionType, Field(description='Suggestion type')], country: Annotated[Optional[StrictStr], Field(description='Filter by country')] = None, include_null: Annotated[Optional[StrictBool], Field(description='Include null values in suggestions')] = None, lens_model: Annotated[Optional[StrictStr], Field(description='Filter by lens model')] = None, make: Annotated[Optional[StrictStr], Field(description='Filter by camera make')] = None, model: Annotated[Optional[StrictStr], Field(description='Filter by camera model')] = None, state: Annotated[Optional[StrictStr], Field(description='Filter by state/province')] = None, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> List[str]

Retrieve search suggestions

Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features.

Parameters:

Name Type Description Default
type Annotated[SearchSuggestionType, Field(description='Suggestion type')]

Suggestion type (required)

 required
country Annotated[Optional[StrictStr], Field(description='Filter by country')]

Filter by country

 None
include_null Annotated[Optional[StrictBool], Field(description='Include null values in suggestions')]

Include null values in suggestions

 None
lens_model Annotated[Optional[StrictStr], Field(description='Filter by lens model')]

Filter by lens model

 None
make Annotated[Optional[StrictStr], Field(description='Filter by camera make')]

Filter by camera make

 None
model Annotated[Optional[StrictStr], Field(description='Filter by camera model')]

Filter by camera model

 None
state Annotated[Optional[StrictStr], Field(description='Filter by state/province')]

Filter by state/province

 None
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
List[str]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
@validate_call
async def get_search_suggestions(
    self,
    type: Annotated[SearchSuggestionType, Field(description="Suggestion type")],
    country: Annotated[
        Optional[StrictStr], Field(description="Filter by country")
    ] = None,
    include_null: Annotated[
        Optional[StrictBool],
        Field(description="Include null values in suggestions"),
    ] = None,
    lens_model: Annotated[
        Optional[StrictStr], Field(description="Filter by lens model")
    ] = None,
    make: Annotated[
        Optional[StrictStr], Field(description="Filter by camera make")
    ] = None,
    model: Annotated[
        Optional[StrictStr], Field(description="Filter by camera model")
    ] = None,
    state: Annotated[
        Optional[StrictStr], Field(description="Filter by state/province")
    ] = None,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> List[str]:
    """Retrieve search suggestions

    Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features.

    :param type: Suggestion type (required)
    :type type: SearchSuggestionType
    :param country: Filter by country
    :type country: str
    :param include_null: Include null values in suggestions
    :type include_null: bool
    :param lens_model: Filter by lens model
    :type lens_model: str
    :param make: Filter by camera make
    :type make: str
    :param model: Filter by camera model
    :type model: str
    :param state: Filter by state/province
    :type state: str
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._get_search_suggestions_serialize(
        type=type,
        country=country,
        include_null=include_null,
        lens_model=lens_model,
        make=make,
        model=model,
        state=state,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[str]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    ).data

get_search_suggestions_with_http_info async 

get_search_suggestions_with_http_info(type: Annotated[SearchSuggestionType, Field(description='Suggestion type')], country: Annotated[Optional[StrictStr], Field(description='Filter by country')] = None, include_null: Annotated[Optional[StrictBool], Field(description='Include null values in suggestions')] = None, lens_model: Annotated[Optional[StrictStr], Field(description='Filter by lens model')] = None, make: Annotated[Optional[StrictStr], Field(description='Filter by camera make')] = None, model: Annotated[Optional[StrictStr], Field(description='Filter by camera model')] = None, state: Annotated[Optional[StrictStr], Field(description='Filter by state/province')] = None, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> ApiResponse[List[str]]

Retrieve search suggestions

Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features.

Parameters:

Name Type Description Default
type Annotated[SearchSuggestionType, Field(description='Suggestion type')]

Suggestion type (required)

 required
country Annotated[Optional[StrictStr], Field(description='Filter by country')]

Filter by country

 None
include_null Annotated[Optional[StrictBool], Field(description='Include null values in suggestions')]

Include null values in suggestions

 None
lens_model Annotated[Optional[StrictStr], Field(description='Filter by lens model')]

Filter by lens model

 None
make Annotated[Optional[StrictStr], Field(description='Filter by camera make')]

Filter by camera make

 None
model Annotated[Optional[StrictStr], Field(description='Filter by camera model')]

Filter by camera model

 None
state Annotated[Optional[StrictStr], Field(description='Filter by state/province')]

Filter by state/province

 None
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
ApiResponse[List[str]]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
@validate_call
async def get_search_suggestions_with_http_info(
    self,
    type: Annotated[SearchSuggestionType, Field(description="Suggestion type")],
    country: Annotated[
        Optional[StrictStr], Field(description="Filter by country")
    ] = None,
    include_null: Annotated[
        Optional[StrictBool],
        Field(description="Include null values in suggestions"),
    ] = None,
    lens_model: Annotated[
        Optional[StrictStr], Field(description="Filter by lens model")
    ] = None,
    make: Annotated[
        Optional[StrictStr], Field(description="Filter by camera make")
    ] = None,
    model: Annotated[
        Optional[StrictStr], Field(description="Filter by camera model")
    ] = None,
    state: Annotated[
        Optional[StrictStr], Field(description="Filter by state/province")
    ] = None,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[List[str]]:
    """Retrieve search suggestions

    Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features.

    :param type: Suggestion type (required)
    :type type: SearchSuggestionType
    :param country: Filter by country
    :type country: str
    :param include_null: Include null values in suggestions
    :type include_null: bool
    :param lens_model: Filter by lens model
    :type lens_model: str
    :param make: Filter by camera make
    :type make: str
    :param model: Filter by camera model
    :type model: str
    :param state: Filter by state/province
    :type state: str
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._get_search_suggestions_serialize(
        type=type,
        country=country,
        include_null=include_null,
        lens_model=lens_model,
        make=make,
        model=model,
        state=state,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[str]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    )

get_search_suggestions_without_preload_content async 

get_search_suggestions_without_preload_content(type: Annotated[SearchSuggestionType, Field(description='Suggestion type')], country: Annotated[Optional[StrictStr], Field(description='Filter by country')] = None, include_null: Annotated[Optional[StrictBool], Field(description='Include null values in suggestions')] = None, lens_model: Annotated[Optional[StrictStr], Field(description='Filter by lens model')] = None, make: Annotated[Optional[StrictStr], Field(description='Filter by camera make')] = None, model: Annotated[Optional[StrictStr], Field(description='Filter by camera model')] = None, state: Annotated[Optional[StrictStr], Field(description='Filter by state/province')] = None, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> RESTResponseType

Retrieve search suggestions

Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features.

Parameters:

Name Type Description Default
type Annotated[SearchSuggestionType, Field(description='Suggestion type')]

Suggestion type (required)

 required
country Annotated[Optional[StrictStr], Field(description='Filter by country')]

Filter by country

 None
include_null Annotated[Optional[StrictBool], Field(description='Include null values in suggestions')]

Include null values in suggestions

 None
lens_model Annotated[Optional[StrictStr], Field(description='Filter by lens model')]

Filter by lens model

 None
make Annotated[Optional[StrictStr], Field(description='Filter by camera make')]

Filter by camera make

 None
model Annotated[Optional[StrictStr], Field(description='Filter by camera model')]

Filter by camera model

 None
state Annotated[Optional[StrictStr], Field(description='Filter by state/province')]

Filter by state/province

 None
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
RESTResponseType

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
@validate_call
async def get_search_suggestions_without_preload_content(
    self,
    type: Annotated[SearchSuggestionType, Field(description="Suggestion type")],
    country: Annotated[
        Optional[StrictStr], Field(description="Filter by country")
    ] = None,
    include_null: Annotated[
        Optional[StrictBool],
        Field(description="Include null values in suggestions"),
    ] = None,
    lens_model: Annotated[
        Optional[StrictStr], Field(description="Filter by lens model")
    ] = None,
    make: Annotated[
        Optional[StrictStr], Field(description="Filter by camera make")
    ] = None,
    model: Annotated[
        Optional[StrictStr], Field(description="Filter by camera model")
    ] = None,
    state: Annotated[
        Optional[StrictStr], Field(description="Filter by state/province")
    ] = None,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
    """Retrieve search suggestions

    Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features.

    :param type: Suggestion type (required)
    :type type: SearchSuggestionType
    :param country: Filter by country
    :type country: str
    :param include_null: Include null values in suggestions
    :type include_null: bool
    :param lens_model: Filter by lens model
    :type lens_model: str
    :param make: Filter by camera make
    :type make: str
    :param model: Filter by camera model
    :type model: str
    :param state: Filter by state/province
    :type state: str
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._get_search_suggestions_serialize(
        type=type,
        country=country,
        include_null=include_null,
        lens_model=lens_model,
        make=make,
        model=model,
        state=state,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[str]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    return response_data.response

search_asset_statistics async 

search_asset_statistics(statistics_search_dto: StatisticsSearchDto, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> SearchStatisticsResponseDto

Search asset statistics

Retrieve statistical data about assets based on search criteria, such as the total matching count.

Parameters:

Name Type Description Default
statistics_search_dto StatisticsSearchDto

(required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
SearchStatisticsResponseDto

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
@validate_call
async def search_asset_statistics(
    self,
    statistics_search_dto: StatisticsSearchDto,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> SearchStatisticsResponseDto:
    """Search asset statistics

    Retrieve statistical data about assets based on search criteria, such as the total matching count.

    :param statistics_search_dto: (required)
    :type statistics_search_dto: StatisticsSearchDto
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_asset_statistics_serialize(
        statistics_search_dto=statistics_search_dto,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "SearchStatisticsResponseDto",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    ).data

search_asset_statistics_with_http_info async 

search_asset_statistics_with_http_info(statistics_search_dto: StatisticsSearchDto, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> ApiResponse[SearchStatisticsResponseDto]

Search asset statistics

Retrieve statistical data about assets based on search criteria, such as the total matching count.

Parameters:

Name Type Description Default
statistics_search_dto StatisticsSearchDto

(required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
ApiResponse[SearchStatisticsResponseDto]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
@validate_call
async def search_asset_statistics_with_http_info(
    self,
    statistics_search_dto: StatisticsSearchDto,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[SearchStatisticsResponseDto]:
    """Search asset statistics

    Retrieve statistical data about assets based on search criteria, such as the total matching count.

    :param statistics_search_dto: (required)
    :type statistics_search_dto: StatisticsSearchDto
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_asset_statistics_serialize(
        statistics_search_dto=statistics_search_dto,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "SearchStatisticsResponseDto",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    )

search_asset_statistics_without_preload_content async 

search_asset_statistics_without_preload_content(statistics_search_dto: StatisticsSearchDto, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> RESTResponseType

Search asset statistics

Retrieve statistical data about assets based on search criteria, such as the total matching count.

Parameters:

Name Type Description Default
statistics_search_dto StatisticsSearchDto

(required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
RESTResponseType

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
@validate_call
async def search_asset_statistics_without_preload_content(
    self,
    statistics_search_dto: StatisticsSearchDto,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
    """Search asset statistics

    Retrieve statistical data about assets based on search criteria, such as the total matching count.

    :param statistics_search_dto: (required)
    :type statistics_search_dto: StatisticsSearchDto
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_asset_statistics_serialize(
        statistics_search_dto=statistics_search_dto,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "SearchStatisticsResponseDto",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    return response_data.response

search_assets async 

search_assets(metadata_search_dto: MetadataSearchDto, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> SearchResponseDto

Search assets by metadata

Search for assets based on various metadata criteria.

Parameters:

Name Type Description Default
metadata_search_dto MetadataSearchDto

(required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
SearchResponseDto

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
@validate_call
async def search_assets(
    self,
    metadata_search_dto: MetadataSearchDto,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> SearchResponseDto:
    """Search assets by metadata

    Search for assets based on various metadata criteria.

    :param metadata_search_dto: (required)
    :type metadata_search_dto: MetadataSearchDto
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_assets_serialize(
        metadata_search_dto=metadata_search_dto,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "SearchResponseDto",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    ).data

search_assets_with_http_info async 

search_assets_with_http_info(metadata_search_dto: MetadataSearchDto, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> ApiResponse[SearchResponseDto]

Search assets by metadata

Search for assets based on various metadata criteria.

Parameters:

Name Type Description Default
metadata_search_dto MetadataSearchDto

(required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
ApiResponse[SearchResponseDto]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
@validate_call
async def search_assets_with_http_info(
    self,
    metadata_search_dto: MetadataSearchDto,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[SearchResponseDto]:
    """Search assets by metadata

    Search for assets based on various metadata criteria.

    :param metadata_search_dto: (required)
    :type metadata_search_dto: MetadataSearchDto
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_assets_serialize(
        metadata_search_dto=metadata_search_dto,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "SearchResponseDto",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    )

search_assets_without_preload_content async 

search_assets_without_preload_content(metadata_search_dto: MetadataSearchDto, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> RESTResponseType

Search assets by metadata

Search for assets based on various metadata criteria.

Parameters:

Name Type Description Default
metadata_search_dto MetadataSearchDto

(required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
RESTResponseType

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
@validate_call
async def search_assets_without_preload_content(
    self,
    metadata_search_dto: MetadataSearchDto,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
    """Search assets by metadata

    Search for assets based on various metadata criteria.

    :param metadata_search_dto: (required)
    :type metadata_search_dto: MetadataSearchDto
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_assets_serialize(
        metadata_search_dto=metadata_search_dto,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "SearchResponseDto",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    return response_data.response

search_large_assets async 

search_large_assets(album_ids: Annotated[Optional[List[UUID]], Field(description='Filter by album IDs')] = None, city: Annotated[Optional[StrictStr], Field(description='Filter by city name')] = None, country: Annotated[Optional[StrictStr], Field(description='Filter by country name')] = None, created_after: Annotated[Optional[datetime], Field(description='Filter by creation date (after)')] = None, created_before: Annotated[Optional[datetime], Field(description='Filter by creation date (before)')] = None, device_id: Annotated[Optional[StrictStr], Field(description='Device ID to filter by')] = None, is_encoded: Annotated[Optional[StrictBool], Field(description='Filter by encoded status')] = None, is_favorite: Annotated[Optional[StrictBool], Field(description='Filter by favorite status')] = None, is_motion: Annotated[Optional[StrictBool], Field(description='Filter by motion photo status')] = None, is_not_in_album: Annotated[Optional[StrictBool], Field(description='Filter assets not in any album')] = None, is_offline: Annotated[Optional[StrictBool], Field(description='Filter by offline status')] = None, lens_model: Annotated[Optional[StrictStr], Field(description='Filter by lens model')] = None, library_id: Annotated[Optional[UUID], Field(description='Library ID to filter by')] = None, make: Annotated[Optional[StrictStr], Field(description='Filter by camera make')] = None, min_file_size: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description='Minimum file size in bytes')] = None, model: Annotated[Optional[StrictStr], Field(description='Filter by camera model')] = None, ocr: Annotated[Optional[StrictStr], Field(description='Filter by OCR text content')] = None, person_ids: Annotated[Optional[List[UUID]], Field(description='Filter by person IDs')] = None, rating: Annotated[Optional[Union[Annotated[float, Field(le=5, strict=True, ge=-1)], Annotated[int, Field(le=5, strict=True, ge=-1)]]], Field(description='Filter by rating [1-5], or null for unrated')] = None, size: Annotated[Optional[Union[Annotated[float, Field(le=1000, strict=True, ge=1)], Annotated[int, Field(le=1000, strict=True, ge=1)]]], Field(description='Number of results to return')] = None, state: Annotated[Optional[StrictStr], Field(description='Filter by state/province name')] = None, tag_ids: Annotated[Optional[List[UUID]], Field(description='Filter by tag IDs')] = None, taken_after: Annotated[Optional[datetime], Field(description='Filter by taken date (after)')] = None, taken_before: Annotated[Optional[datetime], Field(description='Filter by taken date (before)')] = None, trashed_after: Annotated[Optional[datetime], Field(description='Filter by trash date (after)')] = None, trashed_before: Annotated[Optional[datetime], Field(description='Filter by trash date (before)')] = None, type: Annotated[Optional[AssetTypeEnum], Field(description='Asset type filter')] = None, updated_after: Annotated[Optional[datetime], Field(description='Filter by update date (after)')] = None, updated_before: Annotated[Optional[datetime], Field(description='Filter by update date (before)')] = None, visibility: Annotated[Optional[AssetVisibility], Field(description='Filter by visibility')] = None, with_deleted: Annotated[Optional[StrictBool], Field(description='Include deleted assets')] = None, with_exif: Annotated[Optional[StrictBool], Field(description='Include EXIF data in response')] = None, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> List[AssetResponseDto]

Search large assets

Search for assets that are considered large based on specified criteria.

Parameters:

Name Type Description Default
album_ids Annotated[Optional[List[UUID]], Field(description='Filter by album IDs')]

Filter by album IDs

 None
city Annotated[Optional[StrictStr], Field(description='Filter by city name')]

Filter by city name

 None
country Annotated[Optional[StrictStr], Field(description='Filter by country name')]

Filter by country name

 None
created_after Annotated[Optional[datetime], Field(description='Filter by creation date (after)')]

Filter by creation date (after)

 None
created_before Annotated[Optional[datetime], Field(description='Filter by creation date (before)')]

Filter by creation date (before)

 None
device_id Annotated[Optional[StrictStr], Field(description='Device ID to filter by')]

Device ID to filter by

 None
is_encoded Annotated[Optional[StrictBool], Field(description='Filter by encoded status')]

Filter by encoded status

 None
is_favorite Annotated[Optional[StrictBool], Field(description='Filter by favorite status')]

Filter by favorite status

 None
is_motion Annotated[Optional[StrictBool], Field(description='Filter by motion photo status')]

Filter by motion photo status

 None
is_not_in_album Annotated[Optional[StrictBool], Field(description='Filter assets not in any album')]

Filter assets not in any album

 None
is_offline Annotated[Optional[StrictBool], Field(description='Filter by offline status')]

Filter by offline status

 None
lens_model Annotated[Optional[StrictStr], Field(description='Filter by lens model')]

Filter by lens model

 None
library_id Annotated[Optional[UUID], Field(description='Library ID to filter by')]

Library ID to filter by

 None
make Annotated[Optional[StrictStr], Field(description='Filter by camera make')]

Filter by camera make

 None
min_file_size Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description='Minimum file size in bytes')]

Minimum file size in bytes

 None
model Annotated[Optional[StrictStr], Field(description='Filter by camera model')]

Filter by camera model

 None
ocr Annotated[Optional[StrictStr], Field(description='Filter by OCR text content')]

Filter by OCR text content

 None
person_ids Annotated[Optional[List[UUID]], Field(description='Filter by person IDs')]

Filter by person IDs

 None
rating Annotated[Optional[Union[Annotated[float, Field(le=5, strict=True, ge=-1)], Annotated[int, Field(le=5, strict=True, ge=-1)]]], Field(description='Filter by rating [1-5], or null for unrated')]

Filter by rating [1-5], or null for unrated

 None
size Annotated[Optional[Union[Annotated[float, Field(le=1000, strict=True, ge=1)], Annotated[int, Field(le=1000, strict=True, ge=1)]]], Field(description='Number of results to return')]

Number of results to return

 None
state Annotated[Optional[StrictStr], Field(description='Filter by state/province name')]

Filter by state/province name

 None
tag_ids Annotated[Optional[List[UUID]], Field(description='Filter by tag IDs')]

Filter by tag IDs

 None
taken_after Annotated[Optional[datetime], Field(description='Filter by taken date (after)')]

Filter by taken date (after)

 None
taken_before Annotated[Optional[datetime], Field(description='Filter by taken date (before)')]

Filter by taken date (before)

 None
trashed_after Annotated[Optional[datetime], Field(description='Filter by trash date (after)')]

Filter by trash date (after)

 None
trashed_before Annotated[Optional[datetime], Field(description='Filter by trash date (before)')]

Filter by trash date (before)

 None
type Annotated[Optional[AssetTypeEnum], Field(description='Asset type filter')]

Asset type filter

 None
updated_after Annotated[Optional[datetime], Field(description='Filter by update date (after)')]

Filter by update date (after)

 None
updated_before Annotated[Optional[datetime], Field(description='Filter by update date (before)')]

Filter by update date (before)

 None
visibility Annotated[Optional[AssetVisibility], Field(description='Filter by visibility')]

Filter by visibility

 None
with_deleted Annotated[Optional[StrictBool], Field(description='Include deleted assets')]

Include deleted assets

 None
with_exif Annotated[Optional[StrictBool], Field(description='Include EXIF data in response')]

Include EXIF data in response

 None
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
List[AssetResponseDto]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
@validate_call
async def search_large_assets(
    self,
    album_ids: Annotated[
        Optional[List[UUID]], Field(description="Filter by album IDs")
    ] = None,
    city: Annotated[
        Optional[StrictStr], Field(description="Filter by city name")
    ] = None,
    country: Annotated[
        Optional[StrictStr], Field(description="Filter by country name")
    ] = None,
    created_after: Annotated[
        Optional[datetime], Field(description="Filter by creation date (after)")
    ] = None,
    created_before: Annotated[
        Optional[datetime], Field(description="Filter by creation date (before)")
    ] = None,
    device_id: Annotated[
        Optional[StrictStr], Field(description="Device ID to filter by")
    ] = None,
    is_encoded: Annotated[
        Optional[StrictBool], Field(description="Filter by encoded status")
    ] = None,
    is_favorite: Annotated[
        Optional[StrictBool], Field(description="Filter by favorite status")
    ] = None,
    is_motion: Annotated[
        Optional[StrictBool], Field(description="Filter by motion photo status")
    ] = None,
    is_not_in_album: Annotated[
        Optional[StrictBool], Field(description="Filter assets not in any album")
    ] = None,
    is_offline: Annotated[
        Optional[StrictBool], Field(description="Filter by offline status")
    ] = None,
    lens_model: Annotated[
        Optional[StrictStr], Field(description="Filter by lens model")
    ] = None,
    library_id: Annotated[
        Optional[UUID], Field(description="Library ID to filter by")
    ] = None,
    make: Annotated[
        Optional[StrictStr], Field(description="Filter by camera make")
    ] = None,
    min_file_size: Annotated[
        Optional[Annotated[int, Field(strict=True, ge=0)]],
        Field(description="Minimum file size in bytes"),
    ] = None,
    model: Annotated[
        Optional[StrictStr], Field(description="Filter by camera model")
    ] = None,
    ocr: Annotated[
        Optional[StrictStr], Field(description="Filter by OCR text content")
    ] = None,
    person_ids: Annotated[
        Optional[List[UUID]], Field(description="Filter by person IDs")
    ] = None,
    rating: Annotated[
        Optional[
            Union[
                Annotated[float, Field(le=5, strict=True, ge=-1)],
                Annotated[int, Field(le=5, strict=True, ge=-1)],
            ]
        ],
        Field(description="Filter by rating [1-5], or null for unrated"),
    ] = None,
    size: Annotated[
        Optional[
            Union[
                Annotated[float, Field(le=1000, strict=True, ge=1)],
                Annotated[int, Field(le=1000, strict=True, ge=1)],
            ]
        ],
        Field(description="Number of results to return"),
    ] = None,
    state: Annotated[
        Optional[StrictStr], Field(description="Filter by state/province name")
    ] = None,
    tag_ids: Annotated[
        Optional[List[UUID]], Field(description="Filter by tag IDs")
    ] = None,
    taken_after: Annotated[
        Optional[datetime], Field(description="Filter by taken date (after)")
    ] = None,
    taken_before: Annotated[
        Optional[datetime], Field(description="Filter by taken date (before)")
    ] = None,
    trashed_after: Annotated[
        Optional[datetime], Field(description="Filter by trash date (after)")
    ] = None,
    trashed_before: Annotated[
        Optional[datetime], Field(description="Filter by trash date (before)")
    ] = None,
    type: Annotated[
        Optional[AssetTypeEnum], Field(description="Asset type filter")
    ] = None,
    updated_after: Annotated[
        Optional[datetime], Field(description="Filter by update date (after)")
    ] = None,
    updated_before: Annotated[
        Optional[datetime], Field(description="Filter by update date (before)")
    ] = None,
    visibility: Annotated[
        Optional[AssetVisibility], Field(description="Filter by visibility")
    ] = None,
    with_deleted: Annotated[
        Optional[StrictBool], Field(description="Include deleted assets")
    ] = None,
    with_exif: Annotated[
        Optional[StrictBool], Field(description="Include EXIF data in response")
    ] = None,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> List[AssetResponseDto]:
    """Search large assets

    Search for assets that are considered large based on specified criteria.

    :param album_ids: Filter by album IDs
    :type album_ids: List[UUID]
    :param city: Filter by city name
    :type city: str
    :param country: Filter by country name
    :type country: str
    :param created_after: Filter by creation date (after)
    :type created_after: datetime
    :param created_before: Filter by creation date (before)
    :type created_before: datetime
    :param device_id: Device ID to filter by
    :type device_id: str
    :param is_encoded: Filter by encoded status
    :type is_encoded: bool
    :param is_favorite: Filter by favorite status
    :type is_favorite: bool
    :param is_motion: Filter by motion photo status
    :type is_motion: bool
    :param is_not_in_album: Filter assets not in any album
    :type is_not_in_album: bool
    :param is_offline: Filter by offline status
    :type is_offline: bool
    :param lens_model: Filter by lens model
    :type lens_model: str
    :param library_id: Library ID to filter by
    :type library_id: UUID
    :param make: Filter by camera make
    :type make: str
    :param min_file_size: Minimum file size in bytes
    :type min_file_size: int
    :param model: Filter by camera model
    :type model: str
    :param ocr: Filter by OCR text content
    :type ocr: str
    :param person_ids: Filter by person IDs
    :type person_ids: List[UUID]
    :param rating: Filter by rating [1-5], or null for unrated
    :type rating: float
    :param size: Number of results to return
    :type size: float
    :param state: Filter by state/province name
    :type state: str
    :param tag_ids: Filter by tag IDs
    :type tag_ids: List[UUID]
    :param taken_after: Filter by taken date (after)
    :type taken_after: datetime
    :param taken_before: Filter by taken date (before)
    :type taken_before: datetime
    :param trashed_after: Filter by trash date (after)
    :type trashed_after: datetime
    :param trashed_before: Filter by trash date (before)
    :type trashed_before: datetime
    :param type: Asset type filter
    :type type: AssetTypeEnum
    :param updated_after: Filter by update date (after)
    :type updated_after: datetime
    :param updated_before: Filter by update date (before)
    :type updated_before: datetime
    :param visibility: Filter by visibility
    :type visibility: AssetVisibility
    :param with_deleted: Include deleted assets
    :type with_deleted: bool
    :param with_exif: Include EXIF data in response
    :type with_exif: bool
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_large_assets_serialize(
        album_ids=album_ids,
        city=city,
        country=country,
        created_after=created_after,
        created_before=created_before,
        device_id=device_id,
        is_encoded=is_encoded,
        is_favorite=is_favorite,
        is_motion=is_motion,
        is_not_in_album=is_not_in_album,
        is_offline=is_offline,
        lens_model=lens_model,
        library_id=library_id,
        make=make,
        min_file_size=min_file_size,
        model=model,
        ocr=ocr,
        person_ids=person_ids,
        rating=rating,
        size=size,
        state=state,
        tag_ids=tag_ids,
        taken_after=taken_after,
        taken_before=taken_before,
        trashed_after=trashed_after,
        trashed_before=trashed_before,
        type=type,
        updated_after=updated_after,
        updated_before=updated_before,
        visibility=visibility,
        with_deleted=with_deleted,
        with_exif=with_exif,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[AssetResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    ).data

search_large_assets_with_http_info async 

search_large_assets_with_http_info(album_ids: Annotated[Optional[List[UUID]], Field(description='Filter by album IDs')] = None, city: Annotated[Optional[StrictStr], Field(description='Filter by city name')] = None, country: Annotated[Optional[StrictStr], Field(description='Filter by country name')] = None, created_after: Annotated[Optional[datetime], Field(description='Filter by creation date (after)')] = None, created_before: Annotated[Optional[datetime], Field(description='Filter by creation date (before)')] = None, device_id: Annotated[Optional[StrictStr], Field(description='Device ID to filter by')] = None, is_encoded: Annotated[Optional[StrictBool], Field(description='Filter by encoded status')] = None, is_favorite: Annotated[Optional[StrictBool], Field(description='Filter by favorite status')] = None, is_motion: Annotated[Optional[StrictBool], Field(description='Filter by motion photo status')] = None, is_not_in_album: Annotated[Optional[StrictBool], Field(description='Filter assets not in any album')] = None, is_offline: Annotated[Optional[StrictBool], Field(description='Filter by offline status')] = None, lens_model: Annotated[Optional[StrictStr], Field(description='Filter by lens model')] = None, library_id: Annotated[Optional[UUID], Field(description='Library ID to filter by')] = None, make: Annotated[Optional[StrictStr], Field(description='Filter by camera make')] = None, min_file_size: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description='Minimum file size in bytes')] = None, model: Annotated[Optional[StrictStr], Field(description='Filter by camera model')] = None, ocr: Annotated[Optional[StrictStr], Field(description='Filter by OCR text content')] = None, person_ids: Annotated[Optional[List[UUID]], Field(description='Filter by person IDs')] = None, rating: Annotated[Optional[Union[Annotated[float, Field(le=5, strict=True, ge=-1)], Annotated[int, Field(le=5, strict=True, ge=-1)]]], Field(description='Filter by rating [1-5], or null for unrated')] = None, size: Annotated[Optional[Union[Annotated[float, Field(le=1000, strict=True, ge=1)], Annotated[int, Field(le=1000, strict=True, ge=1)]]], Field(description='Number of results to return')] = None, state: Annotated[Optional[StrictStr], Field(description='Filter by state/province name')] = None, tag_ids: Annotated[Optional[List[UUID]], Field(description='Filter by tag IDs')] = None, taken_after: Annotated[Optional[datetime], Field(description='Filter by taken date (after)')] = None, taken_before: Annotated[Optional[datetime], Field(description='Filter by taken date (before)')] = None, trashed_after: Annotated[Optional[datetime], Field(description='Filter by trash date (after)')] = None, trashed_before: Annotated[Optional[datetime], Field(description='Filter by trash date (before)')] = None, type: Annotated[Optional[AssetTypeEnum], Field(description='Asset type filter')] = None, updated_after: Annotated[Optional[datetime], Field(description='Filter by update date (after)')] = None, updated_before: Annotated[Optional[datetime], Field(description='Filter by update date (before)')] = None, visibility: Annotated[Optional[AssetVisibility], Field(description='Filter by visibility')] = None, with_deleted: Annotated[Optional[StrictBool], Field(description='Include deleted assets')] = None, with_exif: Annotated[Optional[StrictBool], Field(description='Include EXIF data in response')] = None, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> ApiResponse[List[AssetResponseDto]]

Search large assets

Search for assets that are considered large based on specified criteria.

Parameters:

Name Type Description Default
album_ids Annotated[Optional[List[UUID]], Field(description='Filter by album IDs')]

Filter by album IDs

 None
city Annotated[Optional[StrictStr], Field(description='Filter by city name')]

Filter by city name

 None
country Annotated[Optional[StrictStr], Field(description='Filter by country name')]

Filter by country name

 None
created_after Annotated[Optional[datetime], Field(description='Filter by creation date (after)')]

Filter by creation date (after)

 None
created_before Annotated[Optional[datetime], Field(description='Filter by creation date (before)')]

Filter by creation date (before)

 None
device_id Annotated[Optional[StrictStr], Field(description='Device ID to filter by')]

Device ID to filter by

 None
is_encoded Annotated[Optional[StrictBool], Field(description='Filter by encoded status')]

Filter by encoded status

 None
is_favorite Annotated[Optional[StrictBool], Field(description='Filter by favorite status')]

Filter by favorite status

 None
is_motion Annotated[Optional[StrictBool], Field(description='Filter by motion photo status')]

Filter by motion photo status

 None
is_not_in_album Annotated[Optional[StrictBool], Field(description='Filter assets not in any album')]

Filter assets not in any album

 None
is_offline Annotated[Optional[StrictBool], Field(description='Filter by offline status')]

Filter by offline status

 None
lens_model Annotated[Optional[StrictStr], Field(description='Filter by lens model')]

Filter by lens model

 None
library_id Annotated[Optional[UUID], Field(description='Library ID to filter by')]

Library ID to filter by

 None
make Annotated[Optional[StrictStr], Field(description='Filter by camera make')]

Filter by camera make

 None
min_file_size Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description='Minimum file size in bytes')]

Minimum file size in bytes

 None
model Annotated[Optional[StrictStr], Field(description='Filter by camera model')]

Filter by camera model

 None
ocr Annotated[Optional[StrictStr], Field(description='Filter by OCR text content')]

Filter by OCR text content

 None
person_ids Annotated[Optional[List[UUID]], Field(description='Filter by person IDs')]

Filter by person IDs

 None
rating Annotated[Optional[Union[Annotated[float, Field(le=5, strict=True, ge=-1)], Annotated[int, Field(le=5, strict=True, ge=-1)]]], Field(description='Filter by rating [1-5], or null for unrated')]

Filter by rating [1-5], or null for unrated

 None
size Annotated[Optional[Union[Annotated[float, Field(le=1000, strict=True, ge=1)], Annotated[int, Field(le=1000, strict=True, ge=1)]]], Field(description='Number of results to return')]

Number of results to return

 None
state Annotated[Optional[StrictStr], Field(description='Filter by state/province name')]

Filter by state/province name

 None
tag_ids Annotated[Optional[List[UUID]], Field(description='Filter by tag IDs')]

Filter by tag IDs

 None
taken_after Annotated[Optional[datetime], Field(description='Filter by taken date (after)')]

Filter by taken date (after)

 None
taken_before Annotated[Optional[datetime], Field(description='Filter by taken date (before)')]

Filter by taken date (before)

 None
trashed_after Annotated[Optional[datetime], Field(description='Filter by trash date (after)')]

Filter by trash date (after)

 None
trashed_before Annotated[Optional[datetime], Field(description='Filter by trash date (before)')]

Filter by trash date (before)

 None
type Annotated[Optional[AssetTypeEnum], Field(description='Asset type filter')]

Asset type filter

 None
updated_after Annotated[Optional[datetime], Field(description='Filter by update date (after)')]

Filter by update date (after)

 None
updated_before Annotated[Optional[datetime], Field(description='Filter by update date (before)')]

Filter by update date (before)

 None
visibility Annotated[Optional[AssetVisibility], Field(description='Filter by visibility')]

Filter by visibility

 None
with_deleted Annotated[Optional[StrictBool], Field(description='Include deleted assets')]

Include deleted assets

 None
with_exif Annotated[Optional[StrictBool], Field(description='Include EXIF data in response')]

Include EXIF data in response

 None
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
ApiResponse[List[AssetResponseDto]]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
@validate_call
async def search_large_assets_with_http_info(
    self,
    album_ids: Annotated[
        Optional[List[UUID]], Field(description="Filter by album IDs")
    ] = None,
    city: Annotated[
        Optional[StrictStr], Field(description="Filter by city name")
    ] = None,
    country: Annotated[
        Optional[StrictStr], Field(description="Filter by country name")
    ] = None,
    created_after: Annotated[
        Optional[datetime], Field(description="Filter by creation date (after)")
    ] = None,
    created_before: Annotated[
        Optional[datetime], Field(description="Filter by creation date (before)")
    ] = None,
    device_id: Annotated[
        Optional[StrictStr], Field(description="Device ID to filter by")
    ] = None,
    is_encoded: Annotated[
        Optional[StrictBool], Field(description="Filter by encoded status")
    ] = None,
    is_favorite: Annotated[
        Optional[StrictBool], Field(description="Filter by favorite status")
    ] = None,
    is_motion: Annotated[
        Optional[StrictBool], Field(description="Filter by motion photo status")
    ] = None,
    is_not_in_album: Annotated[
        Optional[StrictBool], Field(description="Filter assets not in any album")
    ] = None,
    is_offline: Annotated[
        Optional[StrictBool], Field(description="Filter by offline status")
    ] = None,
    lens_model: Annotated[
        Optional[StrictStr], Field(description="Filter by lens model")
    ] = None,
    library_id: Annotated[
        Optional[UUID], Field(description="Library ID to filter by")
    ] = None,
    make: Annotated[
        Optional[StrictStr], Field(description="Filter by camera make")
    ] = None,
    min_file_size: Annotated[
        Optional[Annotated[int, Field(strict=True, ge=0)]],
        Field(description="Minimum file size in bytes"),
    ] = None,
    model: Annotated[
        Optional[StrictStr], Field(description="Filter by camera model")
    ] = None,
    ocr: Annotated[
        Optional[StrictStr], Field(description="Filter by OCR text content")
    ] = None,
    person_ids: Annotated[
        Optional[List[UUID]], Field(description="Filter by person IDs")
    ] = None,
    rating: Annotated[
        Optional[
            Union[
                Annotated[float, Field(le=5, strict=True, ge=-1)],
                Annotated[int, Field(le=5, strict=True, ge=-1)],
            ]
        ],
        Field(description="Filter by rating [1-5], or null for unrated"),
    ] = None,
    size: Annotated[
        Optional[
            Union[
                Annotated[float, Field(le=1000, strict=True, ge=1)],
                Annotated[int, Field(le=1000, strict=True, ge=1)],
            ]
        ],
        Field(description="Number of results to return"),
    ] = None,
    state: Annotated[
        Optional[StrictStr], Field(description="Filter by state/province name")
    ] = None,
    tag_ids: Annotated[
        Optional[List[UUID]], Field(description="Filter by tag IDs")
    ] = None,
    taken_after: Annotated[
        Optional[datetime], Field(description="Filter by taken date (after)")
    ] = None,
    taken_before: Annotated[
        Optional[datetime], Field(description="Filter by taken date (before)")
    ] = None,
    trashed_after: Annotated[
        Optional[datetime], Field(description="Filter by trash date (after)")
    ] = None,
    trashed_before: Annotated[
        Optional[datetime], Field(description="Filter by trash date (before)")
    ] = None,
    type: Annotated[
        Optional[AssetTypeEnum], Field(description="Asset type filter")
    ] = None,
    updated_after: Annotated[
        Optional[datetime], Field(description="Filter by update date (after)")
    ] = None,
    updated_before: Annotated[
        Optional[datetime], Field(description="Filter by update date (before)")
    ] = None,
    visibility: Annotated[
        Optional[AssetVisibility], Field(description="Filter by visibility")
    ] = None,
    with_deleted: Annotated[
        Optional[StrictBool], Field(description="Include deleted assets")
    ] = None,
    with_exif: Annotated[
        Optional[StrictBool], Field(description="Include EXIF data in response")
    ] = None,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[List[AssetResponseDto]]:
    """Search large assets

    Search for assets that are considered large based on specified criteria.

    :param album_ids: Filter by album IDs
    :type album_ids: List[UUID]
    :param city: Filter by city name
    :type city: str
    :param country: Filter by country name
    :type country: str
    :param created_after: Filter by creation date (after)
    :type created_after: datetime
    :param created_before: Filter by creation date (before)
    :type created_before: datetime
    :param device_id: Device ID to filter by
    :type device_id: str
    :param is_encoded: Filter by encoded status
    :type is_encoded: bool
    :param is_favorite: Filter by favorite status
    :type is_favorite: bool
    :param is_motion: Filter by motion photo status
    :type is_motion: bool
    :param is_not_in_album: Filter assets not in any album
    :type is_not_in_album: bool
    :param is_offline: Filter by offline status
    :type is_offline: bool
    :param lens_model: Filter by lens model
    :type lens_model: str
    :param library_id: Library ID to filter by
    :type library_id: UUID
    :param make: Filter by camera make
    :type make: str
    :param min_file_size: Minimum file size in bytes
    :type min_file_size: int
    :param model: Filter by camera model
    :type model: str
    :param ocr: Filter by OCR text content
    :type ocr: str
    :param person_ids: Filter by person IDs
    :type person_ids: List[UUID]
    :param rating: Filter by rating [1-5], or null for unrated
    :type rating: float
    :param size: Number of results to return
    :type size: float
    :param state: Filter by state/province name
    :type state: str
    :param tag_ids: Filter by tag IDs
    :type tag_ids: List[UUID]
    :param taken_after: Filter by taken date (after)
    :type taken_after: datetime
    :param taken_before: Filter by taken date (before)
    :type taken_before: datetime
    :param trashed_after: Filter by trash date (after)
    :type trashed_after: datetime
    :param trashed_before: Filter by trash date (before)
    :type trashed_before: datetime
    :param type: Asset type filter
    :type type: AssetTypeEnum
    :param updated_after: Filter by update date (after)
    :type updated_after: datetime
    :param updated_before: Filter by update date (before)
    :type updated_before: datetime
    :param visibility: Filter by visibility
    :type visibility: AssetVisibility
    :param with_deleted: Include deleted assets
    :type with_deleted: bool
    :param with_exif: Include EXIF data in response
    :type with_exif: bool
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_large_assets_serialize(
        album_ids=album_ids,
        city=city,
        country=country,
        created_after=created_after,
        created_before=created_before,
        device_id=device_id,
        is_encoded=is_encoded,
        is_favorite=is_favorite,
        is_motion=is_motion,
        is_not_in_album=is_not_in_album,
        is_offline=is_offline,
        lens_model=lens_model,
        library_id=library_id,
        make=make,
        min_file_size=min_file_size,
        model=model,
        ocr=ocr,
        person_ids=person_ids,
        rating=rating,
        size=size,
        state=state,
        tag_ids=tag_ids,
        taken_after=taken_after,
        taken_before=taken_before,
        trashed_after=trashed_after,
        trashed_before=trashed_before,
        type=type,
        updated_after=updated_after,
        updated_before=updated_before,
        visibility=visibility,
        with_deleted=with_deleted,
        with_exif=with_exif,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[AssetResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    )

search_large_assets_without_preload_content async 

search_large_assets_without_preload_content(album_ids: Annotated[Optional[List[UUID]], Field(description='Filter by album IDs')] = None, city: Annotated[Optional[StrictStr], Field(description='Filter by city name')] = None, country: Annotated[Optional[StrictStr], Field(description='Filter by country name')] = None, created_after: Annotated[Optional[datetime], Field(description='Filter by creation date (after)')] = None, created_before: Annotated[Optional[datetime], Field(description='Filter by creation date (before)')] = None, device_id: Annotated[Optional[StrictStr], Field(description='Device ID to filter by')] = None, is_encoded: Annotated[Optional[StrictBool], Field(description='Filter by encoded status')] = None, is_favorite: Annotated[Optional[StrictBool], Field(description='Filter by favorite status')] = None, is_motion: Annotated[Optional[StrictBool], Field(description='Filter by motion photo status')] = None, is_not_in_album: Annotated[Optional[StrictBool], Field(description='Filter assets not in any album')] = None, is_offline: Annotated[Optional[StrictBool], Field(description='Filter by offline status')] = None, lens_model: Annotated[Optional[StrictStr], Field(description='Filter by lens model')] = None, library_id: Annotated[Optional[UUID], Field(description='Library ID to filter by')] = None, make: Annotated[Optional[StrictStr], Field(description='Filter by camera make')] = None, min_file_size: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description='Minimum file size in bytes')] = None, model: Annotated[Optional[StrictStr], Field(description='Filter by camera model')] = None, ocr: Annotated[Optional[StrictStr], Field(description='Filter by OCR text content')] = None, person_ids: Annotated[Optional[List[UUID]], Field(description='Filter by person IDs')] = None, rating: Annotated[Optional[Union[Annotated[float, Field(le=5, strict=True, ge=-1)], Annotated[int, Field(le=5, strict=True, ge=-1)]]], Field(description='Filter by rating [1-5], or null for unrated')] = None, size: Annotated[Optional[Union[Annotated[float, Field(le=1000, strict=True, ge=1)], Annotated[int, Field(le=1000, strict=True, ge=1)]]], Field(description='Number of results to return')] = None, state: Annotated[Optional[StrictStr], Field(description='Filter by state/province name')] = None, tag_ids: Annotated[Optional[List[UUID]], Field(description='Filter by tag IDs')] = None, taken_after: Annotated[Optional[datetime], Field(description='Filter by taken date (after)')] = None, taken_before: Annotated[Optional[datetime], Field(description='Filter by taken date (before)')] = None, trashed_after: Annotated[Optional[datetime], Field(description='Filter by trash date (after)')] = None, trashed_before: Annotated[Optional[datetime], Field(description='Filter by trash date (before)')] = None, type: Annotated[Optional[AssetTypeEnum], Field(description='Asset type filter')] = None, updated_after: Annotated[Optional[datetime], Field(description='Filter by update date (after)')] = None, updated_before: Annotated[Optional[datetime], Field(description='Filter by update date (before)')] = None, visibility: Annotated[Optional[AssetVisibility], Field(description='Filter by visibility')] = None, with_deleted: Annotated[Optional[StrictBool], Field(description='Include deleted assets')] = None, with_exif: Annotated[Optional[StrictBool], Field(description='Include EXIF data in response')] = None, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> RESTResponseType

Search large assets

Search for assets that are considered large based on specified criteria.

Parameters:

Name Type Description Default
album_ids Annotated[Optional[List[UUID]], Field(description='Filter by album IDs')]

Filter by album IDs

 None
city Annotated[Optional[StrictStr], Field(description='Filter by city name')]

Filter by city name

 None
country Annotated[Optional[StrictStr], Field(description='Filter by country name')]

Filter by country name

 None
created_after Annotated[Optional[datetime], Field(description='Filter by creation date (after)')]

Filter by creation date (after)

 None
created_before Annotated[Optional[datetime], Field(description='Filter by creation date (before)')]

Filter by creation date (before)

 None
device_id Annotated[Optional[StrictStr], Field(description='Device ID to filter by')]

Device ID to filter by

 None
is_encoded Annotated[Optional[StrictBool], Field(description='Filter by encoded status')]

Filter by encoded status

 None
is_favorite Annotated[Optional[StrictBool], Field(description='Filter by favorite status')]

Filter by favorite status

 None
is_motion Annotated[Optional[StrictBool], Field(description='Filter by motion photo status')]

Filter by motion photo status

 None
is_not_in_album Annotated[Optional[StrictBool], Field(description='Filter assets not in any album')]

Filter assets not in any album

 None
is_offline Annotated[Optional[StrictBool], Field(description='Filter by offline status')]

Filter by offline status

 None
lens_model Annotated[Optional[StrictStr], Field(description='Filter by lens model')]

Filter by lens model

 None
library_id Annotated[Optional[UUID], Field(description='Library ID to filter by')]

Library ID to filter by

 None
make Annotated[Optional[StrictStr], Field(description='Filter by camera make')]

Filter by camera make

 None
min_file_size Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description='Minimum file size in bytes')]

Minimum file size in bytes

 None
model Annotated[Optional[StrictStr], Field(description='Filter by camera model')]

Filter by camera model

 None
ocr Annotated[Optional[StrictStr], Field(description='Filter by OCR text content')]

Filter by OCR text content

 None
person_ids Annotated[Optional[List[UUID]], Field(description='Filter by person IDs')]

Filter by person IDs

 None
rating Annotated[Optional[Union[Annotated[float, Field(le=5, strict=True, ge=-1)], Annotated[int, Field(le=5, strict=True, ge=-1)]]], Field(description='Filter by rating [1-5], or null for unrated')]

Filter by rating [1-5], or null for unrated

 None
size Annotated[Optional[Union[Annotated[float, Field(le=1000, strict=True, ge=1)], Annotated[int, Field(le=1000, strict=True, ge=1)]]], Field(description='Number of results to return')]

Number of results to return

 None
state Annotated[Optional[StrictStr], Field(description='Filter by state/province name')]

Filter by state/province name

 None
tag_ids Annotated[Optional[List[UUID]], Field(description='Filter by tag IDs')]

Filter by tag IDs

 None
taken_after Annotated[Optional[datetime], Field(description='Filter by taken date (after)')]

Filter by taken date (after)

 None
taken_before Annotated[Optional[datetime], Field(description='Filter by taken date (before)')]

Filter by taken date (before)

 None
trashed_after Annotated[Optional[datetime], Field(description='Filter by trash date (after)')]

Filter by trash date (after)

 None
trashed_before Annotated[Optional[datetime], Field(description='Filter by trash date (before)')]

Filter by trash date (before)

 None
type Annotated[Optional[AssetTypeEnum], Field(description='Asset type filter')]

Asset type filter

 None
updated_after Annotated[Optional[datetime], Field(description='Filter by update date (after)')]

Filter by update date (after)

 None
updated_before Annotated[Optional[datetime], Field(description='Filter by update date (before)')]

Filter by update date (before)

 None
visibility Annotated[Optional[AssetVisibility], Field(description='Filter by visibility')]

Filter by visibility

 None
with_deleted Annotated[Optional[StrictBool], Field(description='Include deleted assets')]

Include deleted assets

 None
with_exif Annotated[Optional[StrictBool], Field(description='Include EXIF data in response')]

Include EXIF data in response

 None
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
RESTResponseType

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
@validate_call
async def search_large_assets_without_preload_content(
    self,
    album_ids: Annotated[
        Optional[List[UUID]], Field(description="Filter by album IDs")
    ] = None,
    city: Annotated[
        Optional[StrictStr], Field(description="Filter by city name")
    ] = None,
    country: Annotated[
        Optional[StrictStr], Field(description="Filter by country name")
    ] = None,
    created_after: Annotated[
        Optional[datetime], Field(description="Filter by creation date (after)")
    ] = None,
    created_before: Annotated[
        Optional[datetime], Field(description="Filter by creation date (before)")
    ] = None,
    device_id: Annotated[
        Optional[StrictStr], Field(description="Device ID to filter by")
    ] = None,
    is_encoded: Annotated[
        Optional[StrictBool], Field(description="Filter by encoded status")
    ] = None,
    is_favorite: Annotated[
        Optional[StrictBool], Field(description="Filter by favorite status")
    ] = None,
    is_motion: Annotated[
        Optional[StrictBool], Field(description="Filter by motion photo status")
    ] = None,
    is_not_in_album: Annotated[
        Optional[StrictBool], Field(description="Filter assets not in any album")
    ] = None,
    is_offline: Annotated[
        Optional[StrictBool], Field(description="Filter by offline status")
    ] = None,
    lens_model: Annotated[
        Optional[StrictStr], Field(description="Filter by lens model")
    ] = None,
    library_id: Annotated[
        Optional[UUID], Field(description="Library ID to filter by")
    ] = None,
    make: Annotated[
        Optional[StrictStr], Field(description="Filter by camera make")
    ] = None,
    min_file_size: Annotated[
        Optional[Annotated[int, Field(strict=True, ge=0)]],
        Field(description="Minimum file size in bytes"),
    ] = None,
    model: Annotated[
        Optional[StrictStr], Field(description="Filter by camera model")
    ] = None,
    ocr: Annotated[
        Optional[StrictStr], Field(description="Filter by OCR text content")
    ] = None,
    person_ids: Annotated[
        Optional[List[UUID]], Field(description="Filter by person IDs")
    ] = None,
    rating: Annotated[
        Optional[
            Union[
                Annotated[float, Field(le=5, strict=True, ge=-1)],
                Annotated[int, Field(le=5, strict=True, ge=-1)],
            ]
        ],
        Field(description="Filter by rating [1-5], or null for unrated"),
    ] = None,
    size: Annotated[
        Optional[
            Union[
                Annotated[float, Field(le=1000, strict=True, ge=1)],
                Annotated[int, Field(le=1000, strict=True, ge=1)],
            ]
        ],
        Field(description="Number of results to return"),
    ] = None,
    state: Annotated[
        Optional[StrictStr], Field(description="Filter by state/province name")
    ] = None,
    tag_ids: Annotated[
        Optional[List[UUID]], Field(description="Filter by tag IDs")
    ] = None,
    taken_after: Annotated[
        Optional[datetime], Field(description="Filter by taken date (after)")
    ] = None,
    taken_before: Annotated[
        Optional[datetime], Field(description="Filter by taken date (before)")
    ] = None,
    trashed_after: Annotated[
        Optional[datetime], Field(description="Filter by trash date (after)")
    ] = None,
    trashed_before: Annotated[
        Optional[datetime], Field(description="Filter by trash date (before)")
    ] = None,
    type: Annotated[
        Optional[AssetTypeEnum], Field(description="Asset type filter")
    ] = None,
    updated_after: Annotated[
        Optional[datetime], Field(description="Filter by update date (after)")
    ] = None,
    updated_before: Annotated[
        Optional[datetime], Field(description="Filter by update date (before)")
    ] = None,
    visibility: Annotated[
        Optional[AssetVisibility], Field(description="Filter by visibility")
    ] = None,
    with_deleted: Annotated[
        Optional[StrictBool], Field(description="Include deleted assets")
    ] = None,
    with_exif: Annotated[
        Optional[StrictBool], Field(description="Include EXIF data in response")
    ] = None,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
    """Search large assets

    Search for assets that are considered large based on specified criteria.

    :param album_ids: Filter by album IDs
    :type album_ids: List[UUID]
    :param city: Filter by city name
    :type city: str
    :param country: Filter by country name
    :type country: str
    :param created_after: Filter by creation date (after)
    :type created_after: datetime
    :param created_before: Filter by creation date (before)
    :type created_before: datetime
    :param device_id: Device ID to filter by
    :type device_id: str
    :param is_encoded: Filter by encoded status
    :type is_encoded: bool
    :param is_favorite: Filter by favorite status
    :type is_favorite: bool
    :param is_motion: Filter by motion photo status
    :type is_motion: bool
    :param is_not_in_album: Filter assets not in any album
    :type is_not_in_album: bool
    :param is_offline: Filter by offline status
    :type is_offline: bool
    :param lens_model: Filter by lens model
    :type lens_model: str
    :param library_id: Library ID to filter by
    :type library_id: UUID
    :param make: Filter by camera make
    :type make: str
    :param min_file_size: Minimum file size in bytes
    :type min_file_size: int
    :param model: Filter by camera model
    :type model: str
    :param ocr: Filter by OCR text content
    :type ocr: str
    :param person_ids: Filter by person IDs
    :type person_ids: List[UUID]
    :param rating: Filter by rating [1-5], or null for unrated
    :type rating: float
    :param size: Number of results to return
    :type size: float
    :param state: Filter by state/province name
    :type state: str
    :param tag_ids: Filter by tag IDs
    :type tag_ids: List[UUID]
    :param taken_after: Filter by taken date (after)
    :type taken_after: datetime
    :param taken_before: Filter by taken date (before)
    :type taken_before: datetime
    :param trashed_after: Filter by trash date (after)
    :type trashed_after: datetime
    :param trashed_before: Filter by trash date (before)
    :type trashed_before: datetime
    :param type: Asset type filter
    :type type: AssetTypeEnum
    :param updated_after: Filter by update date (after)
    :type updated_after: datetime
    :param updated_before: Filter by update date (before)
    :type updated_before: datetime
    :param visibility: Filter by visibility
    :type visibility: AssetVisibility
    :param with_deleted: Include deleted assets
    :type with_deleted: bool
    :param with_exif: Include EXIF data in response
    :type with_exif: bool
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_large_assets_serialize(
        album_ids=album_ids,
        city=city,
        country=country,
        created_after=created_after,
        created_before=created_before,
        device_id=device_id,
        is_encoded=is_encoded,
        is_favorite=is_favorite,
        is_motion=is_motion,
        is_not_in_album=is_not_in_album,
        is_offline=is_offline,
        lens_model=lens_model,
        library_id=library_id,
        make=make,
        min_file_size=min_file_size,
        model=model,
        ocr=ocr,
        person_ids=person_ids,
        rating=rating,
        size=size,
        state=state,
        tag_ids=tag_ids,
        taken_after=taken_after,
        taken_before=taken_before,
        trashed_after=trashed_after,
        trashed_before=trashed_before,
        type=type,
        updated_after=updated_after,
        updated_before=updated_before,
        visibility=visibility,
        with_deleted=with_deleted,
        with_exif=with_exif,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[AssetResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    return response_data.response

search_person async 

search_person(name: Annotated[StrictStr, Field(description='Person name to search for')], with_hidden: Annotated[Optional[StrictBool], Field(description='Include hidden people')] = None, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> List[PersonResponseDto]

Search people

Search for people by name.

Parameters:

Name Type Description Default
name Annotated[StrictStr, Field(description='Person name to search for')]

Person name to search for (required)

 required
with_hidden Annotated[Optional[StrictBool], Field(description='Include hidden people')]

Include hidden people

 None
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
List[PersonResponseDto]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
@validate_call
async def search_person(
    self,
    name: Annotated[StrictStr, Field(description="Person name to search for")],
    with_hidden: Annotated[
        Optional[StrictBool], Field(description="Include hidden people")
    ] = None,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> List[PersonResponseDto]:
    """Search people

    Search for people by name.

    :param name: Person name to search for (required)
    :type name: str
    :param with_hidden: Include hidden people
    :type with_hidden: bool
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_person_serialize(
        name=name,
        with_hidden=with_hidden,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[PersonResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    ).data

search_person_with_http_info async 

search_person_with_http_info(name: Annotated[StrictStr, Field(description='Person name to search for')], with_hidden: Annotated[Optional[StrictBool], Field(description='Include hidden people')] = None, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> ApiResponse[List[PersonResponseDto]]

Search people

Search for people by name.

Parameters:

Name Type Description Default
name Annotated[StrictStr, Field(description='Person name to search for')]

Person name to search for (required)

 required
with_hidden Annotated[Optional[StrictBool], Field(description='Include hidden people')]

Include hidden people

 None
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
ApiResponse[List[PersonResponseDto]]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
@validate_call
async def search_person_with_http_info(
    self,
    name: Annotated[StrictStr, Field(description="Person name to search for")],
    with_hidden: Annotated[
        Optional[StrictBool], Field(description="Include hidden people")
    ] = None,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[List[PersonResponseDto]]:
    """Search people

    Search for people by name.

    :param name: Person name to search for (required)
    :type name: str
    :param with_hidden: Include hidden people
    :type with_hidden: bool
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_person_serialize(
        name=name,
        with_hidden=with_hidden,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[PersonResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    )

search_person_without_preload_content async 

search_person_without_preload_content(name: Annotated[StrictStr, Field(description='Person name to search for')], with_hidden: Annotated[Optional[StrictBool], Field(description='Include hidden people')] = None, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> RESTResponseType

Search people

Search for people by name.

Parameters:

Name Type Description Default
name Annotated[StrictStr, Field(description='Person name to search for')]

Person name to search for (required)

 required
with_hidden Annotated[Optional[StrictBool], Field(description='Include hidden people')]

Include hidden people

 None
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
RESTResponseType

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
@validate_call
async def search_person_without_preload_content(
    self,
    name: Annotated[StrictStr, Field(description="Person name to search for")],
    with_hidden: Annotated[
        Optional[StrictBool], Field(description="Include hidden people")
    ] = None,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
    """Search people

    Search for people by name.

    :param name: Person name to search for (required)
    :type name: str
    :param with_hidden: Include hidden people
    :type with_hidden: bool
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_person_serialize(
        name=name,
        with_hidden=with_hidden,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[PersonResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    return response_data.response

search_places async 

search_places(name: Annotated[StrictStr, Field(description='Place name to search for')], _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> List[PlacesResponseDto]

Search places

Search for places by name.

Parameters:

Name Type Description Default
name Annotated[StrictStr, Field(description='Place name to search for')]

Place name to search for (required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
List[PlacesResponseDto]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
@validate_call
async def search_places(
    self,
    name: Annotated[StrictStr, Field(description="Place name to search for")],
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> List[PlacesResponseDto]:
    """Search places

    Search for places by name.

    :param name: Place name to search for (required)
    :type name: str
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_places_serialize(
        name=name,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[PlacesResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    ).data

search_places_with_http_info async 

search_places_with_http_info(name: Annotated[StrictStr, Field(description='Place name to search for')], _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> ApiResponse[List[PlacesResponseDto]]

Search places

Search for places by name.

Parameters:

Name Type Description Default
name Annotated[StrictStr, Field(description='Place name to search for')]

Place name to search for (required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
ApiResponse[List[PlacesResponseDto]]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
@validate_call
async def search_places_with_http_info(
    self,
    name: Annotated[StrictStr, Field(description="Place name to search for")],
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[List[PlacesResponseDto]]:
    """Search places

    Search for places by name.

    :param name: Place name to search for (required)
    :type name: str
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_places_serialize(
        name=name,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[PlacesResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    )

search_places_without_preload_content async 

search_places_without_preload_content(name: Annotated[StrictStr, Field(description='Place name to search for')], _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> RESTResponseType

Search places

Search for places by name.

Parameters:

Name Type Description Default
name Annotated[StrictStr, Field(description='Place name to search for')]

Place name to search for (required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
RESTResponseType

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
@validate_call
async def search_places_without_preload_content(
    self,
    name: Annotated[StrictStr, Field(description="Place name to search for")],
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
    """Search places

    Search for places by name.

    :param name: Place name to search for (required)
    :type name: str
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_places_serialize(
        name=name,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[PlacesResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    return response_data.response

search_random async 

search_random(random_search_dto: RandomSearchDto, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> List[AssetResponseDto]

Search random assets

Retrieve a random selection of assets based on the provided criteria.

Parameters:

Name Type Description Default
random_search_dto RandomSearchDto

(required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
List[AssetResponseDto]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
@validate_call
async def search_random(
    self,
    random_search_dto: RandomSearchDto,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> List[AssetResponseDto]:
    """Search random assets

    Retrieve a random selection of assets based on the provided criteria.

    :param random_search_dto: (required)
    :type random_search_dto: RandomSearchDto
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_random_serialize(
        random_search_dto=random_search_dto,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[AssetResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    ).data

search_random_with_http_info async 

search_random_with_http_info(random_search_dto: RandomSearchDto, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> ApiResponse[List[AssetResponseDto]]

Search random assets

Retrieve a random selection of assets based on the provided criteria.

Parameters:

Name Type Description Default
random_search_dto RandomSearchDto

(required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
ApiResponse[List[AssetResponseDto]]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
@validate_call
async def search_random_with_http_info(
    self,
    random_search_dto: RandomSearchDto,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[List[AssetResponseDto]]:
    """Search random assets

    Retrieve a random selection of assets based on the provided criteria.

    :param random_search_dto: (required)
    :type random_search_dto: RandomSearchDto
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_random_serialize(
        random_search_dto=random_search_dto,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[AssetResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    )

search_random_without_preload_content async 

search_random_without_preload_content(random_search_dto: RandomSearchDto, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> RESTResponseType

Search random assets

Retrieve a random selection of assets based on the provided criteria.

Parameters:

Name Type Description Default
random_search_dto RandomSearchDto

(required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
RESTResponseType

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
@validate_call
async def search_random_without_preload_content(
    self,
    random_search_dto: RandomSearchDto,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
    """Search random assets

    Retrieve a random selection of assets based on the provided criteria.

    :param random_search_dto: (required)
    :type random_search_dto: RandomSearchDto
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_random_serialize(
        random_search_dto=random_search_dto,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[AssetResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    return response_data.response

search_smart async 

search_smart(smart_search_dto: SmartSearchDto, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> SearchResponseDto

Smart asset search

Perform a smart search for assets by using machine learning vectors to determine relevance.

Parameters:

Name Type Description Default
smart_search_dto SmartSearchDto

(required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
SearchResponseDto

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
@validate_call
async def search_smart(
    self,
    smart_search_dto: SmartSearchDto,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> SearchResponseDto:
    """Smart asset search

    Perform a smart search for assets by using machine learning vectors to determine relevance.

    :param smart_search_dto: (required)
    :type smart_search_dto: SmartSearchDto
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_smart_serialize(
        smart_search_dto=smart_search_dto,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "SearchResponseDto",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    ).data

search_smart_with_http_info async 

search_smart_with_http_info(smart_search_dto: SmartSearchDto, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> ApiResponse[SearchResponseDto]

Smart asset search

Perform a smart search for assets by using machine learning vectors to determine relevance.

Parameters:

Name Type Description Default
smart_search_dto SmartSearchDto

(required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
ApiResponse[SearchResponseDto]

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
@validate_call
async def search_smart_with_http_info(
    self,
    smart_search_dto: SmartSearchDto,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[SearchResponseDto]:
    """Smart asset search

    Perform a smart search for assets by using machine learning vectors to determine relevance.

    :param smart_search_dto: (required)
    :type smart_search_dto: SmartSearchDto
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_smart_serialize(
        smart_search_dto=smart_search_dto,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "SearchResponseDto",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    )

search_smart_without_preload_content async 

search_smart_without_preload_content(smart_search_dto: SmartSearchDto, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> RESTResponseType

Smart asset search

Perform a smart search for assets by using machine learning vectors to determine relevance.

Parameters:

Name Type Description Default
smart_search_dto SmartSearchDto

(required)

 required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

 None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

 None
_content_type Optional[StrictStr]

force content-type for the request.

 None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

 None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

 0

Returns:

Type Description
RESTResponseType

Returns the result object.
Source code in immichpy/client/generated/api/search_api.py 
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
@validate_call
async def search_smart_without_preload_content(
    self,
    smart_search_dto: SmartSearchDto,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
    """Smart asset search

    Perform a smart search for assets by using machine learning vectors to determine relevance.

    :param smart_search_dto: (required)
    :type smart_search_dto: SmartSearchDto
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._search_smart_serialize(
        smart_search_dto=smart_search_dto,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "SearchResponseDto",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    return response_data.response