docspace-api-sdk 4.0.0

data/lib/docspace-api-sdk/api/AI/web-search-api.rb

@@ -0,0 +1,571 @@
+# (c) Copyright Ascensio System SIA 2026
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require 'cgi'
+
+module DocspaceApiSdk
+  module AI
+    class WebSearchApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Clear the web-search configuration
+    # Removes the portal's web-search configuration, after which web search is unavailable everywhere it was not configured separately. This is not scoped: it takes no `entityId` and any body sent with it is ignored, so it cannot be used to clear one room's configuration. Clearing an already-unconfigured portal is not an error and the call answers success either way. The stored provider key is destroyed with the configuration and has to be entered again.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-clear/
+    # @param ai_web_search_clear_request [String] Ignored. The operation always clears the portal-wide configuration, so send an empty body; a value here does not scope it to a room.
+    # @param [Hash] opts the optional parameters
+    # @return [AiSuccessResponse]
+    def ai_web_search_clear(ai_web_search_clear_request, opts = {})
+      data, _status_code, _headers = ai_web_search_clear_with_http_info(ai_web_search_clear_request, opts)
+      data
+    end
+
+    # Clear the web-search configuration
+    # Removes the portal's web-search configuration, after which web search is unavailable everywhere it was not configured separately. This is not scoped: it takes no `entityId` and any body sent with it is ignored, so it cannot be used to clear one room's configuration. Clearing an already-unconfigured portal is not an error and the call answers success either way. The stored provider key is destroyed with the configuration and has to be entered again.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-clear/
+    # @param ai_web_search_clear_request [String] Ignored. The operation always clears the portal-wide configuration, so send an empty body; a value here does not scope it to a room.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AiSuccessResponse, Integer, Hash)>] AiSuccessResponse data, response status code and response headers
+    def ai_web_search_clear_with_http_info(ai_web_search_clear_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AI::WebSearchApi.ai_web_search_clear ...'
+      end
+      # verify the required parameter 'ai_web_search_clear_request' is set
+      if @api_client.config.client_side_validation && ai_web_search_clear_request.nil?
+        fail ArgumentError, "Missing the required parameter 'ai_web_search_clear_request' when calling AI::WebSearchApi.ai_web_search_clear"
+      end
+      # resource path
+      local_var_path = '/api/2.0/ai/web-search/clear'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(ai_web_search_clear_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AiSuccessResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AI::WebSearchApi.ai_web_search_clear",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AI::WebSearchApi#ai_web_search_clear\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Configure and verify web search
+    # Validates a web-search configuration against the live provider and stores it only if the provider answers, which makes it the safe way to save a form in one step. `entityId` scopes the configuration to a room and has to name one the caller can open; omitting it configures the portal. A `baseUrl` pointing at a private network address is refused. Use `PUT api/2.0/ai/web-search/set-active-config` when the configuration should be stored without a provider round trip.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-configure/
+    # @param ai_web_search_configure_request [AiWebSearchConfigureRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AiWebSearchMutationResult]
+    def ai_web_search_configure(ai_web_search_configure_request, opts = {})
+      data, _status_code, _headers = ai_web_search_configure_with_http_info(ai_web_search_configure_request, opts)
+      data
+    end
+
+    # Configure and verify web search
+    # Validates a web-search configuration against the live provider and stores it only if the provider answers, which makes it the safe way to save a form in one step. `entityId` scopes the configuration to a room and has to name one the caller can open; omitting it configures the portal. A `baseUrl` pointing at a private network address is refused. Use `PUT api/2.0/ai/web-search/set-active-config` when the configuration should be stored without a provider round trip.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-configure/
+    # @param ai_web_search_configure_request [AiWebSearchConfigureRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AiWebSearchMutationResult, Integer, Hash)>] AiWebSearchMutationResult data, response status code and response headers
+    def ai_web_search_configure_with_http_info(ai_web_search_configure_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AI::WebSearchApi.ai_web_search_configure ...'
+      end
+      # verify the required parameter 'ai_web_search_configure_request' is set
+      if @api_client.config.client_side_validation && ai_web_search_configure_request.nil?
+        fail ArgumentError, "Missing the required parameter 'ai_web_search_configure_request' when calling AI::WebSearchApi.ai_web_search_configure"
+      end
+      # resource path
+      local_var_path = '/api/2.0/ai/web-search/configure'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(ai_web_search_configure_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AiWebSearchMutationResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AI::WebSearchApi.ai_web_search_configure",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AI::WebSearchApi#ai_web_search_configure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get active config
+    # Returns the web-search configuration in force for a scope - the provider, its endpoint and its settings. `entityId` picks a room and has to name one the caller can open; omitting it reads the portal-wide configuration, and a room with none of its own falls back to that. An unconfigured scope answers an empty result rather than 404. The provider key is not part of the answer, so a client cannot read it back after storing it.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-get-active-config/
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :entity_id The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.
+    # @return [AiWebSearchConfig]
+    def ai_web_search_get_active_config(opts = {})
+      data, _status_code, _headers = ai_web_search_get_active_config_with_http_info(opts)
+      data
+    end
+
+    # Get active config
+    # Returns the web-search configuration in force for a scope - the provider, its endpoint and its settings. `entityId` picks a room and has to name one the caller can open; omitting it reads the portal-wide configuration, and a room with none of its own falls back to that. An unconfigured scope answers an empty result rather than 404. The provider key is not part of the answer, so a client cannot read it back after storing it.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-get-active-config/
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :entity_id The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.
+    # @return [Array<(AiWebSearchConfig, Integer, Hash)>] AiWebSearchConfig data, response status code and response headers
+    def ai_web_search_get_active_config_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AI::WebSearchApi.ai_web_search_get_active_config ...'
+      end
+      # resource path
+      local_var_path = '/api/2.0/ai/web-search/get-active-config'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AiWebSearchConfig'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AI::WebSearchApi.ai_web_search_get_active_config",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AI::WebSearchApi#ai_web_search_get_active_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Is configured
+    # Tells whether web search is available in a scope, as a bare boolean, which is the cheap check for hiding or showing the feature. `entityId` picks a room and has to name one the caller can open. It reports the same state as `GET api/2.0/ai/web-search/get-active-config` without transferring the configuration itself. A true answer means a provider is stored, not that the provider is currently reachable - probe that with `POST api/2.0/ai/web-search/test-connection`.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-is-configured/
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :entity_id The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.
+    # @return [Boolean]
+    def ai_web_search_is_configured(opts = {})
+      data, _status_code, _headers = ai_web_search_is_configured_with_http_info(opts)
+      data
+    end
+
+    # Is configured
+    # Tells whether web search is available in a scope, as a bare boolean, which is the cheap check for hiding or showing the feature. `entityId` picks a room and has to name one the caller can open. It reports the same state as `GET api/2.0/ai/web-search/get-active-config` without transferring the configuration itself. A true answer means a provider is stored, not that the provider is currently reachable - probe that with `POST api/2.0/ai/web-search/test-connection`.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-is-configured/
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :entity_id The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.
+    # @return [Array<(Boolean, Integer, Hash)>] Boolean data, response status code and response headers
+    def ai_web_search_is_configured_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AI::WebSearchApi.ai_web_search_is_configured ...'
+      end
+      # resource path
+      local_var_path = '/api/2.0/ai/web-search/is-configured'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Boolean'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AI::WebSearchApi.ai_web_search_is_configured",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AI::WebSearchApi#ai_web_search_is_configured\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Web page contents passthrough
+    # Fetches the contents of web pages on behalf of the document editor's AI plugin, against the portal's active web-search provider, exactly as the search passthrough does — including the `entityId` / `entityKind` billing attribution. The portal-wide configuration is used and a portal without one answers 404. `urls` has to be a non-empty array of strings, or the call answers 400 naming the field. The provider's 4xx status, body and content type are relayed, so its 429 surfaces unchanged, while a 5xx is replaced by a fixed 502 with the detail kept in the server log. This is the follow-up to `POST api/2.0/ai/websearch/v1/search`, which returns the results whose contents this operation retrieves.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-passthrough-contents/
+    # @param ai_web_search_passthrough_contents_request [Hash<String, Object>] A page-contents request in the shape the portal's active web-search provider expects, forwarded to it once `urls` passes a type check. The endpoint and the key come from the stored configuration.
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Object>]
+    def ai_web_search_passthrough_contents(ai_web_search_passthrough_contents_request, opts = {})
+      data, _status_code, _headers = ai_web_search_passthrough_contents_with_http_info(ai_web_search_passthrough_contents_request, opts)
+      data
+    end
+
+    # Web page contents passthrough
+    # Fetches the contents of web pages on behalf of the document editor's AI plugin, against the portal's active web-search provider, exactly as the search passthrough does — including the `entityId` / `entityKind` billing attribution. The portal-wide configuration is used and a portal without one answers 404. `urls` has to be a non-empty array of strings, or the call answers 400 naming the field. The provider's 4xx status, body and content type are relayed, so its 429 surfaces unchanged, while a 5xx is replaced by a fixed 502 with the detail kept in the server log. This is the follow-up to `POST api/2.0/ai/websearch/v1/search`, which returns the results whose contents this operation retrieves.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-passthrough-contents/
+    # @param ai_web_search_passthrough_contents_request [Hash<String, Object>] A page-contents request in the shape the portal's active web-search provider expects, forwarded to it once `urls` passes a type check. The endpoint and the key come from the stored configuration.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
+    def ai_web_search_passthrough_contents_with_http_info(ai_web_search_passthrough_contents_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AI::WebSearchApi.ai_web_search_passthrough_contents ...'
+      end
+      # verify the required parameter 'ai_web_search_passthrough_contents_request' is set
+      if @api_client.config.client_side_validation && ai_web_search_passthrough_contents_request.nil?
+        fail ArgumentError, "Missing the required parameter 'ai_web_search_passthrough_contents_request' when calling AI::WebSearchApi.ai_web_search_passthrough_contents"
+      end
+      # resource path
+      local_var_path = '/api/2.0/ai/websearch/v1/contents'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(ai_web_search_passthrough_contents_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Hash<String, Object>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AI::WebSearchApi.ai_web_search_passthrough_contents",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AI::WebSearchApi#ai_web_search_passthrough_contents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Web search passthrough
+    # Runs a web search on behalf of the document editor's AI plugin, which holds only a placeholder configuration - the portal's active provider and its key are resolved here, so neither ever reaches the browser. The portal-wide configuration is used, and a portal without one answers 404. The `entityId` and `entityKind` query parameters name the document the search is billed to; with the ONLYOFFICE provider the entry is resolved under the caller's credentials and sent to the gateway as the request `metadata` (`source_id` / `source_type` / `source_title`), and an entry the caller cannot open sends none. `query` has to be a non-empty string and `numResults`, when sent, a positive integer; a body failing that answers 400 naming the field, before anything is sent on. The provider's own 4xx status, body and content type are relayed as they stand, so a provider that rate-limits answers 429; a 5xx from the provider or from the hop in front of it is not relayed, its detail stays in the server log and the call answers a fixed 502, which is also what an unreachable provider answers. Closing the connection aborts the upstream request.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-passthrough-search/
+    # @param ai_web_search_passthrough_search_request [Hash<String, Object>] A search request in the shape the portal's active web-search provider expects, forwarded to it once `query` and `numResults` pass a type check. The endpoint and the key come from the stored configuration and must not be sent here.
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Object>]
+    def ai_web_search_passthrough_search(ai_web_search_passthrough_search_request, opts = {})
+      data, _status_code, _headers = ai_web_search_passthrough_search_with_http_info(ai_web_search_passthrough_search_request, opts)
+      data
+    end
+
+    # Web search passthrough
+    # Runs a web search on behalf of the document editor's AI plugin, which holds only a placeholder configuration - the portal's active provider and its key are resolved here, so neither ever reaches the browser. The portal-wide configuration is used, and a portal without one answers 404. The `entityId` and `entityKind` query parameters name the document the search is billed to; with the ONLYOFFICE provider the entry is resolved under the caller's credentials and sent to the gateway as the request `metadata` (`source_id` / `source_type` / `source_title`), and an entry the caller cannot open sends none. `query` has to be a non-empty string and `numResults`, when sent, a positive integer; a body failing that answers 400 naming the field, before anything is sent on. The provider's own 4xx status, body and content type are relayed as they stand, so a provider that rate-limits answers 429; a 5xx from the provider or from the hop in front of it is not relayed, its detail stays in the server log and the call answers a fixed 502, which is also what an unreachable provider answers. Closing the connection aborts the upstream request.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-passthrough-search/
+    # @param ai_web_search_passthrough_search_request [Hash<String, Object>] A search request in the shape the portal's active web-search provider expects, forwarded to it once `query` and `numResults` pass a type check. The endpoint and the key come from the stored configuration and must not be sent here.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
+    def ai_web_search_passthrough_search_with_http_info(ai_web_search_passthrough_search_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AI::WebSearchApi.ai_web_search_passthrough_search ...'
+      end
+      # verify the required parameter 'ai_web_search_passthrough_search_request' is set
+      if @api_client.config.client_side_validation && ai_web_search_passthrough_search_request.nil?
+        fail ArgumentError, "Missing the required parameter 'ai_web_search_passthrough_search_request' when calling AI::WebSearchApi.ai_web_search_passthrough_search"
+      end
+      # resource path
+      local_var_path = '/api/2.0/ai/websearch/v1/search'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(ai_web_search_passthrough_search_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Hash<String, Object>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AI::WebSearchApi.ai_web_search_passthrough_search",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AI::WebSearchApi#ai_web_search_passthrough_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Set active config
+    # Stores a web-search configuration without contacting the provider first, for a form that has already validated its input or for restoring a known-good configuration. `entityId` scopes it to a room and has to name one the caller can open. A `baseUrl` pointing at a private network address is still refused, because that check is local. Nothing guarantees the stored provider works: follow up with `POST api/2.0/ai/web-search/test-connection`, or use `PUT api/2.0/ai/web-search/configure` to have the store gated on a live probe.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-set-active-config/
+    # @param ai_web_search_set_active_config_request [AiWebSearchSetActiveConfigRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AiSuccessResponse]
+    def ai_web_search_set_active_config(ai_web_search_set_active_config_request, opts = {})
+      data, _status_code, _headers = ai_web_search_set_active_config_with_http_info(ai_web_search_set_active_config_request, opts)
+      data
+    end
+
+    # Set active config
+    # Stores a web-search configuration without contacting the provider first, for a form that has already validated its input or for restoring a known-good configuration. `entityId` scopes it to a room and has to name one the caller can open. A `baseUrl` pointing at a private network address is still refused, because that check is local. Nothing guarantees the stored provider works: follow up with `POST api/2.0/ai/web-search/test-connection`, or use `PUT api/2.0/ai/web-search/configure` to have the store gated on a live probe.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-set-active-config/
+    # @param ai_web_search_set_active_config_request [AiWebSearchSetActiveConfigRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AiSuccessResponse, Integer, Hash)>] AiSuccessResponse data, response status code and response headers
+    def ai_web_search_set_active_config_with_http_info(ai_web_search_set_active_config_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AI::WebSearchApi.ai_web_search_set_active_config ...'
+      end
+      # verify the required parameter 'ai_web_search_set_active_config_request' is set
+      if @api_client.config.client_side_validation && ai_web_search_set_active_config_request.nil?
+        fail ArgumentError, "Missing the required parameter 'ai_web_search_set_active_config_request' when calling AI::WebSearchApi.ai_web_search_set_active_config"
+      end
+      # resource path
+      local_var_path = '/api/2.0/ai/web-search/set-active-config'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(ai_web_search_set_active_config_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AiSuccessResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AI::WebSearchApi.ai_web_search_set_active_config",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AI::WebSearchApi#ai_web_search_set_active_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Test a web-search provider
+    # Probes a web-search configuration against the live provider and reports the outcome, storing nothing - this is what a Test button calls so that a failure commits no state. The configuration is taken from the request rather than from storage, so credentials that were never saved can be checked. A `baseUrl` pointing at a private network address is refused before any request leaves the portal. The verdict is carried in the body rather than in the status, so a failed probe still answers 200 and the caller has to read the payload.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-test-connection/
+    # @param ai_web_search_config [AiWebSearchConfig] 
+    # @param [Hash] opts the optional parameters
+    # @return [AiProfilesTestConnection200Response]
+    def ai_web_search_test_connection(ai_web_search_config, opts = {})
+      data, _status_code, _headers = ai_web_search_test_connection_with_http_info(ai_web_search_config, opts)
+      data
+    end
+
+    # Test a web-search provider
+    # Probes a web-search configuration against the live provider and reports the outcome, storing nothing - this is what a Test button calls so that a failure commits no state. The configuration is taken from the request rather than from storage, so credentials that were never saved can be checked. A `baseUrl` pointing at a private network address is refused before any request leaves the portal. The verdict is carried in the body rather than in the status, so a failed probe still answers 200 and the caller has to read the payload.
+    # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/ai-web-search-test-connection/
+    # @param ai_web_search_config [AiWebSearchConfig] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AiProfilesTestConnection200Response, Integer, Hash)>] AiProfilesTestConnection200Response data, response status code and response headers
+    def ai_web_search_test_connection_with_http_info(ai_web_search_config, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AI::WebSearchApi.ai_web_search_test_connection ...'
+      end
+      # verify the required parameter 'ai_web_search_config' is set
+      if @api_client.config.client_side_validation && ai_web_search_config.nil?
+        fail ArgumentError, "Missing the required parameter 'ai_web_search_config' when calling AI::WebSearchApi.ai_web_search_test_connection"
+      end
+      # resource path
+      local_var_path = '/api/2.0/ai/web-search/test-connection'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(ai_web_search_config)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AiProfilesTestConnection200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['cookieAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AI::WebSearchApi.ai_web_search_test_connection",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AI::WebSearchApi#ai_web_search_test_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    end
+  end
+end