Oracledb connector information

[Minal-Agashe-Oracle]

• Added new file oracledb-connector.md
  This is the file path:
  /semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors

• Updated index.md (overview) file.
  This is the file path:
  /semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors

[microsoft-github-policy-service]

@Minal-Agashe-Oracle please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

1. Definitions.
   “Code” means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   “Project” means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative (www.opensource.org).
   “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   “Submission” means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.
5. Licenses.

• Copyright License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.
• Patent License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.
• Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.
8. Information about Submissions. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.
9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.
10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

[learn-build-service-prod]

Learn Build status updates of commit f4d9819:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracledb-connector.md	⚠️Warning		Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/index.md	✅Succeeded

semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracledb-connector.md

• Line 0, Column 0: [Warning: pivot-group-missing - See documentation] Missing metadata attribute: 'zone_pivot_groups'. To use zone pivots in your file, you must specify the valid pivot group that contains the pivot IDs you want to use.
• Line 1, Column 1: [Warning: author-missing - See documentation] Missing required attribute: 'author'. Add the current author's GitHub ID.
• Line 1, Column 1: [Warning: title-missing - See documentation] Missing required attribute: 'title'. Add a title string to show in search engine results.
• Line 1, Column 1: [Warning: ms-author-missing - See documentation] Missing required attribute: 'ms.author'. Add the current author's Microsoft alias.
• Line 1, Column 1: [Warning: ms-topic-missing - See documentation] Missing required attribute: 'ms.topic'.
• Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
• Line 1, Column 1: [Suggestion: ms-date-missing - See documentation] Missing required attribute: 'ms.date'.
• Line 1, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
• Line 1, Column 1: [Suggestion: ms-service-suggested] Missing required attribute: 'ms.service'. ms.service is suggested for Yaml:Mime type: Module.

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.

[learn-build-service-prod]

Learn Build status updates of commit e5eb914:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracledb-connector.md	⚠️Warning		Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/index.md	✅Succeeded

semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracledb-connector.md

• Line 0, Column 0: [Warning: pivot-group-missing - See documentation] Missing metadata attribute: 'zone_pivot_groups'. To use zone pivots in your file, you must specify the valid pivot group that contains the pivot IDs you want to use.
• Line 1, Column 1: [Warning: author-missing - See documentation] Missing required attribute: 'author'. Add the current author's GitHub ID.
• Line 1, Column 1: [Warning: title-missing - See documentation] Missing required attribute: 'title'. Add a title string to show in search engine results.
• Line 1, Column 1: [Warning: ms-author-missing - See documentation] Missing required attribute: 'ms.author'. Add the current author's Microsoft alias.
• Line 1, Column 1: [Warning: ms-topic-missing - See documentation] Missing required attribute: 'ms.topic'.
• Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
• Line 1, Column 1: [Suggestion: ms-date-missing - See documentation] Missing required attribute: 'ms.date'.
• Line 1, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
• Line 1, Column 1: [Suggestion: ms-service-suggested] Missing required attribute: 'ms.service'. ms.service is suggested for Yaml:Mime type: Module.

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.

[learn-build-service-prod]

Learn Build status updates of commit f1e93b3:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/index.md	⚠️Warning		Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md	⚠️Warning		Details

semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/index.md

• Line 50, Column 1: [Warning: file-not-found - See documentation] Invalid file link: './oracledb-connector.md'.

semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md

• Line 2, Column 1: [Warning: ms-author-missing - See documentation] Missing required attribute: 'ms.author'. Add the current author's Microsoft alias.

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.

[learn-build-service-prod]

Learn Build status updates of commit f53fd6a:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md	⚠️Warning		Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/index.md	✅Succeeded

semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md

• Line 2, Column 1: [Warning: ms-author-missing - See documentation] Missing required attribute: 'ms.author'. Add the current author's Microsoft alias.

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.

[learn-build-service-prod]

Learn Build status updates of commit 474b117:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md	⚠️Warning		Details

semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md

• Line 2, Column 1: [Warning: ms-author-missing - See documentation] Missing required attribute: 'ms.author'. Add the current author's Microsoft alias.

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.

[learn-build-service-prod]

Learn Build status updates of commit f7afe13:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md	⚠️Warning		Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/TOC.yml	✅Succeeded

semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md

• Line 2, Column 1: [Warning: ms-author-missing - See documentation] Missing required attribute: 'ms.author'. Add the current author's Microsoft alias.

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.

[westey-m]

Suggested change

	| Supported filter clauses | <ul><li>==</li><li>!=</li><li><</li><li><=</li><li>></li><li>>=</li><li>List.Contains() <ul><li>Only when checking for the model property is in the list</li></ul></li></ul> |
	| Supported filter clauses | <ul><li>==</li><li>!=</li><li><</li><li><=</li><li>></li><li>>=</li><li>List.Contains() <ul><li>Only when checking if the model property is in the list</li></ul></li></ul> |

[alexkeh]

@Minal-Agashe-Oracle Let's accept this change.

[westey-m]

