com.alibaba.cloud.ai.parser.apache.pdfbox.ApachePdfBoxDocumentParser Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024-2025 the original author or authors.
 *
 * 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
 *
 *      https://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.
 */
package com.alibaba.cloud.ai.parser.apache.pdfbox;

import com.alibaba.cloud.ai.document.DocumentParser;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDDocumentInformation;
import org.apache.pdfbox.text.PDFTextStripper;
import org.springframework.ai.document.Document;
import org.springframework.util.Assert;

import java.io.IOException;
import java.io.InputStream;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author HeYQ
 * @since 2024-12-08 22:34
 */

public class ApachePdfBoxDocumentParser implements DocumentParser {

	private final boolean includeMetadata;

	public ApachePdfBoxDocumentParser() {
		this(false);
	}

	public ApachePdfBoxDocumentParser(boolean includeMetadata) {
		this.includeMetadata = includeMetadata;
	}

	@Override
	public List parse(InputStream inputStream) {
		try (PDDocument pdfDocument = PDDocument.load(inputStream)) {
			PDFTextStripper stripper = new PDFTextStripper();
			String text = stripper.getText(pdfDocument);
			Assert.notNull(text, "Text cannot be null");
			return includeMetadata ? Collections.singletonList(new Document(text, toMetadata(pdfDocument)))
					: Collections.singletonList(new Document(text));
		}
		catch (IOException e) {
			throw new RuntimeException(e);
		}
	}

	private Map toMetadata(PDDocument pdDocument) {
		PDDocumentInformation documentInformation = pdDocument.getDocumentInformation();
		Map metadata = new HashMap<>();
		for (String metadataKey : documentInformation.getMetadataKeys()) {
			String value = documentInformation.getCustomMetadataValue(metadataKey);
			if (value != null) {
				metadata.put(metadataKey, value);
			}
		}
		return metadata;
	}

}