3.1.4.1.3.1 ResultTableCollection
Namespace: http://www.microsoft.com/sharepoint/search/KnownTypes/2008/08
Contains the search results and associated properties for a search query.
-
<xs:complexType name="ResultTableCollection" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:sequence> <xs:element minOccurs="0" name="DatabaseTime" type="xs:int"/> <xs:element minOccurs="0" name="Definition" nillable="true" type="q2:ArrayOfResultDefinition"/> <xs:element minOccurs="0" name="ElapsedTime" type="xs:int"/> <xs:element xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="IgnoredNoiseWords" nillable="true" type="q3:ArrayOfstring"/> <xs:element xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="InternalQueryErrors" nillable="true" type="q3:ArrayOfKeyValueOfstringSearchServiceApplicationFaulty6h3NzC8"/> <xs:element minOccurs="0" name="KeywordInformation" nillable="true" type="q2:KeywordInformation"/> <xs:element minOccurs="0" name="QueryMachine" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="QueryModification" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="QueryProcessingTime" type="xs:int"/> <xs:element xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="QueryTerms" nillable="true" type="q3:ArrayOfstring"/> <xs:element minOccurs="0" name="SpellingSuggestion" nillable="true" type="xs:string"/> <xs:element xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="m_ResultTables" nillable="true" type="q3:ArrayOfKeyValueOfResultTypeResultTableUTLV0zE5"/> <xs:element minOccurs="0" name="IMSProxyTime" type="xs:int"/> <xs:element xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="Properties" nillable="true" type="q3:ArrayOfKeyValueOfstringanyType"/> <xs:element minOccurs="0" name="PropertiesContractVersion" nillable="true" type="xs:string"/> <xs:element xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="QueryParameterTimestamps" nillable="true" type="q3:ArrayOfKeyValueOfstringstring"/> <xs:element minOccurs="0" name="RemainingDeserializationSkips" type="xs:int"/> <xs:element minOccurs="0" name="SerializedResultTables" nillable="true" type="xs:string"/> <xs:element xmlns:tns7="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="mResultTables" nillable="true" type="tns7:ArrayOfKeyValuePairOfstringResultTable_PFsic3Az"/> </xs:sequence> </xs:complexType>
DatabaseTime: The time it took to execute the database operations for retrieving results for a search query, in milliseconds. This element MUST contain a non-negative number. If QueryProperties.ResultsProvider (as specified in section 2.2.4.11) is equal to SearchProvider.FASTSearch, this MUST be the time that was used to process the request by the query processing service.
Definition: An array of zero or more extracted definitions for a search query. The protocol server SHOULD compute a list of crawled items that contain definitions for the search query. The criteria used to determine what constitutes an extracted definition are specific to the implementation of the protocol server. This element MUST only be present if the ResultTypes element in the properties element of the Execute operation (as specified in section 3.1.4.1) contains ResultType.DefinitionResults (as specified in section 2.2.5.5). If QueryProperties.ResultsProvider (as specified in section 2.2.4.11) is equal to SearchProvider.FASTSearch, the protocol server MUST NOT return any extracted definitions.
ElapsedTime: The time it took to execute the search query, in milliseconds. This element MUST contain a non-negative number.
IgnoredNoiseWords: An array of zero or more noise words that were found in the search query. If the properties element specified in Execute message is of the complex type FullTextSqlQueryProperties (as specified in section 2.2.4.7), then this SHOULD include all noise words that are used in the CONTAINS predicate of the search query (as specified in [MS-SEARCH] section 2.2.13.3.1.1) and FREETEXT predicate of the search query (as specified in [MS-SEARCH] section 2.2.13.3.1.2). If the properties element specified in Execute message is of the complex type KeywordQueryProperties (as specified in section 3.1.4.7.3.1), then this SHOULD include all noise words used in the text of the search query. If QueryProperties.ResultsProvider (as specified in section 2.2.4.11) is equal to SearchProvider.FASTSearch, the protocol server MUST return an empty array.
InternalQueryErrors: This element contains the list of query errors if there were errors during execution of the search query. If there were no errors, this element MUST be empty. This element is of type ArrayOfKeyValueOfstringSearchServiceApplicationFaulty6h3NzC8 as specified in section 3.1.4.1.3.9.
KeywordInformation: The protocol server SHOULD store a list of user authored definitions for tokens. If such a token is found in the query text, this element SHOULD contain the token and associated definition. If no definition could be found for any of the tokens in the query text, this extended property MUST be empty.
QueryMachine: The name of the computer that is running the search service that executes the search query. The value of this element is specific to the implementation of the protocol server.
QueryModification: The modified search query. The protocol server MAY transform query terms if EnableSpellcheck is set to SpellcheckMode.On on the request, and there is a good chance that the modified query terms will increase the quality of the search results<59>. The criteria used to modify the query are specific to the implementation of the protocol server. If QueryProperties.ResultsProvider (as specified in section 2.2.4.11) is equal to SearchProvider.SharepointSearch, the protocol server MUST NOT return a modified search query.
QueryProcessingTime: The time it took for intermediate processing of the search query on the protocol server, in milliseconds. This value is specific to the implementation of the protocol server.
QueryTerms: An array of zero or more tokens extracted from the search query in the order that they occur. If the properties element specified in Execute message is of the complex type FullTextSqlQueryProperties, this SHOULD include all tokens that are used in the CONTAINS predicate of the search query, as specified in [MS-SEARCH] section 2.2.13.3.1.1, and FREETEXT predicate of the search query, as specified in [MS-SEARCH] section 2.2.13.3.1.2. If the properties element specified in the Execute message is of the complex type KeywordQueryProperties, this SHOULD include all tokens used in the text of the search query. If QueryProperties.ResultsProvider, as specified in section 2.2.4.11, is equal to SearchProvider.FASTSearch, the protocol server MUST return the complete search query in the first element of the array.
SpellingSuggestion: The spelling suggestion for the search query. The protocol server can suggest a different spelling of the search query if there is a good chance that the spelling suggestion will increase the quality of the search results.<60> The criteria used to determine the spelling suggestion and when to show it are specific to the implementation of the protocol server.
m_ResultTables: This element contains the query results for the search query. Depending on the formulation of the search query, there can be multiple sets of query results contained within this element. Each set MUST contain query results of a specific type. MUST NOT include any result sets which are a result of executing query rule actions to add result blocks. MUST be set to NULL if PropertiesContractVersion is not set to 14.0.0.0.
IMSProxyTime: The time it took for intermediate processing of the search query on the protocol server, in milliseconds. This value is specific to the implementation of the protocol server.
Properties: Specifies a property bag of key value pairs. MUST be of ArrayOfKeyValueOfstringanyType data type as specified in section 2.2.4.18 SHOULD contain the following properties:
QueryErrors: This property contains the list of query errors if there were errors during execution of the search query. If there were no errors, this property MUST be empty. This element is an array of Key and Value pairs. Each pair of Key and Value elements consists of a QueryId and the Exception encountered by the search query identified by the QueryId. If the error was encountered while producing a result set for a query rule, QueryId MUST be the unique identifier of the query rule, otherwise it MUST be the same value as the Id element of QueryProperties specified in section 2.2.4.11.
QueryId: Specifies an identifier for the query. MUST be the same value as specified by the protocol client in properties.Properties.Id.
TriggeredRules: This element contains the list of unique identifiers of the query rules that were executed for the search query.
PropertiesContractVersion: Specifies the version of ResultTableCollection complex type being used by the protocol client. MUST be set to the same value as specified in QueryProperties.PropertiesContractVersion in section 2.2.4.11.
QueryParameterTimestamps: MUST be ignored.
RemainingDeserializationSkips: Specifies the recommended serialization steps to skip. If the value specified in PropertiesContractVersion is 14.0.0.0 then the value MUST be set to -1. For all other values in PropertiesContractVersion the value MUST be set to 0.
SerializedResultTables: Specifies a serialized representation of mResultTables serialized using DataContractSerializer. MUST be set to NULL if PropertiesContractVersion is 14.0.0.0.
mResultTables: This element contains the query results for the search query. Depending on the formulation of the search query, there can be multiple sets of query results contained within this element. Each set MUST contain query results of a specific type. MUST be set to NULL, if PropertiesContractVersion is not 14.0.0.0 and the value of SerializedResultTables has been computed.