Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for visualSearch Admin API #388

Merged
merged 1 commit into from
Jul 4, 2023
Merged

Add support for visualSearch Admin API #388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/Api/Admin/AssetsTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,27 @@ public function assetsByAssetFolder($assetFolder, $options = [])
return $this->apiClient->get($uri, $params);
}


/**
* Find images based on their visual content.
*
* @param array $options The optional parameters. See the
* <a href=https://cloudinary.com/documentation/admin_api#visual_search_for_resources
* target="_blank"> AdminAPI</a> documentation.
*
* @return ApiResponse
*
* @see https://cloudinary.com/documentation/admin_api#visual_search_for_resources
*/
public function visualSearch($options = [])
{
$uri = [ApiEndPoint::ASSETS, 'visual_search'];

$params = ArrayUtils::whitelist($options, ['image_url', 'image_asset_id', 'text']);

return $this->apiClient->get($uri, $params);
}

/**
* Returns the details of the specified asset and all its derived assets.
*
Expand Down Expand Up @@ -333,6 +354,7 @@ public function update($publicId, $options = [])
'categorization',
'detection',
'similarity_search',
'visual_search',
'auto_tagging',
'background_removal',
'quality_override',
Expand Down
1 change: 1 addition & 0 deletions src/Api/Upload/UploadTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ public static function buildUploadParams($options)
'raw_convert',
'return_delete_token',
'similarity_search',
'visual_search',
'type',
'unique_filename',
'upload_preset',
Expand Down
10 changes: 6 additions & 4 deletions tests/Unit/Admin/AssetsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ public function testUpdateAssetFields()
'metadata' => ['key' => 'value'],
'asset_folder' => 'asset_folder',
'unique_display_name' => true,
'visual_search' => true,
]
);
$lastRequest = $mockAdminApi->getMockHandler()->getLastRequest();
Expand All @@ -94,6 +95,7 @@ public function testUpdateAssetFields()
'metadata' => 'key=value',
'asset_folder' => 'asset_folder',
'unique_display_name' => true,
'visual_search' => true,
]
);
}
Expand All @@ -120,7 +122,7 @@ public function testRelatedAssets()
self::assertRequestJsonBodySubset(
$lastRequest,
[
'assets_to_relate' => $testIds
'assets_to_relate' => $testIds,
]
);

Expand All @@ -136,7 +138,7 @@ public function testRelatedAssets()
self::assertRequestJsonBodySubset(
$lastRequest,
[
'assets_to_unrelate' => $testIds
'assets_to_unrelate' => $testIds,
]
);
}
Expand All @@ -163,7 +165,7 @@ public function testRelatedAssetsByAssetIds()
self::assertRequestJsonBodySubset(
$lastRequest,
[
'assets_to_relate' => $testAssetIds
'assets_to_relate' => $testAssetIds,
]
);

Expand All @@ -179,7 +181,7 @@ public function testRelatedAssetsByAssetIds()
self::assertRequestJsonBodySubset(
$lastRequest,
[
'assets_to_unrelate' => $testAssetIds
'assets_to_unrelate' => $testAssetIds,
]
);
}
Expand Down
64 changes: 42 additions & 22 deletions tests/Unit/Upload/UploadApiTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,26 @@ final class UploadApiTest extends AssetTestCase
*
* @throws ApiError
*/
public function testAccessibilityAnalysisUpload()
public function testVariousUploadParams()
{
$params = [
'accessibility_analysis' => true,
'cinemagraph_analysis' => true,
'media_metadata' => true,
'visual_search' => true,
];

$mockUploadApi = new MockUploadApi();
$mockUploadApi->upload(self::TEST_BASE64_IMAGE, ['accessibility_analysis' => true]);
$mockUploadApi->upload(
self::TEST_BASE64_IMAGE,
$params
);

$lastOptions = $mockUploadApi->getApiClient()->getRequestMultipartOptions();

self::assertEquals('1', $lastOptions['accessibility_analysis']);
foreach ($params as $param => $value) {
self::assertEquals($value ? '1' : '0', $lastOptions[$param]);
}
}

/**
Expand Down Expand Up @@ -139,50 +152,57 @@ public function testUploadFolderDecoupling()
public function testHeadersExtraHeaders($input, $expectedOutput)
{
$mockUploadApi = new MockUploadApi();
$mockUploadApi->upload(self::TEST_BASE64_IMAGE, $input);
$mockOutput = $mockUploadApi->getApiClient()->getLastRequestHeaders();
$mockUploadApi->upload(self::TEST_BASE64_IMAGE, $input);
$mockOutput = $mockUploadApi->getApiClient()->getLastRequestHeaders();
self::assertSubset($expectedOutput, $mockOutput);
}

/**
* @return array
*/
public function headersDataProvider()
{
return [
[
[
'headers' => ['Content-Type' => 'application/json', 'Accept' => 'application/json'],
'extra_headers' => ['test1' => 'Bearer abc123', 'test2' => 'MyApp/1.0']
'headers' => ['Content-Type' => 'application/json', 'Accept' => 'application/json'],
'extra_headers' => ['test1' => 'Bearer abc123', 'test2' => 'MyApp/1.0'],
],
[
'Content-Type' => ['application/json'],
'Accept' => ['application/json'],
'test1' => ['Bearer abc123'],
'test2' => ['MyApp/1.0'],
],
['Content-Type' => ['application/json'], 'Accept' => ['application/json'],
'test1' => ['Bearer abc123'], 'test2' => ['MyApp/1.0']]
],
[
[
'headers' => ['X-Request-ID' => '12345'],
'extra_headers' => ['Accept-Encoding' => 'gzip']
'headers' => ['X-Request-ID' => '12345'],
'extra_headers' => ['Accept-Encoding' => 'gzip'],
],
['X-Request-ID' => ['12345'], 'Accept-Encoding' => ['gzip']]
['X-Request-ID' => ['12345'], 'Accept-Encoding' => ['gzip']],
],
[
[
'headers' => ['Content-Language' => 'en-US'],
'extra_headers' => []
'headers' => ['Content-Language' => 'en-US'],
'extra_headers' => [],
],
['Content-Language' => ['en-US']]
['Content-Language' => ['en-US']],
],
[
[
'headers' => [],
'extra_headers' => ['X-Debug' => ['true']]
'headers' => [],
'extra_headers' => ['X-Debug' => ['true']],
],
['X-Debug' => ['true']]
['X-Debug' => ['true']],
],
[
[
'headers' => [],
'extra_headers' => []
'headers' => [],
'extra_headers' => [],
],
[]
]
[],
],
];
}
}