Private AI Services API Data Structures

Agent

AgentChatCompletionsRequestPayload

AgentChatCompletionsResponsePayload

AgentCompletionsRequestPayload

AgentCompletionsResponsePayload

AgentCreateRequest

AgentDeleteResponse

AgentListResponse

AgentStatus

AgentStreamChatCompletionsResponsePayload

AgentStreamCompletionsResponsePayload

AgentUpdateRequest

AggregatedIndexingErrors

AggregatedIndexingErrorsList

Body_createDocument

ChatChoice

ChatCompletionsRequestPayload

ChatResponsePayload

ChatUsage

CompletionsChoice

CompletionsRequestPayload

CompletionsResponsePayload

CompletionsUsage

ConfluenceDataSourceCreateRequest

ConfluenceDataSourceCredentials

ConfluenceDataSourceCredentialsToken

ConfluenceDataSourceCredentialsUsernamePassword

ConfluenceDataSourceOptions

ConfluenceDataSourceTestConnectionRequest

DataSource

DataSourceConnectivityResult

DataSourceDetails

DataSourceListResponse

DataSourceTestConnectionResponse

DataSourceType

DataSourceUpdateRequest

DayOfWeek

DeletionStatusResponse

Document

DocumentChunksRetrievalResponse

DocumentChunksRetrievalResponseList

DocumentListResponse

DocumentMediaType

DocumentState

EmbeddingObject

EmbeddingsRequestPayload

EmbeddingsResponsePayload

EmbeddingsUsage

ErrorCode

ErrorDetail

Function

GoogleDriveDataSourceCreateRequest

GoogleDriveDataSourceTestConnectionRequest

HTTPValidationError

Index

IndexContextInfo

IndexContextMetadata

IndexCreateRequest

IndexDetails

IndexDetailsListResponse

IndexEmbeddingsSearchParams

IndexListResponse

IndexStatus

IndexTextSplitting

Indexing

IndexingError

IndexingErrorCode

IndexingErrorListResponse

IndexingErrorSource

IndexingListResponse

IndexingState

KnowledgeBase

KnowledgeBaseCreateRequest

KnowledgeBaseDataOriginType

KnowledgeBaseDataSourceState

KnowledgeBaseDetails

KnowledgeBaseIndexRefreshPolicyDaily

KnowledgeBaseIndexRefreshPolicyHourly

KnowledgeBaseIndexRefreshPolicyManual

KnowledgeBaseIndexRefreshPolicyWeekly

KnowledgeBaseListResponse

KnowledgeBaseStatus

KnowledgeBaseUpdateRequest

LinkedDataSource

LinkedDataSourceBatchCancelDeleteRequest

LinkedDataSourceBatchCancelDeleteResponse

LinkedDataSourceBatchCreateRequest

LinkedDataSourceBatchCreateResponse

LinkedDataSourceBatchDeleteRequest

LinkedDataSourceBatchDeleteResponse

LinkedDataSourceBatchError

LinkedDataSourceCreateRequest

LinkedDataSourceDeleteResponse

LinkedDataSourceListResponse

LinkedKnowledgeBase

LinkedKnowledgeBaseListResponse

OpenAIModel

OpenAIModelListResponse

RequestMessage

ResponseMessage

S3DataSourceCreateRequest

S3DataSourceCredentials

S3DataSourceOptions

S3DataSourceTestConnectionRequest

SharePointDataSourceCreateRequest

SharePointDataSourceOptions

SharePointDataSourceTestConnectionRequest

SharepointDataSourceCredentials

StreamChoice

StreamCompletionsResponsePayload

StreamDelta

StreamResponsePayload

Timezone

TimezoneOffsetListResponse

ToolCall

ValidationError