.png)
Get-SPEnterpriseSearchQuerySuggestionCandidates
Published: July 16, 2012
Applies to: SharePoint Server 2013 Enterprise | SharePoint Server 2013 Standard | SharePoint Foundation 2013
Returns a list of queries.
Get-SPEnterpriseSearchQuerySuggestionCandidates -Owner <SearchObjectOwner> -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-SourceId <Guid>]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Owner | Required | Microsoft.Office.Server.Search.Administration.SearchObjectOwner | Specifies the search object owner that defines the scope at which the corresponding LanguageResourcePhrase is created. The owner must be one of the following valid levels: - Search Service Application - Site Subscription - Site Collection - Site | ||
| SearchApplication | Required | Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind | Specifies the search application that contains the query topology. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
| ||
| SourceId | Optional | System.Guid | Identifies the search result source for which the LanguageResourcePhrase applies to. |
Note: Detailed Description
Use the Get-SPEnterpriseSearchQuerySuggestionCandidates cmdlet to return a list of popular queries that can be displayed in a related queries Web Part. The list gives the administrator a chance to review potential queries and add some of them to the related queries list.
Input Types
Return Types
---------------------EXAMPLE------------------------
$searchapp = Get-SPEnterpriseSearchServiceApplication
Get-SPEnterpriseSearchQuerySuggestionCandidates -SearchApplication $searchapp
This example returns popular search queries by using the search application contained in the variable $searchapp.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
