Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. AiDocument
  5. ProcessorJob
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.AiDocument.ProcessorJob

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Processor Job resource in Oracle Cloud Infrastructure Ai Document service.

    Create a processor job for document analysis.

    Example Usage

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

const testProcessorJob = new oci.aidocument.ProcessorJob("test_processor_job", {
    compartmentId: compartmentId,
    inputLocation: {
        sourceType: processorJobInputLocationSourceType,
        data: processorJobInputLocationData,
        objectLocations: [{
            bucket: processorJobInputLocationObjectLocationsBucket,
            namespace: processorJobInputLocationObjectLocationsNamespace,
            object: processorJobInputLocationObjectLocationsObject,
        }],
    },
    outputLocation: {
        bucket: processorJobOutputLocationBucket,
        namespace: processorJobOutputLocationNamespace,
        prefix: processorJobOutputLocationPrefix,
    },
    processorConfig: {
        features: [{
            featureType: processorJobProcessorConfigFeaturesFeatureType,
            generateSearchablePdf: processorJobProcessorConfigFeaturesGenerateSearchablePdf,
            maxResults: processorJobProcessorConfigFeaturesMaxResults,
            modelId: testModel.id,
            tenancyId: testTenancy.id,
        }],
        processorType: processorJobProcessorConfigProcessorType,
        documentType: processorJobProcessorConfigDocumentType,
        isZipOutputEnabled: processorJobProcessorConfigIsZipOutputEnabled,
        language: processorJobProcessorConfigLanguage,
    },
    displayName: processorJobDisplayName,
});

    import pulumi
import pulumi_oci as oci

