https://github.com/pinecone-io/java-examples
https://github.com/pinecone-io/java-examples
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pinecone-io/java-examples
- Owner: pinecone-io
- License: apache-2.0
- Created: 2024-03-26T17:12:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-01T20:58:13.000Z (about 1 year ago)
- Last Synced: 2025-01-11T05:21:48.755Z (6 months ago)
- Language: Java
- Size: 682 KB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pinecone Java Examples
The official repository for Pinecone examples written in Java.
For more information on the Java client, please refer to
the [documentation](https://docs.pinecone.io/reference/pinecone-clients#java-client).
## Documentation
All examples have individual READMEs. Please refer to the README in each example directory for more information
about the specific example.
## Installation
Each example has its own `pom.xml` file and is treated as its own, standalone Maven project.
## Configuration
At a minimum, all examples require a Pinecone API key. You can obtain an API key by signing up for a Pinecone account
at [pinecone.io](https://www.pinecone.io).
## Indexes
All examples use Pinecone [serverless indexes](https://docs.pinecone.io/reference/architecture/serverless-architecture).
## Contributing
We welcome contributions from the community! If you wish to contribute an example, please follow these guidelines:
- Ensure your example is well-documented and easy to understand.
- Include a README with instructions on how to run your example.
- Include a `pom.xml` file with all necessary dependencies.
- Make a directory for your example in the root of this repository, following the same layout as `semantic-search`.
PRs will be need to be reviewed and approved by the Pinecone team.