forked from langchain-ai/langchain
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'langchain-ai:master' into master
- Loading branch information
Showing
58 changed files
with
3,071 additions
and
1,006 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
Large diffs are not rendered by default.
Oops, something went wrong.
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
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,190 @@ | ||
| { | ||
| "cells": [ | ||
| { | ||
| "cell_type": "raw", | ||
| "id": "afaf8039", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "---\n", | ||
| "sidebar_label: OCIGenAI\n", | ||
| "---" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "id": "e49f1e0d", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "# ChatOCIGenAI\n", | ||
| "\n", | ||
| "This notebook provides a quick overview for getting started with OCIGenAI [chat models](/docs/concepts/#chat-models). For detailed documentation of all ChatOCIGenAI features and configurations head to the [API reference](https://api.python.langchain.com/en/latest/chat_models/langchain_community.chat_models.oci_generative_ai.ChatOCIGenAI.html).\n", | ||
| "\n", | ||
| "Oracle Cloud Infrastructure (OCI) Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases, and which is available through a single API.\n", | ||
| "Using the OCI Generative AI service you can access ready-to-use pretrained models, or create and host your own fine-tuned custom models based on your own data on dedicated AI clusters. Detailed documentation of the service and API is available __[here](https://docs.oracle.com/en-us/iaas/Content/generative-ai/home.htm)__ and __[here](https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/)__.\n", | ||
| "\n", | ||
| "\n", | ||
| "## Overview\n", | ||
| "### Integration details\n", | ||
| "\n", | ||
| "| Class | Package | Local | Serializable | [JS support](https://js.langchain.com/v0.2/docs/integrations/chat/oci_generative_ai) | Package downloads | Package latest |\n", | ||
| "| :--- | :--- | :---: | :---: | :---: | :---: | :---: |\n", | ||
| "| [ChatOCIGenAI](https://api.python.langchain.com/en/latest/chat_models/langchain_community.chat_models.oci_generative_ai.ChatOCIGenAI.html) | [langchain-community](https://api.python.langchain.com/en/latest/community_api_reference.html) | ❌ | ❌ | ❌ |  |  |\n", | ||
| "\n", | ||
| "### Model features\n", | ||
| "| [Tool calling](/docs/how_to/tool_calling/) | [Structured output](/docs/how_to/structured_output/) | JSON mode | [Image input](/docs/how_to/multimodal_inputs/) | Audio input | Video input | [Token-level streaming](/docs/how_to/chat_streaming/) | Native async | [Token usage](/docs/how_to/chat_token_usage_tracking/) | [Logprobs](/docs/how_to/logprobs/) |\n", | ||
| "| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |\n", | ||
| "| ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ✅ | ❌ | \n", | ||
| "\n", | ||
| "## Setup\n", | ||
| "\n", | ||
| "To access OCIGenAI models you'll need to install the `oci` and `langchain-community` packages.\n", | ||
| "\n", | ||
| "### Credentials\n", | ||
| "\n", | ||
| "The credentials and authentication methods supported for this integration are equivalent to those used with other OCI services and follow the __[standard SDK authentication](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm)__ methods, specifically API Key, session token, instance principal, and resource principal.\n", | ||
| "\n", | ||
| "API key is the default authentication method used in the examples above. The following example demonstrates how to use a different authentication method (session token)" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "id": "0730d6a1-c893-4840-9817-5e5251676d5d", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "### Installation\n", | ||
| "\n", | ||
| "The LangChain OCIGenAI integration lives in the `langchain-community` package and you will also need to install the `oci` package:" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "id": "652d6238-1f87-422a-b135-f5abbb8652fc", | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "%pip install -qU langchain-community oci" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "id": "a38cde65-254d-4219-a441-068766c0d4b5", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "## Instantiation\n", | ||
| "\n", | ||
| "Now we can instantiate our model object and generate chat completions:\n" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "id": "cb09c344-1836-4e0c-acf8-11d13ac1dbae", | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "from langchain_community.chat_models.oci_generative_ai import ChatOCIGenAI\n", | ||
| "from langchain_core.messages import AIMessage, HumanMessage, SystemMessage\n", | ||
| "\n", | ||
| "chat = ChatOCIGenAI(\n", | ||
| " model_id=\"cohere.command-r-16k\",\n", | ||
| " service_endpoint=\"https://inference.generativeai.us-chicago-1.oci.oraclecloud.com\",\n", | ||
| " compartment_id=\"MY_OCID\",\n", | ||
| " model_kwargs={\"temperature\": 0.7, \"max_tokens\": 500},\n", | ||
| ")" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "id": "2b4f3e15", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "## Invocation" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "id": "62e0dbc3", | ||
| "metadata": { | ||
| "tags": [] | ||
| }, | ||
| "outputs": [], | ||
| "source": [ | ||
| "messages = [\n", | ||
| " SystemMessage(content=\"your are an AI assistant.\"),\n", | ||
| " AIMessage(content=\"Hi there human!\"),\n", | ||
| " HumanMessage(content=\"tell me a joke.\"),\n", | ||
| "]\n", | ||
| "response = chat.invoke(messages)" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "id": "d86145b3-bfef-46e8-b227-4dda5c9c2705", | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "print(response.content)" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "id": "18e2bfc0-7e78-4528-a73f-499ac150dca8", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "## Chaining\n", | ||
| "\n", | ||
| "We can [chain](/docs/how_to/sequence/) our model with a prompt template like so:\n" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "id": "e197d1d7-a070-4c96-9f8a-a0e86d046e0b", | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "from langchain_core.prompts import ChatPromptTemplate\n", | ||
| "\n", | ||
| "prompt = ChatPromptTemplate.from_template(\"Tell me a joke about {topic}\")\n", | ||
| "chain = prompt | chat\n", | ||
| "\n", | ||
| "response = chain.invoke({\"topic\": \"dogs\"})\n", | ||
| "print(response.content)" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "id": "3a5bb5ca-c3ae-4a58-be67-2cd18574b9a3", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "## API reference\n", | ||
| "\n", | ||
| "For detailed documentation of all ChatOCIGenAI features and configurations head to the API reference: https://api.python.langchain.com/en/latest/chat_models/langchain_community.chat_models.oci_generative_ai.ChatOCIGenAI.html" | ||
| ] | ||
| } | ||
| ], | ||
| "metadata": { | ||
| "kernelspec": { | ||
| "display_name": "Python 3 (ipykernel)", | ||
| "language": "python", | ||
| "name": "python3" | ||
| }, | ||
| "language_info": { | ||
| "codemirror_mode": { | ||
| "name": "ipython", | ||
| "version": 3 | ||
| }, | ||
| "file_extension": ".py", | ||
| "mimetype": "text/x-python", | ||
| "name": "python", | ||
| "nbconvert_exporter": "python", | ||
| "pygments_lexer": "ipython3", | ||
| "version": "3.9.1" | ||
| } | ||
| }, | ||
| "nbformat": 4, | ||
| "nbformat_minor": 5 | ||
| } |
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
Oops, something went wrong.