Unprocessable Entity

name

string

:name

subject

chunks

collections

communities

conversations

documents

entities

graphs

indices

prompts

relationships

retrieval

system

users

AgentResponse

BaseModel

BranchResponse

ChunkResponse

ChunkSearchResult

ChunkSearchSettings

CollectionResponse

CombinedSearchResponse

Community

CommunityId

ConversationResponse

DocumentResponse

DocumentType

Entity

EntityDescriptionEmbedding

EntityMetadata

GenerationConfig

GenerationConfigResponseFormat

GenericBooleanResponse

GenericMessageResponse

GraphResponse

GraphSearchResult

GraphSearchResultContent

GraphSearchSettings

HttpValidationError

HybridSearchSettings

IndexArgsHnsw

IndexArgsIvfFlat

IndexConfig

IndexConfigIndexArguments

IndexMeasure

IngestionMode

IngestionResponse

IngestionStatus

KgCommunityResult

KgCreationSettings

KgEntityResult

KgExtractionStatus

KgGlobalResult

KgRelationshipResult

KgRunType

KgSearchResultType

ListVectorIndicesResponse

LogEntry

LogResponse

Message

MessageResponse

MessageRole

MessageType

PaginatedResultsWrapperListBranchResponse

PaginatedResultsWrapperListChunkResponse

PaginatedResultsWrapperListCollectionResponse

PaginatedResultsWrapperListCommunity

PaginatedResultsWrapperListConversationResponse

PaginatedResultsWrapperListDocumentResponse

PaginatedResultsWrapperListEntity

PaginatedResultsWrapperListGraphResponse

PaginatedResultsWrapperListPromptResponse

PaginatedResultsWrapperListRelationship

PaginatedResultsWrapperListUser

PaginatedResultsWrapperListVectorIndicesResponse

PromptResponse

Relationship

RelationshipDescriptionEmbedding

RelationshipMetadata

ResultsWrapperAgentResponse

ResultsWrapperChunkResponse

ResultsWrapperCollectionResponse

ResultsWrapperCombinedSearchResponse

ResultsWrapperCommunity

ResultsWrapperConversationResponse

ResultsWrapperDocumentResponse

ResultsWrapperEntity

ResultsWrapperGenericBooleanResponse

ResultsWrapperGenericMessageResponse

ResultsWrapperGraphResponse

ResultsWrapperIngestionResponse

ResultsWrapperListChunkSearchResult

ResultsWrapperListLogResponse

ResultsWrapperListMessageResponse

ResultsWrapperMessageResponse

ResultsWrapperPromptResponse

ResultsWrapperRelationship

ResultsWrapperServerStats

ResultsWrapperSettingsResponse

ResultsWrapperTokenResponse

ResultsWrapperUser

SearchMode

SearchSettings

ServerStats

SettingsResponse

Token

TokenResponse

User

ValidationError

ValidationErrorLocItem

VectorTableName

The most advanced AI retrieval system. Containerized, Retrieval-Augmented Generation (RAG) with a RESTful API.

1	from r2r import R2RClient
2
3	client = R2RClient("http://localhost:7272")
4	# when using auth, do client.login(...)
5
6	response = client.graphs.get(
7	collection_id="d09dedb1-b2ab-48a5-b950-6e1f464d83e7"
8	)

1	{
2	"results": {
3	"id": "id",
4	"collection_id": "collection_id",
5	"name": "name",
6	"status": "status",
7	"created_at": "2024-01-15T09:30:00Z",
8	"updated_at": "2024-01-15T09:30:00Z",
9	"document_ids": [
10	"document_ids"
11	],
12	"description": "description"
13	}
14	}

Retrieve graph details

Path parameters

Response

Errors