DeepFellow DOCS

DeepFellow DOCS

Start

Welcome to DeepFellow Docs Quickstart

DeepFellow API Reference

AddAttributePayload AddEntityPayload AddRelationPatternPayload AdHocImageMode ApiKeyCreate ApiKeyCreateRespose ApiKeyDeleteResponse ApiKeyObj ApiKeysList ApiResponse ApiResponseDisablePlugin ApiResponseDiscoverPlugins ApiResponseEnablePlugin ApplyPatchToolCall ApplyPatchToolCallOutput approval AssistantMessage-Input AssistantMessage-Output Attributes AttributesUpdate AudioChunkingStrategy AudioContentPart BackfillScope Base64ImageSource Base64PDFSource BaseMessage-Input BaseMessage-Output BatchFileEntry BatchSize Bias Body_add_upload_part Body_convert_text Body_create_file Body_create_token CacheControlEphemeral CacheCreation Champion ChangePassword ChatCompletionReasoningConfig ChatCompletionRequest ChatCompletionResponse ChatCompletionResponseChoice ChatCompletionUsage ChatFile ChatStreamOptions ChatTemplateKwargs Choice Chunk ChunkFragmentOut ChunkingStrategy ChunkingStrategyStatic CitationCharLocationParam CitationContentBlockLocationParam CitationPageLocationParam CitationsConfigParam CitationSearchResultLocationParam CitationWebSearchResultLocationParam Compaction ComparisonFilter CompleteUploadRequest CompletionLegacyRequest CompletionLegacyResponse CompletionLegacyStreamOptions CompletionLegacyUsage CompletionTokensDetails CompoundFilter-Input CompoundFilter-Output CompoundFilter ContainerFileCitation ContentBlockParam ContentBlockSource CreateFinetunePipelineRequest CreateFineTuningJobRequest CreateMetadataExpansionJobRequest CreateOrganization CreateOrganizationResult CreateSpeechRequest CreateSummarizationJobRequest CreateTranscriptionRequest CreateTranscriptionResponse CreateTranslationRequest CreateTranslationResponse CustomTool-Input CustomTool-Output CustomTool CustomToolCall CustomToolCallOutput CustomToolDef-Input CustomToolDef-Output CustomToolDefUpdate CustomToolInputField CustomToolOutputField CustomToolRequest DeletedVectorStore DeleteOrganizationResult DeveloperMessage-Input DeveloperMessage-Output DocumentBlockParam DocumentIngestionRecord DocumentIngestionStatus DocumentMetadataRecord DocumentRetryResponse DocumentSource DocumentStatusCounts DocumentSummaryRecord DpoHyperparameters DpoMethod-Input DpoMethod-Output DropAttributePayload DropEntityPayload DropRelationPatternPayload DropRelationPayload DynamicSettings Embedding EmbeddingConfig EmbeddingRequest EmbeddingResponse Error ErrorDetail EvalSet EvaluateRequest EvaluateResponse EvolutionPolicy ExpirationPolicy FailedFileDetail File FileCitation FileContentPart FileCounts FileDeleted FileIngestResponse FilePath FileSearchResult FileSearchToolCall FileSearchToolDef-Input FileSearchToolDef-Output FileSearchToolDefUpdate FilesList FileTextFormat FindInPage FinetunePipeline FinetunePipelineList FinetunePipelinesConfig FinetuneRun FinetuneRunList FinetuneRunStatus FineTuningEvent FineTuningEventList FineTuningJob FineTuningJobList FineTuningJobStatus FineTuningWorkerDeleteResponse FineTuningWorkerList FineTuningWorkerResponse FlatParams FunctionCallOutput FunctionCallOutputFileInput FunctionCallOutputImageInput FunctionCallOutputTextInput FunctionDef FunctionToolCall GetOrganizationResult GraphChatMessage GraphCompletionRequest GraphCompletionResponse GraphConfig GraphIngestionJob GraphIngestionStatus GraphSearchRequest GraphSearchResponse GraphSearchResultItem HealthResponse HostedToolChoice HttpInput HTTPValidationError Hyperparameters ImageBlockParam ImageContentPart ImageGenerationCall ImageGenToolDef ImageGenToolDefUpdate ImageMode ImageProcessingMode ImagesInputTokensDetails ImagesRequest ImagesResponse ImagesUsage ImageUrl IncompleteDetails InfoResponse InfraEndpoint InfraHealthResponse InfraInfo InfraMcpToolDef InfraMcpToolDefUpdate InputAudio InputFile InputImage InputImageMask InputMessage InputText Invitation InvitationAccept InvitationCreate InvitationRegister InvitationTokenValidation ItemReference JobMetadata json_type JsonObjectFormat JsonSchemaFormat KnowledgeCompressionPolicy KnowledgeCompressionRecord KnowledgeCompressionStatus KnowledgeGraphPolicy LastError LastErrorCode LearningRateMultiplier ListInvitationsResult ListOrganizationsResult ListUsers LoginModel LoginResult LogoutResult Logprobs LogProbs LogprobsDetail Max512Str Max64Str McpAllowedToolsFilter McpApprovalRequest McpApprovalResponse McpListTools McpRequireApproval McpServerToolsResponse McpToolCall McpToolChoice McpToolData McpToolDef McpToolDefUpdate McpToolSummary McpTransportType MediaType MeResult Message MessageParam MessagesRequest MessagesResponse MessagesRole MessagesTool MessagesUsage MessagesUserLocation Metadata-Output MetadataExpansionDocumentStatus MetadataExpansionJob MetadataExpansionJobStatus MetadataFieldSpec Method-Input Method-Output MigrationFileCounts MigrationState MigrationStatusResponse MigrationTarget MinP ModelList ModelListCompatible ModelObject ModelObjectCompatible ModelProps NEpochs NightshiftQueueGroup Offset OllamaChatMessage OllamaChatRequest OllamaChatResponse OllamaChatToolCall OllamaChatToolCallFunction OllamaOptions OllamaResponseChatMessage OllamaToolDefinition OllamaToolFunction OntologyAttributeSpec OntologyChangeApplyRequest OntologyChangeApplyResponse OntologyChangeCreateRequest OntologyChangeOp OntologyChangeOrigin OntologyChangeResponse OntologyChangeResult OntologyChangeRisk OntologyChangeStatus OntologyChangeUpdateRequest OntologyDraftUpdateRequest OntologyDryRunResult OntologyEvolutionPolicyBody OntologyPresetId OntologyPresetResponse OntologyProposeRequest OntologyRestoreResponse OntologyState OntologyVersionResponse OpenPage OperationCreateFile OperationDeleteFile OperationUpdateFile Organization OrganizationApiKeyCreate OrganizationApiKeyCreateResponse OrganizationApiKeyDeleteResponse OrganizationApiKeyList OrganizationApiKeyObj OrganizationUser OrganizationUserCreate OrganizationUserDeleted OrganizationUserEdit OrganizationUserList output_content_type OutputMessage-Input OutputMessage-Output OutputText-Input OutputText-Output OutputTokensDetails Owner PipelineName PipelinePromotion PipelineSchedule PipelineSource PlainTextSource PluginListResponse PluginStatusResponse Project ProjectCreate ProjectList ProjectOntologyResponse ProjectStatus ProjectUpdate Prompt PromptCacheBreakpoint PromptTokensDetails Purpose QueueListResponse QueueStats RabbitMQConfig RankingOptions ReadyResponse Reasoning ReasoningConfig ReasoningContent ReasoningOutput ReasoningSummary RedactedThinkingBlock RedactedThinkingBlockParam Refusal RegisterFineTuningInfraWorkerData RegisterFineTuningUrlWorkerData RegisterFineTuningUrlWorkerSecureData RegisterFineTuningWorkerRequest ReinforcementHyperparameters ReinforcementMethod-Input ReinforcementMethod-Output RenameAttributePayload RenameEntityPayload RenameRelationPayload RepetitionDetection RepetitionPenalty RequestType RerankRequest RerankResponse RerankResultItem ResetPasswordConfirm ResetPasswordRequest ResetPasswordResponse ResponseFormat ResponsesInputTokensDetails ResponsesRequest ResponsesResponse ResponsesTextFormat ResponsesUsage ResponseTranscriptionFormat RevealedSecret RunDataset RunDecision RunEval RunInfra SafePath SafePathPart SafeRequestPath Search SearchInBody SearchOut SearchResult SearchResultParam SearchSource SemanticFoldMode server__models__message__Content server__models__message__Metadata server__models__vector_store__Metadata server__models__vector_store_file__Content ServerToolUsage ServerToolUseBlockParam ServingStrategy SetDescriptionPayload SMTPConfig SortOrder SourceFile StalledFileDetail StartMigrationRequest StatusOk StopReason StopSequenceList SummarizationDocumentStatus SummarizationJob SummarizationJobStatus SummaryOptions SummaryProvenance SupervisedHyperparameters SupervisedMethod-Input SupervisedMethod-Output SystemMessage-Input SystemMessage-Output SystemOneChoiceAnswer SystemOneChoiceQuestion SystemOneNoulAnswer SystemOneNoulQuestion SystemOneRequest SystemOneResponse SystemOneScoreAnswer SystemOneScoreQuestion SystemOneUsage TextBlock TextBlockParam TextCitationParam TextConfig TextContentPart ThinkingBlock ThinkingBlockParam ThinkingConfigDisabled ThinkingConfigEnabled ThinkingConfigParam ThinkingTokenBudget Tool ToolBash20250124 Toolbox ToolboxCreate ToolboxList ToolboxUpdate ToolCall ToolCallFunction ToolChat ToolChoice ToolChoiceAny ToolChoiceAuto ToolChoiceNone ToolChoiceTool ToolFunction ToolInputSchema ToolMessage-Input ToolMessage-Output ToolResponse ToolResultBlockParam ToolSearchCall ToolSearchOutput-Input ToolSearchOutput-Output ToolsList ToolTextEditor20250124 ToolTextEditor20250429 ToolTextEditor20250728 ToolUnion ToolUseBlock ToolUseBlockParam TopK TopLogProb TopLogprobsDetail TranscriptionInclude TranscriptionLogprob TranscriptionUsage UpdateFinetunePipelineRequest Upload UploadCreate UploadPart UploadStatus UrlCitation URLImageSource URLPDFSource UsageBytes UsageModel User UserAttributes UserChanges UserCreate UserMessage-Input UserMessage-Output ValidationError VectorDatabase VectorDatabaseEmbedding VectorDatabaseProvider VectorDatabaseReranker VectorDatabaseSearch VectorStore VectorStoreCreate VectorStoreFile VectorStoreFileBatch VectorStoreFileBatchCreate VectorStoreFileBatchStatus VectorStoreFileCreate VectorStoreFileDeleted VectorStoreFilesList VectorStoreFileStatus VectorStoreMigration VectorStoreName VectorStoresList VectorStoreStatus VectorStoreUpdate WebhookEndpointCreate WebhookEndpointCreateResponse WebhookEndpointDeleteResponse WebhookEndpointList WebhookEndpointObj WebhookEndpointUpdate WebSearchCall-Input WebSearchCall-Output WebSearchTool20250305 WebsearchToolDef-Input WebsearchToolDef-Output WebsearchToolDefUpdate WebSearchToolRequestError WebSearchToolResultBlockContent WebSearchToolResultBlockItem WebSearchToolResultBlockParam

