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

Update Azure Cognitive Search to latest stable/GA Python SDK version + Renaming to Azure AI Search #924

Merged
merged 31 commits into from
Feb 1, 2024

Conversation

farzad528
Copy link
Contributor

Summary

This PR updates the Vector Database example in the Azure Search Cookbook to utilize the latest stable General Availability (GA) release of the Azure AI Search Python SDK. Additionally, it includes renaming instances of "Azure Search" to "Azure AI Search" to reflect the current branding and product naming conventions.

Motivation

The Azure Search Cookbook is a valuable resource for developers working with Azure AI Search. Keeping the cookbook examples up-to-date with the latest SDK ensures that users have access to the most current features and best practices. The rebranding from "Azure Search" to "Azure AI Search" aligns the cookbook with the official terminology, reducing confusion and improving searchability.


For new content

When contributing new content, read through our contribution guidelines, and mark the following action items as completed:

  • I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website.
  • I have conducted a self-review of my content based on the contribution guidelines:
    • Relevance: This content is related to building with OpenAI technologies and is useful to others.
    • Uniqueness: I have searched for related examples in the OpenAI Cookbook, and verified that my content offers new insights or unique information compared to existing documentation.
    • Spelling and Grammar: I have checked for spelling or grammatical mistakes.
    • Clarity: I have done a final read-through and verified that my submission is well-organized and easy to understand.
    • Correctness: The information I include is correct and all of my code executes successfully.
    • Completeness: I have explained everything fully, including all necessary references and citations.

We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.

@farzad528
Copy link
Contributor Author

farzad528 commented Dec 11, 2023

@pablocastro please review

@farzad528 farzad528 marked this pull request as draft December 11, 2023 15:11
@farzad528 farzad528 marked this pull request as ready for review December 11, 2023 15:11
Copy link

@pablocastro pablocastro left a comment

Choose a reason for hiding this comment

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

Added a few comments to the notebook that would be good to address.

@pablocastro
Copy link

LGTM

@farzad528
Copy link
Contributor Author

farzad528 commented Dec 14, 2023

@simonpfish @shyamal-anadkat requesting review :)

@farzad528
Copy link
Contributor Author

farzad528 commented Jan 15, 2024

@teomusatoiu @ibigio
requesting review plz

@farzad528 farzad528 changed the title Update Azure Cognitive Search to latest stable/GA Python SDK version + Renaming to Azure AI Search Update Azure AI Search to latest stable/GA Python SDK version + Renaming to Azure AI Search Jan 15, 2024
@farzad528 farzad528 changed the title Update Azure AI Search to latest stable/GA Python SDK version + Renaming to Azure AI Search Update Azure Cognitive Search to latest stable/GA Python SDK version + Renaming to Azure AI Search Jan 15, 2024
Copy link
Collaborator

@ibigio ibigio left a comment

Choose a reason for hiding this comment

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

This is great, thank you! Especially appreciate the blurbs explaining what the code blocks do – super helpful. Quality contribution.

@farzad528
Copy link
Contributor Author

thanks @ibigio can we get this merged please?

@ibigio ibigio merged commit 4b35217 into openai:main Feb 1, 2024
katia-openai pushed a commit that referenced this pull request Feb 29, 2024
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.

None yet

3 participants