Skip to content

Service: Search Public Metadata

Eliza Margaretha edited this page May 30, 2022 · 1 revision

Returns only public metadata of the query results (without actual text of the matches).

This service is integrated within the Search service and can be used by setting access-rewrite-disabled=true.

** WARNING: **

  • The rewrites format is experimental and may change without any notice.
  • The overall response format is temporary and will be changed once it has been specified in the KoralQuery documentation.

Example

Request

http://localhost:8089/api/v1.0/search?q=Monnemer&ql=poliqarp&fields=textSigle,title,availablility&access-rewrite-disabled=true

Response

{
    "@context": "http://korap.ids-mannheim.de/ns/KoralQuery/v0.3/context.jsonld",
    "meta": {
        "count": 25,
        "startIndex": 0,
        "timeout": 90000,
        "context": {
            "left": [
                "token",
                6
            ],
            "right": [
                "token",
                6
            ]
        },
        "fields": [
            "textSigle",
            "title",
            "availability"
        ],
        "version": "0.58.6",
        "benchmark": "2.468317367 s",
        "totalResults": 540,
        "serialQuery": "tokens:s:Monnemer",
        "itemsPerPage": 25
    },
    "query": {
        "@type": "koral:token",
        "wrap": {
            "@type": "koral:term",
            "match": "match:eq",
            "layer": "orth",
            "key": "Monnemer",
            "foundry": "opennlp",
            "rewrites": [{
                "@type": "koral:rewrite",
                "src": "Kustvakt",
                "operation": "operation:injection",
                "scope": "foundry"
            }]
        }
    },
    "collection": {
        "operands": [
            {
                "@type": "koral:doc",
                "match": "match:eq",
                "type": "type:regex",
                "value": "CC-BY.*",
                "key": "availability"
            },
            {
                "operands": [
                    {
                        "@type": "koral:doc",
                        "match": "match:eq",
                        "type": "type:regex",
                        "value": "ACA.*",
                        "key": "availability"
                    },
                    {
                        "operands": [
                            {
                                "@type": "koral:doc",
                                "match": "match:eq",
                                "type": "type:regex",
                                "value": "QAO-NC",
                                "key": "availability"
                            },
                            {
                                "@type": "koral:doc",
                                "match": "match:eq",
                                "type": "type:regex",
                                "value": "QAO.*",
                                "key": "availability"
                            }
                        ],
                        "@type": "koral:docGroup",
                        "operation": "operation:or"
                    }
                ],
                "@type": "koral:docGroup",
                "operation": "operation:or"
            }
        ],
        "@type": "koral:docGroup",
        "operation": "operation:or",
        "rewrites": [{
            "@type": "koral:rewrite",
            "src": "Kustvakt",
            "operation": "operation:insertion",
            "scope": "availability(ALL)"
        }]
    },
    "matches": [
         {
            "matchID": "match-WUD17/H48/23706-p68254-68255",
            "UID": 0,
            "textSigle": "WUD17/H48/23706",
            "availability": "CC-BY-SA",
            "title": "Benutzer Diskussion:Hans50/Archiv"
        },
        {
            "matchID": "match-DPA16/JUN/16996-p50-51",
            "UID": 0,
            "textSigle": "DPA16/JUN/16996",
            "availability": "QAO-NC-LOC:ids",
            "title": "6357"
        },
        ...
    ]
}

Advanced Setting

Developer Setting

Search services

Metadata services

Authentication and Authorization services

Client services

Super client services

Plugin services

User services

User group services

Virtual corpus services

Virtual corpus access services

Administrative services

Description services

Clone this wiki locally