alibabacloud-iqs20241111 1.1.5__tar.gz → 1.2.0__tar.gz

{alibabacloud_iqs20241111-1.1.5 → alibabacloud_iqs20241111-1.2.0}/ChangeLog.md

@@ -1,3 +1,14 @@
+2025-03-29 Version: 1.1.6
+- Update API GenericSearch: add request parameters enableRerank.
+- Update API GenericSearch: add request parameters returnMainText.
+- Update API GenericSearch: add request parameters returnMarkdownText.
+- Update API GenericSearch: add request parameters returnSummary.
+
+
+2025-02-27 Version: 1.1.5
+- Update API GenericAdvancedSearch: add param industry.
+
+
 2025-02-18 Version: 1.1.4
 - Generated python 2024-11-11 for IQS.
 

{alibabacloud_iqs20241111-1.1.5 → alibabacloud_iqs20241111-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: alibabacloud_iqs20241111
-Version: 1.1.5
+Version: 1.2.0
 Summary: Alibaba Cloud IQS (20241111) SDK Library for Python
 Home-page: https://github.com/aliyun/alibabacloud-python-sdk
 Author: Alibaba Cloud SDK

alibabacloud_iqs20241111-1.2.0/alibabacloud_iqs20241111/__init__.py

@@ -0,0 +1 @@
+__version__ = '1.2.0'

{alibabacloud_iqs20241111-1.1.5 → alibabacloud_iqs20241111-1.2.0}/alibabacloud_iqs20241111/client.py

@@ -317,12 +317,20 @@ class Client(OpenApiClient):
         """
         UtilClient.validate_model(request)
         query = {}
+        if not UtilClient.is_unset(request.enable_rerank):
+            query['enableRerank'] = request.enable_rerank
         if not UtilClient.is_unset(request.industry):
             query['industry'] = request.industry
         if not UtilClient.is_unset(request.page):
             query['page'] = request.page
         if not UtilClient.is_unset(request.query):
             query['query'] = request.query
+        if not UtilClient.is_unset(request.return_main_text):
+            query['returnMainText'] = request.return_main_text
+        if not UtilClient.is_unset(request.return_markdown_text):
+            query['returnMarkdownText'] = request.return_markdown_text
+        if not UtilClient.is_unset(request.return_summary):
+            query['returnSummary'] = request.return_summary
         if not UtilClient.is_unset(request.session_id):
             query['sessionId'] = request.session_id
         if not UtilClient.is_unset(request.time_range):
@@ -369,12 +377,20 @@ class Client(OpenApiClient):
         """
         UtilClient.validate_model(request)
         query = {}
+        if not UtilClient.is_unset(request.enable_rerank):
+            query['enableRerank'] = request.enable_rerank
         if not UtilClient.is_unset(request.industry):
             query['industry'] = request.industry
         if not UtilClient.is_unset(request.page):
             query['page'] = request.page
         if not UtilClient.is_unset(request.query):
             query['query'] = request.query
+        if not UtilClient.is_unset(request.return_main_text):
+            query['returnMainText'] = request.return_main_text
+        if not UtilClient.is_unset(request.return_markdown_text):
+            query['returnMarkdownText'] = request.return_markdown_text
+        if not UtilClient.is_unset(request.return_summary):
+            query['returnSummary'] = request.return_summary
         if not UtilClient.is_unset(request.session_id):
             query['sessionId'] = request.session_id
         if not UtilClient.is_unset(request.time_range):
@@ -432,3 +448,131 @@ class Client(OpenApiClient):
         runtime = util_models.RuntimeOptions()
         headers = {}
         return await self.generic_search_with_options_async(request, headers, runtime)
+
+    def global_search_with_options(
+        self,
+        request: iqs20241111_models.GlobalSearchRequest,
+        headers: Dict[str, str],
+        runtime: util_models.RuntimeOptions,
+    ) -> iqs20241111_models.GlobalSearchResponse:
+        """
+        @summary 通晓搜索-出海版(全球信息搜索)
+        
+        @param request: GlobalSearchRequest
+        @param headers: map
+        @param runtime: runtime options for this request RuntimeOptions
+        @return: GlobalSearchResponse
+        """
+        UtilClient.validate_model(request)
+        query = {}
+        if not UtilClient.is_unset(request.page):
+            query['page'] = request.page
+        if not UtilClient.is_unset(request.page_size):
+            query['pageSize'] = request.page_size
+        if not UtilClient.is_unset(request.query):
+            query['query'] = request.query
+        if not UtilClient.is_unset(request.time_range):
+            query['timeRange'] = request.time_range
+        req = open_api_models.OpenApiRequest(
+            headers=headers,
+            query=OpenApiUtilClient.query(query)
+        )
+        params = open_api_models.Params(
+            action='GlobalSearch',
+            version='2024-11-11',
+            protocol='HTTPS',
+            pathname=f'/linked-retrieval/linked-retrieval-entry/v1/iqs/search/global',
+            method='GET',
+            auth_type='AK',
+            style='ROA',
+            req_body_type='json',
+            body_type='json'
+        )
+        if UtilClient.is_unset(self._signature_version) or not UtilClient.equal_string(self._signature_version, 'v4'):
+            return TeaCore.from_map(
+                iqs20241111_models.GlobalSearchResponse(),
+                self.call_api(params, req, runtime)
+            )
+        else:
+            return TeaCore.from_map(
+                iqs20241111_models.GlobalSearchResponse(),
+                self.execute(params, req, runtime)
+            )
+
+    async def global_search_with_options_async(
+        self,
+        request: iqs20241111_models.GlobalSearchRequest,
+        headers: Dict[str, str],
+        runtime: util_models.RuntimeOptions,
+    ) -> iqs20241111_models.GlobalSearchResponse:
+        """
+        @summary 通晓搜索-出海版(全球信息搜索)
+        
+        @param request: GlobalSearchRequest
+        @param headers: map
+        @param runtime: runtime options for this request RuntimeOptions
+        @return: GlobalSearchResponse
+        """
+        UtilClient.validate_model(request)
+        query = {}
+        if not UtilClient.is_unset(request.page):
+            query['page'] = request.page
+        if not UtilClient.is_unset(request.page_size):
+            query['pageSize'] = request.page_size
+        if not UtilClient.is_unset(request.query):
+            query['query'] = request.query
+        if not UtilClient.is_unset(request.time_range):
+            query['timeRange'] = request.time_range
+        req = open_api_models.OpenApiRequest(
+            headers=headers,
+            query=OpenApiUtilClient.query(query)
+        )
+        params = open_api_models.Params(
+            action='GlobalSearch',
+            version='2024-11-11',
+            protocol='HTTPS',
+            pathname=f'/linked-retrieval/linked-retrieval-entry/v1/iqs/search/global',
+            method='GET',
+            auth_type='AK',
+            style='ROA',
+            req_body_type='json',
+            body_type='json'
+        )
+        if UtilClient.is_unset(self._signature_version) or not UtilClient.equal_string(self._signature_version, 'v4'):
+            return TeaCore.from_map(
+                iqs20241111_models.GlobalSearchResponse(),
+                await self.call_api_async(params, req, runtime)
+            )
+        else:
+            return TeaCore.from_map(
+                iqs20241111_models.GlobalSearchResponse(),
+                await self.execute_async(params, req, runtime)
+            )
+
+    def global_search(
+        self,
+        request: iqs20241111_models.GlobalSearchRequest,
+    ) -> iqs20241111_models.GlobalSearchResponse:
+        """
+        @summary 通晓搜索-出海版(全球信息搜索)
+        
+        @param request: GlobalSearchRequest
+        @return: GlobalSearchResponse
+        """
+        runtime = util_models.RuntimeOptions()
+        headers = {}
+        return self.global_search_with_options(request, headers, runtime)
+
+    async def global_search_async(
+        self,
+        request: iqs20241111_models.GlobalSearchRequest,
+    ) -> iqs20241111_models.GlobalSearchResponse:
+        """
+        @summary 通晓搜索-出海版(全球信息搜索)
+        
+        @param request: GlobalSearchRequest
+        @return: GlobalSearchResponse
+        """
+        runtime = util_models.RuntimeOptions()
+        headers = {}
+        return await self.global_search_with_options_async(request, headers, runtime)

{alibabacloud_iqs20241111-1.1.5 → alibabacloud_iqs20241111-1.2.0}/alibabacloud_iqs20241111/models.py

@@ -131,6 +131,7 @@ class ScorePageItem(TeaModel):
         score: float = None,
         site_label: str = None,
         snippet: str = None,
+        summary: str = None,
         title: str = None,
     ):
         # This parameter is required.
