Amazon CloudSearch Domain

2015/05/07 - Amazon CloudSearch Domain - 3 new api methods

Suggest (new) Link ¶

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.

For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

Request Syntax

client.suggest(
    query='string',
    suggester='string',
    size=123
)
type query:

string

param query:

[REQUIRED]

Specifies the string for which you want to get suggestions.

type suggester:

string

param suggester:

[REQUIRED]

Specifies the name of the suggester to use to find suggested matches.

type size:

integer

param size:

Specifies the maximum number of suggestions to return.

rtype:

dict

returns:

Response Syntax

{
    'status': {
        'timems': 123,
        'rid': 'string'
    },
    'suggest': {
        'query': 'string',
        'found': 123,
        'suggestions': [
            {
                'suggestion': 'string',
                'score': 123,
                'id': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    Contains the response to a Suggest request.

    • status (dict) --

      The status of a SuggestRequest. Contains the resource ID ( rid) and how long it took to process the request ( timems).

      • timems (integer) --

        How long it took to process the request, in milliseconds.

      • rid (string) --

        The encrypted resource ID for the request.

    • suggest (dict) --

      Container for the matching search suggestion information.

      • query (string) --

        The query string specified in the suggest request.

      • found (integer) --

        The number of documents that were found to match the query string.

      • suggestions (list) --

        The documents that match the query string.

        • (dict) --

          An autocomplete suggestion that matches the query string specified in a SuggestRequest.

          • suggestion (string) --

            The string that matches the query string specified in the SuggestRequest.

          • score (integer) --

            The relevance score of a suggested match.

          • id (string) --

            The document ID of the suggested document.

UploadDocuments (new) Link ¶

Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service.

The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide. For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide.

Request Syntax

client.upload_documents(
    documents=b'bytes'|file,
    contentType='application/json'|'application/xml'
)
type documents:

bytes or seekable file-like object

param documents:

[REQUIRED]

A batch of documents formatted in JSON or HTML.

type contentType:

string

param contentType:

[REQUIRED]

The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:

  • application/json

  • application/xml

rtype:

dict

returns:

Response Syntax

{
    'status': 'string',
    'adds': 123,
    'deletes': 123,
    'warnings': [
        {
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    Contains the response to an UploadDocuments request.

    • status (string) --

      The status of an UploadDocumentsRequest.

    • adds (integer) --

      The number of documents that were added to the search domain.

    • deletes (integer) --

      The number of documents that were deleted from the search domain.

    • warnings (list) --

      Any warnings returned by the document service about the documents being uploaded.

      • (dict) --

        A warning returned by the document service when an issue is discovered while processing an upload request.

        • message (string) --

          The description for a warning returned by the document service.