Management API Reference for web-search-content-retriever

Provided Capabilities (1)

Attributes (3)

• google - The custom Google web search engine configuration.

  Type	OBJECT
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The custom Google web search engine configuration.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["tavily"], "stability" : "default", "access-constraints" : {"sensitive" : {"credential" : {"type" : "core"}}}, "value-type" : { "api-key" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Google Search API key for accessing the Google Custom Search API.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "connect-timeout" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Timeout for the custom Google search.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 60000, "unit" : "MILLISECONDS", "stability" : "default" }, "custom-search-id" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Custom Search ID parameter for search the entire web", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "include-images" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If it is true then include public images relevant to the query. This can add more latency to the search.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "log-requests" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to log API requests.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "log-responses" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to log API responses.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "max-retries" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of retries for API requests.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "site-restrict" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If your Search Engine is restricted to only searching specific sites, you can set this parameter to true.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• max-results - The maximum number of results.

  Type	INT
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of results.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• tavily - The Tavily Search engine configuration.

  Type	OBJECT
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The Tavily Search engine configuration.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["google"], "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "socket-config" : {"type" : "core"} }}, "value-type" : { "api-key" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Your Tavily API key.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "base-url" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The base url to access Tavily API.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "connect-timeout" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Timeout for the Tavily API to respond.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "unit" : "MILLISECONDS", "stability" : "default" }, "exclude-domains" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of domains to specifically exclude from the search results.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "include-answer" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Include answers in the search results.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "include-domains" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of domains to specifically include in the search results.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "include-raw-content" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Include raw content in the search results.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "search-depth" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The depth of the search. It can be basic or advanced. Default is basic for quick results and advanced for indepth high quality results but longer response time. Advanced calls equals 2 requests.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "allowed" : [ "basic", "advanced" ], "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

• add - This operation adds the AI subsystem

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  google	OBJECT	false	true		The custom Google web search engine configuration.
  max-results	INT	false	true		The maximum number of results.
  tavily	OBJECT	false	true		The Tavily Search engine configuration.

  Raw DMR model

  { "operation-name" : "add", "description" : "This operation adds the AI subsystem", "request-properties" : { "google" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The custom Google web search engine configuration.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["tavily"], "stability" : "default", "value-type" : { "api-key" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Google Search API key for accessing the Google Custom Search API.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "connect-timeout" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Timeout for the custom Google search.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 60000, "unit" : "MILLISECONDS", "stability" : "default" }, "custom-search-id" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Custom Search ID parameter for search the entire web", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "include-images" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If it is true then include public images relevant to the query. This can add more latency to the search.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "log-requests" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to log API requests.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "log-responses" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to log API responses.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "max-retries" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of retries for API requests.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "site-restrict" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If your Search Engine is restricted to only searching specific sites, you can set this parameter to true.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" } } }, "max-results" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of results.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "tavily" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The Tavily Search engine configuration.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["google"], "stability" : "default", "value-type" : { "api-key" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Your Tavily API key.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "base-url" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The base url to access Tavily API.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "connect-timeout" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Timeout for the Tavily API to respond.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "unit" : "MILLISECONDS", "stability" : "default" }, "exclude-domains" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of domains to specifically exclude from the search results.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "include-answer" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Include answers in the search results.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "include-domains" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of domains to specifically include in the search results.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "include-raw-content" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Include raw content in the search results.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "search-depth" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The depth of the search. It can be basic or advanced. Default is basic for quick results and advanced for indepth high quality results but longer response time. Advanced calls equals 2 requests.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "allowed" : [ "basic", "advanced" ], "stability" : "default" } } } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - This operation removes the AI subsystem

  Raw DMR model

  { "operation-name" : "remove", "description" : "This operation removes the AI subsystem", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

• subsystem.ai.web-search-content-retriever

          
  <feature spec="subsystem.ai.web-search-content-retriever">
    <param name="web-search-content-retriever" value="{resource name}"/>
    <param name="google" value="{value}"/>
    <param name="max-results" value="{value}"/>
    <param name="tavily" value="{value}"/>
  <feature/>
          
        

  📋