depa.index

This REST service allows users to search for patent documents in Patent Store. The service is based on Elasticsearch.

General

To search in the bib­li­o­graph­ic data of doc­u­ments in the Patent Store, we have pro­vid­ed an elas­tic­search index called deparom. This index has been designed to behave in much the same way as the indices used by the DEPAROM client.
The REST inter­face pro­vides direct access to the func­tion­al­i­ty of elas­tic­search. This means that queries must be exe­cut­ed using the query form and syn­tax that elas­tic search supports.
To con­vert queries from the lega­cy DEPAROM syn­tax to elas­tic search, use the DEPAROM Query Trans­la­tor Ser­vice (DQT).

Information Required

To use this ser­vice no fur­ther infor­ma­tion is required, just the query you intend to execute.

Using Queries

Elas­tic­search search-api sup­ports URI search as well as request body search, which one you use depends on your needs.

REST API

The api exposed con­nects direct­ly to elas­tic­search. The api is described in their doc­u­men­ta­tion. Here just a few notes.

General Error Responses

The most impor­tant error codes are list­ed here. See the elas­tic­search web­page for more details. Oth­er respons­es are list­ed in the table below.
Elas­tic­search returns a detailed error mes­sage in the response body in JSON format.

Service Endpoints

Search & Queries

URI Search

In this form of search, the query is append­ed to the URL as a query string. This is the most sim­ple form of search­ing but also the most limited.

Query
The query is defined as follows:
?q=fieldname:value
Example:
https://api.depa.tech/es/deparom/_search?q=PC:DE
See the elas­tic­search doc­u­men­ta­tion for infor­ma­tion on using more advanced options such as AND / OR operations.

Result
Below is an exam­ple response when search­ing the elas­tic search index. The impor­tant parts are found under hits.
The field total tells us the total num­ber of doc­u­ments found. The field max_score gives an indi­ca­tion of how rel­e­vant the results are.
The sec­ond hits field lists each doc­u­ment found. Each result con­tains a field called source con­tain­ing the data fields of each doc­u­ment found. The field id can be used to retrieve fur­ther doc­u­ment arti­facts (such as the PDF) from the Con­tent Deliv­ery Ser­vice (CDS).

Request Body Search

When search­ing using this method, many more options are available.
The query is a com­plex JSON object, below is a sim­ple exam­ple: a search for the appli­cant ‘Robert Bosch’.
The out­er field query defines where the actu­al query goes. In this case the search is on the field PA, the query is “Robert Bosch”. Note the use of quotes, which must be escaped using ‘\’ in JSON. More search exam­ples can be found on the elas­tic­search website.

Combining Search with Other Services

As stat­ed above, it’s pos­si­ble to com­bine the search ser­vice with oth­er Depa.Tech ser­vices, such as DQT and CDS.

Using Queries from DQT

The DEPAROM Query Trans­la­tor (DQT) can used to gen­er­ate elas­tic­ssearch queries from DEPAROM queries.
The query that is returned from DQT must be wrapped so that it can be used with elas­tic search.
Our exam­ple query in DEPAROM syn­tax would be: PA=“Robert Koch”. Send­ing this to DQT cre­ates the fol­low­ing JSON snippet:

This is only a par­tial JSON query, before send­ing it to elas­tic­search it must be wrapped with { "query: ... } for it to work:

Retrieving Artifacts from CDS

The Con­tent Deliv­ery Ser­vice (CDS) pro­vides access to doc­u­ment arti­facts, such as the PDF file or XML data. To access CDS, a doc­u­ment ID is need­ed. This ID is returned from elas­tic­search. If all that is required is the PDF, for exam­ple, the query can be set to actu­al­ly return just the ID. This speeds queries up, espe­cial­ly if large result sets are expect­ed. To do this, set stored_fields to [], which means return no fields:

The result: