docintel

package module

Go to main page

Versions in this module

v0

v0.3.0

Jul 3, 2026

Changes in this version

+ var ErrMissingOperationLocation = errors.New("docintel: response missing Operation-Location header")

type AzureError

+ Details []AzureError

+ InnerError json.RawMessage

+ Target string

type StatusError

+ RetryAfter time.Duration

v0.2.0

Jul 3, 2026

Changes in this version

type Client

+ func (c *Client) PollBatchResult(ctx context.Context, location string, opts ...PollOption) (*BatchAnalyzeOperation, error)

+ func (c *Client) PollResult(ctx context.Context, location string, opts ...PollOption) (*AnalyzeOperation, error)

+ type PollOption func(*pollConfig)

+ func WithPollInterval(interval time.Duration) PollOption

+ func WithPollTimeout(timeout time.Duration) PollOption

v0.1.0

Jul 3, 2026

Changes in this version

+ var ErrInvalidAnalyzeRequest = errors.New("docintel: invalid analyze request")

+ var ErrInvalidBatchRequest = errors.New("docintel: invalid batch request")

+ var ErrOperationNotFound = errors.New("docintel: operation not found")

+ type AnalyzeBatchParams struct

+ AzureBlobFileListSource *AzureBlobFileListSource

+ AzureBlobSource *AzureBlobSource

+ Locale string

+ Model Model

+ OutputFormat ContentFormat

+ OverwriteExisting bool

+ ResultContainerURL string

+ ResultPrefix string

+ type AnalyzeDocumentParams struct

+ ContentType string

+ Document io.Reader

+ Locale string

+ Model Model

+ OutputFormat ContentFormat

+ type AnalyzeError struct

+ Err *AzureError

+ Status Status

+ func (e *AnalyzeError) Error() string

+ type AnalyzeOperation struct

+ AnalyzeResult AnalyzeResult

+ CreatedDateTime time.Time

+ Error *AzureError

+ LastUpdatedDateTime time.Time

+ Status Status

+ type AnalyzeResult struct

+ APIVersion string

+ Content string

+ ContentFormat string

+ Documents []AnalyzedDocument

+ Figures []DocumentFigure

+ KeyValuePairs []DocumentKeyValuePair

+ Languages []DocumentLanguage

+ ModelID string

+ Pages []DocumentPage

+ Paragraphs []DocumentParagraph

+ Sections []DocumentSection

+ StringIndexType string

+ Styles []DocumentStyle

+ Tables []DocumentTable

+ Warnings []Warning

+ type AnalyzedDocument struct

+ BoundingRegions []BoundingRegion

+ Confidence float64

+ DocType string

+ Fields map[string]DocumentField

+ Spans []Span

+ type AzureBlobFileListSource struct

+ ContainerURL string

+ FileList string

+ type AzureBlobSource struct

+ ContainerURL string

+ Prefix string

+ type AzureError struct

+ Code string

+ Message string

+ type BatchAnalyzeOperation struct

+ CreatedDateTime time.Time

+ Error *AzureError

+ LastUpdatedDateTime time.Time

+ PercentCompleted int

+ Result BatchResult

+ ResultID string

+ Status Status

+ type BatchResult struct

+ Details []BatchResultDetail

+ FailedCount int

+ SkippedCount int

+ SucceededCount int

+ type BatchResultDetail struct

+ Error *AzureError

+ ResultURL string

+ SourceURL string

+ Status Status

+ type BoundingRegion struct

+ PageNumber int

+ Polygon []float64

+ type Client struct

+ func NewClient(endpoint, key string, opts ...Option) *Client

+ func (c *Client) AnalyzeBatch(ctx context.Context, params AnalyzeBatchParams) (string, error)

+ func (c *Client) AnalyzeDocument(ctx context.Context, params AnalyzeDocumentParams) (string, error)

+ func (c *Client) GetAnalyzeResult(ctx context.Context, location string) (*AnalyzeOperation, error)

+ func (c *Client) GetBatchResult(ctx context.Context, location string) (*BatchAnalyzeOperation, error)

+ type ContentFormat string

+ const ContentFormatMarkdown

+ const ContentFormatText

+ type DocumentCaption struct

+ BoundingRegions []BoundingRegion

+ Content string

+ Spans []Span

+ type DocumentField struct

+ BoundingRegions []BoundingRegion

+ Confidence float64

+ Content string

+ Spans []Span

+ Type string

+ type DocumentFigure struct

+ BoundingRegions []BoundingRegion

+ Caption *DocumentCaption

+ ID string

+ Spans []Span

+ type DocumentKeyValueElement struct

+ BoundingRegions []BoundingRegion

+ Content string

+ Spans []Span

+ type DocumentKeyValuePair struct

+ Confidence float64

+ Key DocumentKeyValueElement

+ Value *DocumentKeyValueElement

+ type DocumentLanguage struct

+ Confidence float64

+ Locale string

+ Spans []Span

+ type DocumentLine struct

+ Content string

+ Polygon []float64

+ Spans []Span

+ type DocumentPage struct

+ Angle float64

+ Height float64

+ Lines []DocumentLine

+ PageNumber int

+ Spans []Span

+ Unit string

+ Width float64

+ Words []DocumentWord

+ type DocumentParagraph struct

+ BoundingRegions []BoundingRegion

+ Content string

+ Role string

+ Spans []Span

+ type DocumentSection struct

+ Elements []string

+ Spans []Span

+ type DocumentStyle struct

+ BackgroundColor string

+ Color string

+ Confidence float64

+ FontStyle string

+ FontWeight string

+ IsHandwritten bool

+ Spans []Span

+ type DocumentTable struct

+ BoundingRegions []BoundingRegion

+ Cells []DocumentTableCell

+ ColumnCount int

+ RowCount int

+ Spans []Span

+ type DocumentTableCell struct

+ BoundingRegions []BoundingRegion

+ ColumnIndex int

+ ColumnSpan int

+ Content string

+ Kind string

+ RowIndex int

+ RowSpan int

+ Spans []Span

+ type DocumentWord struct

+ Confidence float64

+ Content string

+ Polygon []float64

+ Span Span

+ type Model string

+ const ModelBusinessCard

+ const ModelContract

+ const ModelIDDocument

+ const ModelInvoice

+ const ModelLayout

+ const ModelRead

+ const ModelReceipt

+ const ModelTaxUSW2

+ type Option func(*Client)

+ func WithAPIVersion(version string) Option

+ func WithHTTPClient(client *http.Client) Option

+ type Span struct

+ Length int

+ Offset int

+ type Status string

+ const StatusCanceled

+ const StatusCompleted

+ const StatusFailed

+ const StatusNotStarted

+ const StatusRunning

+ const StatusSkipped

+ const StatusSucceeded

+ type StatusError struct

+ Body string

+ StatusCode int

+ func (e *StatusError) Error() string

+ func (e *StatusError) Retryable() bool

+ type Warning struct

+ Code string

+ Message string

+ Target string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL