Intelligent Media Services:IPC event search best practices

Prerequisites

1. Call the CreateIpcOrder operation to purchase the service.

2. Set up your environment. For more information, see OpenAPI Portal.

Create a search library

Call the CreateSearchLib operation to create a search library. The following code provides an example:

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

from typing import List

from alibabacloud_ice20201109.client import Client as ICE20201109Client
from alibabacloud_credentials.client import Client as CredentialClient
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_ice20201109 import models as ice20201109_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> ICE20201109Client:
        """
        Initializes a client with credentials.
        @return: Client
        @throws Exception
        """
        # For production environments, use a more secure method that does not require an AccessKey pair. For more information about how to configure credentials, see https://www.alibabacloud.com/help/document_detail/378659.html.
        credential = CredentialClient()
        config = open_api_models.Config(
            credential=credential
        )
        # For more information about endpoints, see https://api.aliyun.com/product/ICE
        config.endpoint = f'ice.cn-shenzhen.aliyuncs.com'
        return ICE20201109Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_search_lib_request = ice20201109_models.CreateSearchLibRequest(
            search_lib_name='IPCamera_test1'
        )
        runtime = util_models.RuntimeOptions()
        try:
            resp = client.create_search_lib_with_options(create_search_lib_request, runtime)
            print(json.dumps(resp, default=str, indent=2))
        except Exception as error:
            # This is for demonstration purposes only. Handle exceptions with care. Do not ignore exceptions in your projects.
            # Error message
            print(error.message)
            # Diagnostic address
            print(error.data.get("Recommend"))

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_search_lib_request = ice20201109_models.CreateSearchLibRequest(
            search_lib_name='IPCamera_test1'
        )
        runtime = util_models.RuntimeOptions()
        try:
            resp = await client.create_search_lib_with_options_async(create_search_lib_request, runtime)
            print(json.dumps(resp, default=str, indent=2))
        except Exception as error:
            # This is for demonstration purposes only. Handle exceptions with care. Do not ignore exceptions in your projects.
            # Error message
            print(error.message)
            # Diagnostic address
            print(error.data.get("Recommend"))


if __name__ == '__main__':
    Sample.main(sys.argv[1:])

Request parameters:

Response parameters:

Response example:

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Success": true,
  "Code": 200,
  "SearchLibName": "IPCamera_test1"
}

Create a search index

Call the CreateSearchIndex operation to create a search index. The following code provides an example:

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

from typing import List

from alibabacloud_ice20201109.client import Client as ICE20201109Client
from alibabacloud_credentials.client import Client as CredentialClient
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_ice20201109 import models as ice20201109_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> ICE20201109Client:
        """
        Initializes a client with credentials.
        @return: Client
        @throws Exception
        """
        # For production environments, use a more secure method that does not require an AccessKey pair. For more information about how to configure credentials, see https://www.alibabacloud.com/help/document_detail/378659.html.
        credential = CredentialClient()
        config = open_api_models.Config(
            credential=credential
        )
        # For more information about endpoints, see https://api.aliyun.com/product/ICE
        config.endpoint = f'ice.cn-shenzhen.aliyuncs.com'
        return ICE20201109Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_search_index_request = ice20201109_models.CreateSearchIndexRequest(
            search_lib_name='IPCamera_test1',
            index_type='mm',
            index_config='{"level":"S.large"}'
        )
        runtime = util_models.RuntimeOptions()
        try:
            resp = client.create_search_index_with_options(create_search_index_request, runtime)
            print(json.dumps(resp, default=str, indent=2))
        except Exception as error:
            # This is for demonstration purposes only. Handle exceptions with care. Do not ignore exceptions in your projects.
            # Error message
            print(error.message)
            # Diagnostic address
            print(error.data.get("Recommend"))

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_search_index_request = ice20201109_models.CreateSearchIndexRequest(
            search_lib_name='IPCamera_test1',
            index_type='mm',
            index_config='{"level":"S.large"}'
        )
        runtime = util_models.RuntimeOptions()
        try:
            resp = await client.create_search_index_with_options_async(create_search_index_request, runtime)
            print(json.dumps(resp, default=str, indent=2))
        except Exception as error:
            # This is for demonstration purposes only. Handle exceptions with care. Do not ignore exceptions in your projects.
            # Error message
            print(error.message)
            # Diagnostic address
            print(error.data.get("Recommend"))


if __name__ == '__main__':
    Sample.main(sys.argv[1:])

Request parameters:

IndexConfig parameters:

Response parameters:

Response example:

{
  "RequestId": "*****ACB-44F2-5F2D-88D7-1283E70*****",
  "Success": true,
  "Code": 200
}

Insert a media asset into the search library

Call the InsertMediaToSearchLib operation to insert a media asset into the search library. The following code provides an example:

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

from typing import List

from alibabacloud_ice20201109.client import Client as ICE20201109Client
from alibabacloud_credentials.client import Client as CredentialClient
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_ice20201109 import models as ice20201109_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> ICE20201109Client:
        """
        Initializes a client with credentials.
        @return: Client
        @throws Exception
        """
        # For production environments, use a more secure method that does not require an AccessKey pair. For more information about how to configure credentials, see https://www.alibabacloud.com/help/document_detail/378659.html.
        credential = CredentialClient()
        config = open_api_models.Config(
            credential=credential
        )
        # For more information about endpoints, see https://api.aliyun.com/product/ICE
        config.endpoint = f'ice.cn-shenzhen.aliyuncs.com'
        return ICE20201109Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        insert_media_to_search_lib_request = ice20201109_models.InsertMediaToSearchLibRequest(
            search_lib_name='IPCamera_test1',
            media_type='video',
            input='oss://[example-bucket-]/[object_path-]',
            msg_body='{"title":"Short description","visionDescription":"Detailed visual description"}',
            images_input='{"images":["oss://[example-bucket-]/[object_path-]xxx1.jpg","oss://[example-bucket-]/[object_path-]xxx2.jpg","oss://[example-bucket-]/[object_path-]xxx3.jpg","oss://[example-bucket-]/[object_path-]xxx4.jpg"]}',
            namespace='name-1'
        )
        runtime = util_models.RuntimeOptions()
        try:
            resp = client.insert_media_to_search_lib_with_options(insert_media_to_search_lib_request, runtime)
            print(json.dumps(resp, default=str, indent=2))
        except Exception as error:
            # This is for demonstration purposes only. Handle exceptions with care. Do not ignore exceptions in your projects.
            # Error message
            print(error.message)
            # Diagnostic address
            print(error.data.get("Recommend"))

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        insert_media_to_search_lib_request = ice20201109_models.InsertMediaToSearchLibRequest(
            search_lib_name='IPCamera_test1',
            media_type='video',
            input='oss://[example-bucket-]/[object_path-]',
            msg_body='{"title":"Short description","visionDescription":"Detailed visual description"}',
            images_input='{"images":["oss://[example-bucket-]/[object_path-]xxx1.jpg","oss://[example-bucket-]/[object_path-]xxx2.jpg","oss://[example-bucket-]/[object_path-]xxx3.jpg","oss://[example-bucket-]/[object_path-]xxx4.jpg"]}',
            namespace='name-1'
        )
        runtime = util_models.RuntimeOptions()
        try:
            resp = await client.insert_media_to_search_lib_with_options_async(insert_media_to_search_lib_request, runtime)
            print(json.dumps(resp, default=str, indent=2))
        except Exception as error:
            # This is for demonstration purposes only. Handle exceptions with care. Do not ignore exceptions in your projects.
            # Error message
            print(error.message)
            # Diagnostic address
            print(error.data.get("Recommend"))


if __name__ == '__main__':
    Sample.main(sys.argv[1:])

Request parameters:

Response parameters:

Response example:

{
  "RequestId": "*****ACB-44F2-5F2D-88D7-1283E70*****",
  "MediaId": "****20b48fb04483915d4f2cd8ac****",
  "Success": true,
  "Code": 200
}

Event retrieval

Call the SearchMediaByHybrid operation to retrieve events. The following code provides an example:

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

from typing import List

from alibabacloud_ice20201109.client import Client as ICE20201109Client
from alibabacloud_credentials.client import Client as CredentialClient
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_ice20201109 import models as ice20201109_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> ICE20201109Client:
        """
        Initializes a client with credentials.
        @return: Client
        @throws Exception
        """
        # For production environments, use a more secure method that does not require an AccessKey pair. For more information about how to configure credentials, see https://www.alibabacloud.com/help/document_detail/378659.html.
        credential = CredentialClient()
        config = open_api_models.Config(
            credential=credential
        )
        # For more information about endpoints, see https://api.aliyun.com/product/ICE
        config.endpoint = f'ice.cn-shenzhen.aliyuncs.com'
        return ICE20201109Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        search_media_by_hybrid_request = ice20201109_models.SearchMediaByHybridRequest(
            search_lib_name='IPCamera_test1',
            media_type='video',
            text='Two pandas are fighting',
            namespace='name-1'
        )
        runtime = util_models.RuntimeOptions()
        try:
            resp = client.search_media_by_hybrid_with_options(search_media_by_hybrid_request, runtime)
            print(json.dumps(resp, default=str, indent=2))
        except Exception as error:
            # This is for demonstration purposes only. Handle exceptions with care. Do not ignore exceptions in your projects.
            # Error message
            print(error.message)
            # Diagnostic address
            print(error.data.get("Recommend"))

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        search_media_by_hybrid_request = ice20201109_models.SearchMediaByHybridRequest(
            search_lib_name='IPCamera_test1',
            media_type='video',
            text='Two pandas are fighting',
            namespace='name-1'
        )
        runtime = util_models.RuntimeOptions()
        try:
            resp = await client.search_media_by_hybrid_with_options_async(search_media_by_hybrid_request, runtime)
            print(json.dumps(resp, default=str, indent=2))
        except Exception as error:
            # This is for demonstration purposes only. Handle exceptions with care. Do not ignore exceptions in your projects.
            # Error message
            print(error.message)
            # Diagnostic address
            print(error.data.get("Recommend"))


if __name__ == '__main__':
    Sample.main(sys.argv[1:])

Request parameters:

Response parameters:

Response example:

{
  "RequestId": "****63E8B7C7-4812-46AD-0FA56029AC86****",
  "Success": true,
  "Code": 200,
  "MediaList": [
    {
      "MediaId": "a18936e0e28771edb59ae6f6f47a****",
      "ClipInfo": [
        {
          "From": 2,
          "To": 4,
          "Score": 0.99
        }
      ]
    }
  ],
  "Total": 20
}

Best practices for event retrieval

Use a complete natural language description with one or two keywords. Avoid using too many keywords, because this can result in partial matches. You should also avoid queries that are too short or ambiguous.