Also check out the index.md file in the same folder as this file. It has a table of all the connectors, which can be updated for .net.

[alexkeh]

Thanks! We're working on updating the index.md as well.

[westey-m]

I think Restricted at least one vector is already covered by Supports multiple vectors in a record.
And since none of the connectors support multiple primary keys today, we can probably leave that out.

[alexkeh]

@Minal-Agashe-Oracle Let's consolidate these two items into a single line item. That should make the points clear.
Supports zero, one, or multiple vectors in a record = Yes

[westey-m]

Consider putting this in an important highlight

Suggested change

	Vector data searches require Oracle Database 23ai. All other Oracle connector features are available using Oracle Database 19c or higher.
	> [!IMPORTANT]
	> Vector data searches require Oracle Database 23ai. All other Oracle connector features are available using Oracle Database 19c or higher.

[alexkeh]

@Minal-Agashe-Oracle We can accept this change.

[westey-m]

Is the package released yet? Was going to test the instructions out, but I don't see the package on nuget yet.

[alexkeh]

@westey-m Not yet. It's likely to be released within the next week.

[westey-m]

Doesn't this one also require a collection name param?

[alexkeh]

Good catch!

@Minal-Agashe-Oracle You can replace the line of code with

var collection = new OracleCollection<string, Hotel>("<connection string>", "skhotels");

[westey-m]

Does it still provide a custom mapper? FYI: We did drop this for the other connectors, since it doesn't really work with the linq based filtering.

[alexkeh]

@westey-m No, we don't provide a custom mapper. VectorData provides basic custom mappings that use VectorStoreCollectionDefinition.

For LINQ-based filtering, Oracle uses table metadata and data model to filter columns. We took care of this in our metadata layer (mappings between data model to Oracle type) in the Oracle connector.

Our implementation may be different than other connectors. What scenarios do not work well with LINQ-based filtering? We can check those situations out.

[westey-m]

If you are not supporting custom mappers, no need to worry. It was something we had originally, but we dropped it. It doesn't work well with linq based filtering, since the model that the user provides and that the linq query is over, does not match the internal db schema, when using a custom mapper.

My comment was really around the fact that the docs here are referring to a custom mapper, and should be revised if there is none.

[alexkeh]

@westey-m
Is storage schema definition using record definitions the long-term plan to provide data mapping?

@Minal-Agashe-Oracle
Replace the current paragraph:

The Oracle Database Vector Store connector allows the application to provide a custom mapper in combination with a VectorStoreCollectionDefinition. In this case, the VectorStoreCollectionDefinition can differ from the supplied data model. The VectorStoreCollectionDefinition is used to define the database schema, while the data model is used to interact with the vector store. A custom mapper is required in this case to map from the data model to the custom database schema defined by the VectorStoreCollectionDefinition.

with the following paragraph instead:

The Oracle Database Vector Store connector supports data model annotations and record definitions. With annotations, developers provide information to the data model for creating indexes and database column mapping. With record definitions, the information can be defined and supplied separately from the data model.

[westey-m]

Is storage schema definition using record definitions the long-term plan to provide data mapping?

@alexkeh, the type of mapping that we had previously supported via custom mappers was e.g. turning nested structures into flat ones and similar complex remapping. Record definitions in my mind is more about defining the schema, and there is typically a fairly standard 1 to 1 mapping from schema to model that we follow.

[learn-build-service-prod]

Learn Build status updates of commit f625c1d:

✅ Validation status: passed

File	Status	Preview URL	Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md	✅Succeeded
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/TOC.yml	✅Succeeded

For more details, please refer to the build report.

[learn-build-service-prod]

Learn Build status updates of commit b236df2:

✅ Validation status: passed

File	Status	Preview URL	Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md	✅Succeeded
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/TOC.yml	✅Succeeded

For more details, please refer to the build report.

[learn-build-service-prod]

Learn Build status updates of commit e61bb76:

✅ Validation status: passed

File	Status	Preview URL	Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/index.md	✅Succeeded
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md	✅Succeeded
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/TOC.yml	✅Succeeded

For more details, please refer to the build report.

[learn-build-service-prod]

Learn Build status updates of commit 0bd30e5:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md	⚠️Warning		Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/index.md	✅Succeeded
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/TOC.yml	✅Succeeded

semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md

• Line 191, Column 224: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/semantic-kernel/concepts/vector-store-connectors/schema-with-record-definition?pivots=programming-language-csharp' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
• Line 191, Column 224: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/semantic-kernel/concepts/vector-store-connectors/schema-with-record-definition?pivots=programming-language-csharp' will be broken in isolated environments. Replace with a relative link.

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.

[learn-build-service-prod]

Learn Build status updates of commit 2a0ba77:

✅ Validation status: passed

File	Status	Preview URL	Details
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/index.md	✅Succeeded
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/oracle-connector.md	✅Succeeded
semantic-kernel/concepts/vector-store-connectors/out-of-the-box-connectors/TOC.yml	✅Succeeded

For more details, please refer to the build report.

[alexkeh]

@microsoft-github-policy-service agree company="Oracle"