test_processor_job = oci.ai_document.ProcessorJob("test_processor_job",
    compartment_id=compartment_id,
    input_location={
        "source_type": processor_job_input_location_source_type,
        "data": processor_job_input_location_data,
        "object_locations": [{
            "bucket": processor_job_input_location_object_locations_bucket,
            "namespace": processor_job_input_location_object_locations_namespace,
            "object": processor_job_input_location_object_locations_object,
        }],
    },
    output_location={
        "bucket": processor_job_output_location_bucket,
        "namespace": processor_job_output_location_namespace,
        "prefix": processor_job_output_location_prefix,
    },
    processor_config={
        "features": [{
            "feature_type": processor_job_processor_config_features_feature_type,
            "generate_searchable_pdf": processor_job_processor_config_features_generate_searchable_pdf,
            "max_results": processor_job_processor_config_features_max_results,
            "model_id": test_model["id"],
            "tenancy_id": test_tenancy["id"],
        }],
        "processor_type": processor_job_processor_config_processor_type,
        "document_type": processor_job_processor_config_document_type,
        "is_zip_output_enabled": processor_job_processor_config_is_zip_output_enabled,
        "language": processor_job_processor_config_language,
    },
    display_name=processor_job_display_name)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := AiDocument.NewProcessorJob(ctx, "test_processor_job", &AiDocument.ProcessorJobArgs{
			CompartmentId: pulumi.Any(compartmentId),
			InputLocation: &aidocument.ProcessorJobInputLocationArgs{
				SourceType: pulumi.Any(processorJobInputLocationSourceType),
				Data:       pulumi.Any(processorJobInputLocationData),
				ObjectLocations: aidocument.ProcessorJobInputLocationObjectLocationArray{
					&aidocument.ProcessorJobInputLocationObjectLocationArgs{
						Bucket:    pulumi.Any(processorJobInputLocationObjectLocationsBucket),
						Namespace: pulumi.Any(processorJobInputLocationObjectLocationsNamespace),
						Object:    pulumi.Any(processorJobInputLocationObjectLocationsObject),
					},
				},
			},
			OutputLocation: &aidocument.ProcessorJobOutputLocationArgs{
				Bucket:    pulumi.Any(processorJobOutputLocationBucket),
				Namespace: pulumi.Any(processorJobOutputLocationNamespace),
				Prefix:    pulumi.Any(processorJobOutputLocationPrefix),
			},
			ProcessorConfig: &aidocument.ProcessorJobProcessorConfigArgs{
				Features: aidocument.ProcessorJobProcessorConfigFeatureArray{
					&aidocument.ProcessorJobProcessorConfigFeatureArgs{
						FeatureType:           pulumi.Any(processorJobProcessorConfigFeaturesFeatureType),
						GenerateSearchablePdf: pulumi.Any(processorJobProcessorConfigFeaturesGenerateSearchablePdf),
						MaxResults:            pulumi.Any(processorJobProcessorConfigFeaturesMaxResults),
						ModelId:               pulumi.Any(testModel.Id),
						TenancyId:             pulumi.Any(testTenancy.Id),
					},
				},
				ProcessorType:      pulumi.Any(processorJobProcessorConfigProcessorType),
				DocumentType:       pulumi.Any(processorJobProcessorConfigDocumentType),
				IsZipOutputEnabled: pulumi.Any(processorJobProcessorConfigIsZipOutputEnabled),
				Language:           pulumi.Any(processorJobProcessorConfigLanguage),
			},
			DisplayName: pulumi.Any(processorJobDisplayName),
		})
		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 = new Oci.AiDocument.ProcessorJob("test_processor_job", new()
    {
        CompartmentId = compartmentId,
        InputLocation = new Oci.AiDocument.Inputs.ProcessorJobInputLocationArgs
        {
            SourceType = processorJobInputLocationSourceType,
            Data = processorJobInputLocationData,
            ObjectLocations = new[]
            {
                new Oci.AiDocument.Inputs.ProcessorJobInputLocationObjectLocationArgs
                {
                    Bucket = processorJobInputLocationObjectLocationsBucket,
                    Namespace = processorJobInputLocationObjectLocationsNamespace,
                    Object = processorJobInputLocationObjectLocationsObject,
                },
            },
        },
        OutputLocation = new Oci.AiDocument.Inputs.ProcessorJobOutputLocationArgs
        {
            Bucket = processorJobOutputLocationBucket,
            Namespace = processorJobOutputLocationNamespace,
            Prefix = processorJobOutputLocationPrefix,
        },
        ProcessorConfig = new Oci.AiDocument.Inputs.ProcessorJobProcessorConfigArgs
        {
            Features = new[]
            {
                new Oci.AiDocument.Inputs.ProcessorJobProcessorConfigFeatureArgs
                {
                    FeatureType = processorJobProcessorConfigFeaturesFeatureType,
                    GenerateSearchablePdf = processorJobProcessorConfigFeaturesGenerateSearchablePdf,
                    MaxResults = processorJobProcessorConfigFeaturesMaxResults,
                    ModelId = testModel.Id,
                    TenancyId = testTenancy.Id,
                },
            },
            ProcessorType = processorJobProcessorConfigProcessorType,
            DocumentType = processorJobProcessorConfigDocumentType,
            IsZipOutputEnabled = processorJobProcessorConfigIsZipOutputEnabled,
            Language = processorJobProcessorConfigLanguage,
        },
        DisplayName = processorJobDisplayName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.AiDocument.ProcessorJob;
import com.pulumi.oci.AiDocument.ProcessorJobArgs;
import com.pulumi.oci.AiDocument.inputs.ProcessorJobInputLocationArgs;
import com.pulumi.oci.AiDocument.inputs.ProcessorJobOutputLocationArgs;
import com.pulumi.oci.AiDocument.inputs.ProcessorJobProcessorConfigArgs;
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) {
        var testProcessorJob = new ProcessorJob("testProcessorJob", ProcessorJobArgs.builder()
            .compartmentId(compartmentId)
            .inputLocation(ProcessorJobInputLocationArgs.builder()
                .sourceType(processorJobInputLocationSourceType)
                .data(processorJobInputLocationData)
                .objectLocations(ProcessorJobInputLocationObjectLocationArgs.builder()
                    .bucket(processorJobInputLocationObjectLocationsBucket)
                    .namespace(processorJobInputLocationObjectLocationsNamespace)
                    .object(processorJobInputLocationObjectLocationsObject)
                    .build())
                .build())
            .outputLocation(ProcessorJobOutputLocationArgs.builder()
                .bucket(processorJobOutputLocationBucket)
                .namespace(processorJobOutputLocationNamespace)
                .prefix(processorJobOutputLocationPrefix)
                .build())
            .processorConfig(ProcessorJobProcessorConfigArgs.builder()
                .features(ProcessorJobProcessorConfigFeatureArgs.builder()
                    .featureType(processorJobProcessorConfigFeaturesFeatureType)
                    .generateSearchablePdf(processorJobProcessorConfigFeaturesGenerateSearchablePdf)
                    .maxResults(processorJobProcessorConfigFeaturesMaxResults)
                    .modelId(testModel.id())
                    .tenancyId(testTenancy.id())
                    .build())
                .processorType(processorJobProcessorConfigProcessorType)
                .documentType(processorJobProcessorConfigDocumentType)
                .isZipOutputEnabled(processorJobProcessorConfigIsZipOutputEnabled)
                .language(processorJobProcessorConfigLanguage)
                .build())
            .displayName(processorJobDisplayName)
            .build());

    }
}

    resources:
  testProcessorJob:
    type: oci:AiDocument:ProcessorJob
    name: test_processor_job
    properties:
      compartmentId: ${compartmentId}
      inputLocation:
        sourceType: ${processorJobInputLocationSourceType}
        data: ${processorJobInputLocationData}
        objectLocations:
          - bucket: ${processorJobInputLocationObjectLocationsBucket}
            namespace: ${processorJobInputLocationObjectLocationsNamespace}
            object: ${processorJobInputLocationObjectLocationsObject}
      outputLocation:
        bucket: ${processorJobOutputLocationBucket}
        namespace: ${processorJobOutputLocationNamespace}
        prefix: ${processorJobOutputLocationPrefix}
      processorConfig:
        features:
          - featureType: ${processorJobProcessorConfigFeaturesFeatureType}
            generateSearchablePdf: ${processorJobProcessorConfigFeaturesGenerateSearchablePdf}
            maxResults: ${processorJobProcessorConfigFeaturesMaxResults}
            modelId: ${testModel.id}
            tenancyId: ${testTenancy.id}
        processorType: ${processorJobProcessorConfigProcessorType}
        documentType: ${processorJobProcessorConfigDocumentType}
        isZipOutputEnabled: ${processorJobProcessorConfigIsZipOutputEnabled}
        language: ${processorJobProcessorConfigLanguage}
      displayName: ${processorJobDisplayName}

    Create ProcessorJob Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ProcessorJob(name: string, args: ProcessorJobArgs, opts?: CustomResourceOptions);
    @overload
