- Resource: Review
- Result
- AnchoredReviewComment
- Severity
- DocumentLocation
- PdfLocation
- TextQuoteSelector
- NormalizedBoundingBox
- TextLocation
- CitationReport
- Verdict
- SearchVerdict
- CitationMetadata
- Author
- Date
- FieldComparison
- GroundingUrl
- DeepReviewRunConfig
- Topology
- Methods
Resource: Review
An evaluation run of a document.
| JSON representation |
|---|
{ "name": string, "state": enum ( |
| Fields | |
|---|---|
name |
Identifier. Resource name in format |
state |
Output only. Current review lifecycle state. |
result |
Output only. Review output (markdown, errors, and future modalities). |
createTime |
Output only. Timestamp when this review attempt was initiated. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
startTime |
Output only. Timestamp when the worker started evaluation. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
endTime |
Output only. Timestamp when the review reached a terminal state. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
runConfig |
Optional. Run configuration parameters used for this review. |
progressPercent |
Output only. Estimated completion progress percentage of the review in [0, 100]. |
Result
Encapsulates the synthesized output or failure details of a single review execution.
| JSON representation |
|---|
{ "reviewMarkdown": string, "error": { object ( |
| Fields | |
|---|---|
reviewMarkdown |
Output only. Synthesized review report markdown. |
error |
Output only. Failure status details if review execution failed. |
anchoredComments[] |
Output only. Structured review comments anchored to specific locations in the document. At most 300 anchored comments are returned per review. |
AnchoredReviewComment
A structured review comment anchored to a specific location in the document.
| JSON representation |
|---|
{ "commentId": string, "severity": enum ( |
| Fields | |
|---|---|
commentId |
Output only. Unique identifier for the comment within the review. |
severity |
Output only. Severity classification of the comment. |
summary |
Output only. Short one-line summary of the review comment. |
bodyMarkdown |
Output only. Detailed markdown explanation of the review comment. |
suggestedEdit |
Output only. Optional suggested replacement text or edit for the anchored span. |
location |
Output only. Polymorphic location in the document where this comment is anchored. |
citationReport |
Output only. Optional structured citation verification report when this comment corresponds to a bibliography reference. |
Severity
Severity level for an anchored review comment.
| Enums | |
|---|---|
SEVERITY_UNSPECIFIED |
Default unspecified severity. |
CRITICAL |
Critical flaw in proofs, methodology, or empirical claims. |
MAJOR |
Major issue affecting key conclusions or experimental validity. |
MINOR |
Minor issue, presentation clarity, or missing detail. |
SUGGESTION |
Constructive suggestion or optional improvement. |
DocumentLocation
A location targeting either a PDF page region/quote or text lines in the document.
| JSON representation |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "pdf": { object ( |
| Fields | |
|---|---|
| The specific document location target. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
pdf |
Output only. Location within a rendered PDF document. |
text |
Output only. Location within a plain-text, Markdown, or LaTeX source document. |
| End of mutually exclusive fields. | |
PdfLocation
Location anchor within a PDF document.
| JSON representation |
|---|
{ "pageNumber": integer, "quoteSelector": { object ( |
| Fields | |
|---|---|
pageNumber |
Output only. 1-indexed page number within the PDF document. |
quoteSelector |
Output only. W3C Web Annotation TextQuoteSelector (https://www.w3.org/TR/annotation-model/#text-quote-selector) for exact text span highlighting. |
boundingBoxes[] |
Output only. Normalized bounding boxes [0.0, 1.0] relative to page width and height. At most 50 bounding boxes are returned per anchored span. |
TextQuoteSelector
W3C Web Annotation TextQuoteSelector for resilient text anchoring (see https://www.w3.org/TR/annotation-model/#text-quote-selector for details).
| JSON representation |
|---|
{ "exact": string, "prefix": string, "suffix": string } |
| Fields | |
|---|---|
exact |
Output only. Verbatim substring extracted from the document character stream. |
prefix |
Output only. Characters immediately preceding |
suffix |
Output only. Characters immediately following |
NormalizedBoundingBox
Bounding box in normalized [0.0, 1.0] page coordinates (origin top-left).
| JSON representation |
|---|
{ "left": number, "top": number, "right": number, "bottom": number } |
| Fields | |
|---|---|
left |
Output only. Left coordinate in [0.0, 1.0]. |
top |
Output only. Top coordinate in [0.0, 1.0]. |
right |
Output only. Right coordinate in [0.0, 1.0]. |
bottom |
Output only. Bottom coordinate in [0.0, 1.0]. |
TextLocation
Location anchor within a plain-text, Markdown, or LaTeX source document.
| JSON representation |
|---|
{ "firstLine": integer, "lastLine": integer, "firstColumn": integer, "lastColumn": integer, "quotedLinePreview": string } |
| Fields | |
|---|---|
firstLine |
Output only. 1-indexed inclusive first line number. |
lastLine |
Output only. 1-indexed inclusive last line number. |
firstColumn |
Output only. Optional 1-indexed inclusive first column offset within |
lastColumn |
Output only. Optional 1-indexed inclusive last column offset within |
quotedLinePreview |
Output only. Verbatim snippet of the anchored source line(s). |
CitationReport
Structured citation verification report for a single bibliography reference.
| JSON representation |
|---|
{ "refNum": integer, "rawReference": string, "citationKey": string, "entryType": string, "finalVerdict": enum ( |
| Fields | |
|---|---|
refNum |
Output only. 1-indexed bibliography reference number in the paper. |
rawReference |
Output only. Verbatim reference string extracted from the paper's bibliography. |
citationKey |
Output only. Generated BibTeX citation key (e.g., "smith2023deep"). |
entryType |
Output only. BibTeX entry type (e.g., "article", "inproceedings", "misc"). |
finalVerdict |
Output only. Final combined verdict after database lookup and search grounding. |
lookupVerdict |
Output only. Verdict from scholarly database lookup (OpenAlex / Crossref) before search grounding. |
searchVerdict |
Output only. Verdict from Google Search grounding verification (when run). |
searchMethod |
Output only. Strategy that produced the scholarly database match (e.g., "doi", "title", "title_author", "autocomplete"). Empty when no title-matching candidate was found. |
extractedMetadata |
Output only. Metadata parsed from the paper's bibliography entry. |
retrievedMetadata |
Output only. Metadata retrieved from OpenAlex / Crossref. Populated only when the retrieved work's title matches the extracted title. Omitted when no candidate matches the title so unrelated papers are never displayed as candidates. |
retrievedBibtex |
Output only. Formatted BibTeX entry for the verified |
fieldComparisons[] |
Output only. Per-field comparisons (populated only when |
firstAuthorFamilyNameMatch |
Output only. Whether the first author's family name matched between extracted and retrieved metadata. |
searchRationale |
Output only. Explanation from the Google Search grounding verification step (when run). |
groundingUrls[] |
Output only. Web sources surfaced during Google Search grounding. |
Verdict
Verification verdict for scholarly lookup and overall reference check.
| Enums | |
|---|---|
VERDICT_UNSPECIFIED |
Default unspecified verdict. |
OK |
Reference metadata matches scholarly database record. |
MINOR_MISMATCH |
Minor discrepancy (e.g., publication year off by 1 or venue variation). |
MAJOR_MISMATCH |
Major discrepancy in authors, year, or venue. |
VERIFIED_BY_SEARCH |
Reference verified using Google Search grounding. |
NOT_FOUND |
Reference not found in scholarly databases and unverified by search. |
HALLUCINATED |
Reference flagged as likely hallucinated by Google Search grounding. |
SKIPPED |
Non-paper entry (e.g., software package or URL) skipped during lookup. |
SearchVerdict
Verdict from Google Search grounding verification.
| Enums | |
|---|---|
SEARCH_VERDICT_UNSPECIFIED |
Default unspecified search verdict (search grounding not run). |
NOT_HALLUCINATED |
Google Search grounding confirmed the work exists. |
HALLUCINATED_BY_SEARCH |
Google Search grounding determined the reference is likely hallucinated. |
SEARCH_ERROR |
Google Search grounding encountered an execution or parsing error. |
CitationMetadata
Structured bibliographic metadata for an extracted or retrieved work.
| JSON representation |
|---|
{ "title": string, "authors": [ { object ( |
| Fields | |
|---|---|
title |
Output only. Work title. |
authors[] |
Output only. Ordered list of authors. |
publicationDate |
Output only. Publication date (month and day left as 0 if just year). |
journal |
Output only. Journal, conference, or venue name. |
volume |
Output only. Volume identifier. |
pages |
Output only. Page range or article number. |
doi |
Output only. Digital Object Identifier (DOI). |
urls[] |
Output only. URLs associated with the reference. |
source |
Output only. Source database for retrieved metadata (e.g., "openalex", "crossref"). Empty on |
Author
Author name components.
| JSON representation |
|---|
{ "givenName": string, "familyName": string } |
| Fields | |
|---|---|
givenName |
Output only. Author given name / initials. |
familyName |
Output only. Author family name / surname (or organization name). |
Date
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:
- A full date, with non-zero year, month, and day values.
- A month and day, with a zero year (for example, an anniversary).
- A year on its own, with a zero month and a zero day.
- A year and month, with a zero day (for example, a credit card expiration date).
Related types:
google.type.TimeOfDaygoogle.type.DateTimegoogle.protobuf.Timestamp
| JSON representation |
|---|
{ "year": integer, "month": integer, "day": integer } |
| Fields | |
|---|---|
year |
Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
month |
Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
day |
Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
FieldComparison
Per-field comparison result between extracted and retrieved metadata.
| JSON representation |
|---|
{ "fieldKey": string, "match": boolean, "detail": string } |
| Fields | |
|---|---|
fieldKey |
Output only. Field key ("title", "authors", "year", "journal", "volume", "pages", "doi"). |
match |
Output only. Whether the extracted and retrieved values matched. |
detail |
Output only. Human-readable comparison detail (e.g., "extracted=2023, found=2024 (diff=1)"). |
GroundingUrl
Web source URL surfaced during Google Search grounding verification.
| JSON representation |
|---|
{ "title": string, "url": string } |
| Fields | |
|---|---|
title |
Output only. Source page title or domain. |
url |
Output only. Source URL. |
DeepReviewRunConfig
Configuration options for the multi-agent document review execution pipeline.
| JSON representation |
|---|
{
"topology": enum ( |
| Fields | |
|---|---|
topology |
Optional. Review execution topology profile to use. |
model |
Optional. The Gemini model identifier to use for the review. If omitted, the server uses its default model. Unsupported values return INVALID_ARGUMENT. |
geminiApiKey |
Optional. Input only. Developer Bring-Your-Own-Key Gemini API key. When provided, requests are billed to the caller's Gemini API project. Input only; forwarded to the asynchronous review runner in the task payload and never persisted in database records or returned in review resources (see companion field |
userPrompt |
Optional. User-provided guidance, focus areas, or custom evaluation instructions passed to the review agents. |
geminiApiKeySet |
Output only. Indicates whether a developer Bring-Your-Own-Key Gemini API key was provided for this review run. |
Topology
Execution topology quality profile for the review pipeline.
| Enums | |
|---|---|
TOPOLOGY_UNSPECIFIED |
Default unspecified topology. The server uses its default topology (MID). |
EXTRA_HIGH |
Extra high quality topology with exhaustive evaluation passes. |
HIGH |
Standard high quality conference review topology. |
MID |
Medium quality topology balancing review latency and depth. |
LOW |
Low latency / fast turnaround topology. |
Methods |
|
|---|---|
|
Creates and initiates an asynchronous multi-agent review for a document. |
|
Retrieves a specific review execution result. |
|
Lists all review execution runs for a document. |