c3.Genai.Llm.MockLlmConfig.clearConfigAndSecretOverride('APP')

c3.Pkg.upsertAllSeed()
c3.Genai.Retriever.Dense.fetch()

retriever_name = "alabamaBond-dense"
retriever = c3.Genai.Retriever.Dense.forName(retriever_name)

query = """How are the key terms and entities defined and interrelated in the context of the financial and legal arrangements
described in the document?"""
results = retriever.similaritySearch({'searchQuery': c3.Genai.Query.fromQueryString(query), "k": 5})

passages = [result.page_content for result in results]
passages

['2 determined on the Mandatory Tender Date in accordance with the terms of the Indenture.  \n\nIf the Bonds are remarketed \non the Initial Mandatory Tender Date, the terms of the Bonds after such date may differ materially from the description \nprovided in this Official Statement.  \n\nTherefore, prospective purchasers of the Bonds on and after the Initial Mandatory Tender Date cannot r ely on this Official Statement, but rather must rely upon any disclosure documents prepared in \nconnection with such remarketing.  \n\n\nThe Bonds are subject to redemption prior to maturity as set forth herein under “THE BONDS. ” \n\n\nProceeds of the Bonds will be used to provide a portion of the financing for the Project.  \n\nAs described under \n“THE PROJECT — Plan of Financing” below, the Borrower expects to obtain permanent financing for its acquisition , \nrehabilitating , installing and equipping the Project primarily from the proceeds of a permanent loan (the “Permanent \nLoan”) from the Alabama Multifamily Loan Consortium, Inc., an Alabama non -profit corporation (the “Permanent \nLender”).  \n\n\nBrief descriptions of the Issuer, the Borrower, the Lender, the Permanent  Lender, the Bond Loan, the \nPermanent Loan, the Project, the Bonds, the security for the Bonds, the Indenture, the Bond Loan Agreement and the \nLand Use Restriction Agreement are included in this Official Statement.\n\nThe summaries herein do not purport to be  \ncomplete and are qualified in their entireties by reference to such documents, agreements and programs as may be \nreferred to herein, and the summaries herein of the Bonds are further qualified in their entireties by reference to the \nform of the Bonds incl uded in the Indenture and the provisions with respect thereto included in the aforesaid \ndocuments.  \n\n\nTHE ISSUER  \nGeneral  \nThe Issuer is a public corporation and instrumentality of the State, created on August 25, 1980, pursuant to \nthe Act.\n\nOne of the Issuer’s purposes is to issue bonds and use the proceeds therefrom to finance the acquisition, \nrehabilitation or construction of multi',
 'B-6 (d) The occurrence and continuance of an Event of Default as defined in the Bond Loan  \nAgreement and described in “APPENDIX C – SUMMARY OF CERTAIN PROVISIONS OF THE LOAN \nAGREEMENT - Events of Default. ” \n\n\nThe term “ default ” or “failure ” as used in the Indenture means (i) a default or failure by the Issuer in the \nobservance or performance of any of the covenants, agreements or obligations on its part to be observed  or performed \ncontained in the Indenture or in the Bonds, or (ii) a default or failure by the Borrower under the Bond Loan Agreement, \nafter giving effect to any period of grace or notice required to constitute a default or failure an Event of Default, as \nprovided above or in the Bond Loan Agreement.  \n\n\nAcceleration  \nUpon the occurrence of an Event of Default described in (a) or (b) above, the Trustee may declare, and upon \nthe written request of the Holders of not less than a majority in aggregate principal amount of Bonds then Outstanding the Trustee shall declare, by a notice in writing delivered to the Borrower and the Issuer, the principal of all Bonds \nthen Outstanding (if not then due and payable), and the interest accrued thereon, to be due an d payable immediately.  \n\n\nUpon the occurrence of any Event of Default other than those described in (a) or (b) above, the Trustee may, with the \nwritten consent of all Holders of Bonds then Outstanding, declare by a notice in writing delivered to the Borrower  and \nthe Issuer, the principal of all Bonds then Outstanding (if not then due and payable), and the interest thereon, to be due and payable immediately.  \n\nUpon such declaration, that principal and interest shall become and be due and payable immediately.  \n\nI nterest on the Bonds shall accrue to the date determined by the Trustee for the tender of payment to \nthe Holders pursuant to that declaration; provided, that interest on any unpaid principal of Bonds Outstanding shall continue to accrue from the date determined by the Trustee for the tender of payment to the Holders of those',
 '22 ADDITIONAL INFORMATION \n\n\nThe summaries and explanation of, or references to, the Act, the Indenture and the Bonds included in this \nOfficial Statement do not purport to be comprehensive or definitive.\n\nSuch summaries, references and descriptions are \nqualified in their entirety by reference to each such document, copies of which are on file with the Trustee.  \n\n\nThe information contained in this Official Statement is subject to change without notice and no implication \nshall be derived therefrom or from the sale of the Bonds that there has been no change in the affairs of the Issuer from \nthe date hereof.  \n\n\nThis Official Statement is submitted in connection with the offering of the Bonds and may not be reproduced \nor used, as a whole or in part, for any other purpose.\n\nAny statements in the Official Statement involving matters of \nopinion or estimate, whether or not expressly so stated, are intended as such and not as representations of fact.\n\nThis \nOfficial Statement is not to be construed as a contract or agreement between the Issuer and the owners of any of the \nBonds. \n \n\n\n[Remainder of page intentionally left blank]',
 'Section 4.  Content of Annual Reports.   \n\nThe Borrower’s Annual Report will contain or incorporate by \nreference the financial information  with respect to the Project, provided at least annually, of the type included in \nExhibit A hereto, which Annual Report may, but is not required to, include Audited Financial Statements.  \n\nIf the \nBorrower’s Audited Financial Statements are not available by the time the Annual Report is required to be filed, the \nAnnual Report will contain unaudited financial statements, and the Audited Financial Statements will be filed in the \nsame manner as the Annual Report when and if they become available.  \n\n\nAny or all of t he items described in Exhibit A  may be incorporated by reference from other documents, \nincluding official statements of debt issues with respect to which the Borrower is an “ Obligated Person ” (as defined \nby the Rule), which have been filed with the MSRB.  \n\nThe Borrower will clearly identify each such other document so \nincorporated by reference.  \n\n\nEach annual report submitted hereunder shall be in readable portable document format ( “PDF” ) or other \nacceptable electronic form.  \n\n\nSection 5.  Reporting of Listed  Even ts. \n\n\n(a) This Section 5 shall govern the giving of notices of the occurrence of any of the following \nevents (each, a “Listed Event ”): \n(i) Principal and interest payment delinquencies;  \n(ii) Non-payment related defaults, if material;  \n(iii) Unscheduled draws on debt service reserves reflecting financial difficulty;',
 ' or acquisition involving the \nBorrower or the sale of all or substantially all of the assets o f the Borrower, other than in the ordinary \ncourse of business, the entry into a definitive agreement to undertake such an action or the termination of a definitive agreement relating to any such actions, other than pursuant to its terms, if material;  \n(xiv) Appointment of a successor or additional trustee or paying agent or the change of \nthe name of a trustee or paying agent, if material ;  \n(xv) Incurrence of a financial obligation of the Borrower, if material, or agreement to \ncovenants, events of default, r emedies, priority rights, or other similar terms of a financial obligation \nof the Borrower, any of which affect security holders, if material;  \n(xvi)']

