In this first of a series of blogs about SOLR Solr result sets I'd like to talk about returned fields, both static and dynamic.
Stored Fields
Any field that is stored in SOLR Solr can be returned in the result set. The following table shows all available stored fields:
namedesctypeindexed| timestamp | last modification stamp | tdate| ab_* | all abstracts | mixed: alexandria_text, alexandria_asian_text | true |
ucid | unique character identifier | stringloadid | meta load identifier | tint| an | application number (tokenized) | alexandria_token | true |
nclms | number of claims | tint| anorig | original, patent office format application number | alexandria_token | true |
nindepclms | number of independent claims | tint| anseries | US application series code | alexandria_string | true |
famfamily | standardized filing identifier | string | true |
pn | patent number (tokenized)| ecla | ECLA classification | alexandria_ |
tokenpdpublication datetintan | application number (tokenized)anorig | original, patent office format application number| fterm | F-Terms | alexandria_string | true |
| icl,cpcl,uscl,ficl | classifications suitable for display | string | false |
| ifi_name_current_id | current assignee identifier | string | true |
| ifi_name_original_id | original assignee identifier | string | true |
| ifi_pa | IFI assignees | alexandria_token | true |
| anseries | US application series code | alexandria_string | true |
| inv | inventors | alexandria_token | true |
| loadid | meta load identifier | tint | true |
| nclms | number of claims | tint | true |
| nindepclms | number of independent claims | tint | true |
| pa | applicants/assignees (all formats) | alexandria_token | true |
adfiling pripriority filing | patent number (tokenized) | alexandria_ |
stringpriorigoriginal, patent office format | priority filing number (tokenized) | alexandria_string | true |
| prid | earliest priority filing date |
tint | true | | icl,cpcl,uscl,ficl | classifications suitable for display | string | false |
inv | inventors | alexandria_tokenpa | applicants/assignees (all formats)| priorig | original, patent office format priority number | alexandria_ |
tokenifi_pa | IFI assignees | alexandria_token| timestamp | last modification stamp | tdate | true |
| ttl_* | all titles | mixed: alexandria_text, alexandria_asian_text | true |
ab_* | all abstracts | mixed: alexandria_text, alexandria_asian_text| ucid | unique character identifier | string | true |
The shorthand to return all static fields is the asterisk fl=*
...
Some things to notice: Multi-valued fields are returned as JSON arrays. Also, as inv, pa and ifi_pa are copyFields containing multiple values, duplicate entries may appear.
Dynamic Fields
Dynamic fields are fields that are generated either internally, like the relevance score or fields that can be generated by computing values using function queries. Dynamic fields must be listed explicitly in the fl parameter, e.g., fl=score. Below, we request the static ucid field together with the relevance score for 5 results.
...
| Code Block |
|---|
|
"docs" : [
{
"ucid" : "US-20160054444-A1",
"nclms" : 19,
"nindepclms" : 2,
"sub(nclms,nindepclms)" : 17
},
{
"ucid" : "US-9268020-B2",
"nclms" : 74,
"nindepclms" : 3,
"sub(nclms,nindepclms)" : 71
}
],
|
Field Aliases
Field aliasing allows individual fields in the result set to be renamed. This functionality is particularly useful to give meaningful names to pseudo fields created by function queries as in the example above. Any field can be renamed using aliases. The syntax is: alias-field-name:original-field-name
...