View source on GitHub
|
A Python Search API used by app developers.
Contains methods used to interface with Search API. Contains API classes that forward to apiproxy.
Classes
class AtomFacet: A Facet that has content to be treated as a single token for indexing.
class AtomField: A Field that has content to be treated as a single token for indexing.
class ConcurrentTransactionError: Indicates a call on the search API failed due to concurrent updates.
class Cursor: Specifies how to get the next page of results in a search.
class DateField: A Field that has a date or datetime value.
class DeleteError: Indicates some error occurred deleting one of the objects requested.
class DeleteResult: The result of deleting a single document.
class Document: Represents a user generated document.
class Error: Indicates a call on the search API has failed.
class ExpressionError: An error occurred while parsing an expression input string.
class Facet: An abstract base class which represents a facet of a document.
class FacetOptions: Options for processing facet reults of a query.
class FacetRange: A facet range with start and end values.
class FacetRefinement: A Facet Refinement to filter out search results based on a facet value.
class FacetResult: Represents a facet result returned from a search with faceted search.
class FacetResultValue: A facet value as part of search result.
class Field: An abstract base class which represents a field of a document.
class FieldExpression: Represents an expression that will be computed for each result returned.
class GeoField: A Field that has a GeoPoint value.
class GeoPoint: Represents a point on the Earth's surface, in lat, long coordinates.
class HtmlField: A Field that has HTML content.
class Index: Represents an index allowing indexing, deleting and searching documents.
class InternalError: Indicates a call on the search API has failed on the internal backend.
class MatchScorer: Assigns a document score based on term frequency.
class NumberFacet: A Facet that has a numeric value.
class NumberField: A Field that has a numeric value.
class OperationResult: Represents result of individual operation of a batch index or removal.
class PutError: Indicates some error occurred indexing one of the objects requested.
class PutResult: The result of indexing a single object.
class Query: Represents a request on the search service to query the index.
class QueryError: An error occurred while parsing a query input string.
class QueryOptions: Options for post-processing results for a query.
class RescoringMatchScorer: Assigns a document score based on term frequency weighted by doc parts.
class ScoredDocument: Represents a scored document returned from a search.
class SearchResults: Represents the result of executing a search request.
class SortExpression: Sort by a user specified scoring expression.
class SortOptions: Represents a multi-dimensional sort of Documents.
class TextField: A Field that has text content.
class Timeout: Indicates a call on the search API could not finish before its deadline.
class TokenizedPrefixField: A field that matches searches on prefixes of its individual terms.
class TransientError: Indicates a call on the search API has failed, but retrying may succeed.
class UntokenizedPrefixField: A field that matches searches on prefixes of the whole field.
class VectorField: A vector field that can be used in a dot product expression.
Functions
get_indexes(...): Returns a list of available indexes.
get_indexes_async(...): Asynchronously returns a list of available indexes.
unichr(...): Return a Unicode string of one character with ordinal i; 0 <= i <= 0x10ffff.
Other Members | |
|---|---|
| DOCUMENT_ID_FIELD_NAME |
'_doc_id'
|
| LANGUAGE_FIELD_NAME |
'_lang'
|
| MAXIMUM_DEPTH_FOR_FACETED_SEARCH |
10000
|
| MAXIMUM_DOCUMENTS_PER_PUT_REQUEST |
200
|
| MAXIMUM_DOCUMENTS_RETURNED_PER_SEARCH |
1000
|
| MAXIMUM_DOCUMENT_ID_LENGTH |
500
|
| MAXIMUM_EXPRESSION_LENGTH |
5000
|
| MAXIMUM_FACETS_TO_RETURN |
100
|
| MAXIMUM_FACET_VALUES_TO_RETURN |
100
|
| MAXIMUM_FIELDS_RETURNED_PER_SEARCH |
1000
|
| MAXIMUM_FIELD_ATOM_LENGTH |
500
|
| MAXIMUM_FIELD_NAME_LENGTH |
500
|
| MAXIMUM_FIELD_PREFIX_LENGTH |
500
|
| MAXIMUM_FIELD_VALUE_LENGTH |
1048576
|
| MAXIMUM_GET_INDEXES_OFFSET |
1000
|
| MAXIMUM_INDEXES_RETURNED_PER_GET_REQUEST |
1000
|
| MAXIMUM_INDEX_NAME_LENGTH |
100
|
| MAXIMUM_NUMBER_FOUND_ACCURACY |
25000
|
| MAXIMUM_QUERY_LENGTH |
2000
|
| MAXIMUM_SEARCH_OFFSET |
1000
|
| MAXIMUM_SORTED_DOCUMENTS |
10000
|
| MAX_DATE |
Instance of google.appengine.ext.db.DateTimeProperty.data_type
|
| MAX_NUMBER_VALUE |
2147483647
|
| MIN_DATE |
Instance of google.appengine.ext.db.DateTimeProperty.data_type
|
| MIN_NUMBER_VALUE |
-2147483647
|
| RANK_FIELD_NAME |
'_rank'
|
| SCORE_FIELD_NAME |
'_score'
|
| TIMESTAMP_FIELD_NAME |
'_timestamp'
|
| VECTOR_FIELD_MAX_SIZE |
10000
|