extraction_configs = c3.Genai.UnstructuredQuery.Engine.REA.ExtractorConfig.listConfigs().toData()
extraction_configs

extractor_config = c3.Genai.UnstructuredQuery.Engine.REA.ExtractorConfig.forConfigKey("extraction_config")
extractor_config

{
  "type" : "Genai.UnstructuredQuery.Engine.REA.ExtractorConfig",
  "name" : "extraction_config",
  "configOverride" : "APP",
  "modelInferenceConfigName" : "extraction_inference_config_gpt4"
}

model_inference_configs = c3.Genai.UnstructuredQuery.Engine.ModelConfig.listConfigs().toData()
model_inference_configs.loc[
    model_inference_configs['name'].str.startswith("extraction"),
    ["name", "llmType", "llmKwargs"]
]

extractor_config.setConfigValue('modelInferenceConfigName','extraction_inference_config_gpt4o')
extractor_config.getConfig()

{
  "type" : "Genai.UnstructuredQuery.Engine.REA.ExtractorConfig",
  "name" : "extraction_config",
  "configOverride" : "APP",
  "modelInferenceConfigName" : "extraction_inference_config_gpt4"
}

import getpass
import json



# Check if running in Jarvis, otherwise set OpenAI configurations
if c3.TestApi.isRunningInJarvis():
    print("Jarvis is running and initializing OpenAI Key")
    c3.TestApi.setOpenAiApiKey()
else:
    # Extract OpenAI API values from the JSON config
    # Load configuration from a JSON file
    config_path = 'openaijsonservice.json'
    with open(config_path, 'r') as file:
        config_data = json.load(file)
    openai_api_key = config_data['openai_api_key']
    openai_api_base = config_data['openai_api_base']
    openai_api_version = config_data['openai_api_version']

    print("Jarvis is not running and initializing OpenAI Key from config file")

    # Set OpenAI configurations
    c3.Genai.Llm.OpenAI.Config.inst().setSecretValue("apiKey", openai_api_key, c3.ConfigOverride.APP)
    c3.Genai.Llm.OpenAI.Config.inst().setConfigValue("apiBase", openai_api_base, c3.ConfigOverride.APP)
    c3.Genai.Llm.OpenAI.Config.inst().setConfigValue("apiVersion", openai_api_version, c3.ConfigOverride.APP)

Jarvis is not running and initializing OpenAI Key from config file

# Getting Model Config
model_inference_config = c3.Genai.UnstructuredQuery.Engine.ModelConfig.forConfigKey("extraction_inference_config_gpt4o")
model_inference_config

{
    "name": "extraction_inference_config_gpt4",
    "configOverride": null,
    "userFriendlyName": null,
    "llmDeployment": "Genai.Llm.AzureOpenAI",
    "prompt": {
        "description": null,
        "id": "extraction_prompt_config",
        "meta": null,
        "name": null,
        "params": {},
        "rawTemplate": null,
        "status": "INITIAL",
        "templateFile": null,
        "typeIdent": null,
        "typeWithBindings": null,
        "version": null
    },
    "llmType": "Gpt",
    "llmKwargs": {
        "truncate_prompt_totally": false,
        "model_name": "gpt-4",
        "temperature": 0.0,
        "stream_response": false,
        "context_length": 4096,
        "max_output_tokens": 512
    },
    "uiOptions": null,
    "configSuffix": null,
    "isHidden": false
}

prompt_config = c3.Genai.Prompt.fetch({"filter": c3.Filter.eq("id", model_inference_config.prompt.id)}).first()
print(prompt_config.rawTemplate)

You are given a question and a passage. Your job is to determine if the passage may contain information useful for answering the question.
If yes, return extracts of the passage that contain the useful information.
If no, return None.

Question: What is the role of Yousri Sellami at the bank?
Passage: Bank executives, including Emmanuel Sunak, Rishi Macron and Yousri Haider, resigned in September 2021 after being indicted for fraud.
Extract: None

Question: What sporting facilities are provided by at the clubhouse?
Passage: Club facilities include 26 tennis courts and a gymnasium, as well as 2 restaurants, a bar and a theatre.
Extract: Sporting facilities include 26 tennis courts and a gymnasium.

Question: What is the name of the largest Egyptian pyramid?
Passage: The Great Pyramid of Giza is the largest Egyptian pyramid. Built over a period of about 27 years, the pyramid is the oldest of the Seven Wonders of the Ancient World.
Extract: The Great Pyramid of Giza is the largest Egyptian pyramid.

Question: {{query}}
Passage: {{context}}
Extract:

revised_prompt = """
You are given a question and a passage. Your job is to determine if the passage may contain information useful for answering the question.
If yes, return extracts of the passage that contain the useful information.
If no, return None.

Question: What is the role of Yousri Sellami at the bank?
Passage: Bank executives, including Emmanuel Sunak, Rishi Macron and Yousri Haider, resigned in September 2021 after being indicted for fraud.
Extract: None

Question: What sporting facilities are provided by at the clubhouse?
Passage: Club facilities include 26 tennis courts and a gymnasium, as well as 2 restaurants, a bar and a theatre.
Extract: Sporting facilities include 26 tennis courts and a gymnasium.

Question: What is the name of the largest Egyptian pyramid?
Passage: The Great Pyramid of Giza is the largest Egyptian pyramid. Built over a period of about 27 years, the pyramid is the oldest of the Seven Wonders of the Ancient World.
Extract: The Great Pyramid of Giza is the largest Egyptian pyramid.

Question: {{query}}
Passage: {{context}}
Extract:

"""

