Documentation for the PostgreSQL vector store connector #204
Conversation
Includes some expanded docs around dotnet and adds docs for the python
|
Learn Build status updates of commit 1c05ab7:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md | Details | ||
| semantic-kernel/concepts/vector-store-connectors/code-samples.md | ✅Succeeded |
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
- Line 172, Column 86: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/concepts-azure-ad-authentication' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 305, Column 58: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 394, Column 86: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/concepts-azure-ad-authentication' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 492, Column 55: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/python/api/azure-identity/azure.identity.defaultazurecredential?view=azure-python' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 172, Column 86: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/concepts-azure-ad-authentication' will be broken in isolated environments. Replace with a relative link. - Line 305, Column 58: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet' will be broken in isolated environments. Replace with a relative link. - Line 305, Column 58: [Suggestion: preserve-view-not-set - See documentation]
You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://learn.microsoft.com/en-us/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet - Line 394, Column 86: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/concepts-azure-ad-authentication' will be broken in isolated environments. Replace with a relative link. - Line 492, Column 55: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/python/api/azure-identity/azure.identity.defaultazurecredential?view=azure-python' will be broken in isolated environments. Replace with a relative link. - Line 492, Column 55: [Suggestion: preserve-view-not-set - See documentation]
You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://learn.microsoft.com/en-us/python/api/azure-identity/azure.identity.defaultazurecredential?view=azure-python
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit a05198b: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
@westey-m now that both the pythion and dotnet versions are released for PG vector search, it would be great to get the docs published as well. What's the process for review and publishing here? Thanks! |
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Show resolved
Hide resolved
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
| logger = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| async def get_entra_token_async(credential: AsyncTokenCredential) -> str: |
There was a problem hiding this comment.
in semantic_kernel/utils/authentication/entra_id_authentication.py we have prebuilt function for this, just pass the endpoint into that!
There was a problem hiding this comment.
That function is helpful, but there's not an async version and doesn't take in a credential as an option so always uses DefaultAzureCredential...passing in a credential is useful e.g. when you are operating in a service pod on AKS that has a workload identity, and you don't want to iterate through the possible credential paths because you only want a single credential mechanism.
I could contribute a PR that adds the credential argument and async version if you think that would be useful.
There was a problem hiding this comment.
that would be very useful, I'm very surprised there is no async in that one... and I like the idea of passing specific creds!
There was a problem hiding this comment.
Ok, put that on the TODO list. Looks like there's implications for the classes that use it, e.g. allowing credentials to be specificed in AzureOpenAIConfigBase.Do you think that should be blocking to this PR? It would be great to get this into the docs now that the postgres vectorstore feature is published. I can update the docs once the utils change gets merged and released.
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
|
Learn Build status updates of commit 0c40d8b: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
Learn Build status updates of commit 1c3f6e0: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
Learn Build status updates of commit 9c2a63f: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
@westey-m , @eavanvalkenburg - Thanks for the review! Apologies for the low quality code examples; guess I've been leaning on the type checker harder than I thought :-) I put the code examples into project code files to make sure the types were correct, and addressed all comments. I have a PR to make against semantic-kernel to add the PRIMARY KEY constraint and potentially to add functionality to the (Edit: Turns out I was implementing the PRIMARY KEY constraint correctly, just differently than I expected. updated docs to reflect this). |
|
Learn Build status updates of commit a7a7477: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
...ntic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/postgres-connector.md
Outdated
Show resolved
Hide resolved
|
Learn Build status updates of commit a2ee2a8: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
This PR adds the Postgres code samples to code-samples.md, expands on some of the dotnet docs, and adds python docs for the Postgres connector.