View as Markdown
Codeq Natural Language Processing API icon

Codeq Natural Language Processing API ACTION

Analyze Document

Receives a text and returns a JSON object containing a list of analyzed sentences. See the docs here
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Codeq Natural Language Processing API account once, then configure and run Analyze Document from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "codeq_natural_language_processing_api-analyze-document",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    codeq_natural_language_processing_api: { authProvisionId: "apn_xxxxxxx" },
    sentences: ["Sentences"],
    pipeline: ["Pipeline"],
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Analyze Document inputs
Property Type Description
sentences Sentences string[]
A list of strings to be analyzed.
Required
pipeline Pipeline string[]
A list of strings indicating the specific NLP annotators to apply.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
codeq_natural_language_processing_api-analyze-document
Version
0.0.2
App
Codeq Natural Language Processing API
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes