Perform AI assistive search within project version

Updated on Dec 24, 2024
Published on Apr 27, 2024

5 minute(s) read

Anand Murali

Post

/v2/ProjectVersions/ask-eddy

Security

API Key

Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Body parameters

object

prompt

string | null

version_id

string | null

language_code

string | null

enable_citation

boolean

Responses

200

Success

Success status response

This is sample response for this endpoint.

{
  "prompt": "How to configure single sign-on in Document360?",
  "result": "To configure Single Sign On in Document360, follow these steps:


    Access the Azure AD portal and log in to your Microsoft Azure account.

    Add your application by logging in to your Azure account, visiting the Azure portal page, and selecting the New application option.

    Navigate to Document360 portal, select Settings → Users Security → SAML/OpenID → SAML, and set up your application by copying the parameters from Document360 to the Azure AD portal.

    Configure SAML based SSO settings by copying and pasting values between Document360 and Azure AD portal.

    Test the configuration by logging into Document360 using the credentials added to the registered application.

\",\r\n",
  "reference_articles": [
    {
      "id": null,
      "citation_id": null,
      "category_id": "807cafd4-5d9b-4be6-becd-906f1509b0db",
      "category_title": "SAML",
      "category_slug": "saml",
      "version_name": "Document360 2.0",
      "version_slug": "help",
      "article_id": "fb0444b1-6ff6-41dc-b68b-93e86c0470cc",
      "article_title": "SAML SSO with Azure AD",
      "article_slug": "saml-sso-with-azure-ad",
      "version_display_name": null,
      "language_code": null,
      "data_source_type": 0,
      "external_source_link": null,
      "external_source_name": null,
      "external_source_id": null
    },
    {
      "id": null,
      "citation_id": null,
      "category_id": "807cafd4-5d9b-4be6-becd-906f1509b0db",
      "category_title": "SAML",
      "category_slug": "saml",
      "version_name": "Document360 2.0",
      "version_slug": "help",
      "article_id": "4a88b443-fbdb-4dc7-882a-e802bb9de6e9",
      "article_title": "Identity Provider (IdP) initiated login",
      "article_slug": "idp-initiated-login",
      "version_display_name": null,
      "language_code": null,
      "data_source_type": 0,
      "external_source_link": null,
      "external_source_name": null,
      "external_source_id": null
    },
    {
      "id": null,
      "citation_id": null,
      "category_id": null,
      "category_title": null,
      "category_slug": null,
      "version_name": null,
      "version_slug": null,
      "article_id": null,
      "article_title": null,
      "article_slug": null,
      "version_display_name": null,
      "language_code": null,
      "data_source_type": 1,
      "external_source_link": "https://example.com/",
      "external_source_name": "Example source",
      "external_source_id": null
    }
  ],
  "limit_exceeded": false,
  "analytics_id": "8ac6020b-d329-4968-b562-5497c88e65a6",
  "remaining_credits": 10,
  "extension_data": null,
  "context": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": [],
  "feature_explorer_status": null,
  "custom_page_element": null
}

Expand All

object

prompt

string | null

result

string | null

reference_articles

Array of object (VectorSearchReferenceArticles) | null

object

string | null

citation_id

string | null

category_id

string | null

category_title

string | null

category_slug

string | null

version_name

string | null

version_slug

string | null

article_id

string | null

article_title

string | null

article_slug

string | null

version_display_name

string | null

language_code

string | null

data_source_type

integer (int32)

Valid values[ 0, 1 ]

external_source_link

string | null

external_source_name

string | null

external_source_id

string | null

limit_exceeded

boolean

analytics_id

string | null

remaining_credits

integer (int32)

extension_data

object | null

context

object | null

extension_data

object | null

caller_reference

string | null

success

boolean

errors

Array of object (BaseError) | null

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

feature_explorer_status

object | null

feature_usage_score

number (double)

section

integer (int32)

Valid values[ 0, 1, 2, 3, 4, 5 ]

feature_id

string | null

feature_name

integer (int32)

Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26 ]

advanced_feature_user_role

integer (int32)

Valid values[ 0, 1, 2 ]

feature_explorer_user_analytics

object | null

string | null

project_id

string | null

user_id

string | null

trophy_status

object | null

first

boolean

second

boolean

third

boolean

fourth

boolean

show_default

boolean

show_advanced_section_popup

boolean

hide_popup

boolean

hide_popup_date

string (date-time)

is_advanced_section_unlocked

boolean

usage_score

number (double)

features

Array of object (FeatureAnalytics) | null

object

section

integer (int32)

Valid values[ 0, 1, 2, 3, 4, 5 ]

feature_name

integer (int32)

Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26 ]

is_feature_explored

boolean

time_stamp

string (date-time)

is_closed_content_reuse_info

boolean

custom_page_element

object | null

element_type

integer (int32)

Valid values[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38 ]

element_name

string | null

element_guid

string | null

display_name

string | null

view_styles

object | null

property*

view_properties

object | null

property*

editable_properties

Array of object (FormEditableProperties) | null

object

element_name

string | null

element_type

integer (int32) | null

Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8 ]

label

string | null

value

string | null

view_form_control

object | null

property_key

string | null

is_children

integer (int32)

view_type

string | null

element_name

string | null

is_children_root

boolean

element_type

string | null

inverted_value

boolean

is_dirty

boolean

editable_properties

object | null Recursive

element_guid

string | null

children

Array of object (FormEditableProperties) | null

object Recursive

edit_component_style_properties

object | null

property*

edit_component_properties

object | null

property*

children

Array of object (UIElement) | null

object Recursive

400

Bad Request

Invalid prompt

Kindly ensure the prompt is not empty and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Prompt should not be empty",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Invalid project version ID

Kindly ensure the project version ID is not empty and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Project version ID should not be empty",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Invalid language code

Kindly ensure the language code is not empty and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Language Code should not be empty",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Public API access is disabled

Kindly ensure the public API is enabled and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "API access is disabled. Please contact your project administrator.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Expand All

object

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

Was this article helpful?