Data structures
Struct: SummarizationRequest
|
Key
|
Field
|
Type
|
Description
|
Requiredness
|
Default value
|
|
1
|
queryTerms
|
list<
string
>
|
Terms or features pertinent to the query.
Can be empty, meaning summarize all source material with
no a priori beliefs about what is important to summarize.
|
optional
|
|
|
2
|
maximumTokens
|
i32
|
Limit on how long the returned summary can be in tokens.
|
optional
|
|
|
3
|
maximumCharacters
|
i32
|
Limit on how long the returned summary can be in characters.
|
optional
|
|
|
4
|
sourceType
|
SummarySourceType
|
How to interpret the ids in sourceIds.
May be null is sourceIds is null, otherwise must be populated.
|
optional
|
|
|
5
|
sourceIds
|
list<
uuid.UUID
>
|
A list of concrete object ids which serve as the material
to summarize.
|
optional
|
|
|
6
|
sourceCommunication
|
communication.Communication
|
Alternative to sourceIds+sourceType: provide a Communication
of text to summarize.
|
optional
|
|
A request to summarize which specifies the length of the desired
summary and the text data to be summarized.
Either set sourceCommunication or sourceType and sourceIds.
Struct: SummaryConcept
|
Key
|
Field
|
Type
|
Description
|
Requiredness
|
Default value
|
|
1
|
tokens
|
structure.TokenRefSequence
|
Location in summaryCommunication of this concept
|
optional
|
|
|
2
|
concept
|
string
|
Short description of the concept being evoked, e.g. "kbrel:bornIn" or "related:ACME_Corp"
|
optional
|
|
|
3
|
confidence
|
double
|
How confident is the system that this concept was evoked by this mention, in [0,1]
|
optional
|
1
|
|
4
|
utility
|
double
|
How informative/important it is that this concept be included in the summary (non-negative).
|
optional
|
1
|
A mention of a concept described in a summary which is thought
to be informative. Concepts might be named entities, facts, or
events which were determined to be salient in the text being
summarized.
Struct: Summary
|
Key
|
Field
|
Type
|
Description
|
Requiredness
|
Default value
|
|
1
|
summaryCommunication
|
communication.Communication
|
Contains the text of the generated summary.
|
optional
|
|
|
2
|
concepts
|
list<
SummaryConcept
>
|
Concepts mentioned in the summary which are believed to be
interesting and/or worth highlighting.
|
optional
|
|
A shortened version of some text, possibly with some concepts
annotated as justifications for why particular pieces of the
summary were kept.
Struct: SummarizationCapability
|
Key
|
Field
|
Type
|
Description
|
Requiredness
|
Default value
|
|
1
|
type
|
SummarySourceType
|
|
required
|
|
|
2
|
lang
|
string
|
|
required
|
|