-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
274 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
71 changes: 71 additions & 0 deletions
71
pkg/plugin/processor/builtin/impl/openaiembedding/config_paramgen.go
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
186 changes: 186 additions & 0 deletions
186
pkg/plugin/processor/builtin/impl/openaiembedding/openai_embedding.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,186 @@ | ||
| // Copyright © 2024 Meroxa, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| //go:generate paramgen -output=config_paramgen.go procConfig | ||
|
|
||
| package openaiembedding | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/Azure/azure-sdk-for-go/sdk/ai/azopenai" | ||
| "github.com/Azure/azure-sdk-for-go/sdk/azcore" | ||
| "github.com/conduitio/conduit-commons/config" | ||
| "github.com/conduitio/conduit-commons/opencdc" | ||
| sdk "github.com/conduitio/conduit-processor-sdk" | ||
| "github.com/conduitio/conduit/pkg/foundation/cerrors" | ||
| "github.com/conduitio/conduit/pkg/foundation/log" | ||
| ) | ||
|
|
||
| type procConfig struct { | ||
| APIKey string `json:"apiKey" validate:"required"` | ||
| Endpoint string `json:"endpoint" default:"https://api.openai.com/v1"` | ||
| EmbeddingEncodingFormat string `json:"embeddingEncodingFormat" default:"float" validate:"inclusion=float|base64"` | ||
| Model string `json:"model" validate:"required,inclusion=text-embedding-3-small|text-embedding-3-large"` | ||
| InputField string `json:"inputField" validate:"regex=^\\.(Payload|Key).*" default:".Payload.After"` | ||
| OutputField string `json:"outputField" validate:"regex=^\\.(Payload|Key).*" default:".Payload.After.vectors"` | ||
| } | ||
|
|
||
| type processor struct { | ||
| sdk.UnimplementedProcessor | ||
|
|
||
| cfg procConfig | ||
|
|
||
| inputFieldRefResolver sdk.ReferenceResolver | ||
| outputFieldRefResolver sdk.ReferenceResolver | ||
|
|
||
| client *azopenai.Client | ||
| logger log.CtxLogger | ||
| } | ||
|
|
||
| func NewProcessor(log log.CtxLogger) sdk.Processor { | ||
| return &processor{ | ||
| logger: log.WithComponent("openai_embedding"), | ||
| } | ||
| } | ||
|
|
||
| func (p *processor) Specification() (sdk.Specification, error) { | ||
| return sdk.Specification{ | ||
| Name: "openai.embedding", | ||
| Summary: "Generate OpenAI embeddings.", | ||
| Description: "", | ||
| Version: "v0.1.0", | ||
| Author: "Meroxa, Inc.", | ||
| Parameters: procConfig{}.Parameters(), | ||
| }, nil | ||
| } | ||
|
|
||
| func (p *processor) Configure(ctx context.Context, c config.Config) error { | ||
| cfg := procConfig{} | ||
| err := sdk.ParseConfig(ctx, c, &cfg, procConfig{}.Parameters()) | ||
| if err != nil { | ||
| return cerrors.Errorf("failed to parse configuration: %w", err) | ||
| } | ||
|
|
||
| inputResolver, err := sdk.NewReferenceResolver(cfg.InputField) | ||
| if err != nil { | ||
| return cerrors.Errorf(`failed to create a field resolver for %v parameter: %w`, cfg.InputField, err) | ||
| } | ||
| p.inputFieldRefResolver = inputResolver | ||
|
|
||
| outputResolver, err := sdk.NewReferenceResolver(cfg.OutputField) | ||
| if err != nil { | ||
| return cerrors.Errorf(`failed to create a field resolver for %v parameter: %w`, cfg.OutputField, err) | ||
| } | ||
| p.outputFieldRefResolver = outputResolver | ||
|
|
||
| p.cfg = cfg | ||
| return nil | ||
| } | ||
|
|
||
| func (p *processor) Open(ctx context.Context) error { | ||
| keyCredential := azcore.NewKeyCredential(p.cfg.APIKey) | ||
|
|
||
| // NOTE: this constructor creates a client that connects to the public OpenAI endpoint. | ||
| // To connect to an Azure OpenAI endpoint, use azopenai.NewClient() or azopenai.NewClientWithyKeyCredential. | ||
| client, err := azopenai.NewClientForOpenAI("https://api.openai.com/v1", keyCredential, nil) | ||
| if err != nil { | ||
| return cerrors.Errorf("failed to create OpenAI client: %w", err) | ||
| } | ||
|
|
||
| p.client = client | ||
| return nil | ||
| } | ||
|
|
||
| func (p *processor) Process(ctx context.Context, records []opencdc.Record) []sdk.ProcessedRecord { | ||
| out := make([]sdk.ProcessedRecord, 0, len(records)) | ||
|
|
||
| // Prepare request (embedding inputs) | ||
| var embeddingInputs []string | ||
| for _, record := range records { | ||
| inRef, err := p.inputFieldRefResolver.Resolve(&record) | ||
| if err != nil { | ||
| out = append(out, sdk.ErrorRecord{Error: fmt.Errorf("failed to resolve reference %v: %w", p.cfg.InputField, err)}) | ||
| continue | ||
| } | ||
|
|
||
| embeddingInputs = append(embeddingInputs, p.getEmbeddingInput(inRef.Get())) | ||
| } | ||
|
|
||
| // Execute request (get embeddings) | ||
| embeddings, err := p.client.GetEmbeddings( | ||
| ctx, | ||
| azopenai.EmbeddingsOptions{ | ||
| Input: embeddingInputs, | ||
| Dimensions: nil, | ||
| EncodingFormat: (*azopenai.EmbeddingEncodingFormat)(&p.cfg.EmbeddingEncodingFormat), | ||
| DeploymentName: &p.cfg.Model, | ||
| InputType: nil, | ||
| User: nil, | ||
| }, | ||
| nil, | ||
| ) | ||
| // If the request failed, declare processing for all records as failed | ||
| if err != nil { | ||
| for range len(records) { | ||
| out = append(out, sdk.ErrorRecord{Error: err}) | ||
| } | ||
|
|
||
| return out | ||
| } | ||
|
|
||
| p.logger.Trace(ctx). | ||
| Any("embedding_input", embeddingInputs). | ||
| Any("embedding_output", embeddings). | ||
| Msg("got embeddings") | ||
|
|
||
| for i, record := range records { | ||
| outRef, err := p.outputFieldRefResolver.Resolve(&record) | ||
| if err != nil { | ||
| out = append(out, sdk.ErrorRecord{Error: cerrors.Errorf("failed to resolve reference %v: %w", p.cfg.OutputField, err)}) | ||
| continue | ||
| } | ||
|
|
||
| embeddingsMap := opencdc.StructuredData{ | ||
| // todo if the encoding format is base64, this needs to change | ||
| "embeddings": embeddings.Data[i].Embedding, | ||
| } | ||
| err = outRef.Set(embeddingsMap) | ||
| if err != nil { | ||
| out = append(out, sdk.ErrorRecord{Error: cerrors.Errorf("failed to set embeddings to %v: %w", p.cfg.OutputField, err)}) | ||
| continue | ||
| } | ||
|
|
||
| // todo add metadata related to the embeddings | ||
| out = append(out, sdk.SingleRecord(record)) | ||
| } | ||
|
|
||
| return out | ||
| } | ||
|
|
||
| func (p *processor) Teardown(ctx context.Context) error { | ||
| return nil | ||
| } | ||
|
|
||
| func (p *processor) getEmbeddingInput(val any) string { | ||
| switch v := val.(type) { | ||
| case opencdc.RawData: | ||
| return string(v) | ||
| case opencdc.StructuredData: | ||
| return string(v.Bytes()) | ||
| default: | ||
| return fmt.Sprintf("%v", v) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters