Skip to content

Latest commit

 

History

History
152 lines (100 loc) · 6.73 KB

SearchApi.md

File metadata and controls

152 lines (100 loc) · 6.73 KB
Raw

manticoresearch.SearchApi

All URIs are relative to http://127.0.0.1:9308

Method HTTP request Description
percolate POST /pq/{index}/search Perform reverse search on a percolate index
search POST /search Performs a search on an index

percolate

SearchResponse percolate(index, percolate_request)

Perform reverse search on a percolate index

Performs a percolate search. This method must be used only on percolate indexes. Expects two parameters: the index name and an object with array of documents to be tested. An example of the documents object: { \"query\": { \"percolate\": { \"document\": { \"content\":\"sample content\" } } } } Responds with an object with matched stored queries: { 'timed_out':false, 'hits': { 'total':2, 'max_score':1, 'hits': [ { '_index':'idx_pq_1', '_type':'doc', '_id':'2', '_score':'1', '_source': { 'query': { 'match':{'title':'some'} } } }, { '_index':'idx_pq_1', '_type':'doc', '_id':'5', '_score':'1', '_source': { 'query': { 'ql':'some | none' } } } ] } }

Example

import manticoresearch
from manticoresearch.models.percolate_request import PercolateRequest
from manticoresearch.models.search_response import SearchResponse
from manticoresearch.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://127.0.0.1:9308
# See configuration.py for a list of all supported configuration parameters.
configuration = manticoresearch.Configuration(
    host = "http://127.0.0.1:9308"
)


# Enter a context with an instance of the API client
with manticoresearch.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = manticoresearch.SearchApi(api_client)
    index = 'index_example' # str | Name of the percolate index
    percolate_request = {"query":{"percolate":{"document":{"title":"some text to match"}}}} # PercolateRequest | 

    try:
        # Perform reverse search on a percolate index
        api_response = api_instance.percolate(index, percolate_request)
        print("The response of SearchApi->percolate:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SearchApi->percolate: %s\n" % e)

Parameters

Name Type Description Notes
index str Name of the percolate index
percolate_request PercolateRequest

Return type

SearchResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 items found -
0 error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search

SearchResponse search(search_request)

Performs a search on an index

The method expects an object with the following mandatory properties: * the name of the index to search * the match query object For details, see the documentation on SearchRequest The method returns an object with the following properties: - took: the time taken to execute the search query. - timed_out: a boolean indicating whether the query timed out. - hits: an object with the following properties: - total: the total number of hits found. - hits: an array of hit objects, where each hit object represents a matched document. Each hit object has the following properties: - _id: the ID of the matched document. - _score: the score of the matched document. - _source: the source data of the matched document. In addition, if profiling is enabled, the response will include an additional array with profiling information attached. Here is an example search response: { 'took':10, 'timed_out':false, 'hits': { 'total':2, 'hits': [ {'_id':'1','_score':1,'_source':{'gid':11}}, {'_id':'2','_score':1,'_source':{'gid':12}} ] } } For more information about the match query syntax and additional parameters that can be added to request and response, please see the documentation here.

Example

import manticoresearch
from manticoresearch.models.search_request import SearchRequest
from manticoresearch.models.search_response import SearchResponse
from manticoresearch.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://127.0.0.1:9308
# See configuration.py for a list of all supported configuration parameters.
configuration = manticoresearch.Configuration(
    host = "http://127.0.0.1:9308"
)


# Enter a context with an instance of the API client
with manticoresearch.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = manticoresearch.SearchApi(api_client)
    search_request = ["'request=SearchRequest(index=\"test\",query=Query(query_string=\"abc\"))'"] # SearchRequest | 

    try:
        # Performs a search on an index
        api_response = api_instance.search(search_request)
        print("The response of SearchApi->search:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SearchApi->search: %s\n" % e)

Parameters

Name Type Description Notes
search_request SearchRequest

Return type

SearchResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
0 error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]