Jun 5, 2024 · Jun 4, 2024 · Jun 5, 2024 · Jun 5, 2024 · Jun 5, 2024 · Jun 5, 2024
diff --git a/pgml-cms/docs/api/client-sdk/README.md b/pgml-cms/docs/api/client-sdk/README.md
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 #include <stdio.h>
 #include "pgml.h"

 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 // Add this code to the end of the main function from the above example.
 PipelineC * pipeline = pgml_pipelinec_new("sample_pipeline", "{\"text\": {\"splitter\": {\"model\": \"recursive_character\"},\"semantic_search\": {\"model\": \"Alibaba-NLP/gte-base-en-v1.5\"}}}");

 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 // Add this code to the end of the main function in the above example.
 char * documents_to_upsert[2] = {"{\"id\": \"Document One\", \"text\": \"document one contents...\"}", "{\"id\": \"Document Two\", \"text\": \"document two contents...\"}"};

 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 // Add this code to the end of the main function in the above example.
 r_size = 0;
 char** results = pgml_collectionc_vector_search(collection, "{\"query\": {\"fields\": {\"text\": {\"query\": \"Something about a document...\"}}}, \"limit\": 2}", pipeline, &r_size);
diff --git a/pgml-cms/docs/api/client-sdk/collections.md b/pgml-cms/docs/api/client-sdk/collections.md
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 CollectionC * collection = pgml_collectionc_new("test_collection", NULL);
 ```
 {% endtab %}
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 CollectionC * collection = pgml_collectionc_new("test_collection", CUSTOM_DATABASE_URL);
 ```
 {% endtab %}
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 char * documents[2] = {
  "{\"id\": \"document_one\", \"title\": \"Document One\", \"text\": \"Here are the contents of Document 1\", \"random_key\": \"here is some random data\"}",
  "{\"id\": \"document_two\", \"title\": \"Document Two\", \"text\": \"Here are the contents of Document 2\", \"random_key\": \"here is some random data\"}"
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 char * documents[2] = {
  "{\"id\": \"document_one\", \"title\": \"Document One\", \"text\": \"Here is some new text for document one\", \"random_key\": \"here is some random data\"}",
  "{\"id\": \"document_two\", \"title\": \"Document Two\", \"text\": \"Here is some new text for document two\", \"random_key\": \"here is some random data\"}"
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 char * documents[2] = {
  "{\"id\": \"document_one\", \"new_key\": \"this will be a new key in document one\", \"random_key\": \"this will replace old random_key\"}",
  "{\"id\": \"document_two\", \"new_key\": \"this will be a new key in document two\", \"random_key\": \"this will replace old random_key\"}"
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 unsigned long r_size = 0;
 char** documents = pgml_collectionc_get_documents(collection, "{\"limit\": 100}", &r_size);
 ```
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 unsigned long r_size = 0;
 char** documents = pgml_collectionc_get_documents(collection, "{\"limit\": 100, \"offset\": 10}", &r_size);
 ```
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 unsigned long r_size = 0;
 char** documents = pgml_collectionc_get_documents(collection, "{\"limit\": 100, \"last_row_id\": 10}", &r_size);
 ```
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 unsigned long r_size = 0;
 char** documents = pgml_collectionc_get_documents(collection, "{\"limit\": 100, \"filter\": {\"id\": {\"$eq\": \"document_one\"}}}", &r_size);
 ```
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 unsigned long r_size = 0;
 char** documents = pgml_collectionc_get_documents(collection, "{\"limit\": 100, \"offset\": 10, \"order_by\": {\"id\": \"desc\"}}", &r_size);
 ```
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 pgml_collectionc_delete_documents(collection, "{\"id\": { \"$eq\": 1}}");
 ```
 {% endtab %}
diff --git a/pgml-cms/docs/api/client-sdk/document-search.md b/pgml-cms/docs/api/client-sdk/document-search.md
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 PipelineC *pipeline = pgml_pipelinec_new("test_pipeline", "{\
    \"abstract\": {\
        \"semantic_search\": {\
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 char * results = pgml_collectionc_search(collection, "\
     \"query\": {\
        \"full_text_search\": {\
diff --git a/pgml-cms/docs/api/client-sdk/pipelines.md b/pgml-cms/docs/api/client-sdk/pipelines.md
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 PipelineC * pipeline = pgml_pipelinec_new(
  "test_pipeline",
  "{\
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 PipelineC * pipeline = pgml_pipelinec_new(
  "test_pipeline",
  "{\

 This `Pipeline` splits and embeds the `body` text enabling semantic search using vectors. This is a very popular `Pipeline` for RAG.

 ### Switching from OpenAI

 We support most every open source model on [Hugging Face](https://huggingface.co/), and OpenAI's embedding models. To use a model from OpenAI specify the `source` as `openai`, and make sure and set the environment variable `OPENAI_API_KEY`.

 {% tabs %}
 )
 ```
 {% endtab %}

 {% tab title="Rust" %}
 ```rust
 let mut pipeline = Pipeline::new(
    "test_pipeline",
    Some(
        serde_json::json!({
            "body": {
                "splitter": {"model": "recursive_character"},
                "semantic_search": {
                    "model": "text-embedding-ada-002",
                    "source": "openai"
                },
            },
        })
        .into(),
    ),
 )?;

 ```
 {% endtab %}

 {% tab title="C" %}
 ```cpp
 PipelineC * pipeline = pgml_pipelinec_new(
  "test_pipeline",
  "{\
    \"body\": {\
      \"splitter\": {\"model\": \"recursive_character\"},\
      \"semantic_search\": {\
        \"model\": \"text-embedding-ada-002\",\
        \"source\": \"openai\"\
      }\
    }\
  }"
 );
 ```
 {% endtab %}
 {% endtabs %}

 ## Customizing the Indexes
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 PipelineC * pipeline = pgml_pipelinec_new(
  "test_pipeline",
  "{\
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 pgml_collectionc_add_pipeline(collection, pipeline);
 ```
 {% endtab %}
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 PipelineC * pipeline = pgml_pipelinec_new("test_pipeline",  NULL);
 ```
 {% endtab %}
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 CollectionC * collection = pgml_collectionc_new("test_collection", NULL);
 PipelineC * pipeline = pgml_pipelinec_new("test_pipeline",  NULL);
 pgml_collectionc_disable_pipeline(collection, pipeline);
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 CollectionC * collection = pgml_collectionc_new("test_collection", NULL);
 PipelineC * pipeline = pgml_pipelinec_new("test_pipeline",  NULL);
 pgml_collectionc_enable_pipeline(collection, pipeline);
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 CollectionC * collection = pgml_collectionc_new("test_collection", NULL);
 PipelineC * pipeline = pgml_pipelinec_new("test_pipeline",  NULL);
 pgml_collectionc_remove_pipeline(collection, pipeline);
diff --git a/pgml-cms/docs/api/client-sdk/search.md b/pgml-cms/docs/api/client-sdk/search.md
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 PipelineC *pipeline = pgml_pipelinec_new("test_pipeline", "{\
    \"abstract\": {\
        \"semantic_search\": {\
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 r_size = 0;
 char **results = pgml_collectionc_vector_search(collection, "{\
  \"query\": {\
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 r_size = 0;
 char **results = pgml_collectionc_vector_search(collection, "{\
 \"query\": {\
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 r_size = 0;
 char **results = pgml_collectionc_vector_search(collection, "{\
    \"query\": {\
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 r_size = 0;
 char **results = pgml_collectionc_vector_search(collection, "{\
    \"query\": {\
 {% endtab %}

 {% tab title="C" %}
 ```c
 ```cpp
 r_size = 0;
 char **results = pgml_collectionc_vector_search(collection, "{\
  \"query\": {\
Original file line number	Diff line number	Diff line change
Expand Up		@@ -99,7 +99,7 @@ async fn main() -> Result<(), Error> {
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
levkk marked this conversation as resolved. Show resolvedHide resolved
		#include <stdio.h>
		#include "pgml.h"

Expand DownExpand Up		@@ -176,7 +176,7 @@ collection.add_pipeline(&mut pipeline).await?;
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		// Add this code to the end of the main function from the above example.
		PipelineC * pipeline = pgml_pipelinec_new("sample_pipeline", "{\"text\": {\"splitter\": {\"model\": \"recursive_character\"},\"semantic_search\": {\"model\": \"Alibaba-NLP/gte-base-en-v1.5\"}}}");

Expand DownExpand Up		@@ -251,7 +251,7 @@ collection.upsert_documents(documents, None).await?;
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		// Add this code to the end of the main function in the above example.
		char * documents_to_upsert[2] = {"{\"id\": \"Document One\", \"text\": \"document one contents...\"}", "{\"id\": \"Document Two\", \"text\": \"document two contents...\"}"};

Expand DownExpand Up		@@ -334,7 +334,7 @@ Ok(())
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		// Add this code to the end of the main function in the above example.
		r_size = 0;
		char** results = pgml_collectionc_vector_search(collection, "{\"query\": {\"fields\": {\"text\": {\"query\": \"Something about a document...\"}}}, \"limit\": 2}", pipeline, &r_size);
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,7 +34,7 @@ let mut collection = Collection::new("test_collection", None)?;
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		CollectionC * collection = pgml_collectionc_new("test_collection", NULL);
		```
		{% endtab %}
Expand DownExpand Up		@@ -64,7 +64,7 @@ let mut collection = Collection::new("test_collection", Some(CUSTOM_DATABASE_URL
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		CollectionC * collection = pgml_collectionc_new("test_collection", CUSTOM_DATABASE_URL);
		```
		{% endtab %}
Expand DownExpand Up		@@ -138,7 +138,7 @@ collection.upsert_documents(documents, None).await?;
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		char * documents[2] = {
		"{\"id\": \"document_one\", \"title\": \"Document One\", \"text\": \"Here are the contents of Document 1\", \"random_key\": \"here is some random data\"}",
		"{\"id\": \"document_two\", \"title\": \"Document Two\", \"text\": \"Here are the contents of Document 2\", \"random_key\": \"here is some random data\"}"
Expand DownExpand Up		@@ -214,7 +214,7 @@ collection.upsert_documents(documents, None).await?;
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		char * documents[2] = {
		"{\"id\": \"document_one\", \"title\": \"Document One\", \"text\": \"Here is some new text for document one\", \"random_key\": \"here is some random data\"}",
		"{\"id\": \"document_two\", \"title\": \"Document Two\", \"text\": \"Here is some new text for document two\", \"random_key\": \"here is some random data\"}"
Expand DownExpand Up		@@ -288,7 +288,7 @@ collection
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		char * documents[2] = {
		"{\"id\": \"document_one\", \"new_key\": \"this will be a new key in document one\", \"random_key\": \"this will replace old random_key\"}",
		"{\"id\": \"document_two\", \"new_key\": \"this will be a new key in document two\", \"random_key\": \"this will replace old random_key\"}"
Expand DownExpand Up		@@ -324,7 +324,7 @@ let documents = collection
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		unsigned long r_size = 0;
		char** documents = pgml_collectionc_get_documents(collection, "{\"limit\": 100}", &r_size);
		```
Expand DownExpand Up		@@ -359,7 +359,7 @@ let documents = collection
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		unsigned long r_size = 0;
		char** documents = pgml_collectionc_get_documents(collection, "{\"limit\": 100, \"offset\": 10}", &r_size);
		```
Expand DownExpand Up		@@ -390,7 +390,7 @@ let documents = collection
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		unsigned long r_size = 0;
		char** documents = pgml_collectionc_get_documents(collection, "{\"limit\": 100, \"last_row_id\": 10}", &r_size);
		```
Expand DownExpand Up		@@ -447,7 +447,7 @@ let documents = collection
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		unsigned long r_size = 0;
		char** documents = pgml_collectionc_get_documents(collection, "{\"limit\": 100, \"filter\": {\"id\": {\"$eq\": \"document_one\"}}}", &r_size);
		```
Expand DownExpand Up		@@ -501,7 +501,7 @@ let documents = collection
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		unsigned long r_size = 0;
		char** documents = pgml_collectionc_get_documents(collection, "{\"limit\": 100, \"offset\": 10, \"order_by\": {\"id\": \"desc\"}}", &r_size);
		```
Expand DownExpand Up		@@ -549,7 +549,7 @@ let documents = collection
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		pgml_collectionc_delete_documents(collection, "{\"id\": { \"$eq\": 1}}");
		```
		{% endtab %}
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -79,7 +79,7 @@ collection.add_pipeline(&mut pipeline).await?;
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		PipelineC *pipeline = pgml_pipelinec_new("test_pipeline", "{\
		\"abstract\": {\
		\"semantic_search\": {\
Expand DownExpand Up		@@ -192,7 +192,7 @@ let results = collection
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		char * results = pgml_collectionc_search(collection, "\
		\"query\": {\
		\"full_text_search\": {\
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -82,7 +82,7 @@ let mut pipeline = Pipeline::new(
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		PipelineC * pipeline = pgml_pipelinec_new(
		"test_pipeline",
		"{\
Expand DownExpand Up		@@ -156,7 +156,7 @@ let mut pipeline = Pipeline::new(
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		PipelineC * pipeline = pgml_pipelinec_new(
		"test_pipeline",
		"{\
Expand All		@@ -174,6 +174,8 @@ PipelineC * pipeline = pgml_pipelinec_new(

		This `Pipeline` splits and embeds the `body` text enabling semantic search using vectors. This is a very popular `Pipeline` for RAG.

		### Switching from OpenAI

		We support most every open source model on [Hugging Face](https://huggingface.co/), and OpenAI's embedding models. To use a model from OpenAI specify the `source` as `openai`, and make sure and set the environment variable `OPENAI_API_KEY`.

		{% tabs %}
Expand DownExpand Up		@@ -204,6 +206,44 @@ pipeline = Pipeline(
		)
		```
		{% endtab %}

		{% tab title="Rust" %}
		```rust
		let mut pipeline = Pipeline::new(
		"test_pipeline",
		Some(
		serde_json::json!({
		"body": {
		"splitter": {"model": "recursive_character"},
		"semantic_search": {
		"model": "text-embedding-ada-002",
		"source": "openai"
		},
		},
		})
		.into(),
		),
		)?;

		```
		{% endtab %}

		{% tab title="C" %}
		```cpp
		PipelineC * pipeline = pgml_pipelinec_new(
		"test_pipeline",
		"{\
		\"body\": {\
		\"splitter\": {\"model\": \"recursive_character\"},\
		\"semantic_search\": {\
		\"model\": \"text-embedding-ada-002\",\
		\"source\": \"openai\"\
		}\
		}\
		}"
		);
		```
		{% endtab %}
		{% endtabs %}

		## Customizing the Indexes
Expand DownExpand Up		@@ -267,7 +307,7 @@ let mut pipeline = Pipeline::new(
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		PipelineC * pipeline = pgml_pipelinec_new(
		"test_pipeline",
		"{\
Expand DownExpand Up		@@ -308,7 +348,7 @@ collection.add_pipeline(&mut pipeline).await?;
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		pgml_collectionc_add_pipeline(collection, pipeline);
		```
		{% endtab %}
Expand DownExpand Up		@@ -336,7 +376,7 @@ let mut pipeline = Pipeline::new("test_pipeline", None)?;
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		PipelineC * pipeline = pgml_pipelinec_new("test_pipeline", NULL);
		```
		{% endtab %}
Expand DownExpand Up		@@ -381,7 +421,7 @@ collection.disable_pipeline(&mut pipeline).await?;
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		CollectionC * collection = pgml_collectionc_new("test_collection", NULL);
		PipelineC * pipeline = pgml_pipelinec_new("test_pipeline", NULL);
		pgml_collectionc_disable_pipeline(collection, pipeline);
Expand DownExpand Up		@@ -421,7 +461,7 @@ collection.enable_pipeline(&mut pipeline).await?;
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		CollectionC * collection = pgml_collectionc_new("test_collection", NULL);
		PipelineC * pipeline = pgml_pipelinec_new("test_pipeline", NULL);
		pgml_collectionc_enable_pipeline(collection, pipeline);
Expand DownExpand Up		@@ -459,7 +499,7 @@ collection.remove_pipeline(&mut pipeline).await?;
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		CollectionC * collection = pgml_collectionc_new("test_collection", NULL);
		PipelineC * pipeline = pgml_pipelinec_new("test_pipeline", NULL);
		pgml_collectionc_remove_pipeline(collection, pipeline);
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -80,7 +80,7 @@ collection.add_pipeline(&mut pipeline).await?;
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		PipelineC *pipeline = pgml_pipelinec_new("test_pipeline", "{\
		\"abstract\": {\
		\"semantic_search\": {\
Expand DownExpand Up		@@ -173,7 +173,7 @@ let results = collection
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		r_size = 0;
		char **results = pgml_collectionc_vector_search(collection, "{\
		\"query\": {\
Expand DownExpand Up		@@ -283,7 +283,7 @@ let results = collection
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		r_size = 0;
		char **results = pgml_collectionc_vector_search(collection, "{\
		\"query\": {\
Expand DownExpand Up		@@ -389,7 +389,7 @@ let results = collection
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		r_size = 0;
		char **results = pgml_collectionc_vector_search(collection, "{\
		\"query\": {\
Expand DownExpand Up		@@ -488,7 +488,7 @@ let results = collection
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		r_size = 0;
		char **results = pgml_collectionc_vector_search(collection, "{\
		\"query\": {\
Expand DownExpand Up		@@ -615,7 +615,7 @@ let results = collection
		{% endtab %}

		{% tab title="C" %}
		```c
		```cpp
		r_size = 0;
		char **results = pgml_collectionc_vector_search(collection, "{\
		\"query\": {\
Expand Down