Ask a question
Ask a question against an Ahoy Data Intelligence project and return an answer.
API documentation: https://www.ahoyams.com/marketplace/cbe0812f-2def-46ec-a73c-788f97ff2c2a#description/introduction
Application
- Ahoy Data Intelligence
Inputs (what you have)
| Name | Description | Data Type | Required? | Example |
|---|---|---|---|---|
| Project name | Name of the Ahoy Data Intelligence project to query | Text (Short) | Yes | Wrk Product Knowledge |
| Question | Question or request to answer using the selected project's knowledge | Text (Long) | Yes | Which case studies apply to accounts payable automation? |
| Conversation mode | Whether to start a new conversation or continue an existing conversation. Defaults to New conversation | Choice list | No | New conversation |
| Conversation ID | Conversation identifier from an earlier run. Required when Conversation mode is Continue conversation | Text (Short) | Conditional | thread_abc |
| Instructions | Optional guidance for how the answer should be written, such as tone, length, or focus. Provide it again when continuing a conversation if the same guidance should apply | Text (Long) | No | Answer concisely |
| Use web search | Whether to use web search in addition to the selected project's knowledge. Leave False to keep the answer grounded only in the project. Defaults to False | True/False | No | false |
Note: the value of inputs can either be a set value in the configuration of the Wrk Action within the Wrkflow, or a variable from the Data Library section. These variables in the Data Library section are the outputs of previous Wrk Actions in the Wrkflow.
Outputs (what you get)
| Name | Description | Data Type | Required? | Example |
|---|---|---|---|---|
| Answer | Answer returned for the question | Text (Long) | Yes | |
| Conversation ID | Identifier for the conversation, when available. Use it with Conversation mode = Continue conversation to continue the same conversation | Text (Short) | No | thread_abc |
| Citations | Sources or citations returned with the answer, when available | Text (Long) | No | |
| Raw response | Additional response details that are not mapped to the other outputs | Text (Long) | No |
Outcomes
| Name | Description |
|---|---|
| Success | This status is selected if the job has successfully completed. |
Requirements
- N/A