chore: import upstream snapshot with attribution
CodeQL / Analyze (python) (push) Has been cancelled
Update Platform Components Table / update (push) Has been cancelled
Docker image release / Build base image (push) Has been cancelled
Sync docs with Docusaurus / sync (push) Has been cancelled
Tests / Check if changed (push) Has been cancelled
Tests / format (push) Has been cancelled
Tests / check-imports (push) Has been cancelled
Tests / Unit / macos-latest (push) Has been cancelled
Tests / Unit / ubuntu-latest (push) Has been cancelled
Tests / Unit / windows-latest (push) Has been cancelled
Tests / mypy (push) Has been cancelled
Tests / Integration / ubuntu-latest (push) Has been cancelled
Tests / Integration / macos-latest (push) Has been cancelled
Tests / Integration / windows-latest (push) Has been cancelled
Tests / notify-slack-on-failure (push) Has been cancelled
Tests / Mark tests as completed (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
Update Platform Components Table / update (push) Has been cancelled
Docker image release / Build base image (push) Has been cancelled
Sync docs with Docusaurus / sync (push) Has been cancelled
Tests / Check if changed (push) Has been cancelled
Tests / format (push) Has been cancelled
Tests / check-imports (push) Has been cancelled
Tests / Unit / macos-latest (push) Has been cancelled
Tests / Unit / ubuntu-latest (push) Has been cancelled
Tests / Unit / windows-latest (push) Has been cancelled
Tests / mypy (push) Has been cancelled
Tests / Integration / ubuntu-latest (push) Has been cancelled
Tests / Integration / macos-latest (push) Has been cancelled
Tests / Integration / windows-latest (push) Has been cancelled
Tests / notify-slack-on-failure (push) Has been cancelled
Tests / Mark tests as completed (push) Has been cancelled
This commit is contained in:
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: "Component Name"
|
||||
id: "component-name"
|
||||
description: "A short description of the component"
|
||||
slug: "/component-name"
|
||||
---
|
||||
|
||||
# Component Name
|
||||
|
||||
<div className="key-value-table">
|
||||
|
||||
| | |
|
||||
| --- | --- |
|
||||
| **Most common position in a pipeline** | |
|
||||
| **Mandatory init variables** | |
|
||||
| **Mandatory run variables** | |
|
||||
| **Output variables** | |
|
||||
| **API reference** | |
|
||||
| **GitHub link** | |
|
||||
| **Package name** | |
|
||||
|
||||
</div>
|
||||
|
||||
## Overview
|
||||
|
||||
*What does it do in general? For example,..?*
|
||||
|
||||
*How does it work more specifically? Are there any pitfalls to pay attention to?*
|
||||
|
||||
*(if applicable) How is it different from this other very similar component? Which one do you choose?*
|
||||
|
||||
## Usage
|
||||
|
||||
*Any mandatory imports?*
|
||||
|
||||
### On its own
|
||||
|
||||
*Code snippet on how to run a component*
|
||||
|
||||
### In a pipeline
|
||||
|
||||
*Code snippet of a component being introduced in a pipeline*
|
||||
|
||||
*There can be more than one example. Add examples of pipelines where this component would be most useful, for example RAG, doc retrieval, etc.*
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "Document Store Name"
|
||||
id: "document-store-name"
|
||||
description: "A short description of the document store"
|
||||
slug: "/document-store-name"
|
||||
---
|
||||
|
||||
# Document Store Name
|
||||
|
||||
## Description
|
||||
|
||||
*What are this Document Store features? When would a user select it, and when not?*
|
||||
|
||||
*Are there any limitations?*
|
||||
|
||||
*Users are often curious to know if a document store supports metadata filtering and sparse vectors.*
|
||||
|
||||
## Initialization
|
||||
|
||||
*Describe how to get this Document Store to work, with code samples.*
|
||||
|
||||
## Supported Retrievers
|
||||
|
||||
*Name of the supported Retriever(s).*
|
||||
|
||||
*If several – describe how to choose an appropriate one for user’s goals (perhaps, one is faster and the other is more accurate).*
|
||||
|
||||
## Link to GitHub
|
||||
|
||||
*for example [https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/gradient](https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/gradient)*
|
||||
Reference in New Issue
Block a user