def ProcessorJob(resource_name: str,
                 args: ProcessorJobArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ProcessorJob(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 compartment_id: Optional[str] = None,
                 input_location: Optional[_aidocument.ProcessorJobInputLocationArgs] = None,
                 output_location: Optional[_aidocument.ProcessorJobOutputLocationArgs] = None,
                 processor_config: Optional[_aidocument.ProcessorJobProcessorConfigArgs] = None,
                 display_name: Optional[str] = None)
    func NewProcessorJob(ctx *Context, name string, args ProcessorJobArgs, opts ...ResourceOption) (*ProcessorJob, error)
    public ProcessorJob(string name, ProcessorJobArgs args, CustomResourceOptions? opts = null)
    public ProcessorJob(String name, ProcessorJobArgs args)
public ProcessorJob(String name, ProcessorJobArgs args, CustomResourceOptions options)

    type: oci:AiDocument:ProcessorJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ProcessorJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProcessorJobArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProcessorJobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProcessorJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProcessorJobArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var processorJobResource = new Oci.AiDocument.ProcessorJob("processorJobResource", new()
{
    CompartmentId = "string",
    InputLocation = new Oci.AiDocument.Inputs.ProcessorJobInputLocationArgs
    {
        SourceType = "string",
        Data = "string",
        ObjectLocations = new[]
        {
            new Oci.AiDocument.Inputs.ProcessorJobInputLocationObjectLocationArgs
            {
                Bucket = "string",
                Namespace = "string",
                Object = "string",
            },
        },
    },
    OutputLocation = new Oci.AiDocument.Inputs.ProcessorJobOutputLocationArgs
    {
        Bucket = "string",
        Namespace = "string",
        Prefix = "string",
    },
    ProcessorConfig = new Oci.AiDocument.Inputs.ProcessorJobProcessorConfigArgs
    {
        Features = new[]
        {
            new Oci.AiDocument.Inputs.ProcessorJobProcessorConfigFeatureArgs
            {
                FeatureType = "string",
                GenerateSearchablePdf = false,
                MaxResults = 0,
                ModelId = "string",
                TenancyId = "string",
            },
        },
        ProcessorType = "string",
        DocumentType = "string",
        IsZipOutputEnabled = false,
        Language = "string",
    },
    DisplayName = "string",
});

    example, err := AiDocument.NewProcessorJob(ctx, "processorJobResource", &AiDocument.ProcessorJobArgs{
	CompartmentId: pulumi.String("string"),
	InputLocation: &aidocument.ProcessorJobInputLocationArgs{
		SourceType: pulumi.String("string"),
		Data:       pulumi.String("string"),
		ObjectLocations: aidocument.ProcessorJobInputLocationObjectLocationArray{
			&aidocument.ProcessorJobInputLocationObjectLocationArgs{
				Bucket:    pulumi.String("string"),
				Namespace: pulumi.String("string"),
				Object:    pulumi.String("string"),
			},
		},
	},
	OutputLocation: &aidocument.ProcessorJobOutputLocationArgs{
		Bucket:    pulumi.String("string"),
		Namespace: pulumi.String("string"),
		Prefix:    pulumi.String("string"),
	},
	ProcessorConfig: &aidocument.ProcessorJobProcessorConfigArgs{
		Features: aidocument.ProcessorJobProcessorConfigFeatureArray{
			&aidocument.ProcessorJobProcessorConfigFeatureArgs{
				FeatureType:           pulumi.String("string"),
				GenerateSearchablePdf: pulumi.Bool(false),
				MaxResults:            pulumi.Int(0),
				ModelId:               pulumi.String("string"),
				TenancyId:             pulumi.String("string"),
			},
		},
		ProcessorType:      pulumi.String("string"),
		DocumentType:       pulumi.String("string"),
		IsZipOutputEnabled: pulumi.Bool(false),
		Language:           pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
})

    var processorJobResource = new ProcessorJob("processorJobResource", ProcessorJobArgs.builder()
    .compartmentId("string")
    .inputLocation(ProcessorJobInputLocationArgs.builder()
        .sourceType("string")
        .data("string")
        .objectLocations(ProcessorJobInputLocationObjectLocationArgs.builder()
            .bucket("string")
            .namespace("string")
            .object("string")
            .build())
        .build())
    .outputLocation(ProcessorJobOutputLocationArgs.builder()
        .bucket("string")
        .namespace("string")
        .prefix("string")
        .build())
    .processorConfig(ProcessorJobProcessorConfigArgs.builder()
        .features(ProcessorJobProcessorConfigFeatureArgs.builder()
            .featureType("string")
            .generateSearchablePdf(false)
            .maxResults(0)
            .modelId("string")
            .tenancyId("string")
            .build())
        .processorType("string")
        .documentType("string")
        .isZipOutputEnabled(false)
        .language("string")
        .build())
    .displayName("string")
    .build());

    processor_job_resource = oci.ai_document.ProcessorJob("processorJobResource",
    compartment_id="string",
    input_location={
        "source_type": "string",
        "data": "string",
        "object_locations": [{
            "bucket": "string",
            "namespace": "string",
            "object": "string",
        }],
    },
    output_location={
        "bucket": "string",
        "namespace": "string",
        "prefix": "string",
    },
    processor_config={
        "features": [{
            "feature_type": "string",
            "generate_searchable_pdf": False,
            "max_results": 0,
            "model_id": "string",
            "tenancy_id": "string",
        }],
        "processor_type": "string",
        "document_type": "string",
        "is_zip_output_enabled": False,
        "language": "string",
    },
    display_name="string")

    const processorJobResource = new oci.aidocument.ProcessorJob("processorJobResource", {
    compartmentId: "string",
    inputLocation: {
        sourceType: "string",
        data: "string",
        objectLocations: [{
            bucket: "string",
            namespace: "string",
            object: "string",
        }],
    },
    outputLocation: {
        bucket: "string",
        namespace: "string",
        prefix: "string",
    },
    processorConfig: {
        features: [{
            featureType: "string",
            generateSearchablePdf: false,
            maxResults: 0,
            modelId: "string",
            tenancyId: "string",
        }],
        processorType: "string",
        documentType: "string",
        isZipOutputEnabled: false,
        language: "string",
    },
    displayName: "string",
});

    type: oci:AiDocument:ProcessorJob
properties:
    compartmentId: string
    displayName: string
    inputLocation:
        data: string
        objectLocations:
            - bucket: string
              namespace: string
              object: string
        sourceType: string
    outputLocation:
        bucket: string
        namespace: string
        prefix: string
    processorConfig:
        documentType: string
        features:
            - featureType: string
              generateSearchablePdf: false
              maxResults: 0
              modelId: string
              tenancyId: string
        isZipOutputEnabled: false
        language: string
        processorType: string

    ProcessorJob Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ProcessorJob resource accepts the following input properties:

    CompartmentId string
    The compartment identifier.
    InputLocation ProcessorJobInputLocation
    The location of the inputs.
    OutputLocation ProcessorJobOutputLocation
    The object storage location where to store analysis results.
    ProcessorConfig ProcessorJobProcessorConfig
    The configuration of a processor.
    DisplayName string
    The display name of the processor job.
    CompartmentId string
    The compartment identifier.
    InputLocation ProcessorJobInputLocationArgs
    The location of the inputs.
    OutputLocation ProcessorJobOutputLocationArgs
    The object storage location where to store analysis results.
    ProcessorConfig ProcessorJobProcessorConfigArgs
    The configuration of a processor.
    DisplayName string
    The display name of the processor job.
    compartmentId String
    The compartment identifier.
    inputLocation ProcessorJobInputLocation
    The location of the inputs.
    outputLocation ProcessorJobOutputLocation
    The object storage location where to store analysis results.
    processorConfig ProcessorJobProcessorConfig
    The configuration of a processor.
    displayName String
    The display name of the processor job.
    compartmentId string
    The compartment identifier.
    inputLocation ProcessorJobInputLocation
    The location of the inputs.
    outputLocation ProcessorJobOutputLocation
    The object storage location where to store analysis results.
    processorConfig ProcessorJobProcessorConfig
    The configuration of a processor.
    displayName string
    The display name of the processor job.
    compartment_id str
    The compartment identifier.
    input_location aidocument.ProcessorJobInputLocationArgs
    The location of the inputs.
    output_location aidocument.ProcessorJobOutputLocationArgs
    The object storage location where to store analysis results.
    processor_config aidocument.ProcessorJobProcessorConfigArgs
    The configuration of a processor.
    display_name str
    The display name of the processor job.
    compartmentId String
    The compartment identifier.
    inputLocation Property Map
    The location of the inputs.
    outputLocation Property Map
    The object storage location where to store analysis results.
    processorConfig Property Map
    The configuration of a processor.
    displayName String
    The display name of the processor job.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProcessorJob resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    The detailed status of FAILED state.
    PercentComplete double
    How much progress the operation has made, compared to the total amount of work to be performed.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    The detailed status of FAILED state.
    PercentComplete float64
    How much progress the operation has made, compared to the total amount of work to be performed.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    The detailed status of FAILED state.
    percentComplete Double
    How much progress the operation has made, compared to the total amount of work to be performed.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    The detailed status of FAILED state.
    percentComplete number
    How much progress the operation has made, compared to the total amount of work to be performed.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    The detailed status of FAILED state.
    percent_complete float
    How much progress the operation has made, compared to the total amount of work to be performed.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    The detailed status of FAILED state.
    percentComplete Number
    How much progress the operation has made, compared to the total amount of work to be performed.
    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.

    Look up Existing ProcessorJob Resource

    Get an existing ProcessorJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ProcessorJobState, opts?: CustomResourceOptions): ProcessorJob
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        display_name: Optional[str] = None,
        input_location: Optional[_aidocument.ProcessorJobInputLocationArgs] = None,
        lifecycle_details: Optional[str] = None,
        output_location: Optional[_aidocument.ProcessorJobOutputLocationArgs] = None,
        percent_complete: Optional[float] = None,
        processor_config: Optional[_aidocument.ProcessorJobProcessorConfigArgs] = None,
        state: Optional[str] = None,
        time_accepted: Optional[str] = None,
        time_finished: Optional[str] = None,
        time_started: Optional[str] = None) -> ProcessorJob
    func GetProcessorJob(ctx *Context, name string, id IDInput, state *ProcessorJobState, opts ...ResourceOption) (*ProcessorJob, error)
    public static ProcessorJob Get(string name, Input<string> id, ProcessorJobState? state, CustomResourceOptions? opts = null)
    public static ProcessorJob get(String name, Output<String> id, ProcessorJobState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    The compartment identifier.
    DisplayName string
    The display name of the processor job.
    InputLocation ProcessorJobInputLocation
    The location of the inputs.
    LifecycleDetails string
    The detailed status of FAILED state.
    OutputLocation ProcessorJobOutputLocation
    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.
    ProcessorConfig ProcessorJobProcessorConfig
    The configuration of a processor.
    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.
    InputLocation ProcessorJobInputLocationArgs
    The location of the inputs.
    LifecycleDetails string
    The detailed status of FAILED state.
    OutputLocation ProcessorJobOutputLocationArgs
    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.
    ProcessorConfig ProcessorJobProcessorConfigArgs
    The configuration of a processor.
    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.
    inputLocation ProcessorJobInputLocation
    The location of the inputs.
    lifecycleDetails String
    The detailed status of FAILED state.
    outputLocation ProcessorJobOutputLocation
    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.
    processorConfig ProcessorJobProcessorConfig
    The configuration of a processor.
    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.
    inputLocation ProcessorJobInputLocation
    The location of the inputs.
    lifecycleDetails string
    The detailed status of FAILED state.
    outputLocation ProcessorJobOutputLocation
    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.
    processorConfig ProcessorJobProcessorConfig
    The configuration of a processor.
    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.
    input_location aidocument.ProcessorJobInputLocationArgs
    The location of the inputs.
    lifecycle_details str
    The detailed status of FAILED state.
    output_location aidocument.ProcessorJobOutputLocationArgs
    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_config aidocument.ProcessorJobProcessorConfigArgs
    The configuration of a processor.
    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.
    inputLocation Property Map
    The location of the inputs.
    lifecycleDetails String
    The detailed status of FAILED state.
    outputLocation 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.
    processorConfig Property Map
    The configuration of a processor.
    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

    ProcessorJobInputLocation, ProcessorJobInputLocationArgs

    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<ProcessorJobInputLocationObjectLocation>
    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 []ProcessorJobInputLocationObjectLocation
    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<ProcessorJobInputLocationObjectLocation>
    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 ProcessorJobInputLocationObjectLocation[]
    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 str
    Raw document data with Base64 encoding.
    object_locations Sequence[aidocument.ProcessorJobInputLocationObjectLocation]
    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<Property Map>
    The list of ObjectLocations.

    ProcessorJobInputLocationObjectLocation, ProcessorJobInputLocationObjectLocationArgs

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

    ProcessorJobOutputLocation, ProcessorJobOutputLocationArgs

    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.

    ProcessorJobProcessorConfig, ProcessorJobProcessorConfigArgs

    Features List<ProcessorJobProcessorConfigFeature>
    The types of document analysis requested.
    ProcessorType string

    The type of the processor.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DocumentType string
    The document type.
    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.
    Features []ProcessorJobProcessorConfigFeature
    The types of document analysis requested.
    ProcessorType string

    The type of the processor.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DocumentType string
    The document type.
    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.
    features List<ProcessorJobProcessorConfigFeature>
    The types of document analysis requested.
    processorType String

    The type of the processor.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    documentType String
    The document type.
    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.
    features ProcessorJobProcessorConfigFeature[]
    The types of document analysis requested.
    processorType string

    The type of the processor.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    documentType string
    The document type.
    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.
    features Sequence[aidocument.ProcessorJobProcessorConfigFeature]
    The types of document analysis requested.
    processor_type str

    The type of the processor.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    document_type str
    The document type.
    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.
    features List<Property Map>
    The types of document analysis requested.
    processorType String

    The type of the processor.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    documentType String
    The document type.
    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.

    ProcessorJobProcessorConfigFeature, ProcessorJobProcessorConfigFeatureArgs

    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.

    Import

    ProcessorJobs can be imported using the id, e.g.

    $ pulumi import oci:AiDocument/processorJob:ProcessorJob test_processor_job "id"

    To learn more about importing existing cloud resources, see Importing resources.

    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 v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci