Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

migrate code from googleapis/nodejs-document-ai #2842

Closed
wants to merge 54 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
8504a1d
chore: initial build of document ai library
bcoe Sep 12, 2019
55c4ab1
feat!: initial generation of beta client (#5)
bcoe Nov 6, 2019
a67b85d
feat(samples): adds Document AI parse table, forms samples (#8)
telpirion Feb 14, 2020
5a44e58
feat: updated library from protos (#9)
telpirion Mar 18, 2020
eb1ebee
feat: adds beta samples
telpirion Mar 20, 2020
f45d365
chore: release 1.0.0 (#6)
release-please[bot] Mar 25, 2020
d0a4777
chore: removes unneeded samples (#25)
telpirion Mar 26, 2020
623f37b
feat!: drop node8 support (#30)
alexander-fenster Apr 2, 2020
51b929d
chore(deps): update dependency @types/mocha (#18)
renovate-bot Apr 7, 2020
9e3c061
chore: update region tags (#33)
telpirion Apr 8, 2020
a2a3a65
fix(samples): do not pass location (#39)
alexander-fenster Apr 12, 2020
9f8e532
chore: fix samples according to service resource change (#35)
telpirion Apr 13, 2020
8f218de
fix(deps): update dependency @google-cloud/storage to v5 (#56)
renovate-bot May 15, 2020
e416127
chore: release 2.0.0 (#31)
release-please[bot] Jun 2, 2020
e0abce8
chore(deps): update dependency mocha to v8 (#63)
renovate-bot Jun 11, 2020
4eeb11a
chore: release 2.1.0 (#61)
release-please[bot] Jun 28, 2020
717fa49
chore: release 2.1.1 (#75)
release-please[bot] Jul 10, 2020
8247c1a
build(test): recursively find test files; fail on unsupported depende…
yoshi-automation Sep 15, 2020
42fdf06
feat: generation error and set v1beta3 as default (#112)
sofisl Oct 15, 2020
4dd1a49
docs(samples): new Doc AI samples for v1beta3 (#101)
telpirion Oct 15, 2020
a707b66
chore: release 2.2.0 (#106)
release-please[bot] Oct 20, 2020
a03c2f1
chore: release 2.2.1 (#128)
release-please[bot] Nov 11, 2020
de3ae06
docs: make projectId variable consistent in quickstart.js comments
asrivas Nov 30, 2020
d077a0d
chore: release 2.2.2 (#132)
release-please[bot] Dec 2, 2020
3cd6a57
docs: make processor ID variable consistent with comments in snippet …
asrivas Dec 3, 2020
8bfa832
chore: release 2.3.0 (#144)
release-please[bot] Jan 12, 2021
b6ae8c0
chore: release 2.4.0 (#153)
release-please[bot] Feb 17, 2021
e87c3e5
chore: release 2.5.0 (#155)
release-please[bot] Feb 24, 2021
2ddd56f
chore: release 2.6.0 (#182)
release-please[bot] Mar 15, 2021
87729dd
chore: release 2.7.0 (#193)
release-please[bot] Apr 12, 2021
0ba68c4
chore: release 2.8.0 (#197)
release-please[bot] Apr 13, 2021
9a8cfaf
samples: updates v1beta3 to v1; renames v1beta2 samples (#198)
telpirion Apr 14, 2021
a71ffff
chore: release 2.9.0 (#205)
release-please[bot] Apr 28, 2021
cdb1cb4
chore: new owl bot post processor docker image (#212)
gcf-owl-bot[bot] May 10, 2021
1824057
chore: release 2.10.0 (#213)
release-please[bot] May 13, 2021
00c9291
samples: Update quickstart.js (#189)
mtannerfors May 20, 2021
67443c9
chore: release 3.0.0 (#221)
release-please[bot] Jul 1, 2021
4b71ad6
chore: release 3.0.1 (#244)
release-please[bot] Jul 21, 2021
89fbcb4
chore: release 3.0.2 (#254)
release-please[bot] Aug 17, 2021
9bac12a
chore: release 3.1.0 (#259)
release-please[bot] Sep 27, 2021
1e2f11b
docs(samples): add OCR, form, quality, splitter and specialized proce…
Nov 12, 2021
b3a3780
samples: added default value for undefined (#287)
galz10 Dec 14, 2021
25335af
chore: release 3.2.0 (#288)
release-please[bot] Dec 14, 2021
153a5a6
chore(main): release 3.3.0 (#306)
release-please[bot] Feb 22, 2022
dcad383
chore: removed v1beta2 samples (#325)
galz10 Apr 22, 2022
c568986
build!: update library to use Node 12 (#333)
alexander-fenster May 17, 2022
cc14ec8
fix(deps): update dependency @google-cloud/storage to v6 (#335)
renovate-bot Jun 20, 2022
34098ed
chore(main): release 4.0.0 (#334)
release-please[bot] Jun 20, 2022
40e75f9
chore(main): release 4.1.0 (#340)
release-please[bot] Jul 6, 2022
52387fd
chore(main): release 5.0.0 (#344)
release-please[bot] Aug 17, 2022
ff7e21c
fix(deps): update dependency uuid to v9 (#356)
renovate-bot Sep 9, 2022
7177468
chore(main): release 6.0.0 (#347)
release-please[bot] Sep 22, 2022
d58c964
chore(main): release 6.1.0 (#374)
release-please[bot] Nov 11, 2022
20ff589
Merge remote-tracking branch 'migration/main' into nodejs-document-ai…
Nov 11, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions document-ai/.eslintrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
rules:
no-console: off
node/no-unsupported-features/node-builtins: off
149 changes: 149 additions & 0 deletions document-ai/batch-process-document.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
/**
* Copyright 2020 Google LLC
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

const uuid = require('uuid');

async function main(
projectId = 'YOUR_PROJECT_ID',
location = 'YOUR_PROJECT_LOCATION',
processorId = 'YOUR_PROCESSOR_ID', // Create this in the Cloud Console
gcsInputUri = 'gs://cloud-samples-data/documentai/invoice.pdf',
gcsOutputUri = 'output-bucket',
gcsOutputUriPrefix = uuid.v4()
) {
// [START documentai_batch_process_document]
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
// const projectId = 'YOUR_PROJECT_ID';
// const location = 'YOUR_PROJECT_LOCATION'; // Format is 'us' or 'eu'
// const processorId = 'YOUR_PROCESSOR_ID';
// const gcsInputUri = 'YOUR_SOURCE_PDF';
// const gcsOutputUri = 'YOUR_STORAGE_BUCKET';
// const gcsOutputUriPrefix = 'YOUR_STORAGE_PREFIX';

// Imports the Google Cloud client library
const {DocumentProcessorServiceClient} =
require('@google-cloud/documentai').v1;
const {Storage} = require('@google-cloud/storage');

// Instantiates Document AI, Storage clients
const client = new DocumentProcessorServiceClient();
const storage = new Storage();

const {default: PQueue} = require('p-queue');

async function batchProcessDocument() {
const name = `projects/${projectId}/locations/${location}/processors/${processorId}`;

// Configure the batch process request.
const request = {
name,
inputDocuments: {
gcsDocuments: {
documents: [
{
gcsUri: gcsInputUri,
mimeType: 'application/pdf',
},
],
},
},
documentOutputConfig: {
gcsOutputConfig: {
gcsUri: `${gcsOutputUri}/${gcsOutputUriPrefix}/`,
},
},
};

// Batch process document using a long-running operation.
// You can wait for now, or get results later.
// Note: first request to the service takes longer than subsequent
// requests.
const [operation] = await client.batchProcessDocuments(request);

// Wait for operation to complete.
await operation.promise();
console.log('Document processing complete.');

// Query Storage bucket for the results file(s).
const query = {
prefix: gcsOutputUriPrefix,
};

console.log('Fetching results ...');

// List all of the files in the Storage bucket
const [files] = await storage.bucket(gcsOutputUri).getFiles(query);

// Add all asynchronous downloads to queue for execution.
const queue = new PQueue({concurrency: 15});
const tasks = files.map((fileInfo, index) => async () => {
// Get the file as a buffer
const [file] = await fileInfo.download();

console.log(`Fetched file #${index + 1}:`);

// The results stored in the output Storage location
// are formatted as a document object.
const document = JSON.parse(file.toString());
const {text} = document;

// Extract shards from the text field
const getText = textAnchor => {
if (!textAnchor.textSegments || textAnchor.textSegments.length === 0) {
return '';
}

// First shard in document doesn't have startIndex property
const startIndex = textAnchor.textSegments[0].startIndex || 0;
const endIndex = textAnchor.textSegments[0].endIndex;

return text.substring(startIndex, endIndex);
};

// Read the text recognition output from the processor
console.log('The document contains the following paragraphs:');

const [page1] = document.pages;
const {paragraphs} = page1;
for (const paragraph of paragraphs) {
const paragraphText = getText(paragraph.layout.textAnchor);
console.log(`Paragraph text:\n${paragraphText}`);
}

// Form parsing provides additional output about
// form-formatted PDFs. You must create a form
// processor in the Cloud Console to see full field details.
console.log('\nThe following form key/value pairs were detected:');

const {formFields} = page1;
for (const field of formFields) {
const fieldName = getText(field.fieldName.textAnchor);
const fieldValue = getText(field.fieldValue.textAnchor);

console.log('Extracted key value pair:');
console.log(`\t(${fieldName}, ${fieldValue})`);
}
});
await queue.addAll(tasks);
}
// [END documentai_batch_process_document]

batchProcessDocument();
}
main(...process.argv.slice(2));
25 changes: 25 additions & 0 deletions document-ai/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "nodejs-document-ai-samples",
"private": true,
"license": "Apache-2.0",
"author": "Google LLC",
"engines": {
"node": ">=12.0.0"
},
"files": [
"*.js"
],
"scripts": {
"test": "mocha test/*.js --timeout 600000"
},
"dependencies": {
"@google-cloud/documentai": "^6.1.0",
"@google-cloud/storage": "^6.0.0",
"p-queue": "^6.6.2",
"uuid": "^9.0.0"
},
"devDependencies": {
"chai": "^4.2.0",
"mocha": "^8.0.0"
}
}
132 changes: 132 additions & 0 deletions document-ai/process-document-form.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
/**
* Copyright 2021, Google, Inc.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

async function main(projectId, location, processorId, filePath) {
// [START documentai_process_form_document]
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
// const projectId = 'YOUR_PROJECT_ID';
// const location = 'YOUR_PROJECT_LOCATION'; // Format is 'us' or 'eu'
// const processorId = 'YOUR_PROCESSOR_ID'; // Create processor in Cloud Console
// const filePath = '/path/to/local/pdf';

const {DocumentProcessorServiceClient} =
require('@google-cloud/documentai').v1beta3;

// Instantiates a client
const client = new DocumentProcessorServiceClient();

async function processDocument() {
// The full resource name of the processor, e.g.:
// projects/project-id/locations/location/processor/processor-id
// You must create new processors in the Cloud Console first
const name = `projects/${projectId}/locations/${location}/processors/${processorId}`;

// Read the file into memory.
const fs = require('fs').promises;
const imageFile = await fs.readFile(filePath);

// Convert the image data to a Buffer and base64 encode it.
const encodedImage = Buffer.from(imageFile).toString('base64');

const request = {
name,
rawDocument: {
content: encodedImage,
mimeType: 'application/pdf',
},
};

// Recognizes text entities in the PDF document
const [result] = await client.processDocument(request);

console.log('Document processing complete.');

// Read the table and form fields output from the processor
// The form processor also contains OCR data. For more information
// on how to parse OCR data please see the OCR sample.
// For a full list of Document object attributes,
// please reference this page: https://googleapis.dev/nodejs/documentai/latest/index.html
const {document} = result;
const {text} = document;
console.log(`Full document text: ${JSON.stringify(text)}`);
console.log(`There are ${document.pages.length} page(s) in this document.`);

for (const page of document.pages) {
console.log(`\n\n**** Page ${page.pageNumber} ****`);

console.log(`Found ${page.tables.length} table(s):`);
for (const table of page.tables) {
const numCollumns = table.headerRows[0].cells.length;
const numRows = table.bodyRows.length;
console.log(`Table with ${numCollumns} columns and ${numRows} rows:`);
printTableInfo(table, text);
}
console.log(`Found ${page.formFields.length} form field(s):`);
for (const field of page.formFields) {
const fieldName = getText(field.fieldName.textAnchor, text);
const fieldValue = getText(field.fieldValue.textAnchor, text);
console.log(
`\t* ${JSON.stringify(fieldName)}: ${JSON.stringify(fieldValue)}`
);
}
}
}

const printTableInfo = (table, text) => {
// Print header row
let headerRowText = '';
for (const headerCell of table.headerRows[0].cells) {
const headerCellText = getText(headerCell.layout.textAnchor, text);
headerRowText += `${JSON.stringify(headerCellText.trim())} | `;
}
console.log(
`Collumns: ${headerRowText.substring(0, headerRowText.length - 3)}`
);
// Print first body row
let bodyRowText = '';
for (const bodyCell of table.bodyRows[0].cells) {
const bodyCellText = getText(bodyCell.layout.textAnchor, text);
bodyRowText += `${JSON.stringify(bodyCellText.trim())} | `;
}
console.log(
`First row data: ${bodyRowText.substring(0, bodyRowText.length - 3)}`
);
};

// Extract shards from the text field
const getText = (textAnchor, text) => {
if (!textAnchor.textSegments || textAnchor.textSegments.length === 0) {
return '';
}

// First shard in document doesn't have startIndex property
const startIndex = textAnchor.textSegments[0].startIndex || 0;
const endIndex = textAnchor.textSegments[0].endIndex;

return text.substring(startIndex, endIndex);
};

// [END documentai_process_form_document]
await processDocument();
}

main(...process.argv.slice(2)).catch(err => {
console.error(err);
process.exitCode = 1;
});
Loading