ArthurAI RAG Notebooks API
The RAG Notebooks API from ArthurAI — 4 operation(s) for rag notebooks.
OpenAPI Specification
openapi: 3.1.0
info:
title: Arthur GenAI Engine Agent Discovery RAG Notebooks API
version: 2.1.688
tags:
- name: RAG Notebooks
paths:
/api/v1/tasks/{task_id}/rag_notebooks:
post:
tags:
- RAG Notebooks
summary: Create a RAG notebook
description: Create a new RAG notebook for organizing experiments within a task
operationId: create_rag_notebook_api_v1_tasks__task_id__rag_notebooks_post
security:
- API Key: []
parameters:
- name: task_id
in: path
required: true
schema:
type: string
format: uuid
title: Task Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRagNotebookRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RagNotebookDetail'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- RAG Notebooks
summary: List RAG notebooks
description: List all RAG notebooks for a task with pagination and optional name search
operationId: list_rag_notebooks_api_v1_tasks__task_id__rag_notebooks_get
security:
- API Key: []
parameters:
- name: task_id
in: path
required: true
schema:
type: string
format: uuid
title: Task Id
- name: name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Name
- name: sort
in: query
required: false
schema:
$ref: '#/components/schemas/PaginationSortMethod'
description: Sort the results (asc/desc)
default: desc
description: Sort the results (asc/desc)
- name: page_size
in: query
required: false
schema:
type: integer
description: Page size. Default is 10. Must be greater than 0 and less than 5000.
default: 10
title: Page Size
description: Page size. Default is 10. Must be greater than 0 and less than 5000.
- name: page
in: query
required: false
schema:
type: integer
description: Page number
default: 0
title: Page
description: Page number
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RagNotebookListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/rag_notebooks/{notebook_id}:
get:
tags:
- RAG Notebooks
summary: Get RAG notebook details
description: Get detailed information about a RAG notebook including state and experiment history
operationId: get_rag_notebook_api_v1_rag_notebooks__notebook_id__get
security:
- API Key: []
parameters:
- name: notebook_id
in: path
required: true
schema:
type: string
description: RAG Notebook ID
title: Notebook Id
description: RAG Notebook ID
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RagNotebookDetail'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- RAG Notebooks
summary: Update RAG notebook metadata
description: Update RAG notebook name or description (not the state)
operationId: update_rag_notebook_api_v1_rag_notebooks__notebook_id__put
security:
- API Key: []
parameters:
- name: notebook_id
in: path
required: true
schema:
type: string
description: RAG Notebook ID
title: Notebook Id
description: RAG Notebook ID
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRagNotebookRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RagNotebookDetail'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- RAG Notebooks
summary: Delete RAG notebook
description: Delete a RAG notebook (experiments are kept)
operationId: delete_rag_notebook_api_v1_rag_notebooks__notebook_id__delete
security:
- API Key: []
parameters:
- name: notebook_id
in: path
required: true
schema:
type: string
description: RAG Notebook ID
title: Notebook Id
description: RAG Notebook ID
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/rag_notebooks/{notebook_id}/state:
get:
tags:
- RAG Notebooks
summary: Get RAG notebook state
description: Get the current state (draft configuration) of a RAG notebook
operationId: get_rag_notebook_state_api_v1_rag_notebooks__notebook_id__state_get
security:
- API Key: []
parameters:
- name: notebook_id
in: path
required: true
schema:
type: string
description: RAG Notebook ID
title: Notebook Id
description: RAG Notebook ID
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RagNotebookStateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- RAG Notebooks
summary: Set RAG notebook state
description: Set the state (draft configuration) of a RAG notebook
operationId: set_rag_notebook_state_api_v1_rag_notebooks__notebook_id__state_put
security:
- API Key: []
parameters:
- name: notebook_id
in: path
required: true
schema:
type: string
description: RAG Notebook ID
title: Notebook Id
description: RAG Notebook ID
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SetRagNotebookStateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RagNotebookDetail'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/rag_notebooks/{notebook_id}/history:
get:
tags:
- RAG Notebooks
summary: Get RAG notebook history
description: Get paginated list of experiments run from this RAG notebook
operationId: get_rag_notebook_history_api_v1_rag_notebooks__notebook_id__history_get
security:
- API Key: []
parameters:
- name: notebook_id
in: path
required: true
schema:
type: string
description: RAG Notebook ID
title: Notebook Id
description: RAG Notebook ID
- name: sort
in: query
required: false
schema:
$ref: '#/components/schemas/PaginationSortMethod'
description: Sort the results (asc/desc)
default: desc
description: Sort the results (asc/desc)
- name: page_size
in: query
required: false
schema:
type: integer
description: Page size. Default is 10. Must be greater than 0 and less than 5000.
default: 10
title: Page Size
description: Page size. Default is 10. Must be greater than 0 and less than 5000.
- name: page
in: query
required: false
schema:
type: integer
description: Page number
default: 0
title: Page
description: Page number
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RagExperimentListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
RagNotebookStateResponse:
properties:
rag_configs:
anyOf:
- items:
oneOf:
- $ref: '#/components/schemas/SavedRagConfig-Output'
- $ref: '#/components/schemas/UnsavedRagConfigResponse'
discriminator:
propertyName: type
mapping:
saved: '#/components/schemas/SavedRagConfig-Output'
unsaved: '#/components/schemas/UnsavedRagConfigResponse'
type: array
- type: 'null'
title: Rag Configs
description: List of RAG configurations
dataset_ref:
anyOf:
- $ref: '#/components/schemas/DatasetRef'
- type: 'null'
description: Dataset reference (includes name)
dataset_row_filter:
anyOf:
- items:
$ref: '#/components/schemas/NewDatasetVersionRowColumnItemRequest'
type: array
- type: 'null'
title: Dataset Row Filter
description: Optional list of column name and value filters. Only rows matching ALL specified column name-value pairs (AND condition) will be included.
eval_list:
anyOf:
- items:
$ref: '#/components/schemas/EvalRef-Output'
type: array
- type: 'null'
title: Eval List
description: List of evaluations
type: object
title: RagNotebookStateResponse
description: 'Draft state of a RAG notebook - mirrors RAG experiment config but all fields optional.
Used for responses (output).'
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
EvalVariableMapping-Input:
properties:
variable_name:
type: string
title: Variable Name
description: Name of the eval variable
source:
oneOf:
- $ref: '#/components/schemas/DatasetColumnVariableSource'
- $ref: '#/components/schemas/ExperimentOutputVariableSource'
title: Source
description: Source of the variable value
discriminator:
propertyName: type
mapping:
dataset_column: '#/components/schemas/DatasetColumnVariableSource'
experiment_output: '#/components/schemas/ExperimentOutputVariableSource'
type: object
required:
- variable_name
- source
title: EvalVariableMapping
description: Mapping of an eval variable to its source (dataset column or experiment output)
SavedRagConfig-Input:
properties:
type:
type: string
const: saved
title: Type
default: saved
setting_configuration_id:
type: string
format: uuid
title: Setting Configuration Id
description: ID of the RAG search setting configuration
version:
type: integer
title: Version
description: Version of the RAG search setting configuration
query_column:
$ref: '#/components/schemas/DatasetColumnVariableSource'
description: Dataset column to use as the RAG search query
type: object
required:
- setting_configuration_id
- version
- query_column
title: SavedRagConfig
description: Configuration for a saved RAG setting configuration version
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
RagNotebookState:
properties:
rag_configs:
anyOf:
- items:
oneOf:
- $ref: '#/components/schemas/SavedRagConfig-Input'
- $ref: '#/components/schemas/UnsavedRagConfig'
discriminator:
propertyName: type
mapping:
saved: '#/components/schemas/SavedRagConfig-Input'
unsaved: '#/components/schemas/UnsavedRagConfig'
type: array
- type: 'null'
title: Rag Configs
description: List of RAG configurations
dataset_ref:
anyOf:
- $ref: '#/components/schemas/DatasetRefInput'
- type: 'null'
description: Dataset reference (includes name)
dataset_row_filter:
anyOf:
- items:
$ref: '#/components/schemas/NewDatasetVersionRowColumnItemRequest'
type: array
- type: 'null'
title: Dataset Row Filter
description: Optional list of column name and value filters. Only rows matching ALL specified column name-value pairs (AND condition) will be included.
eval_list:
anyOf:
- items:
$ref: '#/components/schemas/EvalRef-Input'
type: array
- type: 'null'
title: Eval List
description: List of evaluations
type: object
title: RagNotebookState
description: 'Draft state of a RAG notebook - mirrors RAG experiment config but all fields optional.
Used for requests (input).'
DatasetRef:
properties:
id:
type: string
format: uuid
title: Id
description: Dataset ID
version:
type: integer
title: Version
description: Dataset version number
name:
type: string
title: Name
description: Dataset name
type: object
required:
- id
- version
- name
title: DatasetRef
description: Reference to a dataset and version (with name)
WeaviateHybridSearchSettingsConfigurationRequest:
properties:
collection_name:
type: string
title: Collection Name
description: Name of the vector collection used for the search.
limit:
anyOf:
- type: integer
- type: 'null'
title: Limit
description: Maximum number of objects to return.
include_vector:
anyOf:
- type: boolean
- type: string
- items:
type: string
type: array
- type: 'null'
title: Include Vector
description: Boolean value whether to include vector embeddings in the response or can be used to specify the names of the vectors to include in the response if your collection uses named vectors. Will be included as a dictionary in the vector property in the response.
default: false
offset:
anyOf:
- type: integer
- type: 'null'
title: Offset
description: Skips first N results in similarity response. Useful for pagination.
auto_limit:
anyOf:
- type: integer
- type: 'null'
title: Auto Limit
description: Automatically limit search results to groups of objects with similar distances, stopping after auto_limit number of significant jumps.
return_metadata:
anyOf:
- items:
type: string
enum:
- creation_time
- last_update_time
- distance
- certainty
- score
- explain_score
- is_consistent
- query_profile
type: array
- $ref: '#/components/schemas/MetadataQuery'
- type: 'null'
title: Return Metadata
description: Specify metadata fields to return.
return_properties:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Return Properties
description: Specify which properties to return for each object.
rag_provider:
type: string
const: weaviate
title: Rag Provider
default: weaviate
alpha:
type: number
title: Alpha
description: Balance between the relative weights of the keyword and vector search. 1 is pure vector search, 0 is pure keyword search.
default: 0.7
query_properties:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Query Properties
description: Apply keyword search to only a specified subset of object properties.
fusion_type:
anyOf:
- $ref: '#/components/schemas/HybridFusion'
- type: 'null'
description: Set the fusion algorithm to use. Default is Relative Score Fusion.
max_vector_distance:
anyOf:
- type: number
- type: 'null'
title: Max Vector Distance
description: Maximum threshold for the vector search component.
minimum_match_or_operator:
anyOf:
- type: integer
- type: 'null'
title: Minimum Match Or Operator
description: Minimum number of keywords that define a match. Objects returned will have to have at least this many matches. Applies to keyword search only.
and_operator:
anyOf:
- type: boolean
- type: 'null'
title: And Operator
description: Search returns objects that contain all tokens in the search string. Cannot be used with minimum_match_or_operator. Applies to keyword search only.
target_vector:
anyOf:
- type: string
- items:
type: string
type: array
- $ref: '#/components/schemas/_MultiTargetVectorJoin'
- type: 'null'
title: Target Vector
description: Specifies vector to use for vector search when using named vectors.
search_kind:
type: string
const: hybrid_search
title: Search Kind
default: hybrid_search
type: object
required:
- collection_name
title: WeaviateHybridSearchSettingsConfigurationRequest
RagNotebookDetail:
properties:
id:
type: string
title: Id
description: Notebook ID
task_id:
type: string
title: Task Id
description: Associated task ID
name:
type: string
title: Name
description: Notebook name
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Description
created_at:
type: string
title: Created At
description: ISO timestamp when created
updated_at:
type: string
title: Updated At
description: ISO timestamp when last updated
state:
$ref: '#/components/schemas/RagNotebookStateResponse'
description: Current draft state
experiments:
items:
$ref: '#/components/schemas/RagExperimentSummary'
type: array
title: Experiments
description: History of experiments run from this notebook
type: object
required:
- id
- task_id
- name
- created_at
- updated_at
- state
- experiments
title: RagNotebookDetail
description: Detailed RAG notebook information
RagExperimentSummary:
properties:
id:
type: string
title: Id
description: Unique identifier for the experiment
name:
type: string
title: Name
description: Name of the experiment
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Description of the experiment
created_at:
type: string
title: Created At
description: ISO timestamp when experiment was created
finished_at:
anyOf:
- type: string
- type: 'null'
title: Finished At
description: ISO timestamp when experiment finished
status:
$ref: '#/components/schemas/ExperimentStatus'
description: Current status of the experiment
dataset_id:
type: string
format: uuid
title: Dataset Id
description: ID of the dataset used
dataset_name:
type: string
title: Dataset Name
description: Name of the dataset used
dataset_version:
type: integer
title: Dataset Version
description: Version of the dataset used
total_rows:
type: integer
title: Total Rows
description: Total number of test rows in the experiment
completed_rows:
type: integer
title: Completed Rows
description: Number of test rows completed successfully
failed_rows:
type: integer
title: Failed Rows
description: Number of test rows that failed
total_cost:
anyOf:
- type: string
- type: 'null'
title: Total Cost
description: Total cost of running the experiment
rag_configs:
items:
oneOf:
- $ref: '#/components/schemas/SavedRagConfig-Output'
- $ref: '#/components/schemas/UnsavedRagConfigResponse'
discriminator:
propertyName: type
mapping:
saved: '#/components/schemas/SavedRagConfig-Output'
unsaved: '#/components/schemas/UnsavedRagConfigResponse'
type: array
title: Rag Configs
description: List of RAG configurations being tested
type: object
required:
- id
- name
- created_at
- status
- dataset_id
- dataset_name
- dataset_version
- total_rows
- completed_rows
- failed_rows
- rag_configs
title: RagExperimentSummary
description: Summary of a RAG experiment
MetadataQuery:
properties:
creation_time:
type: boolean
title: Creation Time
default: false
last_update_time:
type: boolean
title: Last Update Time
default: false
distance:
type: boolean
title: Distance
default: false
certainty:
type: boolean
title: Certainty
default: false
score:
type: boolean
title: Score
default: false
explain_score:
type: boolean
title: Explain Score
default: false
is_consistent:
type: boolean
title: Is Consistent
default: false
query_profile:
type: boolean
title: Query Profile
default: false
additionalProperties: false
type: object
title: MetadataQuery
description: Define which metadata should be returned in the query's results.
WeaviateHybridSearchSettingsConfigurationResponse:
properties:
collection_name:
type: string
title: Collection Name
description: Name of the vector collection used for the search.
limit:
anyOf:
- type: integer
- type: 'null'
title: Limit
description: Maximum number of objects to return.
include_vector:
anyOf:
- type: boolean
- type: string
- items:
type: string
type: array
- type: 'null'
title: Include Vector
description: Boolean value whether to include vector embeddings in the response or can be used to specify the names of the vectors to include in the response if your collection uses named vectors. Will be included as a dictionary in the vector property in the response.
default: false
offset:
anyOf:
- type: integer
- type: 'null'
title: Offset
description: Skips first N results in similarity response. Useful for pagination.
auto_limit:
anyOf:
- type: integer
- type: 'null'
title: Auto Limit
description: Automatically limit search results to groups of objects with similar distances, stopping after auto_limit number of significant jumps.
return_metadata:
anyOf:
- items:
type: string
enum:
- creation_time
- last_update_time
- distance
- certainty
- score
- explain_score
- is_consistent
- query_profile
type: array
- $ref: '#/components/schemas/MetadataQuery'
- type: 'null'
title: Return Metadata
description: Specify metadata fields to return.
return_properties:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Return Properties
description: Specify which properties to return for each object.
rag_provider:
type: string
const: weaviate
title: Rag Provider
default: weaviate
search_kind:
type: string
const: hybrid_search
title: Search Kind
default: hybrid_search
alpha:
type: number
title: Alpha
description: Balance between the relative weights of the keyword and vector search. 1 is pure vector search, 0 is pure keyword search.
default: 0.7
query_properties:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Query Properties
description: Apply keyword search to only a specified subset of object properties.
fusion_type:
anyOf:
- $ref: '#/components/schemas/HybridFusion'
- type: 'null'
description: Set the fusion algorithm to use. Default is Relative Score Fusion.
max_vector_distance:
anyOf:
- type: number
- type: 'null'
title: Max Vector Distance
description: Maximum threshold for the vector search component.
minimum_match_or_operator:
anyOf:
- type: integer
- type: 'null'
title: Minimum Match Or Operator
description: Minimum number of keywords that define a match. Objects returned will have to have at least this many matches. Applies to keyword search only.
and_operator:
anyOf:
- type: boolean
- type: 'null'
title: And Operator
description: Search returns objects that contain all tokens in the search string. Cannot be used with minimum_match_or_operator. Applies to keyword search only.
target_vector:
anyOf:
- type: string
- items:
type: string
type: array
- $ref: '#/components/schemas/_MultiTargetVectorJoin'
- type: 'null'
title: Target Vector
description: Specifies vector to use for vector search when using named vectors.
type: object
required:
- collection_name
title: WeaviateHybridSearchSettingsConfigurationResponse
UpdateRagNotebookRequest:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: New name
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: New description
type: object
title: UpdateRagNotebookRequest
description: Request to update a RAG notebook
UnsavedRagConfigResponse:
properties:
type:
type: string
const: unsaved
title: Type
default: unsaved
unsaved_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Unsaved Id
description: Unique identifier for this unsaved RAG configuration (generated by backend if not provided)
rag_provider_id:
type: string
format: uuid
title: Rag Provider Id
description: ID of the RAG provider to use for this search
settings:
anyOf:
- $ref: '#/components/schemas/WeaviateHybridSearchSettingsConfigurationResponse'
- $ref: '#/components/schemas/WeaviateVectorSimilarityTextSearchSettingsConfigurationResponse'
- $ref: '#/components/schemas/WeaviateKeywordSearchSettingsConfigurationResponse'
title: Settings
description: RAG search settings configuration
query_column:
$ref: '#/components/schemas/DatasetColumnVariableSource'
description: Dataset column to use as the RAG search query
type: object
required:
- rag_provider_id
- settings
- query_column
title: UnsavedRagConfigResponse
description: Configuration for an unsaved RAG search setting (response version)
_MultiTargetVectorJoin:
properties:
combination:
$ref: '#/components/schemas/_MultiTargetVectorJoinEnum'
target_vectors:
items:
type: string
type: array
title: Target Vectors
weights:
anyOf:
- additionalProperties:
anyOf:
- type: number
- items:
type: number
type: array
type: object
- type: 'null'
title: Weights
type: object
required:
- combination
- target_vectors
title: _MultiTargetVectorJoin
WeaviateKeywordSearchSettingsConfigurationResponse:
properties:
collection_name:
type: string
title: Collection Name
description: Name of the vector collection used for the search.
limit:
anyOf:
- type: integer
- type: 'null'
title: Limit
description: Maximum number of objects to return.
include_vector:
anyOf:
- type: boolean
- type: string
- items:
type: string
type: array
- t
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/arthurai/refs/heads/main/openapi/arthurai-rag-notebooks-api-openapi.yml