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

Draft docs for the AI functions #101

Merged
merged 3 commits into from
Jul 13, 2023
Merged

Draft docs for the AI functions #101

merged 3 commits into from
Jul 13, 2023

Conversation

eolivelli
Copy link
Collaborator

@eolivelli eolivelli commented Jul 13, 2023

Summary:

  • add a new minimal file for the ai-tools steps
  • add some docs about how to configure "openai" and "datasource"

@eolivelli eolivelli requested a review from cbornet July 13, 2023 11:10
pulsar-ai-tools/README.md Outdated Show resolved Hide resolved
|------------------|---------------------------------------------------------------------------------------------------------------------|
| model | The model to use, it depends on the provider |
| compute-service | The embeddings provider (openai, huggingface...) |
| text | Template for the text to compute the embeddings on. You can use the Mustache syntax (for example {{value.field1}} ) |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Ad link to mustache spec ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

good idea

|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| output-field | The name of the field to add or update (for example value.embeddingsvector) |
| messages | Template for the messages, it is an array. You can use Mustache in order to fill in the template with the fields of the message. |
| model | ID of the model to use. See the [model endpoint compatibility](https://platform.openai.com/docs/models/model-endpoint-compatibility) table for details on which models work with the Chat API. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Models have different names on Azure. We could also put a link for Azure ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

good idea

@eolivelli eolivelli merged commit b42a9b5 into master Jul 13, 2023
8 checks passed
@eolivelli eolivelli deleted the impl/docs-gen-ai branch July 13, 2023 12:36
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