Upload Document for Parsing with Affinda API on New Instance State Change (Instant) from Oracle Cloud Infrastructure API

Pipedream makes it easy to connect APIs for Affinda, Oracle Cloud Infrastructure and 2,800+ other apps remarkably fast.

Trigger workflow on

New Instance State Change (Instant) from the Oracle Cloud Infrastructure API

Next, do this

Upload Document for Parsing with the Affinda API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Oracle Cloud Infrastructure trigger and Affinda action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Instance State Change (Instant) trigger
1. Connect your Oracle Cloud Infrastructure account
2. Select a Compartment ID
3. Select a Instance ID
Configure the Upload Document for Parsing action
1. Connect your Affinda account
2. Select a Organization
3. Select a Workspace
4. Select a Collection
5. Configure URL
6. Optional- Configure Wait
7. Optional- Configure Identifier
8. Optional- Configure File Name
9. Optional- Configure Expiry Time
10. Optional- Configure Language
11. Optional- Configure Reject Duplicates
12. Optional- Configure Region Bias
13. Optional- Configure Low Priority
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Instance State Change (Instant) on Oracle Cloud Infrastructure

Description:Emit new event when a compute instance changes state (e.g., from stopped to running). This requires instance OCID and proper event rules set up in Oracle Cloud Infrastructure. [See the documentation](https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/Rule/CreateRule).

Version:0.0.1

Key:oracle_cloud_infrastructure-new-instance-state-change-instant

View on GitHub

Trigger Code#

import common from "../common/webhook.mjs";
import events from "../common/events.mjs";

export default {
  ...common,
  key: "oracle_cloud_infrastructure-new-instance-state-change-instant",
  name: "New Instance State Change (Instant)",
  description: "Emit new event when a compute instance changes state (e.g., from stopped to running). This requires instance OCID and proper event rules set up in Oracle Cloud Infrastructure. [See the documentation](https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/Rule/CreateRule).",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    instanceId: {
      propDefinition: [
        common.props.app,
        "instanceId",
        ({ compartmentId }) => ({
          compartmentId,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    getTopicName() {
      return `new-instance-state-change-${Date.now()}`;
    },
    // https://docs.oracle.com/en-us/iaas/Content/Events/Concepts/filterevents.htm
    getCondition() {
      return JSON.stringify({
        eventType: [
          events.COMPUTE.INSTANCE_ACTION_BEGIN,
          events.COMPUTE.INSTANCE_ACTION_END,
          events.COMPUTE.CHANGE_INSTANCE_COMPARTMENT_BEGIN,
          events.COMPUTE.CHANGE_INSTANCE_COMPARTMENT_END,
          events.COMPUTE.INSTANCE_FAILED,
          events.COMPUTE.LAUNCH_INSTANCE_BEGIN,
          events.COMPUTE.LAUNCH_INSTANCE_END,
          events.COMPUTE.LIVE_MIGRATE_BEGIN,
          events.COMPUTE.LIVE_MIGRATE_END,
          events.COMPUTE.INSTANCE_PREEMPTION_ACTION,
          events.COMPUTE.SCHEDULE_MAINTENANCE,
          events.COMPUTE.TERMINATE_INSTANCE_BEGIN,
          events.COMPUTE.TERMINATE_INSTANCE_END,
          events.COMPUTE.UPDATE_INSTANCE_BEGIN,
          events.COMPUTE.UPDATE_INSTANCE_END,
        ],
        data: {
          resourceId: this.instanceId,
        },
      });
    },
    generateMeta(resource) {
      return {
        id: resource.eventID,
        summary: `Instance state changed: ${resource.data?.resourceName}`,
        ts: Date.parse(resource.eventTime),
      };
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Oracle Cloud Infrastructure	`app`	`app`	This component uses the Oracle Cloud Infrastructure app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Compartment ID	`compartmentId`	`string`	Select a value from the drop down menu.
Instance ID	`instanceId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Oracle Cloud Infrastructure uses API keys for authentication. When you connect your Oracle Cloud Infrastructure account, Pipedream securely stores the keys so you can easily authenticate to Oracle Cloud Infrastructure APIs in both code and no-code steps.

To retrieve your Region, Private Key, and FIngerprint,

Navigate to your Oracle Cloud Infrastructure account using Oracle Cloud Console and sign in
Expand the navigation menu on the top left with the three horizontal lines
Click "Identity & Security"
Select "Identity" > "Domains"
Click on one of your domains available
Go to "Users"
Open one of your users
Go to "Resources" > "API Keys"

About Oracle Cloud Infrastructure#

The next-generation cloud designed to run any application, faster and more securely, for less.

Action#

Upload Document for Parsing on Affinda

Description:Uploads a document for parsing. [See docs here](https://docs.affinda.com/reference/createdocument)

Version:0.0.1

Key:affinda-upload-document-from-url

View on GitHub

Affinda Overview#

The Affinda API offers a suite of powerful tools for document analysis and extraction, enabling you to automate the processing of resumes, invoices, bank statements, and other documents. By parsing detailed information from documents, Affinda can transform unstructured data into structured, actionable insights. With Pipedream, you can integrate Affinda's capabilities into serverless workflows, connecting to hundreds of apps to automate tasks like candidate screening, financial data aggregation, or content management.

Action Code#

import affinda from "../../affinda.app.mjs";

export default {
  key: "affinda-upload-document-from-url",
  name: "Upload Document for Parsing",
  description: "Uploads a document for parsing. [See docs here](https://docs.affinda.com/reference/createdocument)",
  version: "0.0.1",
  type: "action",
  props: {
    affinda,
    organization: {
      propDefinition: [
        affinda,
        "organization",
      ],
    },
    workspace: {
      propDefinition: [
        affinda,
        "workspace",
        (c) => ({
          organization: c.organization,
        }),
      ],
    },
    collection: {
      propDefinition: [
        affinda,
        "collection",
        (c) => ({
          workspace: c.workspace,
        }),
      ],
    },
    url: {
      type: "string",
      label: "URL",
      description: "URL to download the document.",
    },
    wait: {
      type: "boolean",
      label: "Wait",
      description: "If `true`, will return a response only after processing has completed. If `false`, will return an empty data object which can be polled at the GET endpoint until processing is complete. Defaults to `true`.",
      optional: true,
    },
    identifier: {
      type: "string",
      label: "Identifier",
      description: "Specify a custom identifier for the document.",
      optional: true,
    },
    fileName: {
      type: "string",
      label: "File Name",
      description: "Optional filename of the file",
      optional: true,
    },
    expiryTime: {
      type: "string",
      label: "Expiry Time",
      description: "The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.",
      optional: true,
    },
    language: {
      type: "string",
      label: "Language",
      description: "Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.",
      optional: true,
    },
    rejectDuplicates: {
      type: "boolean",
      label: "Reject Duplicates",
      description: "If `true`, parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If `false`, will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.",
      optional: true,
    },
    regionBias: {
      type: "object",
      label: "Region Bias",
      description: "A JSON representation of the RegionBias object. Example: `{\"country\": \"vn\"}`",
      optional: true,
    },
    lowPriority: {
      type: "boolean",
      label: "Low Priority",
      description: "Explicitly mark this document as low priority.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (typeof this.regionBias === "string") {
      this.regionBias = JSON.parse(this.regionBias);
    }

    const response = await this.affinda.uploadDocument({
      $,
      data: {
        url: this.url,
        collection: this.collection,
        workspace: this.workspace,
        wait: this.wait,
        identifier: this.identifier,
        fileName: this.fileName,
        expiryTime: this.expiryTime,
        language: this.language,
        rejectDuplicates: this.rejectDuplicates,
        regionBias: this.regionBias,
        lowPriority: this.lowPriority,
      },
    });
    $.export("$summary", "Document uploaded successfully");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Affinda	`affinda`	`app`	This component uses the Affinda app.
Organization	`organization`	`string`	Select a value from the drop down menu.
Workspace	`workspace`	`string`	Select a value from the drop down menu.
Collection	`collection`	`string`	Select a value from the drop down menu.
URL	`url`	`string`	URL to download the document.
Wait	`wait`	`boolean`	If `true`, will return a response only after processing has completed. If `false`, will return an empty data object which can be polled at the GET endpoint until processing is complete. Defaults to `true`.
Identifier	`identifier`	`string`	Specify a custom identifier for the document.
File Name	`fileName`	`string`	Optional filename of the file
Expiry Time	`expiryTime`	`string`	The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
Language	`language`	`string`	Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.
Reject Duplicates	`rejectDuplicates`	`boolean`	If `true`, parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If `false`, will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.
Region Bias	`regionBias`	`object`	A JSON representation of the RegionBias object. Example: `{"country": "vn"}`
Low Priority	`lowPriority`	`boolean`	Explicitly mark this document as low priority.

Action Authentication#

Affinda uses API keys for authentication. When you connect your Affinda account, Pipedream securely stores the keys so you can easily authenticate to Affinda APIs in both code and no-code steps.

Generate and copy your API key from Account Settings

About Affinda#

Use AI to do your document processing, and free your team to do the real work

More Ways to Connect Affinda + Oracle Cloud Infrastructure#

Other Popular Integrations#

Create Or Update Object with Oracle Cloud Infrastructure API on New Document Parse Completed from Affinda API

Affinda + Oracle Cloud Infrastructure

Try it

Create Or Update Object with Oracle Cloud Infrastructure API on New Document Validated from Affinda API

Affinda + Oracle Cloud Infrastructure

Try it

Delete Object with Oracle Cloud Infrastructure API on New Document Parse Completed from Affinda API

Affinda + Oracle Cloud Infrastructure

Try it

Delete Object with Oracle Cloud Infrastructure API on New Document Validated from Affinda API

Affinda + Oracle Cloud Infrastructure

Try it

Upload Document for Parsing with Affinda API on New Autonomous Database Created (Instant) from Oracle Cloud Infrastructure API

Oracle Cloud Infrastructure + Affinda

Try it

Popular Triggers#

New Autonomous Database Created (Instant) from the Oracle Cloud Infrastructure API

Emit new event when a new autonomous database is created in a specified compartment. See the documentation

Try it

New Instance State Change (Instant) from the Oracle Cloud Infrastructure API

Emit new event when a compute instance changes state (e.g., from stopped to running). This requires instance OCID and proper event rules set up in Oracle Cloud Infrastructure. See the documentation

Try it

New Object Storage Object (Instant) from the Oracle Cloud Infrastructure API

Emit new event when a new object is uploaded to a specified Oracle Cloud Infrastructure Object Storage bucket. See the documentation

Try it

New Document Parse Completed from the Affinda API

Emit new event when a document parsing is completed in Affinda See docs here

Try it

New Document Validated from the Affinda API

Emit new event when a document is validated in Affinda. See docs here

Try it