PromptAnthropicAI
Description
Sends a prompt to Anthropic, writing the response either as a FlowFile attribute or to the contents of the incoming FlowFile. The prompt may consist of pure text interaction or may include an image. Use dynamic properties to enable beta features in the Anthropic endpoint.
Tags
ai, anthropic, chat, image, prompt, text
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Web Client Service * | Web Client Service | Controller Service: WebClientServiceProvider Implementations: StandardWebClientServiceProvider | The Web Client Service to use for communicating with Anthropic | |
| Anthropic API Key * | Anthropic API Key | The API Key for authenticating to Anthropic | ||
| Prompt Type * | Prompt Type | Text |
| The type of prompt to send to Anthropic. TEXT to send a simple prompt. IMAGE to send an image first and then a prompt. Use JSON for advanced use of Anthropic's /v1/messages endpoint. |
| Image MIME Type | Image MIME Type | ${mime.type} | The MIME type of the image in the FlowFile content. Supported types are image/jpeg, image/png, image/gif, and image/webp. Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| |
| Model Name * | Model Name | claude-3-5-sonnet-20240620 | The name of the Anthropic model Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| |
| System Message | System Message | The system message to send to Anthropic. FlowFile attributes may be referenced via Expression Language, and the contents of the FlowFile may be referenced via the flowfile_content variable. E.g., ${flowfile_content} Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| User Message * | User Message | The user message to send to Anthropic. FlowFile attributes may be referenced via Expression Language, and the contents of the FlowFile may be referenced via the flowfile_content variable. E.g., ${flowfile_content}. The user message is added first, unless an image is present. Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Assistant Message | Assistant Message | The assistant message to send to Anthropic. FlowFile attributes may be referenced via Expression Language, and the contents of the FlowFile may be referenced via the flowfile_content variable. E.g., ${flowfile_content}. The assistant message is added last Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Response Format * | Response Format | Plain Text |
| The format of the response from Anthropic |
| User ID | User ID | The user id to set in the request metadata Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Stop Sequences | Stop Sequences | A comma delimited list of strings act as stop sequences. The model will halt after encountering one of the stop sequences. Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Max File Size | Max File Size | 10 MB | The maximum size of a FlowFile that can be sent to Anthropic as an image. If the FlowFile is larger than this, it will be routed to 'failure'. This property is only considered if:
| |
| Temperature | Temperature | The temperature to use for generating the response. Defaults to 1.0. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks. Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Top K | Top K | The top K value to use for generating the response. Only sample from the top K options for each subsequent token. Recommended for advanced use cases only. You usually only need to use temperature. Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Top P | Top P | The top P value to use for generating the response. Top P is for nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p.Recommended for advanced use cases only. You usually only need to use temperature. Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Max Tokens * | Max Tokens | 1000 | The maximum number of tokens to generate Supports Expression Language, using FlowFile attributes and Environment variables. This property is only considered if:
| |
| Output Strategy * | Output Strategy | FlowFile |
| Determines response output destination |
| Results Attribute * | Results Attribute | The name of the attribute to write the response to. This property is only considered if:
|
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | If unable to obtain a valid response from Anthropic, the original FlowFile will be routed to this relationship |
| retry | If a 5XX response from Anthropic is returned, the original FlowFile will be routed to this relationship |
| success | The response from Anthropic is routed to this relationship |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| anthropic.chat.completion.id | A unique id assigned to the conversation |
| anthropic.chat.completion.stop.reason | The reason that we stopped. |
| anthropic.chat.completion.stop.sequence | Which custom stop sequence was generated, if any, may be 'null'. |
| anthropic.usage.inputTokens | The number of input tokens read in the request. |
| anthropic.usage.outputTokens | The number of output tokens generated in the response. |
| filename | An updated filename for the response. |
| mime.type | The mime type of the response. |
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component requires an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.