@@ -155,6 +156,7 @@ class ScorePageItem(TeaModel):
         self.score = score
         self.site_label = site_label
         self.snippet = snippet
+        self.summary = summary
         # This parameter is required.
         self.title = title
 
@@ -204,6 +206,8 @@ class ScorePageItem(TeaModel):
             result['siteLabel'] = self.site_label
         if self.snippet is not None:
             result['snippet'] = self.snippet
+        if self.summary is not None:
+            result['summary'] = self.summary
         if self.title is not None:
             result['title'] = self.title
         return result
@@ -245,6 +249,8 @@ class ScorePageItem(TeaModel):
             self.site_label = m.get('siteLabel')
         if m.get('snippet') is not None:
             self.snippet = m.get('snippet')
+        if m.get('summary') is not None:
+            self.summary = m.get('summary')
         if m.get('title') is not None:
             self.title = m.get('title')
         return self
@@ -588,6 +594,255 @@ class GenericSearchResult(TeaModel):
         return self
 
 
+class GlobalPageItem(TeaModel):
+    def __init__(
+        self,
+        link: str = None,
+        snippet: str = None,
+        title: str = None,
+    ):
+        # This parameter is required.
+        self.link = link
+        self.snippet = snippet
+        # This parameter is required.
+        self.title = title
+
+    def validate(self):
+        pass
+
+    def to_map(self):
+        _map = super().to_map()
+        if _map is not None:
+            return _map
+
+        result = dict()
+        if self.link is not None:
+            result['link'] = self.link
+        if self.snippet is not None:
+            result['snippet'] = self.snippet
+        if self.title is not None:
+            result['title'] = self.title
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        if m.get('link') is not None:
+            self.link = m.get('link')
+        if m.get('snippet') is not None:
+            self.snippet = m.get('snippet')
+        if m.get('title') is not None:
+            self.title = m.get('title')
+        return self
+
+
+class GlobalQueryContextOriginalQuery(TeaModel):
+    def __init__(
+        self,
+        page: str = None,
+        query: str = None,
+        time_range: str = None,
+    ):
+        self.page = page
+        self.query = query
+        self.time_range = time_range
+
+    def validate(self):
+        pass
+
+    def to_map(self):
+        _map = super().to_map()
+        if _map is not None:
+            return _map
+
+        result = dict()
+        if self.page is not None:
+            result['page'] = self.page
+        if self.query is not None:
+            result['query'] = self.query
+        if self.time_range is not None:
+            result['timeRange'] = self.time_range
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        if m.get('page') is not None:
+            self.page = m.get('page')
+        if m.get('query') is not None:
+            self.query = m.get('query')
+        if m.get('timeRange') is not None:
+            self.time_range = m.get('timeRange')
+        return self
+
+
+class GlobalQueryContext(TeaModel):
+    def __init__(
+        self,
+        original_query: GlobalQueryContextOriginalQuery = None,
+    ):
+        self.original_query = original_query
+
+    def validate(self):
+        if self.original_query:
+            self.original_query.validate()
+
+    def to_map(self):
+        _map = super().to_map()
+        if _map is not None:
+            return _map
+
+        result = dict()
+        if self.original_query is not None:
+            result['originalQuery'] = self.original_query.to_map()
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        if m.get('originalQuery') is not None:
+            temp_model = GlobalQueryContextOriginalQuery()
+            self.original_query = temp_model.from_map(m['originalQuery'])
+        return self
+
+
+class GlobalSceneItem(TeaModel):
+    def __init__(
+        self,
+        detail: str = None,
+        type: str = None,
+    ):
+        self.detail = detail
+        self.type = type
+
+    def validate(self):
+        pass
+
+    def to_map(self):
+        _map = super().to_map()
+        if _map is not None:
+            return _map
+
+        result = dict()
+        if self.detail is not None:
+            result['detail'] = self.detail
+        if self.type is not None:
+            result['type'] = self.type
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        if m.get('detail') is not None:
+            self.detail = m.get('detail')
+        if m.get('type') is not None:
+            self.type = m.get('type')
+        return self
+
+
+class GlobalSearchInformation(TeaModel):
+    def __init__(
+        self,
+        search_time: int = None,
+        total: int = None,
+    ):
+        self.search_time = search_time
+        self.total = total
+
+    def validate(self):
+        pass
+
+    def to_map(self):
+        _map = super().to_map()
+        if _map is not None:
+            return _map
+
+        result = dict()
+        if self.search_time is not None:
+            result['searchTime'] = self.search_time
+        if self.total is not None:
+            result['total'] = self.total
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        if m.get('searchTime') is not None:
+            self.search_time = m.get('searchTime')
+        if m.get('total') is not None:
+            self.total = m.get('total')
+        return self
+
+
+class GlobalSearchResult(TeaModel):
+    def __init__(
+        self,
+        page_items: List[GlobalPageItem] = None,
+        query_context: GlobalQueryContext = None,
+        request_id: str = None,
+        scene_items: List[GlobalSceneItem] = None,
+        search_information: GlobalSearchInformation = None,
+    ):
+        self.page_items = page_items
+        self.query_context = query_context
+        self.request_id = request_id
+        self.scene_items = scene_items
+        self.search_information = search_information
+
+    def validate(self):
+        if self.page_items:
+            for k in self.page_items:
+                if k:
+                    k.validate()
+        if self.query_context:
+            self.query_context.validate()
+        if self.scene_items:
+            for k in self.scene_items:
+                if k:
+                    k.validate()
+        if self.search_information:
+            self.search_information.validate()
+
+    def to_map(self):
+        _map = super().to_map()
+        if _map is not None:
+            return _map
+
+        result = dict()
+        result['pageItems'] = []
+        if self.page_items is not None:
+            for k in self.page_items:
+                result['pageItems'].append(k.to_map() if k else None)
+        if self.query_context is not None:
+            result['queryContext'] = self.query_context.to_map()
+        if self.request_id is not None:
+            result['requestId'] = self.request_id
+        result['sceneItems'] = []
+        if self.scene_items is not None:
+            for k in self.scene_items:
+                result['sceneItems'].append(k.to_map() if k else None)
+        if self.search_information is not None:
+            result['searchInformation'] = self.search_information.to_map()
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        self.page_items = []
+        if m.get('pageItems') is not None:
+            for k in m.get('pageItems'):
+                temp_model = GlobalPageItem()
+                self.page_items.append(temp_model.from_map(k))
+        if m.get('queryContext') is not None:
+            temp_model = GlobalQueryContext()
+            self.query_context = temp_model.from_map(m['queryContext'])
+        if m.get('requestId') is not None:
+            self.request_id = m.get('requestId')
+        self.scene_items = []
+        if m.get('sceneItems') is not None:
+            for k in m.get('sceneItems'):
+                temp_model = GlobalSceneItem()
+                self.scene_items.append(temp_model.from_map(k))
+        if m.get('searchInformation') is not None:
+            temp_model = GlobalSearchInformation()
+            self.search_information = temp_model.from_map(m['searchInformation'])
+        return self
+
+
 class AiSearchRequest(TeaModel):
     def __init__(
         self,
@@ -976,16 +1231,24 @@ class GenericAdvancedSearchResponse(TeaModel):
 class GenericSearchRequest(TeaModel):
     def __init__(
         self,
+        enable_rerank: bool = None,
         industry: str = None,
         page: int = None,
         query: str = None,
+        return_main_text: bool = None,
+        return_markdown_text: bool = None,
+        return_summary: bool = None,
         session_id: str = None,
         time_range: str = None,
     ):
+        self.enable_rerank = enable_rerank
         self.industry = industry
         self.page = page
         # This parameter is required.
         self.query = query
+        self.return_main_text = return_main_text
+        self.return_markdown_text = return_markdown_text
+        self.return_summary = return_summary
         self.session_id = session_id
         self.time_range = time_range
 
@@ -998,12 +1261,20 @@ class GenericSearchRequest(TeaModel):
             return _map
 
         result = dict()
+        if self.enable_rerank is not None:
+            result['enableRerank'] = self.enable_rerank
         if self.industry is not None:
             result['industry'] = self.industry
         if self.page is not None:
             result['page'] = self.page
         if self.query is not None:
             result['query'] = self.query
+        if self.return_main_text is not None:
+            result['returnMainText'] = self.return_main_text
+        if self.return_markdown_text is not None:
+            result['returnMarkdownText'] = self.return_markdown_text
+        if self.return_summary is not None:
+            result['returnSummary'] = self.return_summary
         if self.session_id is not None:
             result['sessionId'] = self.session_id
         if self.time_range is not None:
@@ -1012,12 +1283,20 @@ class GenericSearchRequest(TeaModel):
 
     def from_map(self, m: dict = None):
         m = m or dict()
+        if m.get('enableRerank') is not None:
+            self.enable_rerank = m.get('enableRerank')
         if m.get('industry') is not None:
             self.industry = m.get('industry')
         if m.get('page') is not None:
             self.page = m.get('page')
         if m.get('query') is not None:
             self.query = m.get('query')
+        if m.get('returnMainText') is not None:
+            self.return_main_text = m.get('returnMainText')
+        if m.get('returnMarkdownText') is not None:
+            self.return_markdown_text = m.get('returnMarkdownText')
+        if m.get('returnSummary') is not None:
+            self.return_summary = m.get('returnSummary')
         if m.get('sessionId') is not None:
             self.session_id = m.get('sessionId')
         if m.get('timeRange') is not None:
@@ -1066,3 +1345,90 @@ class GenericSearchResponse(TeaModel):
         return self
 
 
+class GlobalSearchRequest(TeaModel):
+    def __init__(
+        self,
+        page: int = None,
+        page_size: int = None,
+        query: str = None,
+        time_range: str = None,
+    ):
+        self.page = page
+        self.page_size = page_size
+        # This parameter is required.
+        self.query = query
+        self.time_range = time_range
+
+    def validate(self):
+        pass
+
+    def to_map(self):
+        _map = super().to_map()
+        if _map is not None:
+            return _map
+
+        result = dict()
+        if self.page is not None:
+            result['page'] = self.page
+        if self.page_size is not None:
+            result['pageSize'] = self.page_size
+        if self.query is not None:
+            result['query'] = self.query
+        if self.time_range is not None:
+            result['timeRange'] = self.time_range
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        if m.get('page') is not None:
+            self.page = m.get('page')
+        if m.get('pageSize') is not None:
+            self.page_size = m.get('pageSize')
+        if m.get('query') is not None:
+            self.query = m.get('query')
+        if m.get('timeRange') is not None:
+            self.time_range = m.get('timeRange')
+        return self
+
+
+class GlobalSearchResponse(TeaModel):
+    def __init__(
+        self,
+        headers: Dict[str, str] = None,
+        status_code: int = None,
+        body: GlobalSearchResult = None,
+    ):
+        self.headers = headers
+        self.status_code = status_code
+        self.body = body
+
+    def validate(self):
+        if self.body:
+            self.body.validate()
+
+    def to_map(self):
+        _map = super().to_map()
+        if _map is not None:
+            return _map
+
+        result = dict()
+        if self.headers is not None:
+            result['headers'] = self.headers
+        if self.status_code is not None:
+            result['statusCode'] = self.status_code
+        if self.body is not None:
+            result['body'] = self.body.to_map()
+        return result
+
+    def from_map(self, m: dict = None):
+        m = m or dict()
+        if m.get('headers') is not None:
+            self.headers = m.get('headers')
+        if m.get('statusCode') is not None:
+            self.status_code = m.get('statusCode')
+        if m.get('body') is not None:
+            temp_model = GlobalSearchResult()
+            self.body = temp_model.from_map(m['body'])
+        return self
+
+

{alibabacloud_iqs20241111-1.1.5 → alibabacloud_iqs20241111-1.2.0}/alibabacloud_iqs20241111.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: alibabacloud-iqs20241111
-Version: 1.1.5
+Version: 1.2.0
 Summary: Alibaba Cloud IQS (20241111) SDK Library for Python
 Home-page: https://github.com/aliyun/alibabacloud-python-sdk
 Author: Alibaba Cloud SDK

{alibabacloud_iqs20241111-1.1.5 → alibabacloud_iqs20241111-1.2.0}/setup.py

@@ -24,7 +24,7 @@ from setuptools import setup, find_packages
 """
 setup module for alibabacloud_iqs20241111.
 
-Created on 27/02/2025
+Created on 08/04/2025
 
 @author: Alibaba Cloud SDK
 """

alibabacloud_iqs20241111-1.1.5/alibabacloud_iqs20241111/__init__.py

@@ -1 +0,0 @@
-__version__ = '1.1.5'