mirror of
				https://github.com/KevinMidboe/immich.git
				synced 2025-10-29 17:40:28 +00:00 
			
		
		
		
	feat(server): CLIP search integration (#1939)
This commit is contained in:
		
							
								
								
									
										32
									
								
								mobile/openapi/doc/SearchApi.md
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										32
									
								
								mobile/openapi/doc/SearchApi.md
									
									
									
										generated
									
									
									
								
							@@ -113,7 +113,7 @@ This endpoint does not need any parameter.
 | 
			
		||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 | 
			
		||||
 | 
			
		||||
# **search**
 | 
			
		||||
> SearchResponseDto search(query, type, isFavorite, exifInfoPeriodCity, exifInfoPeriodState, exifInfoPeriodCountry, exifInfoPeriodMake, exifInfoPeriodModel, smartInfoPeriodObjects, smartInfoPeriodTags, recent, motion)
 | 
			
		||||
> SearchResponseDto search()
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@@ -134,21 +134,9 @@ import 'package:openapi/api.dart';
 | 
			
		||||
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
 | 
			
		||||
 | 
			
		||||
final api_instance = SearchApi();
 | 
			
		||||
final query = query_example; // String | 
 | 
			
		||||
final type = type_example; // String | 
 | 
			
		||||
final isFavorite = true; // bool | 
 | 
			
		||||
final exifInfoPeriodCity = exifInfoPeriodCity_example; // String | 
 | 
			
		||||
final exifInfoPeriodState = exifInfoPeriodState_example; // String | 
 | 
			
		||||
final exifInfoPeriodCountry = exifInfoPeriodCountry_example; // String | 
 | 
			
		||||
final exifInfoPeriodMake = exifInfoPeriodMake_example; // String | 
 | 
			
		||||
final exifInfoPeriodModel = exifInfoPeriodModel_example; // String | 
 | 
			
		||||
final smartInfoPeriodObjects = []; // List<String> | 
 | 
			
		||||
final smartInfoPeriodTags = []; // List<String> | 
 | 
			
		||||
final recent = true; // bool | 
 | 
			
		||||
final motion = true; // bool | 
 | 
			
		||||
 | 
			
		||||
try {
 | 
			
		||||
    final result = api_instance.search(query, type, isFavorite, exifInfoPeriodCity, exifInfoPeriodState, exifInfoPeriodCountry, exifInfoPeriodMake, exifInfoPeriodModel, smartInfoPeriodObjects, smartInfoPeriodTags, recent, motion);
 | 
			
		||||
    final result = api_instance.search();
 | 
			
		||||
    print(result);
 | 
			
		||||
} catch (e) {
 | 
			
		||||
    print('Exception when calling SearchApi->search: $e\n');
 | 
			
		||||
@@ -156,21 +144,7 @@ try {
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Parameters
 | 
			
		||||
 | 
			
		||||
Name | Type | Description  | Notes
 | 
			
		||||
------------- | ------------- | ------------- | -------------
 | 
			
		||||
 **query** | **String**|  | [optional] 
 | 
			
		||||
 **type** | **String**|  | [optional] 
 | 
			
		||||
 **isFavorite** | **bool**|  | [optional] 
 | 
			
		||||
 **exifInfoPeriodCity** | **String**|  | [optional] 
 | 
			
		||||
 **exifInfoPeriodState** | **String**|  | [optional] 
 | 
			
		||||
 **exifInfoPeriodCountry** | **String**|  | [optional] 
 | 
			
		||||
 **exifInfoPeriodMake** | **String**|  | [optional] 
 | 
			
		||||
 **exifInfoPeriodModel** | **String**|  | [optional] 
 | 
			
		||||
 **smartInfoPeriodObjects** | [**List<String>**](String.md)|  | [optional] [default to const []]
 | 
			
		||||
 **smartInfoPeriodTags** | [**List<String>**](String.md)|  | [optional] [default to const []]
 | 
			
		||||
 **recent** | **bool**|  | [optional] 
 | 
			
		||||
 **motion** | **bool**|  | [optional] 
 | 
			
		||||
This endpoint does not need any parameter.
 | 
			
		||||
 | 
			
		||||
### Return type
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										95
									
								
								mobile/openapi/lib/api/search_api.dart
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										95
									
								
								mobile/openapi/lib/api/search_api.dart
									
									
									
										generated
									
									
									
								
							@@ -110,33 +110,7 @@ class SearchApi {
 | 
			
		||||
  /// 
 | 
			
		||||
  ///
 | 
			
		||||
  /// Note: This method returns the HTTP [Response].
 | 
			
		||||
  ///
 | 
			
		||||
  /// Parameters:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] query:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] type:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [bool] isFavorite:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] exifInfoPeriodCity:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] exifInfoPeriodState:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] exifInfoPeriodCountry:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] exifInfoPeriodMake:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] exifInfoPeriodModel:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [List<String>] smartInfoPeriodObjects:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [List<String>] smartInfoPeriodTags:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [bool] recent:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [bool] motion:
 | 
			
		||||
  Future<Response> searchWithHttpInfo({ String? query, String? type, bool? isFavorite, String? exifInfoPeriodCity, String? exifInfoPeriodState, String? exifInfoPeriodCountry, String? exifInfoPeriodMake, String? exifInfoPeriodModel, List<String>? smartInfoPeriodObjects, List<String>? smartInfoPeriodTags, bool? recent, bool? motion, }) async {
 | 
			
		||||
  Future<Response> searchWithHttpInfo() async {
 | 
			
		||||
    // ignore: prefer_const_declarations
 | 
			
		||||
    final path = r'/search';
 | 
			
		||||
 | 
			
		||||
@@ -147,43 +121,6 @@ class SearchApi {
 | 
			
		||||
    final headerParams = <String, String>{};
 | 
			
		||||
    final formParams = <String, String>{};
 | 
			
		||||
 | 
			
		||||
    if (query != null) {
 | 
			
		||||
      queryParams.addAll(_queryParams('', 'query', query));
 | 
			
		||||
    }
 | 
			
		||||
    if (type != null) {
 | 
			
		||||
      queryParams.addAll(_queryParams('', 'type', type));
 | 
			
		||||
    }
 | 
			
		||||
    if (isFavorite != null) {
 | 
			
		||||
      queryParams.addAll(_queryParams('', 'isFavorite', isFavorite));
 | 
			
		||||
    }
 | 
			
		||||
    if (exifInfoPeriodCity != null) {
 | 
			
		||||
      queryParams.addAll(_queryParams('', 'exifInfo.city', exifInfoPeriodCity));
 | 
			
		||||
    }
 | 
			
		||||
    if (exifInfoPeriodState != null) {
 | 
			
		||||
      queryParams.addAll(_queryParams('', 'exifInfo.state', exifInfoPeriodState));
 | 
			
		||||
    }
 | 
			
		||||
    if (exifInfoPeriodCountry != null) {
 | 
			
		||||
      queryParams.addAll(_queryParams('', 'exifInfo.country', exifInfoPeriodCountry));
 | 
			
		||||
    }
 | 
			
		||||
    if (exifInfoPeriodMake != null) {
 | 
			
		||||
      queryParams.addAll(_queryParams('', 'exifInfo.make', exifInfoPeriodMake));
 | 
			
		||||
    }
 | 
			
		||||
    if (exifInfoPeriodModel != null) {
 | 
			
		||||
      queryParams.addAll(_queryParams('', 'exifInfo.model', exifInfoPeriodModel));
 | 
			
		||||
    }
 | 
			
		||||
    if (smartInfoPeriodObjects != null) {
 | 
			
		||||
      queryParams.addAll(_queryParams('multi', 'smartInfo.objects', smartInfoPeriodObjects));
 | 
			
		||||
    }
 | 
			
		||||
    if (smartInfoPeriodTags != null) {
 | 
			
		||||
      queryParams.addAll(_queryParams('multi', 'smartInfo.tags', smartInfoPeriodTags));
 | 
			
		||||
    }
 | 
			
		||||
    if (recent != null) {
 | 
			
		||||
      queryParams.addAll(_queryParams('', 'recent', recent));
 | 
			
		||||
    }
 | 
			
		||||
    if (motion != null) {
 | 
			
		||||
      queryParams.addAll(_queryParams('', 'motion', motion));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    const contentTypes = <String>[];
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@@ -199,34 +136,8 @@ class SearchApi {
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /// 
 | 
			
		||||
  ///
 | 
			
		||||
  /// Parameters:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] query:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] type:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [bool] isFavorite:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] exifInfoPeriodCity:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] exifInfoPeriodState:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] exifInfoPeriodCountry:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] exifInfoPeriodMake:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [String] exifInfoPeriodModel:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [List<String>] smartInfoPeriodObjects:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [List<String>] smartInfoPeriodTags:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [bool] recent:
 | 
			
		||||
  ///
 | 
			
		||||
  /// * [bool] motion:
 | 
			
		||||
  Future<SearchResponseDto?> search({ String? query, String? type, bool? isFavorite, String? exifInfoPeriodCity, String? exifInfoPeriodState, String? exifInfoPeriodCountry, String? exifInfoPeriodMake, String? exifInfoPeriodModel, List<String>? smartInfoPeriodObjects, List<String>? smartInfoPeriodTags, bool? recent, bool? motion, }) async {
 | 
			
		||||
    final response = await searchWithHttpInfo( query: query, type: type, isFavorite: isFavorite, exifInfoPeriodCity: exifInfoPeriodCity, exifInfoPeriodState: exifInfoPeriodState, exifInfoPeriodCountry: exifInfoPeriodCountry, exifInfoPeriodMake: exifInfoPeriodMake, exifInfoPeriodModel: exifInfoPeriodModel, smartInfoPeriodObjects: smartInfoPeriodObjects, smartInfoPeriodTags: smartInfoPeriodTags, recent: recent, motion: motion, );
 | 
			
		||||
  Future<SearchResponseDto?> search() async {
 | 
			
		||||
    final response = await searchWithHttpInfo();
 | 
			
		||||
    if (response.statusCode >= HttpStatus.badRequest) {
 | 
			
		||||
      throw ApiException(response.statusCode, await _decodeBodyBytes(response));
 | 
			
		||||
    }
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								mobile/openapi/test/search_api_test.dart
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										2
									
								
								mobile/openapi/test/search_api_test.dart
									
									
									
										generated
									
									
									
								
							@@ -33,7 +33,7 @@ void main() {
 | 
			
		||||
 | 
			
		||||
    // 
 | 
			
		||||
    //
 | 
			
		||||
    //Future<SearchResponseDto> search({ String query, String type, bool isFavorite, String exifInfoPeriodCity, String exifInfoPeriodState, String exifInfoPeriodCountry, String exifInfoPeriodMake, String exifInfoPeriodModel, List<String> smartInfoPeriodObjects, List<String> smartInfoPeriodTags, bool recent, bool motion }) async
 | 
			
		||||
    //Future<SearchResponseDto> search() async
 | 
			
		||||
    test('test search', () async {
 | 
			
		||||
      // TODO
 | 
			
		||||
    });
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user