> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# azure-cognitive-ai

> Azure Language AI

**Server path:** `/azure-cognitive-ai` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                        | Description                                                                                                                      |
| ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| [`azure_cognitive_ai_analyze_text`](#azure_cognitive_ai_analyze_text)                       | Request text analysis over a collection of documents.                                                                            |
| [`azure_cognitive_ai_analyze_text_cancel_job`](#azure_cognitive_ai_analyze_text_cancel_job) | Cancel a long-running Text Analysis job.                                                                                         |
| [`azure_cognitive_ai_analyze_text_job_status`](#azure_cognitive_ai_analyze_text_job_status) | Get analysis status and results                                                                                                  |
| [`azure_cognitive_ai_analyze_text_submit_job`](#azure_cognitive_ai_analyze_text_submit_job) | Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation. |

***

## azure\_cognitive\_ai\_analyze\_text

Request text analysis over a collection of documents.

**Parameters:**

| Parameter       | Type    | Required | Default | Description                                                                             |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------- |
| `showStats`     | boolean | No       | —       | (Optional) if set to true, response will contain request and document level statistics. |
| `analysisInput` | object  | Yes      | —       | Input documents to analyze.                                                             |
| `kind`          | string  | Yes      | —       | The kind of text analysis to perform.                                                   |
| `parameters`    | object  | No       | —       | Optional task parameters (e.g. modelVersion, loggingOptOut).                            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "showStats": {
        "type": "boolean",
        "description": "(Optional) if set to true, response will contain request and document level statistics."
      },
      "analysisInput": {
        "type": "object",
        "description": "Input documents to analyze.",
        "properties": {
          "documents": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "List of documents. Each document needs an 'id' (string) and 'text' (string). For non-LanguageDetection tasks, include 'language' (e.g. 'en')."
          }
        },
        "required": [
          "documents"
        ]
      },
      "kind": {
        "type": "string",
        "description": "The kind of text analysis to perform.",
        "enum": [
          "SentimentAnalysis",
          "EntityRecognition",
          "PiiEntityRecognition",
          "KeyPhraseExtraction",
          "LanguageDetection",
          "EntityLinking"
        ]
      },
      "parameters": {
        "type": "object",
        "description": "Optional task parameters (e.g. modelVersion, loggingOptOut).",
        "properties": {
          "modelVersion": {
            "type": "string",
            "description": "Model version to use (default: 'latest')."
          },
          "loggingOptOut": {
            "type": "boolean",
            "description": "If true, opt out of logging input text for troubleshooting."
          }
        }
      }
    },
    "required": [
      "PCID",
      "analysisInput",
      "kind"
    ]
  }
  ```
</Expandable>

***

## azure\_cognitive\_ai\_analyze\_text\_cancel\_job

Cancel a long-running Text Analysis job.

**Parameters:**

| Parameter | Type   | Required | Default | Description           |
| --------- | ------ | -------- | ------- | --------------------- |
| `jobId`   | string | Yes      | —       | The job ID to cancel. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "jobId": {
        "type": "string",
        "description": "The job ID to cancel."
      }
    },
    "required": [
      "PCID",
      "jobId"
    ]
  }
  ```
</Expandable>

***

## azure\_cognitive\_ai\_analyze\_text\_job\_status

Get analysis status and results

**Parameters:**

| Parameter   | Type    | Required | Default | Description                                                                             |
| ----------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------- |
| `jobId`     | string  | Yes      | —       | job ID                                                                                  |
| `showStats` | boolean | No       | —       | (Optional) if set to true, response will contain request and document level statistics. |
| `top`       | integer | No       | —       | The maximum number of resources to return from the collection.                          |
| `skip`      | integer | No       | —       | An offset into the collection of the first resource to be returned.                     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "jobId": {
        "type": "string",
        "description": "job ID"
      },
      "showStats": {
        "type": "boolean",
        "description": "(Optional) if set to true, response will contain request and document level statistics."
      },
      "top": {
        "type": "integer",
        "description": "The maximum number of resources to return from the collection."
      },
      "skip": {
        "type": "integer",
        "description": "An offset into the collection of the first resource to be returned."
      }
    },
    "required": [
      "PCID",
      "jobId"
    ]
  }
  ```
</Expandable>

***

## azure\_cognitive\_ai\_analyze\_text\_submit\_job

Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.

**Parameters:**

| Parameter       | Type      | Required | Default | Description                                                  |
| --------------- | --------- | -------- | ------- | ------------------------------------------------------------ |
| `analysisInput` | object    | Yes      | —       | Collection of input documents to be analyzed by the service. |
| `displayName`   | string    | No       | —       | Name for the task.                                           |
| `tasks`         | object\[] | Yes      | —       | List of tasks to be performed as part of the LRO.            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "analysisInput": {
        "type": "object",
        "description": "Collection of input documents to be analyzed by the service.",
        "properties": {
          "documents": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "The input documents to be analyzed."
          }
        }
      },
      "displayName": {
        "type": "string",
        "description": "Name for the task."
      },
      "tasks": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "taskName": {
              "type": "string",
              "description": "task name"
            },
            "kind": {
              "type": "string",
              "enum": [
                "SentimentAnalysis",
                "EntityRecognition",
                "PiiEntityRecognition",
                "KeyPhraseExtraction",
                "EntityLinking",
                "Healthcare",
                "CustomEntityRecognition",
                "CustomSingleLabelClassification",
                "CustomMultiLabelClassification",
                "ExtractiveSummarization",
                "AbstractiveSummarization"
              ],
              "description": "The kind of the long running analyze text tasks supported."
            }
          },
          "required": [
            "kind"
          ]
        },
        "description": "List of tasks to be performed as part of the LRO."
      }
    },
    "required": [
      "PCID",
      "analysisInput",
      "tasks"
    ]
  }
  ```
</Expandable>