DeepFellow CLI Reference

Features

Toolbox Integrations Websearch Plugins Finetuning

Fundamentals

Glossary Architecture Hardware Requirements

Guides

Configuration Logs and Status Observability Authorization Webhooks DeepFellow Infra Web Panel Apple GPU on macOS DeepFellow Server Web Panel Listing Models Supported Models Custom Models Custom Service Custom Endpoints MCP Servers Image Generation Text to Speech Speech to Text Embeddings Decision Models Uploading Large Files Vector Store Embedding Migration Nightshift Background Jobs Metadata Expansion Document Summarization Fine-Tuning Pipelines Knowledge Graph Knowledge Graph Ontology AI-Readable Documentation

Tutorials

Start coding with DeepFellow Running DeepFellow on AWS Secure OpenAI Inference with DeepFellow Secure Google AI Inference with DeepFellow Secure Anthropic Inference with DeepFellow Secure Ollama Cloud Inference with DeepFellow Integrate with LangChain Integrate with BentoML Integrate with OpenCode Using Vector Stores How to Create Your RAG Create Plugins Multilingual Text to Speech Using Tools Doc Chunker

DeepFellow API ReferenceTypes

ChatTemplateKwargs

Extra keyword arguments for the chat template, e.g. `{"enable_thinking": false}`. At most 16 scalar entries.

Extra keyword arguments for the chat template, e.g. {"enable_thinking": false}. At most 16 scalar entries.

This type has no documented properties.

We use cookies on our website. We use them to ensure proper functioning of the site and, if you agree, for purposes such as analytics, marketing, and targeting ads.

ChatStreamOptions

Previous Page

Choice

Represents a single completion choice.