Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added together AI documentation #190

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

Wimukti
Copy link
Contributor

@Wimukti Wimukti commented Sep 30, 2024

@BeeBombshell Please review the PR.

Copy link

vercel bot commented Sep 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
buildship-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 30, 2024 6:45am

### Together AI API Authentication

You will need a Together AI API Key to authenticate your requests. For more information on obtaining an API Key, refer
to the [Together AI API documentation](https://docs.together.ai/authentication).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Wimukti, looks like this link gives a 404. Maybe we could rephrase and add a link to https://api.together.xyz/settings/api-keys instead for directly getting the API Keys from their account?


<Image src={togetherai1} alt='Together AI Integration' width={1200} />

- **API Key**: The Together AI API key is required to authenticate each request you make through the BuildShip nodes.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You will need a Together AI API Key to authenticate your requests. For more information on obtaining an API Key, refer to the Together AI API documentation.

  • API Key: The Together AI API key is required to authenticate each request you make through the BuildShip nodes.

Perhaps we could combine these two and remove the single list item entirely?

Set API Key

Before using any of the Together AI nodes, set your API key for authentication.

Inputs

  • API Key: The API key obtained from Together AI for authentication. Make sure to keep it secure.
You must provide the API key in the headers of each node request. Once set, it allows secure communication with the Together AI API.

Lets remove the "Set API Key" section, instead refer the prerequisites section for the API Key if needed. We can also mention that the users can save their API Keys as Secrets and add a link to /secrets.

- **Input**: The text or data for which you want to generate embeddings. This could be a single text input or multiple
entries (batch processing).

- **API Key**: Your Together AI API Key for authentication.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, maybe we could we reorder the inputs sequence to match the nodes? :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants