camel.apache.org/hwcloud-frs
1
0
Fork 0
generated from camel.apache.org/component
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update wiki Home page for hwcloud-frs

gitea_admin 2026-03-11 14:39:02 +00:00
parent 7f59aad84d
commit bb00637a43
1 changed files with 44 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
Home.md

@ -1,21 +1,51 @@
# Deploy the Project on CamelX Platform # Huawei Cloud Face Recognition Service (FRS)
Deploy on CamelX Platform in three steps Face Recognition Service (FRS) is an intelligent service that uses computers to process, analyze, and understand facial images based on human facial features.
## Step 1: Create a release ## Metadata
From the project space, click on **"Create a release"**
The new version is automatically available in the list | Property | Value |
|----------|-------|
| Scheme | `hwcloud-frs` |
| Support Level | Stable |
| Labels | cloud,messaging |
| Version | 4.10.2 |
## Step 2: Deploy ## Maven Dependency
Click on **"Deploy"**
- **Version:** Select the desired release ```xml
- **Environment:** Choose `Development`, `Staging`, or `Production` <dependency>
- **Configuration:** Select the configuration source <groupId>org.apache.camel</groupId>
- **Resources:** Set CPU and Memory <artifactId>camel-huaweicloud-frs</artifactId>
<version>4.10.2</version>
</dependency>
```
## Step 3: Expose ## Endpoint Properties
Enable **"Expose"**
Choose an **API Gateway** (Internal, Public, etc.) | Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `operation` | string | ✓ | | Name of Face Recognition operation to perform, including faceDetection, faceVerification and faceLiveDetection |
| `accessKey` | string | ✓ | | Access key for the cloud user |
| `actions` | string | | | This param is mandatory when the operation is faceLiveDetection, indicating the action code sequence list. Actions are separated by commas (,). Currently, the following actions are supported: 1: Shake the head to the left. 2: Shake the head to the right. 3: Nod the head. 4: Mouth movement. |
| `actionTimes` | string | | | This param can be used when the operation is faceLiveDetection, indicating the action time array. The length of the array is the same as the number of actions. Each item contains the start time and end time of the action in the corresponding sequence. The unit is the milliseconds from the video start time. |
| `anotherImageBase64` | string | | | This param can be used when operation is faceVerification, indicating the Base64 character string converted from the other image. It needs to be configured if imageBase64 is set. The image size cannot exceed 10 MB. The image resolution of the narrow sides must be greater than 15 pixels, and that of the wide sides cannot exceed 4096 pixels. The supported image formats include JPG, PNG, and BMP. |
| `anotherImageFilePath` | string | | | This param can be used when operation is faceVerification, indicating the local file path of the other image. It needs to be configured if imageFilePath is set. Image size cannot exceed 8 MB, and it is recommended that the image size be less than 1 MB. |
| `anotherImageUrl` | string | | | This param can be used when operation is faceVerification, indicating the URL of the other image. It needs to be configured if imageUrl is set. The options are as follows: 1.HTTP/HTTPS URLs on the public network 2.OBS URLs. To use OBS data, authorization is required, including service authorization, temporary authorization, and anonymous public authorization. For details, see Configuring the Access Permission of OBS. |
| `endpoint` | string | | | Fully qualified Face Recognition service url. Carries higher precedence than region based configuration. |
| `imageBase64` | string | | | This param can be used when operation is faceDetection or faceVerification, indicating the Base64 character string converted from an image. Any one of imageBase64, imageUrl and imageFilePath needs to be set, and the priority is imageBase64 imageUrl imageFilePath. The Image size cannot exceed 10 MB. The image resolution of the narrow sides must be greater than 15 pixels, and that of the wide sides cannot exceed 4096 pixels. The supported image formats include JPG, PNG, and BMP. |
| `imageFilePath` | string | | | This param can be used when operation is faceDetection or faceVerification, indicating the local image file path. Any one of imageBase64, imageUrl and imageFilePath needs to be set, and the priority is imageBase64 imageUrl imageFilePath. Image size cannot exceed 8 MB, and it is recommended that the image size be less than 1 MB. |
| `imageUrl` | string | | | This param can be used when operation is faceDetection or faceVerification, indicating the URL of an image. Any one of imageBase64, imageUrl and imageFilePath needs to be set, and the priority is imageBase64 imageUrl imageFilePath. The options are as follows: 1.HTTP/HTTPS URLs on the public network 2.OBS URLs. To use OBS data, authorization is required, including service authorization, temporary authorization, and anonymous public authorization. For details, see Configuring the Access Permission of OBS. |
| `projectId` | string | ✓ | | Cloud project ID |
| `proxyHost` | string | | | Proxy server ip/hostname |
| `proxyPassword` | string | | | Proxy authentication password |
| `proxyPort` | integer | | | Proxy server port |
| `proxyUser` | string | | | Proxy authentication user |
| `region` | string | ✓ | | Face Recognition service region. Currently only cn-north-1 and cn-north-4 are supported. This is lower precedence than endpoint based configuration. |
| `secretKey` | string | ✓ | | Secret key for the cloud user |
| `serviceKeys` | object | | | Configuration object for cloud service authentication |
| `videoBase64` | string | | | This param can be used when operation is faceLiveDetection, indicating the Base64 character string converted from a video. Any one of videoBase64, videoUrl and videoFilePath needs to be set, and the priority is videoBase64 videoUrl videoFilePath. Requirements are as follows: 1.The video size after Base64 encoding cannot exceed 8 MB. It is recommended that the video file be compressed to 200 KB to 2 MB on the client. 2.The video duration must be 1 to 15 seconds. 3.The recommended frame rate is 10 fps to 30 fps. 4.The encapsulation format can be MP4, AVI, FLV, WEBM, ASF, or MOV. 5.The video encoding format can be H.261, H.263, H.264, HEVC, VC-1, VP8, VP9, or WMV3. |
| `videoFilePath` | string | | | This param can be used when operation is faceLiveDetection, indicating the local video file path. Any one of videoBase64, videoUrl and videoFilePath needs to be set, and the priority is videoBase64 videoUrl videoFilePath. The video requirements are as follows: 1.The size of a video file cannot exceed 8 MB. It is recommended that the video file be compressed to 200 KB to 2 MB on the client. 2.The video duration must be 1 to 15 seconds. 3.The recommended frame rate is 10 fps to 30 fps. 4.The encapsulation format can be MP4, AVI, FLV, WEBM, ASF, or MOV. 5.The video encoding format can be H.261, H.263, H.264, HEVC, VC-1, VP8, VP9, or WMV3. |
| `videoUrl` | string | | | This param can be used when operation is faceLiveDetection, indicating the URL of a video. Any one of videoBase64, videoUrl and videoFilePath needs to be set, and the priority is videoBase64 videoUrl videoFilePath. Currently, only the URL of an OBS bucket on HUAWEI CLOUD is supported and FRS must have the permission to read data in the OBS bucket. For details about how to enable the read permission, see Service Authorization. The video requirements are as follows: 1.The video size after Base64 encoding cannot exceed 8 MB. 2.The video duration must be 1 to 15 seconds. 3.The recommended frame rate is 10 fps to 30 fps. 4.The encapsulation format can be MP4, AVI, FLV, WEBM, ASF, or MOV. 5.The video encoding format can be H.261, H.263, H.264, HEVC, VC-1, VP8, VP9, or WMV3. |
| `lazyStartProducer` | boolean | | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
| `ignoreSslVerification` | boolean | | `false` | Ignore SSL verification |