Skip to content

Commit 117de37

Browse files
Jak-MSJak-MS
authored
Merge pull request #96017 from DarrinEide/patch-3
[Cog Svcs] Adding more verbose documentation for paper entity
2 parents e92c4fe + 0b36d97 commit 117de37

File tree

1 file changed

+61
-27
lines changed

1 file changed

+61
-27
lines changed

‎articles/cognitive-services/Academic-Knowledge/PaperEntityAttributes.md

Lines changed: 61 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,15 @@ manager: nitinme
99
ms.service: cognitive-services
1010
ms.subservice: academic-knowledge
1111
ms.topic: conceptual
12-
ms.date: 10/22/2019
12+
ms.date: 11/14/2019
1313
ms.author: darrine
1414
ROBOTS: NOINDEX
1515
---
1616

1717
# Paper Entity
1818

19-
<sub>
20-
*Below attributes are specific to paper entity. (Ty = '0')
21-
</sub>
19+
> [!NOTE]
20+
> Below attributes are specific to paper entity. (Ty = '0')
2221
2322
Name | Description | Type | Operations
2423
--- | --- | --- | ---
@@ -29,43 +28,78 @@ AA.AuN | Normalized author name | String | Equals, StartsWith
2928
AA.DAuN | Original author name | String | None
3029
AA.DAfN | Original affiliation name | String | None
3130
AA.S | Numeric position in author list | Int32 | Equals
32-
CC | Citation count | Int32 | None
31+
BT | BibTex document type ('a':Journal article, 'b':Book, 'c':Book chapter, 'p':Conference paper) | String | None
32+
BV | BibTex venue name | String | None
3333
C.CId | Conference series ID | Int64 | Equals
3434
C.CN | Conference series name | String | Equals, StartsWith
35+
CC | Citation count | Int32 | None
36+
CitCon | Citation contexts</br></br>List of referenced paper ID’s and the corresponding context in the paper (e.g. [{123:["brown foxes are known for jumping as referenced in paper 123", "the lazy dogs are a historical misnomer as shown in paper 123"]}) | Custom | None
3537
D | Date published in YYYY-MM-DD format | Date | Equals, IsBetween
36-
E | Extended metadata (see table below) | String | N/A
38+
DN | Original paper title | String | None
39+
DOI | Digital Object Identifier | String | Equals, StartsWith
40+
E | Extended metadata</br></br>**IMPORTANT**: This attribute has been deprecated and is only supported for legacy applications. Requesting this attribute individually (i.e. attributes=Id,Ti,E) will result in all extended metadata attributes being returned in a *serialized JSON string*</br></br>All attributes contained in the extended metadata are now available as a top-level attribute and can be requested as such (i.e. attributes=Id,Ti,DOI,IA) | [Extended](#extended) | None
3741
ECC | Estimated citation count | Int32 | None
3842
F.DFN | Original field of study name | String | None
3943
F.FId | Field of study ID | Int64 | Equals
4044
F.FN | Normalized field of study name | String | Equals, StartsWith
45+
FP | First page of paper in publication | String | Equals
46+
I | Publication issue | String | Equals
47+
IA | Inverted abstract | [InvertedAbstract](#invertedabstract) | None
4148
Id | Paper ID | Int64 | Equals
4249
J.JId | Journal ID | Int64 | Equals
4350
J.JN | Journal name | String | Equals, StartsWith
51+
LP | Last page of paper in publication | String | Equals
52+
PB | Publisher | String | None
4453
Pt | Publication type (0:Unknown, 1:Journal article, 2:Patent, 3:Conference paper, 4:Book chapter, 5:Book, 6:Book reference entry, 7:Dataset, 8:Repository | String | Equals
4554
RId | List of referenced paper IDs | Int64[] | Equals
55+
S | List of source URLs of the paper, sorted by relevance | [Source](#source)[] | None
4656
Ti | Normalized title | String | Equals, StartsWith
57+
V | Publication volume | String | Equals
58+
VFN | Full name of the Journal or Conference venue | String | None
59+
VSN | Short name of the Journal or Conference venue | String | None
4760
W | Unique words in title | String[] | Equals
4861
Y | Year published | Int32 | Equals, IsBetween
4962

50-
## Extended Metadata Attributes ##
63+
## Extended
64+
> [!IMPORTANT]
65+
> This attribute has been deprecated and is only supported for legacy applications. Requesting this attribute individually (i.e. attributes=Id,Ti,E) will result in all extended metadata attributes being returned in a *serialized JSON string*</br></br>All attributes contained in the extended metadata are now available as a top-level attribute and can be requested as such (i.e. attributes=Id,Ti,DOI,IA)
66+
67+
> [!IMPORTANT]
68+
> Support for requesting individual extended attributes by using the "E." scope, i.e. "E.DN" is being deprecated. While this is still technically supported, requesting individual extended attributes using the "E." scope will result in the attribute value being returned in two places in the JSON response, as part of the "E" object and as a top level attribute.
69+
70+
Name | Description | Type | Operations
71+
--- | --- | --- | ---
72+
BT | BibTex document type ('a':Journal article, 'b':Book, 'c':Book chapter, 'p':Conference paper) | String | None
73+
BV | BibTex venue name | String | None
74+
CC | Citation contexts</br></br>List of referenced paper ID’s and the corresponding context in the paper (e.g. [{123:["brown foxes are known for jumping as referenced in paper 123", "the lazy dogs are a historical misnomer as shown in paper 123"]}) | Custom | None
75+
DN | Original paper title | String | None
76+
DOI | Digital Object Identifier | String | None
77+
FP | First page of paper in publication | String | None
78+
I | Publication issue | String | None
79+
IA | Inverted Abstract | [InvertedAbstract](#invertedabstract) | None
80+
LP | Last page of paper in publication | String | None
81+
PB | Publisher | String | None
82+
S | List of source URLs of the paper, sorted by relevance | [Source](#source)[] | None
83+
V | Publication volume | String | None
84+
VFN | Full name of the Journal or Conference venue | String | None
85+
VSN | Short name of the Journal or Conference venue | String | None
86+
87+
## InvertedAbstract
88+
89+
> [!IMPORTANT]
90+
> InvertedAbstract attributes cannot be directly requested as a return attribute. If you need an individual attribute you must request the top level "IA" attribute, i.e. to get IA.IndexLength request attributes=IA
5191
52-
Name | Description
53-
--- | ---
54-
BT | BibTex document type ('a':Journal article, 'b':Book, 'c':Book chapter, 'p':Conference paper)
55-
BV | BibTex venue name
56-
CC | Citation Contexts – List of referenced paper ID’s and the corresponding context in the paper (e.g. [{123:["brown foxes are known for jumping as referenced in paper 123", "the lazy dogs are a historical misnomer as shown in paper 123"]})
57-
DN | Original paper title
58-
DOI | Digital Object Identifier
59-
FP | First page of paper in publication
60-
I | Publication issue
61-
IA | Inverted Abstract
62-
IA.IndexLength | Number of items in the index (abstract's word count)
63-
IA.InvertedIndex | List of abstract words and their corresponding position in the original abstract (e.g. [{"the":[0, 15, 30]}, {"brown":[1]}, {"fox":[2]}])
64-
LP | Last page of paper in publication
65-
PB | Publisher
66-
S | Sources - list of web sources of the paper, sorted by static rank
67-
S.Ty | Source Type (1:HTML, 2:Text, 3:PDF, 4:DOC, 5:PPT, 6:XLS, 7:PS)
68-
S.U | Source URL
69-
V | Publication volume
70-
VFN | Full name of the Journal or Conference venue
71-
VSN | Short name of the Journal or Conference venue
92+
Name | Description | Type | Operations
93+
--- | --- | --- | ---
94+
IndexLength | Number of items in the index (abstract's word count) | Int32 | None
95+
InvertedIndex | List of abstract words and their corresponding position in the original abstract (e.g. [{"the":[0, 15, 30]}, {"brown":[1]}, {"fox":[2]}]) | Custom | None
96+
97+
## Source
98+
99+
> [!IMPORTANT]
100+
> Source attributes cannot be directly requested as a return attribute. If you need an individual attribute you must request the top level "S" attribute, i.e. to get S.U request attributes=S
101+
102+
Name | Description | Type | Operations
103+
--- | --- | --- | ---
104+
Ty | Source URL type (1:HTML, 2:Text, 3:PDF, 4:DOC, 5:PPT, 6:XLS, 7:PS) | String | None
105+
U | Source URL | String | None

0 commit comments

Comments
 (0)