diff --git a/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pgvector.adoc b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pgvector.adoc new file mode 100644 index 000000000..1e5cfcce8 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-langchain4j-pgvector.adoc @@ -0,0 +1,114 @@ + +:summaryTableId: quarkus-langchain4j-pgvector +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-langchain4j-pgvector_configuration]]link:#quarkus-langchain4j-pgvector_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-langchain4j-pgvector_quarkus.langchain4j.pgvector.table]]`link:#quarkus-langchain4j-pgvector_quarkus.langchain4j.pgvector.table[quarkus.langchain4j.pgvector.table]` + + +[.description] +-- +The table name for storing embeddings + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_TABLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_TABLE+++` +endif::add-copy-button-to-env-var[] +--|string +|`embeddings` + + +a| [[quarkus-langchain4j-pgvector_quarkus.langchain4j.pgvector.dimension]]`link:#quarkus-langchain4j-pgvector_quarkus.langchain4j.pgvector.dimension[quarkus.langchain4j.pgvector.dimension]` + + +[.description] +-- +The dimension of the embedding vectors. This has to be the same as the dimension of vectors produced by the embedding model that you use. For example, AllMiniLmL6V2QuantizedEmbeddingModel produces vectors of dimension 384. OpenAI's text-embedding-ada-002 produces vectors of dimension 1536. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_DIMENSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_DIMENSION+++` +endif::add-copy-button-to-env-var[] +--|int +|required icon:exclamation-circle[title=Configuration property is required] + + +a| [[quarkus-langchain4j-pgvector_quarkus.langchain4j.pgvector.use-index]]`link:#quarkus-langchain4j-pgvector_quarkus.langchain4j.pgvector.use-index[quarkus.langchain4j.pgvector.use-index]` + + +[.description] +-- +Use index or not + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_USE_INDEX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_USE_INDEX+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + + +a| [[quarkus-langchain4j-pgvector_quarkus.langchain4j.pgvector.index-list-size]]`link:#quarkus-langchain4j-pgvector_quarkus.langchain4j.pgvector.index-list-size[quarkus.langchain4j.pgvector.index-list-size]` + + +[.description] +-- +index size + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_INDEX_LIST_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_INDEX_LIST_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`0` + + +a| [[quarkus-langchain4j-pgvector_quarkus.langchain4j.pgvector.create-table]]`link:#quarkus-langchain4j-pgvector_quarkus.langchain4j.pgvector.create-table[quarkus.langchain4j.pgvector.create-table]` + + +[.description] +-- +Create table or not + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_CREATE_TABLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_CREATE_TABLE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-langchain4j-pgvector_quarkus.langchain4j.pgvector.drop-table-first]]`link:#quarkus-langchain4j-pgvector_quarkus.langchain4j.pgvector.drop-table-first[quarkus.langchain4j.pgvector.drop-table-first]` + + +[.description] +-- +Drop table or not + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LANGCHAIN4J_PGVECTOR_DROP_TABLE_FIRST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LANGCHAIN4J_PGVECTOR_DROP_TABLE_FIRST+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`false` + +|=== \ No newline at end of file diff --git a/docs/modules/ROOT/pages/pgvector-store.adoc b/docs/modules/ROOT/pages/pgvector-store.adoc index b130cbf0d..17cd162f8 100644 --- a/docs/modules/ROOT/pages/pgvector-store.adoc +++ b/docs/modules/ROOT/pages/pgvector-store.adoc @@ -28,7 +28,7 @@ Upon installing the extension, you can utilize the pgvector store using the foll [source,java] ---- -include::{examples-dir}/io/quarkiverse/langchain4j/samples/IngestorPgvectorExample.java[] +include::{examples-dir}/io/quarkiverse/langchain4j/samples/IngestorExampleWithPgvector.java[] ---- == Configuration Settings diff --git a/docs/pom.xml b/docs/pom.xml index b89de7c36..6ff2d280f 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -63,6 +63,11 @@ quarkus-langchain4j-pinecone-deployment ${project.version} + + io.quarkiverse.langchain4j + quarkus-langchain4j-pgvector-deployment + ${project.version} + io.quarkiverse.langchain4j quarkus-langchain4j-hugging-face-deployment @@ -121,6 +126,7 @@ quarkus-langchain4j-redis.adoc quarkus-langchain4j-chroma.adoc quarkus-langchain4j-pinecone.adoc + quarkus-langchain4j-pgvector.adoc false