View source on GitHub
|
Search API module.
Modules
expression_parser module: Wrapper for ExpressionParser.
query_parser module: Wrapper for QueryParser.
search module: A Python Search API used by app developers.
search_util module: Provides utility methods used by modules in the FTS API stub.
unicode_util module: Utility methods related to Unicode.
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 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 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.