Skip to content

Commit 6f415e3

Browse files
nitinmenitinme
committed
Revert "Retiring Academic Knowledge content"
This reverts commit 54d2331.
1 parent 54d2331 commit 6f415e3

16 files changed

+983
-56
lines changed

‎.openpublishing.redirection.json

Lines changed: 0 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -34780,62 +34780,6 @@
3478034780
"redirect_url": "/azure/cognitive-services/academic-knowledge/home",
3478134781
"redirect_document_id": false
3478234782
},
34783-
{
34784-
"source_path": "articles/cognitive-services/academic-knowledge/home.md",
34785-
"redirect_document_id": false
34786-
},
34787-
{
34788-
"source_path": "articles/cognitive-services/academic-knowledge/QueryExpressionSyntax.md",
34789-
"redirect_document_id": false
34790-
},
34791-
{
34792-
"source_path": "articles/cognitive-services/academic-knowledge/EntityAttributes.md",
34793-
"redirect_document_id": false
34794-
},
34795-
{
34796-
"source_path": "articles/cognitive-services/academic-knowledge/AffiliationEntityAttributes.md",
34797-
"redirect_document_id": false
34798-
},
34799-
{
34800-
"source_path": "articles/cognitive-services/academic-knowledge/AuthorEntityAttributes.md",
34801-
"redirect_document_id": false
34802-
},
34803-
{
34804-
"source_path": "articles/cognitive-services/academic-knowledge/ConferenceInstanceEntityAttributes.md",
34805-
"redirect_document_id": false
34806-
},
34807-
{
34808-
"source_path": "articles/cognitive-services/academic-knowledge/ConferenceSeriesEntityAttributes.md",
34809-
"redirect_document_id": false
34810-
},
34811-
{
34812-
"source_path": "articles/cognitive-services/academic-knowledge/FieldsOfStudyEntityAttributes.md",
34813-
"redirect_document_id": false
34814-
},
34815-
{
34816-
"source_path": "articles/cognitive-services/academic-knowledge/JournalEntityAttributes.md",
34817-
"redirect_document_id": false
34818-
},
34819-
{
34820-
"source_path": "articles/cognitive-services/academic-knowledge/PaperEntityAttributes.md",
34821-
"redirect_document_id": false
34822-
},
34823-
{
34824-
"source_path": "articles/cognitive-services/academic-knowledge/CalcHistogramMethod.md",
34825-
"redirect_document_id": false
34826-
},
34827-
{
34828-
"source_path": "articles/cognitive-services/academic-knowledge/EvaluateMethod.md",
34829-
"redirect_document_id": false
34830-
},
34831-
{
34832-
"source_path": "articles/cognitive-services/academic-knowledge/InterpretMethod.md",
34833-
"redirect_document_id": false
34834-
},
34835-
{
34836-
"source_path": "articles/cognitive-services/academic-knowledge/SimilarityMethod.md",
34837-
"redirect_document_id": false
34838-
},
3483934783
{
3484034784
"source_path": "articles/cognitive-services/entitylinking/index.md",
3484134785
"redirect_url": "/azure/cognitive-services/text-analytics",

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Affiliation entity attributes in the Academic Knowledge API
3+
titlesuffix: Azure Cognitive Services
4+
description: Learn the attributes you can use with the Affiliation entity in the Academic Knowledge API.
5+
services: cognitive-services
6+
author: darrine
7+
manager: kuansanw
8+
9+
ms.service: cognitive-services
10+
ms.subservice: academic-knowledge
11+
ms.topic: conceptual
12+
ms.date: 11/14/2019
13+
ms.author: darrine
14+
ROBOTS: NOINDEX
15+
---
16+
17+
# Affiliation Entity
18+
19+
> [!NOTE]
20+
> Following attributes are specific to affiliation entity. (Ty = '5')
21+
22+
Name | Description | Type | Operations
23+
--- | --- | --- | ---
24+
AfN | Affiliation normalized name |String |Equals
25+
CC | Affiliation total citation count |Int32 |none
26+
DAfN | Affiliation display name |String |none
27+
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
28+
ECC | Affiliation total estimated citation count |Int32 |none
29+
Id | Entity ID |Int64 |Equals
30+
PC | Total number of publications written in affiliation with this entity | Int32 | None
31+
32+
## Extended
33+
34+
> [!IMPORTANT]
35+
> 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)
36+
37+
> [!IMPORTANT]
38+
> 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.
39+
40+
Name | Description | Type | Operations
41+
--- | --- | --- | ---
42+
PC | Total number of publications written in affiliation with this entity | Int32 | None

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

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Author entity attributes - Academic Knowledge API
3+
titlesuffix: Azure Cognitive Services
4+
description: Learn the attributes you can use with the Author entity in the Academic Knowledge API.
5+
services: cognitive-services
6+
author: darrine
7+
manager: kuansanw
8+
9+
ms.service: cognitive-services
10+
ms.subservice: academic-knowledge
11+
ms.topic: conceptual
12+
ms.date: 11/14/2019
13+
ms.author: darrine
14+
ROBOTS: NOINDEX
15+
---
16+
17+
# Author Entity
18+
19+
> [!NOTE]
20+
> Following attributes are specific to author entity. (Ty = '1')
21+
22+
Name | Description | Type | Operations
23+
--- | --- | --- | ---
24+
Id | Entity ID |Int64 |Equals
25+
AuN | Author normalized name |String |Equals
26+
CC | Author total citation count |Int32 |None
27+
DAuN | Author display name |String |None
28+
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
29+
ECC | Author total estimated citation count |Int32 |None
30+
LKA.AfId | Entity ID of the last known affiliation found for the author | Int64 | None
31+
LKA.AfN | Normalized name of the last known affiliation found for the author | String | None
32+
PC | Author total publication count | Int32 | None
33+
34+
## Extended
35+
36+
> [!IMPORTANT]
37+
> 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)
38+
39+
> [!IMPORTANT]
40+
> 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.
41+
42+
Name | Description | Type | Operations
43+
--- | --- | --- | ---
44+
LKA.AfId | Entity ID of the last known affiliation found for the author | Int64 | None
45+
LKA.AfN | Normalized name of the last known affiliation found for the author | String | None
46+
PC | Author total publication count | Int32 | None

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

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
title: CalcHistogram method - Academic Knowledge API
3+
titlesuffix: Azure Cognitive Services
4+
description: Use the CalcHistogram method to calculate the distribution of attribute values for a set of paper entities.
5+
services: cognitive-services
6+
author: alch-msft
7+
manager: nitinme
8+
9+
ms.service: cognitive-services
10+
ms.subservice: academic-knowledge
11+
ms.topic: conceptual
12+
ms.date: 03/27/2017
13+
ms.author: alch
14+
ROBOTS: NOINDEX
15+
---
16+
17+
# CalcHistogram Method
18+
19+
The **calchistogram** REST API is used to calculate the distribution of attribute values for a set of paper entities.
20+
21+
22+
**REST endpoint:**
23+
```
24+
https:// westus.api.cognitive.microsoft.com/academic/v1.0/calchistogram?
25+
```
26+
<br>
27+
28+
## Request Parameters
29+
30+
Name |Value | Required? |Description
31+
-----------|----------|--------|----------
32+
**expr** |Text string | Yes |A query expression that specifies the entities over which to calculate histograms.
33+
**model** |Text string | No |Select the name of the model that you wish to query. Currently, the value defaults to *latest*.
34+
**attributes** | Text string | No<br>default: | A comma-delimited list that specifies the attribute values that are included in the response. Attribute names are case-sensitive.
35+
**count** |Number | No<br>Default: 10 |Number of results to return.
36+
**offset** |Number | No<br>Default: 0 |Index of the first result to return.
37+
**timeout** |Number | No<br>Default: 1000 |Timeout in milliseconds. Only interpretations found before the timeout has elapsed are returned.
38+
39+
## Response (JSON)
40+
41+
Name | Description
42+
--------|---------
43+
**expr** |The expr parameter from the request.
44+
**num_entities** | Total number of matching entities.
45+
**histograms** | An array of histograms, one for each attribute specified in the request.
46+
**histograms[x].attribute** | Name of the attribute over which the histogram was computed.
47+
**histograms[x].distinct_values** | Number of distinct values among matching entities for this attribute.
48+
**histograms[x].total_count** | Total number of value instances among matching entities for this attribute.
49+
**histograms[x].histogram** | Histogram data for this attribute.
50+
**histograms[x].histogram[y].value** | A value for the attribute.
51+
**histograms[x].histogram[y].logprob** |Total natural log probability of matching entities with this attribute value.
52+
**histograms[x].histogram[y].count** |Number of matching entities with this attribute value.
53+
**aborted** | True if the request timed out.
54+
55+
56+
#### Example:
57+
```
58+
https:// westus.api.cognitive.microsoft.com/academic/v1.0/calchistogram?expr=And(Composite(AA.AuN=='jaime teevan'),Y>2012)&attributes=Y,F.FN&count=4
59+
```
60+
<br>In this example, in order to generate a histogram of the count of publications by year for a particular author since 2010, we can first generate the query expression using the **interpret** API with query string: *papers by jaime teevan after 2012*.
61+
62+
```
63+
https:// westus.api.cognitive.microsoft.com/academic/v1.0/interpret?query=papers by jaime teevan after 2012
64+
```
65+
<br>The expression in the first interpretation that is returned from the interpret API is *And(Composite(AA.AuN=='jaime teevan'),Y>2012)*.
66+
<br>This expression value is then passed in to the **calchistogram** API. The *attributes=Y,F.FN* parameter indicates that the distributions of paper counts should be by Year and Field of Study, e.g.:
67+
```
68+
https:// westus.api.cognitive.microsoft.com/academic/v1.0/calchistogram?expr=And(Composite(AA.AuN=='jaime teevan'),Y>2012)&attributes=Y,F.FN&count=4
69+
```
70+
<br>The response to this request first indicates that there are 37 papers that match the query expression. For the *Year* attribute, there are 3 distinct values, one for each year after 2012 (i.e. 2013, 2014, and 2015) as specified in the query. The total paper count over the 3 distinct values is 37. For each *Year*, the histogram shows the value, total natural log probability, and count of matching entities.
71+
72+
The histogram for *Field of Study* shows that there are 34 distinct fields of study. As a paper may be associated with multiple fields of study, the total count (53) can be larger than the number of matching entities. Although there are 34 distinct values, the response only includes the top 4 because of the *count=4* parameter.
73+
74+
```JSON
75+
{
76+
"expr": "And(Composite(AA.AuN=='jaime teevan'),Y>2012)",
77+
"num_entities": 37,
78+
"histograms": [
79+
{
80+
"attribute": "Y",
81+
"distinct_values": 3,
82+
"total_count": 37,
83+
"histogram": [
84+
{
85+
"value": 2014,
86+
"logprob": -15.753,
87+
"count": 15
88+
},
89+
{
90+
"value": 2013,
91+
"logprob": -15.805,
92+
"count": 12
93+
},
94+
{
95+
"value": 2015,
96+
"logprob": -16.035,
97+
"count": 10
98+
}
99+
]
100+
},
101+
{
102+
"attribute": "F.FN",
103+
"distinct_values": 34,
104+
"total_count": 53,
105+
"histogram": [
106+
{
107+
"value": "crowdsourcing",
108+
"logprob": -15.258,
109+
"count": 9
110+
},
111+
{
112+
"value": "information retrieval",
113+
"logprob": -16.002,
114+
"count": 4
115+
},
116+
{
117+
"value": "personalization",
118+
"logprob": -16.226,
119+
"count": 3
120+
},
121+
{
122+
"value": "mobile search",
123+
"logprob": -17.228,
124+
"count": 2
125+
}
126+
]
127+
}
128+
]
129+
}
130+
```

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

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Conference Instance entity attributes - Academic Knowledge API
3+
titlesuffix: Azure Cognitive Services
4+
description: Learn the attributes you can use with the Conference Instance entity in the Academic Knowledge API.
5+
services: cognitive-services
6+
author: darrine
7+
manager: kuansanw
8+
9+
ms.service: cognitive-services
10+
ms.subservice: academic-knowledge
11+
ms.topic: conceptual
12+
ms.date: 11/14/2019
13+
ms.author: darrine
14+
ROBOTS: NOINDEX
15+
---
16+
17+
# Conference Instance Entity
18+
19+
> [!NOTE]
20+
> Following attributes are specific to conference instance entity. (Ty = '4')
21+
22+
Name | Description | Type | Operations
23+
--- | --- | --- | ---
24+
CC |Conference instance total citation count |Int32 |None
25+
CD.D |Date of a conference instance event |Date |Equals, IsBetween
26+
CD.T |Title of a conference instance event |Date |Equals, IsBetween
27+
CIARD |Abstract registration due date of the conference instance |Date |Equals, IsBetween
28+
CIED |End date of the conference instance |Date |Equals, IsBetween
29+
CIFVD |Final version due date of the conference instance |Date |Equals, IsBetween
30+
CIL |Location of the conference instance |String |Equals, StartsWith
31+
CIN |Conference instance normalized name |String |Equals
32+
CINDD |Notification date of the conference instance |Date |Equals, IsBetween
33+
CISD |Start date of the conference instance |Date |Equals, IsBetween
34+
CISDD |Submission due date of the conference instance |Date |Equals, IsBetween
35+
DCN |Conference instance display name |String |None
36+
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
37+
ECC |Conference instance total estimated citation count |Int32 |None
38+
FN | Conference instance full name | String | None
39+
Id |Entity ID |Int64 |Equals
40+
PC | Conference instance total publication count | Int32 | None
41+
PCS.CN |Parent conference series name of the instance |String |Equals
42+
PCS.CId |Parent conference series ID of the instance |Int64 |Equals
43+
44+
## Extended
45+
46+
> [!IMPORTANT]
47+
> 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)
48+
49+
> [!IMPORTANT]
50+
> 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.
51+
52+
Name | Description | Type | Operations
53+
--- | --- | --- | ---
54+
FN | Conference instance full name | String | None
55+
PC | Conference instance total publication count | Int32 | None

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Conference Series entity attributes - Academic Knowledge API
3+
titlesuffix: Azure Cognitive Services
4+
description: Learn about the attributes you can use with the Conference Series entity.
5+
services: cognitive-services
6+
author: darrine
7+
manager: kuansanw
8+
9+
ms.service: cognitive-services
10+
ms.subservice: academic-knowledge
11+
ms.topic: conceptual
12+
ms.date: 11/14/2019
13+
ms.author: darrine
14+
ROBOTS: NOINDEX
15+
---
16+
17+
# Conference Series Entity
18+
19+
> [!NOTE]
20+
> Following attributes are specific to conference series entity. (Ty = '3')
21+
22+
Name | Description | Type | Operations
23+
--- | --- | --- | ---
24+
CC |Conference series total citation count |Int32 |None
25+
CN |Conference series normalized name |String |Equals
26+
DCN |Conference series display name |String |None
27+
ECC |Conference series total estimated citation count |Int32 |None
28+
F.FId |Field of study entity ID associated with the conference series |Int64 | Equals
29+
F.FN |Field of study name associated with the conference series | Equals,<br/>StartsWith
30+
Id |Entity ID |Int64 |Equals
31+
PC |Conference series total publication count |Int32 | None

0 commit comments

Comments
 (0)