Files
wehub-resource-sync e904b667c6
Build/Publish Develop Docs / deploy (push) Failing after 1s
PaddleOCR Code Style Check / check-code-style (push) Failing after 1s
PaddleOCR PR Tests GPU / detect-changes (push) Failing after 1s
PaddleOCR PR Tests / detect-changes (push) Failing after 1s
PaddleOCR PR Tests GPU / test-pr-gpu (push) Has been cancelled
PaddleOCR PR Tests / test-pr (push) Has been cancelled
PaddleOCR PR Tests GPU / test-pr-gpu-impl (push) Has been cancelled
PaddleOCR PR Tests / test-pr-python (3.13) (push) Has been cancelled
PaddleOCR PR Tests / test-pr-python (3.8) (push) Has been cancelled
PaddleOCR PR Tests / test-pr-python (3.9) (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 11:59:26 +08:00

31 lines
1.5 KiB
Go

// Copyright (c) 2026 PaddlePaddle Authors. All Rights Reserved.
//
// 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.
// Package paddleocr provides a Go client for the PaddleOCR official API.
//
// Create a client with NewClient and authenticate with WithToken or the
// PADDLEOCR_ACCESS_TOKEN environment variable. Use OCR for supported OCR models
// and ParseDocument for document parsing models.
// SubmitOCR and SubmitDocumentParsing return an Operation for non-blocking
// status checks with Poll or typed waits with WaitOCR and WaitDocumentParsing.
// SaveResource downloads one result resource URL. SaveOCRResultResources and
// SaveDocumentParsingResultResources save resources from typed result objects
// into an existing directory.
//
// Request timeout and polling timeout are configured separately with
// WithRequestTimeout and WithPollTimeout. Errors are exposed as typed values,
// such as AuthError, InvalidRequestError, APIError, ResponseFormatError, and
// ResultParseError, and are suitable for errors.As.
package paddleocr