# Microsoft.Search.Query.Office.Keywords Schema Documentation

This topic contains documentation for the Microsoft.Search.Query.Office.Keywords schema. For the text of the schema, see Microsoft.Search.Query.Office.Keywords Schema.

## Documentation for the urn:Microsoft.Search.Query.Office.Keywords schema

Defines a list of keywords representing a query. The root element in this schema is designed to be used inside the Microsoft.Search.Query.xsd schema.

## Basic Schema Attributes

Attribute | Value
--- | ---
targetNamespace | urn:Microsoft.Search.Query.Office.Keywords
elementFormDefault | qualified
attributeFormDefault | unqualified (default)

## Declared Namespaces

Namespace | Prefix
--- | ---
urn:Microsoft.Search.Types | t:
urn:Microsoft.Search.Query.Office.Keywords | (default)
http://www.w3.org/2001/XMLSchema | xsd:
http://www.w3.org/XML/1998/namespace | xml:

## Imported Schemas

namespace | id | schemaLocation
--- | --- | ---
urn:Microsoft.Search.Types | (none) | Microsoft.Search.Types.xsd

## Overview

<Keywords>

<QueryText/>

<Keyword>

<Word/>

<AltWord/>

<Stem/>

<Any/>

</Keyword>

<StartAltPhrase/>

<EndAltPhrase/>

<EndOfSentence/>

<Any/>

</Keywords>

## Top-Level Elements

Element: Keywords

List of keywords representing a query. It represents the word-breaking and stemming done to the original query string.

Property | Value
--- | ---
abstract | false (default)
name | Keywords
nillable | false (default)
type | complexType

Attributes

- Attribute: revision

  Unsigned integer indicating the revision of the schema used in the request.

  Property | Value
  --- | ---
  name | revision
  type | xsd:unsignedInt
  use | optional

- Attribute: build

  The build of the component used to generate the request.

  Property | Value
  --- | ---
  name | build
  type | t:String255
  use | optional

Subelements: Sequence

Elements must appear in the specified order.

- Element: QueryText

  The original query string, whose breakdown into keywords follows.

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 1
  maxOccurs | 1 (default)
  name | QueryText
  nillable | false (default)
  type | t:String255

Subelements: Choice

Only one element can be chosen.

The minimum number of occurrences (minOccurs) for the choice is 0.

The maximum number of occurrences (maxOccurs) for the choice is unbounded.

- Element: Keyword

  Individual word in the query, together with word variants.

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 1
  maxOccurs | 1 (default)
  name | Keyword
  nillable | false (default)
  type | KeywordType

- Element: StartAltPhrase

  Indicates the beginning of a phrase. All keywords between the StartAltPhrase and EndAltPhrase elements or between two StartAltPhrase elements are considered part of a phrase.

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 1
  maxOccurs | 1 (default)
  name | StartAltPhrase
  nillable | false (default)

- Element: EndAltPhrase

  Indicates the end of a phrase. All keywords between the StartAltPhrase and EndAltPhrase elements are considered part of a phrase.

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 1
  maxOccurs | 1 (default)
  name | EndAltPhrase
  nillable | false (default)

- Element: EndOfSentence

  Indicates the end of a sentence

  Property | Value
  --- | ---
  abstract | false (default)
  minOccurs | 1
  maxOccurs | 1 (default)
  name | EndOfSentence
  nillable | false (default)

- Any

  Any element in another namespace. Can be used for extensibility in the future.

  Property | Value
  --- | ---
  namespace | ##other
  processContents | skip
  minOccurs | 0
  maxOccurs | unbounded

## Top-Level Types and Groups

- Complex Type: KeywordType

  Describes an individual keyword.

  Attributes

  None

  Subelements: Sequence

  Elements must appear in the specified order.

  Subelements: Choice

  Only one element can be chosen.

  - Element: Word

    The actual word.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | 1 (default)
    name | Word
    nillable | false (default)
    type | t:String255

  - Element: AltWord

    An alternative word to the following keyword.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 1
    maxOccurs | 1 (default)
    name | AltWord
    nillable | false (default)
    type | t:String255

  - Element: Stem

    Variant of the word that can be used to make the query more flexible.

    Property | Value
    --- | ---
    abstract | false (default)
    minOccurs | 0
    maxOccurs | 25
    name | Stem
    nillable | false (default)
    type | t:String255

  - Any

    Any element in another namespace. Can be used for extensibility in the future.

    Property | Value
    --- | ---
    namespace | ##other
    processContents | skip
    minOccurs | 0
    maxOccurs | unbounded

©2003-2004 Microsoft Corporation. All rights reserved. Permission to copy, display and distribute this document is available at: http://msdn.microsoft.com/library/en-us/odcXMLRef/html/odcXMLRefLegalNotice.asp