pub.chive.claiming.getSuggestions
Get suggested papers for the authenticated user to claim based on their profile
Repository
@lexicons.governance.chive.pub did:plc:egjghlwgts2hlcer2txilxeh
not from the namespace authority
Details · query
| Kind | query |
|---|---|
| Authority | claiming.chive.pub |
| Indexed |
Checks
Validunlimited-stringdefs.externalAuthor.properties.affiliationNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.externalAuthor.properties.emailNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.externalAuthor.properties.nameNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.externalAuthor.properties.orcidNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.profileMetadata.properties.displayNameNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.profileMetadata.properties.nameVariants.itemsNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.suggestedPaper.properties.abstractNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.suggestedPaper.properties.categories.itemsNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.suggestedPaper.properties.chiveUriNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.suggestedPaper.properties.doiNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.suggestedPaper.properties.externalIdNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.suggestedPaper.properties.matchReasonNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.suggestedPaper.properties.sourceNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.suggestedPaper.properties.titleNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"externalAuthor": {
"properties": {
"affiliation": {
"description": "Institution affiliation",
"type": "string"
},
"email": {
"description": "Email address",
"type": "string"
},
"name": {
"description": "Author name",
"type": "string"
},
"orcid": {
"description": "ORCID identifier",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"main": {
"description": "Get suggested papers for the authenticated user to claim based on their profile",
"errors": [
{
"name": "AuthenticationRequired"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"papers": {
"description": "Suggested papers sorted by match score",
"items": {
"ref": "#suggestedPaper",
"type": "ref"
},
"type": "array"
},
"profileUsed": {
"ref": "#profileMetadata",
"type": "ref"
}
},
"required": [
"papers",
"profileUsed"
],
"type": "object"
}
},
"parameters": {
"properties": {
"limit": {
"default": 20,
"description": "Maximum number of suggestions to return",
"maximum": 50,
"minimum": 1,
"type": "integer"
}
},
"type": "params"
},
"type": "query"
},
"profileMetadata": {
"description": "Profile data used for matching",
"properties": {
"displayName": {
"description": "User display name",
"type": "string"
},
"hasExternalIds": {
"description": "Whether user has external authority IDs",
"type": "boolean"
},
"hasOrcid": {
"description": "Whether user has ORCID linked",
"type": "boolean"
},
"nameVariants": {
"description": "Name variants used for matching",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"nameVariants",
"hasOrcid",
"hasExternalIds"
],
"type": "object"
},
"suggestedPaper": {
"properties": {
"abstract": {
"description": "Abstract text",
"type": "string"
},
"authors": {
"description": "Author list",
"items": {
"ref": "#externalAuthor",
"type": "ref"
},
"type": "array"
},
"categories": {
"description": "Subject categories",
"items": {
"type": "string"
},
"type": "array"
},
"chiveUri": {
"description": "AT-URI of the paper in Chive's index (present when source is 'chive')",
"type": "string"
},
"doi": {
"description": "DOI if assigned",
"type": "string"
},
"externalId": {
"description": "Source-specific identifier",
"type": "string"
},
"matchReason": {
"description": "Human-readable match reason",
"type": "string"
},
"matchScore": {
"description": "Match confidence score (0-100)",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"pdfUrl": {
"description": "URL to PDF",
"format": "uri",
"type": "string"
},
"publicationDate": {
"description": "Publication date",
"format": "datetime",
"type": "string"
},
"source": {
"description": "Source system",
"type": "string"
},
"title": {
"description": "Eprint title",
"type": "string"
},
"url": {
"description": "Full URL to the eprint",
"format": "uri",
"type": "string"
}
},
"required": [
"externalId",
"url",
"title",
"authors",
"source",
"matchScore",
"matchReason"
],
"type": "object"
}
},
"id": "pub.chive.claiming.getSuggestions",
"lexicon": 1,
"revision": 1
}