Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. AiDocument
  5. getProcessorJob
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.AiDocument.getProcessorJob

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Processor Job resource in Oracle Cloud Infrastructure Ai Document service.

    Get the details of a processor job.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testProcessorJob = oci.AiDocument.getProcessorJob({
    processorJobId: testProcessorJobOciAiDocumentProcessorJob.id,
});

    import pulumi
import pulumi_oci as oci

test_processor_job = oci.AiDocument.get_processor_job(processor_job_id=test_processor_job_oci_ai_document_processor_job["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/AiDocument"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := AiDocument.GetProcessorJob(ctx, &aidocument.GetProcessorJobArgs{
			ProcessorJobId: testProcessorJobOciAiDocumentProcessorJob.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testProcessorJob = Oci.AiDocument.GetProcessorJob.Invoke(new()
    {
        ProcessorJobId = testProcessorJobOciAiDocumentProcessorJob.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.AiDocument.AiDocumentFunctions;
import com.pulumi.oci.AiDocument.inputs.GetProcessorJobArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testProcessorJob = AiDocumentFunctions.getProcessorJob(GetProcessorJobArgs.builder()
            .processorJobId(testProcessorJobOciAiDocumentProcessorJob.id())
            .build());

    }
}

    variables:
  testProcessorJob:
    fn::invoke:
      Function: oci:AiDocument:getProcessorJob
      Arguments:
        processorJobId: ${testProcessorJobOciAiDocumentProcessorJob.id}

    Using getProcessorJob

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getProcessorJob(args: GetProcessorJobArgs, opts?: InvokeOptions): Promise<GetProcessorJobResult>
function getProcessorJobOutput(args: GetProcessorJobOutputArgs, opts?: InvokeOptions): Output<GetProcessorJobResult>
    def get_processor_job(processor_job_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetProcessorJobResult
def get_processor_job_output(processor_job_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetProcessorJobResult]
    func GetProcessorJob(ctx *Context, args *GetProcessorJobArgs, opts ...InvokeOption) (*GetProcessorJobResult, error)
func GetProcessorJobOutput(ctx *Context, args *GetProcessorJobOutputArgs, opts ...InvokeOption) GetProcessorJobResultOutput

    > Note: This function is named GetProcessorJob in the Go SDK.

    public static class GetProcessorJob 
{
    public static Task<GetProcessorJobResult> InvokeAsync(GetProcessorJobArgs args, InvokeOptions? opts = null)
    public static Output<GetProcessorJobResult> Invoke(GetProcessorJobInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetProcessorJobResult> getProcessorJob(GetProcessorJobArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:AiDocument/getProcessorJob:getProcessorJob
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ProcessorJobId string
    Processor job id.
    ProcessorJobId string
    Processor job id.
    processorJobId String
    Processor job id.
    processorJobId string
    Processor job id.
    processor_job_id str
    Processor job id.
    processorJobId String
    Processor job id.

    getProcessorJob Result

    The following output properties are available:

    CompartmentId string
    The compartment identifier.
    DisplayName string
    The display name of the processor job.
    Id string
    The id of the processor job.
    InputLocations List<GetProcessorJobInputLocation>
    The location of the inputs.
    LifecycleDetails string
    The detailed status of FAILED state.
    OutputLocations List<GetProcessorJobOutputLocation>
    The object storage location where to store analysis results.
    PercentComplete double
    How much progress the operation has made, compared to the total amount of work to be performed.
    ProcessorConfigs List<GetProcessorJobProcessorConfig>
    The configuration of a processor.
    ProcessorJobId string
    State string
    The current state of the processor job.
    TimeAccepted string
    The job acceptance time.
    TimeFinished string
    The job finish time.
    TimeStarted string
    The job start time.
    CompartmentId string
    The compartment identifier.
    DisplayName string
    The display name of the processor job.
    Id string
    The id of the processor job.
    InputLocations []GetProcessorJobInputLocation
    The location of the inputs.
    LifecycleDetails string
    The detailed status of FAILED state.
    OutputLocations []GetProcessorJobOutputLocation
    The object storage location where to store analysis results.
    PercentComplete float64
    How much progress the operation has made, compared to the total amount of work to be performed.
    ProcessorConfigs []GetProcessorJobProcessorConfig
    The configuration of a processor.
    ProcessorJobId string
    State string
    The current state of the processor job.
    TimeAccepted string
    The job acceptance time.
    TimeFinished string
    The job finish time.
    TimeStarted string
    The job start time.
    compartmentId String
    The compartment identifier.
    displayName String
    The display name of the processor job.
    id String
    The id of the processor job.
    inputLocations List<GetProcessorJobInputLocation>
    The location of the inputs.
    lifecycleDetails String
    The detailed status of FAILED state.
    outputLocations List<GetProcessorJobOutputLocation>
    The object storage location where to store analysis results.
    percentComplete Double
    How much progress the operation has made, compared to the total amount of work to be performed.
    processorConfigs List<GetProcessorJobProcessorConfig>
    The configuration of a processor.
    processorJobId String
    state String
    The current state of the processor job.
    timeAccepted String
    The job acceptance time.
    timeFinished String
    The job finish time.
    timeStarted String
    The job start time.
    compartmentId string
    The compartment identifier.
    displayName string
    The display name of the processor job.
    id string
    The id of the processor job.
    inputLocations GetProcessorJobInputLocation[]
    The location of the inputs.
    lifecycleDetails string
    The detailed status of FAILED state.
    outputLocations GetProcessorJobOutputLocation[]
    The object storage location where to store analysis results.
    percentComplete number
    How much progress the operation has made, compared to the total amount of work to be performed.
    processorConfigs GetProcessorJobProcessorConfig[]
    The configuration of a processor.
    processorJobId string
    state string
    The current state of the processor job.
    timeAccepted string
    The job acceptance time.
    timeFinished string
    The job finish time.
    timeStarted string
    The job start time.
    compartment_id str
    The compartment identifier.
    display_name str
    The display name of the processor job.
    id str
    The id of the processor job.
    input_locations Sequence[aidocument.GetProcessorJobInputLocation]
    The location of the inputs.
    lifecycle_details str
    The detailed status of FAILED state.
    output_locations Sequence[aidocument.GetProcessorJobOutputLocation]
    The object storage location where to store analysis results.
    percent_complete float
    How much progress the operation has made, compared to the total amount of work to be performed.
    processor_configs Sequence[aidocument.GetProcessorJobProcessorConfig]
    The configuration of a processor.
    processor_job_id str
    state str
    The current state of the processor job.
    time_accepted str
    The job acceptance time.
    time_finished str
    The job finish time.
    time_started str
    The job start time.
    compartmentId String
    The compartment identifier.
    displayName String
    The display name of the processor job.
    id String
    The id of the processor job.
    inputLocations List<Property Map>
    The location of the inputs.
    lifecycleDetails String
    The detailed status of FAILED state.
    outputLocations List<Property Map>
    The object storage location where to store analysis results.
    percentComplete Number
    How much progress the operation has made, compared to the total amount of work to be performed.
    processorConfigs List<Property Map>
    The configuration of a processor.
    processorJobId String
    state String
    The current state of the processor job.
    timeAccepted String
    The job acceptance time.
    timeFinished String
    The job finish time.
    timeStarted String
    The job start time.

    Supporting Types

    GetProcessorJobInputLocation

    Data string
    Raw document data with Base64 encoding.
    ObjectLocations List<GetProcessorJobInputLocationObjectLocation>
    The list of ObjectLocations.
    SourceType string
    The type of input location. The allowed values are:

    • OBJECT_STORAGE_LOCATIONS: A list of object locations in Object Storage.
    • INLINE_DOCUMENT_CONTENT: The content of an inline document.
    Data string
    Raw document data with Base64 encoding.
    ObjectLocations []GetProcessorJobInputLocationObjectLocation
    The list of ObjectLocations.
    SourceType string
    The type of input location. The allowed values are:

    • OBJECT_STORAGE_LOCATIONS: A list of object locations in Object Storage.
    • INLINE_DOCUMENT_CONTENT: The content of an inline document.
    data String
    Raw document data with Base64 encoding.
    objectLocations List<GetProcessorJobInputLocationObjectLocation>
    The list of ObjectLocations.
    sourceType String
    The type of input location. The allowed values are:

    • OBJECT_STORAGE_LOCATIONS: A list of object locations in Object Storage.
    • INLINE_DOCUMENT_CONTENT: The content of an inline document.
    data string
    Raw document data with Base64 encoding.
    objectLocations GetProcessorJobInputLocationObjectLocation[]
    The list of ObjectLocations.
    sourceType string
    The type of input location. The allowed values are:

    • OBJECT_STORAGE_LOCATIONS: A list of object locations in Object Storage.
    • INLINE_DOCUMENT_CONTENT: The content of an inline document.
    data str
    Raw document data with Base64 encoding.
    object_locations Sequence[aidocument.GetProcessorJobInputLocationObjectLocation]
    The list of ObjectLocations.
    source_type str
    The type of input location. The allowed values are:

    • OBJECT_STORAGE_LOCATIONS: A list of object locations in Object Storage.
    • INLINE_DOCUMENT_CONTENT: The content of an inline document.
    data String
    Raw document data with Base64 encoding.
    objectLocations List<Property Map>
    The list of ObjectLocations.
    sourceType String
    The type of input location. The allowed values are:

    • OBJECT_STORAGE_LOCATIONS: A list of object locations in Object Storage.
    • INLINE_DOCUMENT_CONTENT: The content of an inline document.

    GetProcessorJobInputLocationObjectLocation

    Bucket string
    The Object Storage bucket name.
    Namespace string
    The Object Storage namespace.
    Object string
    The Object Storage object name.
    Bucket string
    The Object Storage bucket name.
    Namespace string
    The Object Storage namespace.
    Object string
    The Object Storage object name.
    bucket String
    The Object Storage bucket name.
    namespace String
    The Object Storage namespace.
    object String
    The Object Storage object name.
    bucket string
    The Object Storage bucket name.
    namespace string
    The Object Storage namespace.
    object string
    The Object Storage object name.
    bucket str
    The Object Storage bucket name.
    namespace str
    The Object Storage namespace.
    object str
    The Object Storage object name.
    bucket String
    The Object Storage bucket name.
    namespace String
    The Object Storage namespace.
    object String
    The Object Storage object name.

    GetProcessorJobOutputLocation

    Bucket string
    The Object Storage bucket name.
    Namespace string
    The Object Storage namespace.
    Prefix string
    The Object Storage folder name.
    Bucket string
    The Object Storage bucket name.
    Namespace string
    The Object Storage namespace.
    Prefix string
    The Object Storage folder name.
    bucket String
    The Object Storage bucket name.
    namespace String
    The Object Storage namespace.
    prefix String
    The Object Storage folder name.
    bucket string
    The Object Storage bucket name.
    namespace string
    The Object Storage namespace.
    prefix string
    The Object Storage folder name.
    bucket str
    The Object Storage bucket name.
    namespace str
    The Object Storage namespace.
    prefix str
    The Object Storage folder name.
    bucket String
    The Object Storage bucket name.
    namespace String
    The Object Storage namespace.
    prefix String
    The Object Storage folder name.

    GetProcessorJobProcessorConfig

    DocumentType string
    The document type.
    Features List<GetProcessorJobProcessorConfigFeature>
    The types of document analysis requested.
    IsZipOutputEnabled bool
    Whether or not to generate a ZIP file containing the results.
    Language string
    The document language, abbreviated according to the BCP 47 Language-Tag syntax.
    ProcessorType string
    The type of the processor.
    DocumentType string
    The document type.
    Features []GetProcessorJobProcessorConfigFeature
    The types of document analysis requested.
    IsZipOutputEnabled bool
    Whether or not to generate a ZIP file containing the results.
    Language string
    The document language, abbreviated according to the BCP 47 Language-Tag syntax.
    ProcessorType string
    The type of the processor.
    documentType String
    The document type.
    features List<GetProcessorJobProcessorConfigFeature>
    The types of document analysis requested.
    isZipOutputEnabled Boolean
    Whether or not to generate a ZIP file containing the results.
    language String
    The document language, abbreviated according to the BCP 47 Language-Tag syntax.
    processorType String
    The type of the processor.
    documentType string
    The document type.
    features GetProcessorJobProcessorConfigFeature[]
    The types of document analysis requested.
    isZipOutputEnabled boolean
    Whether or not to generate a ZIP file containing the results.
    language string
    The document language, abbreviated according to the BCP 47 Language-Tag syntax.
    processorType string
    The type of the processor.
    document_type str
    The document type.
    features Sequence[aidocument.GetProcessorJobProcessorConfigFeature]
    The types of document analysis requested.
    is_zip_output_enabled bool
    Whether or not to generate a ZIP file containing the results.
    language str
    The document language, abbreviated according to the BCP 47 Language-Tag syntax.
    processor_type str
    The type of the processor.
    documentType String
    The document type.
    features List<Property Map>
    The types of document analysis requested.
    isZipOutputEnabled Boolean
    Whether or not to generate a ZIP file containing the results.
    language String
    The document language, abbreviated according to the BCP 47 Language-Tag syntax.
    processorType String
    The type of the processor.

    GetProcessorJobProcessorConfigFeature

    FeatureType string
    The type of document analysis requested. The allowed values are:

    • LANGUAGE_CLASSIFICATION: Detect the language.
    • TEXT_EXTRACTION: Recognize text.
    • TABLE_EXTRACTION: Detect and extract data in tables.
    • KEY_VALUE_EXTRACTION: Extract form fields.
    • DOCUMENT_CLASSIFICATION: Identify the type of document.
    GenerateSearchablePdf bool
    Whether or not to generate a searchable PDF file.
    MaxResults int
    The maximum number of results to return.
    ModelId string
    The custom model ID.
    TenancyId string
    The custom model tenancy ID when modelId represents aliasName.
    FeatureType string
    The type of document analysis requested. The allowed values are:

    • LANGUAGE_CLASSIFICATION: Detect the language.
    • TEXT_EXTRACTION: Recognize text.
    • TABLE_EXTRACTION: Detect and extract data in tables.
    • KEY_VALUE_EXTRACTION: Extract form fields.
    • DOCUMENT_CLASSIFICATION: Identify the type of document.
    GenerateSearchablePdf bool
    Whether or not to generate a searchable PDF file.
    MaxResults int
    The maximum number of results to return.
    ModelId string
    The custom model ID.
    TenancyId string
    The custom model tenancy ID when modelId represents aliasName.
    featureType String
    The type of document analysis requested. The allowed values are:

    • LANGUAGE_CLASSIFICATION: Detect the language.
    • TEXT_EXTRACTION: Recognize text.
    • TABLE_EXTRACTION: Detect and extract data in tables.
    • KEY_VALUE_EXTRACTION: Extract form fields.
    • DOCUMENT_CLASSIFICATION: Identify the type of document.
    generateSearchablePdf Boolean
    Whether or not to generate a searchable PDF file.
    maxResults Integer
    The maximum number of results to return.
    modelId String
    The custom model ID.
    tenancyId String
    The custom model tenancy ID when modelId represents aliasName.
    featureType string
    The type of document analysis requested. The allowed values are:

    • LANGUAGE_CLASSIFICATION: Detect the language.
    • TEXT_EXTRACTION: Recognize text.
    • TABLE_EXTRACTION: Detect and extract data in tables.
    • KEY_VALUE_EXTRACTION: Extract form fields.
    • DOCUMENT_CLASSIFICATION: Identify the type of document.
    generateSearchablePdf boolean
    Whether or not to generate a searchable PDF file.
    maxResults number
    The maximum number of results to return.
    modelId string
    The custom model ID.
    tenancyId string
    The custom model tenancy ID when modelId represents aliasName.
    feature_type str
    The type of document analysis requested. The allowed values are:

    • LANGUAGE_CLASSIFICATION: Detect the language.
    • TEXT_EXTRACTION: Recognize text.
    • TABLE_EXTRACTION: Detect and extract data in tables.
    • KEY_VALUE_EXTRACTION: Extract form fields.
    • DOCUMENT_CLASSIFICATION: Identify the type of document.
    generate_searchable_pdf bool
    Whether or not to generate a searchable PDF file.
    max_results int
    The maximum number of results to return.
    model_id str
    The custom model ID.
    tenancy_id str
    The custom model tenancy ID when modelId represents aliasName.
    featureType String
    The type of document analysis requested. The allowed values are:

    • LANGUAGE_CLASSIFICATION: Detect the language.
    • TEXT_EXTRACTION: Recognize text.
    • TABLE_EXTRACTION: Detect and extract data in tables.
    • KEY_VALUE_EXTRACTION: Extract form fields.
    • DOCUMENT_CLASSIFICATION: Identify the type of document.
    generateSearchablePdf Boolean
    Whether or not to generate a searchable PDF file.
    maxResults Number
    The maximum number of results to return.
    modelId String
    The custom model ID.
    tenancyId String
    The custom model tenancy ID when modelId represents aliasName.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-oci