Class v1.DocumentProcessorServiceClient (8.10.0)

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of
   *  Processor google.cloud.documentai.v1.Processor  or
   *  ProcessorVersion google.cloud.documentai.v1.ProcessorVersion.
   *  Format: `projects/{project}/locations/{location}/processors/{processor}`,
   *  or
   *  `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
   */
  // const name = 'abc123'
  /**
   *  The input documents for the
   *  BatchProcessDocuments google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments 
   *  method.
   */
  // const inputDocuments = {}
  /**
   *  The output configuration for the
   *  BatchProcessDocuments google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments 
   *  method.
   */
  // const documentOutputConfig = {}
  /**
   *  Whether human review should be skipped for this request. Default to
   *  `false`.
   */
  // const skipHumanReview = true
  /**
   *  Inference-time options for the process API
   */
  // const processOptions = {}
  /**
   *  Optional. The labels with user-defined metadata for the request.
   *  Label keys and values can be no longer than 63 characters
   *  (Unicode codepoints) and can only contain lowercase letters, numeric
   *  characters, underscores, and dashes. International characters are allowed.
   *  Label values are optional. Label keys must start with a letter.
   */
  // const labels = [1,2,3,4]

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callBatchProcessDocuments() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.batchProcessDocuments(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callBatchProcessDocuments();

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of
   *  Processor google.cloud.documentai.v1.Processor  or
   *  ProcessorVersion google.cloud.documentai.v1.ProcessorVersion.
   *  Format: `projects/{project}/locations/{location}/processors/{processor}`,
   *  or
   *  `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
   */
  // const name = 'abc123'
  /**
   *  The input documents for the
   *  BatchProcessDocuments google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments 
   *  method.
   */
  // const inputDocuments = {}
  /**
   *  The output configuration for the
   *  BatchProcessDocuments google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments 
   *  method.
   */
  // const documentOutputConfig = {}
  /**
   *  Whether human review should be skipped for this request. Default to
   *  `false`.
   */
  // const skipHumanReview = true
  /**
   *  Inference-time options for the process API
   */
  // const processOptions = {}
  /**
   *  Optional. The labels with user-defined metadata for the request.
   *  Label keys and values can be no longer than 63 characters
   *  (Unicode codepoints) and can only contain lowercase letters, numeric
   *  characters, underscores, and dashes. International characters are allowed.
   *  Label values are optional. Label keys must start with a letter.
   */
  // const labels = [1,2,3,4]

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callBatchProcessDocuments() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.batchProcessDocuments(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callBatchProcessDocuments();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor resource name to be deleted.
   */
  // const name = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callDeleteProcessor() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.deleteProcessor(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteProcessor();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor version resource name to be deleted.
   */
  // const name = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callDeleteProcessorVersion() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.deleteProcessorVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteProcessorVersion();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor version resource name to be deployed.
   */
  // const name = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callDeployProcessorVersion() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.deployProcessorVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeployProcessorVersion();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor resource name to be disabled.
   */
  // const name = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callDisableProcessor() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.disableProcessor(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDisableProcessor();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor resource name to be enabled.
   */
  // const name = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callEnableProcessor() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.enableProcessor(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callEnableProcessor();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the
   *  ProcessorVersion google.cloud.documentai.v1.ProcessorVersion  to
   *  evaluate.
   *  `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
   */
  // const processorVersion = 'abc123'
  /**
   *  Optional. The documents used in the evaluation. If unspecified, use the
   *  processor's dataset as evaluation input.
   */
  // const evaluationDocuments = {}

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callEvaluateProcessorVersion() {
    // Construct request
    const request = {
      processorVersion,
    };

    // Run request
    const [operation] = await documentaiClient.evaluateProcessorVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callEvaluateProcessorVersion();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  An inline document proto.
   */
  // const inlineDocument = {}
  /**
   *  Required. The resource name of the
   *  HumanReviewConfig google.cloud.documentai.v1.HumanReviewConfig  that the
   *  document will be reviewed with.
   */
  // const humanReviewConfig = 'abc123'
  /**
   *  Whether the validation should be performed on the ad-hoc review request.
   */
  // const enableSchemaValidation = true
  /**
   *  The priority of the human review task.
   */
  // const priority = {}
  /**
   *  The document schema of the human review task.
   */
  // const documentSchema = {}

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callReviewDocument() {
    // Construct request
    const request = {
      humanReviewConfig,
    };

    // Run request
    const [operation] = await documentaiClient.reviewDocument(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callReviewDocument();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the
   *  Processor google.cloud.documentai.v1.Processor  to change default
   *  version.
   */
  // const processor = 'abc123'
  /**
   *  Required. The resource name of child
   *  ProcessorVersion google.cloud.documentai.v1.ProcessorVersion  to use as
   *  default. Format:
   *  `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}`
   */
  // const defaultProcessorVersion = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callSetDefaultProcessorVersion() {
    // Construct request
    const request = {
      processor,
      defaultProcessorVersion,
    };

    // Run request
    const [operation] = await documentaiClient.setDefaultProcessorVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callSetDefaultProcessorVersion();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Options to control Custom Document Extraction (CDE) Processor.
   */
  // const customDocumentExtractionOptions = {}
  /**
   *  Options to control foundation model tuning of a processor.
   */
  // const foundationModelTuningOptions = {}
  /**
   *  Required. The parent (project, location and processor) to create the new
   *  version for. Format:
   *  `projects/{project}/locations/{location}/processors/{processor}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The processor version to be created.
   */
  // const processorVersion = {}
  /**
   *  Optional. The schema the processor version will be trained with.
   */
  // const documentSchema = {}
  /**
   *  Optional. The input data used to train the
   *  ProcessorVersion google.cloud.documentai.v1.ProcessorVersion.
   */
  // const inputData = {}
  /**
   *  Optional. The processor version to use as a base for training. This
   *  processor version must be a child of `parent`. Format:
   *  `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
   */
  // const baseProcessorVersion = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callTrainProcessorVersion() {
    // Construct request
    const request = {
      parent,
      processorVersion,
    };

    // Run request
    const [operation] = await documentaiClient.trainProcessorVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callTrainProcessorVersion();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor version resource name to be undeployed.
   */
  // const name = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callUndeployProcessorVersion() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.undeployProcessorVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUndeployProcessorVersion();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent (project and location) under which to create the
   *  processor. Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The processor to be created, requires
   *  Processor.type google.cloud.documentai.v1.Processor.type  and
   *  Processor.display_name google.cloud.documentai.v1.Processor.display_name 
   *  to be set. Also, the
   *  Processor.kms_key_name google.cloud.documentai.v1.Processor.kms_key_name 
   *  field must be set if the processor is under CMEK.
   */
  // const processor = {}

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callCreateProcessor() {
    // Construct request
    const request = {
      parent,
      processor,
    };

    // Run request
    const response = await documentaiClient.createProcessor(request);
    console.log(response);
  }

  callCreateProcessor();

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor resource name to be deleted.
   */
  // const name = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callDeleteProcessor() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.deleteProcessor(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteProcessor();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor version resource name to be deleted.
   */
  // const name = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callDeleteProcessorVersion() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.deleteProcessorVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteProcessorVersion();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor version resource name to be deployed.
   */
  // const name = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callDeployProcessorVersion() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.deployProcessorVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeployProcessorVersion();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor resource name to be disabled.
   */
  // const name = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callDisableProcessor() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.disableProcessor(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDisableProcessor();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The processor resource name to be enabled.
   */
  // const name = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callEnableProcessor() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await documentaiClient.enableProcessor(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callEnableProcessor();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the
   *  ProcessorVersion google.cloud.documentai.v1.ProcessorVersion  to
   *  evaluate.
   *  `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
   */
  // const processorVersion = 'abc123'
  /**
   *  Optional. The documents used in the evaluation. If unspecified, use the
   *  processor's dataset as evaluation input.
   */
  // const evaluationDocuments = {}

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callEvaluateProcessorVersion() {
    // Construct request
    const request = {
      processorVersion,
    };

    // Run request
    const [operation] = await documentaiClient.evaluateProcessorVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callEvaluateProcessorVersion();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location of processor types to list.
   *  Format: `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callFetchProcessorTypes() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const response = await documentaiClient.fetchProcessorTypes(request);
    console.log(response);
  }

  callFetchProcessorTypes();

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the
   *  Evaluation google.cloud.documentai.v1.Evaluation  to get.
   *  `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`
   */
  // const name = 'abc123'

  // Imports the Documentai library
  const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;

  // Instantiates a client
  const documentaiClient = new DocumentProcessorServiceClient();

  async function callGetEvaluation() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await documentaiClient.getEvaluation(request);
    console.log(response);
  }

  callGetEvaluation();