Skip to content
API Reference
/
ai-index
/
ai_index_orgs_users_documents_search_create

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai_index_orgs_users_documents_pathways_list

Request

Description: Retrieves a list of document embeddings for a specific pathway with optional search and pagination.

Methods:

  • GET: Retrieves document embeddings that match the specified search criteria and are paginated according to offset and limit.

Parameters:

  • search (str): Search query to filter document names or URLs.
  • offset (int): Offset number for pagination.
  • limit (int): Limit number for pagination.

Returns:

  • GET: A paginated list of document embeddings with their details. { "count": 10, "next": "http://api.example.com/retriever_documents/?offset=10&limit=2", "previous": "http://api.example.com/retriever_documents/?offset=0&limit=2", "results": [ { "document_name": "Document2", "platform_key": "example_platform", "pathway": "example_pathway" } ] }

Error Responses:

  • 400 Bad Request: Invalid query parameters.
  • 404 Not Found: No document embeddings found for the specified criteria.
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
pathwaystringrequired
user_idstringrequired
Query
limitinteger

limit number

offsetinteger

Offset number

searchstringnon-empty

Search query

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/?limit=0&offset=0&search=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?offset=400&limit=100"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?offset=200&limit=100"
resultsArray of objects(RetrieverDocumentEmbedding)required
results[].​idintegerread-onlyrequired
results[].​metadataany or null
results[].​document_namestring or null
results[].​document_typestring or null
results[].​training_status(TrainingStatusEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
One of:
  • trained - Trained
  • failed - Failed
  • pending - Pending
  • untrained - Untrained
string or null(TrainingStatusEnum)
  • trained - Trained
  • failed - Failed
  • pending - Pending
  • untrained - Untrained
Enum"trained""failed""pending""untrained"
results[].​pathwaystringrequired
results[].​urlstring or null
results[].​tokensinteger or null(int64)[ -9223372036854776000 .. 9223372036854776000 ]
results[].​platform_keystringrequired
results[].​is_trainedboolean
results[].​access(AccessEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
One of:
  • public - Public
  • private - Private
string or null(AccessEnum)
  • public - Public
  • private - Private
Enum"public""private"
results[].​crawler_max_depthinteger or null[ -2147483648 .. 2147483647 ]
results[].​crawler_max_pages_limitinteger or null[ -2147483648 .. 2147483647 ]
results[].​crawler_max_concurrencyinteger or null[ -2147483648 .. 2147483647 ]
results[].​crawler_match_patternsany

List of patterns that the crawler should use to match urls. Patterns may be a glob pattern or a full regex pattern. Indicate the specified type in crawler_use_glob_matching.

results[].​crawler_use_glob_matchingboolean
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    [ … ]
  ]
}

ai_index_orgs_users_documents_search_create

Request

Retrieve resource documents similar to the given query.

This endpoint performs a semantic search to find documents that are relevant to the provided query within the specified pathway.

Args: request: The HTTP request containing the search query. org: Organization key identifier.

Returns: Response: A list of documents relevant to the search query.

Raises: ValidationError: If the request data is invalid.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Body
required
querystringrequired

The query for similarity search

pathwaystringrequired

The pathway of the docs

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-index/orgs/{org}/users/{user_id}/documents/search/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "Computational thinking",
    "pathway": "test-pathway"
  }'

Responses

Bodyapplication/json
resultsArray of objects(PageContent)required

Docs from similarity search

results[].​page_contentstringrequired

The page content

Response
application/json
{
  "results": [
    { … },
    { … }
  ]
}

ai_index_orgs_users_documents_sources_create

Request

Retrieve document sources related to a given query.

This endpoint performs a semantic search to find document sources that are relevant to the provided query within the specified pathway, and returns them along with confidence levels.

Args: request: The HTTP request containing the search query. org: Organization key identifier.

Returns: Response: A list of document sources with confidence levels.

Raises: ValidationError: If the request data is invalid.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Body
required
querystringrequired

The query for similarity search

pathwaystringrequired

The pathway of the docs

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-index/orgs/{org}/users/{user_id}/documents/sources/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "Computational thinking",
    "pathway": "test-pathway"
  }'

Responses

Bodyapplication/jsonArray [
sourcestringrequired

The source url of the docuemnt

confidence_levelnumber(double)required

The percentge confidence level of the document retrieved

]
Response
application/json
[
  [
    { … },
    { … }
  ]
]

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com