Tools

Answer Tool

Answer the given natural language question. Please note, it only has the capability to answer questions on structured data.

The payload should contain the question, and optionally, any supplemental context that could be beneficial, such as additional information from a second query attempt after the user has provided further context.

This operation performs the exact same function as the "callAnswer" operation, but is designed to be compatible with OpenAI-style tool calls.

post/v0/aice/{orgid}/{projectid}/answerTool

Request

  • Base URL
    https://api.data.world
  • URL
    https://api.data.world/v0/aice/{orgid}/{projectid}/answerTool
  • Auth
    OAuth 2
    Authorization code: https://data.world/oauth/authorize
    Token URL: https://data.world/oauth/access_token scopes: user_api_read

Path parameters

orgidstring required

Unique identifier of the organization that owns the project. For example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld, jonloyens is the unique identifier of the owner.

projectidstring required

Unique identifier for the project. For example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld, an-intro-to-dataworld is the projectid.

Query parameters

demoboolean

Don't execute the call using the context engine. Instead, return a mock answer generated by the llm.

Request body

chatContextstring

The context of the chat so far (optional).

questionstring

A question that can be answered by structured data, written in English.

Response

default response

answerstring required
questionUrlstring
sparqlstring

Changes

No recorded changes to this operation across all 1 revision of this API.