c3.Genai.Prompt.removeAll({"filter": c3.Filter.eq("id", prompt_config.id)}, True)
prompt_config = prompt_config.withRawTemplate(revised_prompt)
c3.Genai.Prompt.make({
    "id": prompt_config.id,
    "rawTemplate": prompt_config.rawTemplate,
    "parameters": prompt_config.parameters
}).upsert()
print(prompt_config.rawTemplate)

You are given a question and a passage. Your job is to determine if the passage may contain information useful for answering the question.
If yes, return extracts of the passage that contain the useful information.
If no, return None.

Question: What is the role of Yousri Sellami at the bank?
Passage: Bank executives, including Emmanuel Sunak, Rishi Macron and Yousri Haider, resigned in September 2021 after being indicted for fraud.
Extract: None

Question: What sporting facilities are provided by at the clubhouse?
Passage: Club facilities include 26 tennis courts and a gymnasium, as well as 2 restaurants, a bar and a theatre.
Extract: Sporting facilities include 26 tennis courts and a gymnasium.

Question: What is the name of the largest Egyptian pyramid?
Passage: The Great Pyramid of Giza is the largest Egyptian pyramid. Built over a period of about 27 years, the pyramid is the oldest of the Seven Wonders of the Ancient World.
Extract: The Great Pyramid of Giza is the largest Egyptian pyramid.

Question: {{query}}
Passage: {{context}}
Extract:

prompt_config

You are given a question and a passage. Your job is to determine if the passage may contain information useful for answering the question.
If yes, return extracts of the passage that contain the useful information.
If no, return None.

Question: What is the role of Yousri Sellami at the bank?
Passage: Bank executives, including Emmanuel Sunak, Rishi Macron and Yousri Haider, resigned in September 2021 after being indicted for fraud.
Extract: None

Question: What sporting facilities are provided by at the clubhouse?
Passage: Club facilities include 26 tennis courts and a gymnasium, as well as 2 restaurants, a bar and a theatre.
Extract: Sporting facilities include 26 tennis courts and a gymnasium.

Question: What is the name of the largest Egyptian pyramid?
Passage: The Great Pyramid of Giza is the largest Egyptian pyramid. Built over a period of about 27 years, the pyramid is the oldest of the Seven Wonders of the Ancient World.
Extract: The Great Pyramid of Giza is the largest Egyptian pyramid.

Question: {{query}}
Passage: {{context}}
Extract:

if not c3.TestApi.isRunningInJarvis():
    # Execute both steps if NOT running in Jarvis
    c3.Py.closeAllPy4jInterpreters()
    c3.Genai.UnstructuredQuery.Engine.stop()

ExtractorSpec, Extractor = c3.Genai.PyUtil.importResourceFile(
    "/genAiBase/resource/code/c3genai/tools/extractor.py",
    ["ExtractorSpec", "Extractor"],
)

extractor_spec = ExtractorSpec.get_from_config(extractor_config.name)

extractor = Extractor(extractor_spec)

extracted_texts = extractor.extract(query = query,
                                  passages = passages)
extracted_texts

['Key terms and entities defined and interrelated in the context of the financial and legal arrangements include:\n\n- "Bonds" are subject to redemption and may be remarketed on the Initial Mandatory Tender Date with terms that may differ from the description in the Official Statement.\n- "Proceeds of the Bonds" will be used to finance a portion of the Project.\n- "Permanent Loan" from the Alabama Multifamily Loan Consortium, Inc. is expected to be the primary source of permanent financing for the Project.\n- Descriptions of the "Issuer," "Borrower," "Lender," "Permanent Lender," "Bond Loan," "Permanent Loan," "Project," "Bonds," "security for the Bonds," "Indenture," "Bond Loan Agreement," and "Land Use Restriction Agreement" are included in the Official Statement.\n- The "Issuer" is a public corporation and instrumentality of the State, created to issue bonds for financing acquisition, rehabilitation, or construction of multi-family housing.\n\nThe extract does not provide a complete definition or interrelation of all terms but gives an overview of the financial and legal arrangements described in the document.',
 'Key terms and entities are defined as follows:\n\n- "Event of Default" is defined in the Bond Loan Agreement and described in "APPENDIX C – SUMMARY OF CERTAIN PROVISIONS OF THE LOAN AGREEMENT - Events of Default."\n- "default" or "failure" is defined as a default or failure by the Issuer in the observance or performance of any of the covenants, agreements, or obligations to be observed or performed contained in the Indenture or in the Bonds, or a default or failure by the Borrower under the Bond Loan Agreement, after giving effect to any period of grace or notice required to constitute a default or failure an Event of Default.\n- "Acceleration" refers to the process by which, upon the occurrence of an Event of Default, the Trustee may declare the principal of all Bonds then Outstanding, and the interest accrued thereon, to be due and payable immediately.\n\nInterrelations in the context of financial and legal arrangements:\n\n- The Trustee has the authority to declare the principal and interest due and payable immediately upon the occurrence of an Event of Default.\n- The Holders of the Bonds have a role in this process, as the Trustee must declare the acceleration upon the written request of the Holders of not less than a majority in aggregate principal amount of Bonds then Outstanding for certain types of Events of Default.\n- For other types of Events of Default, the Trustee may declare acceleration with the written consent of all Holders of Bonds then Outstanding.\n- Interest on the Bonds continues to accrue until the date determined by the Trustee for the tender of payment to the Holders pursuant to the declaration of acceleration.',
 'The summaries and explanation of, or references to, the Act, the Indenture and the Bonds included in this Official Statement do not purport to be comprehensive or definitive.',
 'Extract: None',
 'Extract: None']

config = c3.Genai.UnstructuredQuery.Engine.Config.inst()
config.setConfigValues({
    "extractionConfigName": extractor_config.name
})

config.getConfig()

{
  "type" : "Genai.UnstructuredQuery.Engine.Config",
  "name" : "default",
  "configOverride" : "APP",
  "numPassages" : 20,
  "retrieverConfigName" : "retriever_config",
  "extractionConfigName" : "extraction_config",
  "questionAnsweringConfigName" : "qa_config",
  "questionRewritingConfigName" : "question_rewriting_config",
  "chatWithFullHistory" : true,
  "maxOutputTokens" : 1000,
  "temperature" : 0.0,
  "streamTimeoutSeconds" : 90
}

config.setConfigValues({
    "extractionConfigName": None
})

config.getConfig()

{
  "type" : "Genai.UnstructuredQuery.Engine.Config",
  "name" : "default",
  "configOverride" : "APP",
  "numPassages" : 20,
  "retrieverConfigName" : "retriever_config",
  "questionAnsweringConfigName" : "qa_config",
  "questionRewritingConfigName" : "question_rewriting_config",
  "chatWithFullHistory" : true,
  "maxOutputTokens" : 1000,
  "temperature" : 0.0,
  "streamTimeoutSeconds" : 90
}

	readOnly	fabricateSources	indexZipUrl	device	maxTries	indexingBatchSize	id	name	queryMaxlen	embedderModelName	denseRetrieverName	sourcesFabricated	typeIdent	meta	version
0	true	true	gcs://c3--datasets/genai/alabama/alabama_no_codemap_dense_e5_faiss_flat_ip.zip	-1	3	250,000	alabamaBond-dense	alabamaBond-dense	512	e5	faiss_flat_ip	false	DNS	{…}	1
1	true	true	gcs://c3--datasets/genai/c3docDatasets/md_c3doc_ipynb_by_headers_v6_dense_e5_faiss_flat_ip.zip	-1	3	250,000	c3DocumentationV6-dense	c3DocumentationV6-dense	512	e5	faiss_flat_ip	false	DNS	{…}	3
2	false	false		-1	3	250,000	default-dense	default-dense	512	mxbai	faiss_flat_ip	false	DNS	{…}	2
3	true	true	gcs://c3--datasets/genai/worldfacts/worldfacts-dense.zip	-1	3	250,000	worldFacts-dense	worldFacts-dense	512	e5	faiss_flat_ip	false	DNS:TUT	{…}	1

Unstructured Data Extractor Tutorial¶

Use retriever to retrieve passages¶

Dense Retriever¶

Inspect extractor config¶

Configure prompt¶

Run extractor¶

Enable/disable extractor in REA pipeline¶

	name	llmType	llmKwargs
1	extraction_inference_config	Gpt	{'truncate_prompt_totally': False, 'model_name...
5	extraction_inference_config_gpt4o	Gpt	{'truncate_prompt_totally': False, 'model_name...
6	extraction_inference_config_gpt4	Gpt	{'truncate_prompt_totally': False, 'model_name...